Skip to Navigation

OTRS 2.4 - Admin Manual

René Bakker, Hauke Böttcher, Stefan Bedorf, Shawn Beasley, Jens Bothe, Udo Bretz, Martin Edenhofer, Manuel Hecht, Christopher Kuhn, André Mindermann, Henning Oschwald, Thomas Raith, Stefan Rother, Burchard Steinbild

This work is copyrighted by OTRS AG.

You may copy it in whole or in part as long as the copies retain this copyright statement.

UNIX is a registered trademark of X/Open Company Limited. Linux is a registered trademark of Linus Torvalds.

MS-DOS, Windows, Windows 95, Windows 98, Windows NT, Windows 2000, Windows XP, Windows 2003 and Windows Vista are registered trademarks of Microsoft Corporation. Other trademarks and registered trademarks are: SUSE and YaST of SUSE Linux GmbH, Red Hat and Fedora are registered trademarks of Red Hat, Inc. Mandrake is a registered trademark of MandrakeSoft, SA. Debian is a registered trademark of Software in the Public Interest, Inc. MySQL and the MySQL Logo are registered trademarks of MySQL AB.

All trade names are used without the guarantee for their free use and are possibly registered trade marks.

OTRS AG essentially follows the notations of the manufacturers. Other products mentioned in this manual may be trademarks of the respective manufacturer.


Table of Contents

Preface
1. Basics about trouble ticket systems
What is a trouble ticket system and why do you need it?
What is a trouble ticket?
2. OTRS - Open Ticket Request System
Basics
Features
New features of OTRS 2.4
New features of OTRS 2.3
New features of OTRS 2.2
New features of OTRS 2.1
Hard and software requirements
Community
Commercial Support and Services for OTRS
3. Installation / Upgrade of the OTRS framework
The simple way - Installation of pre-built packages
Installing the rpm on a SUSE Linux server
Installing OTRS on a Debian system
Installing OTRS on Microsoft Windows systems
Installation from source (Linux, Unix)
Preparing the installation from source
Installation of Perl modules
Configuring the apache web server
Configuring the database
Setting up the cron jobs for OTRS
Upgrading the OTRS Frameworks
Upgrading .tar.gz
Upgrading RPM
4. First steps in OTRS
Agent web interface
Customer web interface
Public web interface
First login
An overview to the web interface
What is a queue?
User preferences
5. The admin area of OTRS
Basics
Users, groups and roles
Users
Groups
Roles
Customer users and customer groups
Customer users
Customer groups
Queues
Salutations, signatures, attachments and responses
Salutations
Signatures
Attachments
Auto answers
Email addresses
Notifications
SMIME
PGP
States
SysConfig
Using mail accounts
Filtering incoming messages
Executing automated jobs with the GenericAgent
Admin email
Session management
System Log
SQL queries via the SQL box
Package manager
6. Configuring the system
The config files of OTRS
Configuring the system through the web interface
7. Sending/Receiving emails
Sending emails
Via Sendmail (default)
Via SMTP server or smarthost
Receiving emails
Mail accounts configured via the OTRS GUI
Via command line program and e.g. procmail (PostMaster.pl)
Fetching emails via POP3 or IMAP and fetchmail for PostMaster.pl
Filtering/dispatching by OTRS/PostMaster modules (for more complex dispatching)
8. Time related functions
Setting up business hours, holidays and time zones
Business Hours
Fixed date holidays
TimeVacationDaysOneTime
Automated Unlocking
9. Ticket responsibility and ticket watching
Ticket responsibility
Ticket watching
10. Customize the PDF output
11. Using external backends
Customer data
Customer user backend
Database (Default)
LDAP
Use more than one customer backend with OTRS
Backends to authenticate agents and customer users
Authentication backends for agents
Authentication backends for customer users
Customize the customer self registration
Customizing the web interface
Customer mapping
Customize the customer_user table in the OTRS DB
12. States
Predefined states
New
Open
Pending reminder
Pending auto close-
Pending auto close+
Merged
Closed Successful
Closed Unsuccessful
Customizing states
13. Modifying ticket priorities
14. Creating your own themes
15. Localization of the OTRS frontend
16. PGP
17. S/MIME
18. Access Control Lists (ACLs)
19. Stats module
Handling of the module by the agent
Overview
Generate and view stats
Edit - New
Import
Administration of the stat module by the OTRS administrator
Permission settings, groups and queues
SysConfig
Administration of the stats module by the system administrator
Data base table
List of all files
Caching
mkStats.pl
Automated stat generation - Cron
Static stats
Using old static stats
Default stats
20. Additional applications
Calendar
Content manager
File manager
Web mailer
FAQ
System status
21. Performance Tuning
OTRS
TicketIndexModule
TicketStorageModule
Database
MySQL
PostgreSQL
Webserver
Pre-establish database connections
Preloaded modules - startup.pl
Reload Perl modules when updated on disk
Choosing the Right Strategy
mod_gzip/mod_deflate
22. Backing up the system
Backup
Restore
A. Additional Resources
Homepage OTRS.org
Mailing lists
Bug tracking
Commercial Support
B. Configuration Options Reference
Framework
Core
Core::LinkObject
Core::Log
Core::MIME-Viewer
Core::MirrorDB
Core::PDF
Core::Package
Core::PerformanceLog
Core::SOAP
Core::Sendmail
Core::Session
Core::SpellChecker
Core::Stats
Core::Stats::Graph
Core::Time
Core::Time::Calendar1
Core::Time::Calendar2
Core::Time::Calendar3
Core::Time::Calendar4
Core::Time::Calendar5
Core::Time::Calendar6
Core::Time::Calendar7
Core::Time::Calendar8
Core::Time::Calendar9
Core::Web
Core::WebUserAgent
Crypt::PGP
Crypt::SMIME
Frontend::Admin::ModuleRegistration
Frontend::Agent
Frontend::Agent::Dashboard
Frontend::Agent::ModuleMetaHead
Frontend::Agent::ModuleNotify
Frontend::Agent::ModuleRegistration
Frontend::Agent::NavBarModule
Frontend::Agent::Preferences
Frontend::Agent::Stats
Frontend::Customer
Frontend::Customer::Auth
Frontend::Customer::ModuleMetaHead
Frontend::Customer::ModuleNotify
Frontend::Customer::ModuleRegistration
Frontend::Customer::Preferences
Frontend::Public
Frontend::Public::ModuleRegistration
Ticket
Core::ArticleFreeText
Core::FulltextSearch
Core::PostMaster
Core::Ticket
Core::TicketACL
Core::TicketBulkAction
Core::TicketFreeText
Core::TicketFreeTextDefault
Core::TicketFreeTime
Core::TicketWatcher
Frontend::Admin::ModuleRegistration
Frontend::Agent
Frontend::Agent::CustomerSearch
Frontend::Agent::Dashboard
Frontend::Agent::ModuleNotify
Frontend::Agent::ModuleRegistration
Frontend::Agent::NavBarModule
Frontend::Agent::Preferences
Frontend::Agent::Ticket::ArticleAttachmentModule
Frontend::Agent::Ticket::ArticleComposeModule
Frontend::Agent::Ticket::ArticleViewModule
Frontend::Agent::Ticket::ArticleViewModulePre
Frontend::Agent::Ticket::MenuModule
Frontend::Agent::Ticket::MenuModulePre
Frontend::Agent::Ticket::ViewBounce
Frontend::Agent::Ticket::ViewBulk
Frontend::Agent::Ticket::ViewClose
Frontend::Agent::Ticket::ViewCompose
Frontend::Agent::Ticket::ViewCustomer
Frontend::Agent::Ticket::ViewEmailNew
Frontend::Agent::Ticket::ViewEscalation
Frontend::Agent::Ticket::ViewForward
Frontend::Agent::Ticket::ViewFreeText
Frontend::Agent::Ticket::ViewHistory
Frontend::Agent::Ticket::ViewMailbox
Frontend::Agent::Ticket::ViewMerge
Frontend::Agent::Ticket::ViewMove
Frontend::Agent::Ticket::ViewNote
Frontend::Agent::Ticket::ViewOwner
Frontend::Agent::Ticket::ViewPending
Frontend::Agent::Ticket::ViewPhoneNew
Frontend::Agent::Ticket::ViewPhoneOutbound
Frontend::Agent::Ticket::ViewPriority
Frontend::Agent::Ticket::ViewQueue
Frontend::Agent::Ticket::ViewResponsible
Frontend::Agent::Ticket::ViewSearch
Frontend::Agent::Ticket::ViewStatus
Frontend::Agent::Ticket::ViewZoom
Frontend::Agent::TicketOverview
Frontend::Customer
Frontend::Customer::ModuleRegistration
Frontend::Customer::Preferences
Frontend::Customer::Ticket::ViewNew
Frontend::Customer::Ticket::ViewSearch
Frontend::Customer::Ticket::ViewZoom
Frontend::Queue::Preferences
Frontend::SLA::Preferences
Frontend::Service::Preferences
C. Credits
D. GNU Free Documentation License
0. PREAMBLE
1. APPLICABILITY AND DEFINITIONS
2. VERBATIM COPYING
3. COPYING IN QUANTITY
4. MODIFICATIONS
5. COMBINING DOCUMENTS
6. COLLECTIONS OF DOCUMENTS
7. AGGREGATION WITH INDEPENDENT WORKS
8. TRANSLATION
9. TERMINATION
10. FUTURE REVISIONS OF THIS LICENSE
How to use this License for your documents