OTOBO Development Tutorial

This is the OTOBO Development Tutorial, which provides guidance for developers who want to extend and customize OTOBO. It covers topics such as the architecture of OTOBO, how to create and publish extensions, and how to contribute to the OTOBO project.

Warning

This documentation is for the 11.1 beta version of OTOBO. It may contain incomplete or inaccurate information, and some features may not be fully functional. Please use this documentation with caution and report any issues to the OTOBO development team. You may find the documentation for the latest stable release at https://doc.otobo.org/manual/installation/11.0/en/content/index.html.

Contents

• Getting Started
  • Development Environment
    • Obtain the Source Code
    • Useful Tools
    • Linking Expansion Modules
    • Tipps and tricks
  • Architecture Overview
    • Directories
    • Files
    • Core Modules
    • Front End Handle
    • Front End Modules
    • CMD Front End
    • Generic Interface Modules
    • Scheduler Task Handler Modules
    • Database
• OTOBO Internals - How it Works
  • Config Mechanism
    • Defaults.pm: OTOBO Default Configuration
    • Automatically Generated Configuration Files
    • XML Configuration Files
    • Accessing Config Options at Runtime
  • Database Mechanism
    • SQL
    • XML
    • Database Drivers
    • Supported Databases
  • Log Mechanism
    • System Log
    • Communication Log
  • Date and Time
    • Introduction
    • Creation of a DateTime Object
    • Time Zones
    • Method Summary
    • Deprecated Package Kernel::System::Time
  • Skins
    • Skin Basics
    • How Skins Are Loaded
    • Creating a New Skin
  • The CSS and JavaScript Loader
    • How it works
    • Basic Operation
    • Configuring the Loader: JavaScript
    • Configuring the Loader: CSS
  • Templating Mechanism
    • Template Commands
    • Using a Template File
  • Creating Your Own Themes
  • Localization / Translation Mechanism
    • Marking Translatable Strings in the Source Files
    • Collecting Translatable Strings Into The Translation Database
    • The Translation Process Itself
    • Using The Translated Data From The Code
  • Async Jobs
    • Load parent module
    • Use functions from parent module
• How to Extend OTOBO
  • Writing A New OTOBO Front End Module
    • What we want to write
    • Default Config File
    • Front End Module
    • Core Module
    • Template File
    • Language File
    • Summary
  • Writing A New OTOBO Front End Component
    • The Goal
    • Using The Skeleton Command
    • The Route Configuration
    • Component Template Code
    • Component Core Code
    • Component Style Code
    • Passing Parameters to the Route Component
    • Component Folders
    • Packaging Additional Vendor Modules
  • Using the power of the OTOBO module layers
    • Agent Authentication Module
    • Authentication Synchronization Module
    • Customer Authentication Module
    • Customer User Preferences Module
    • Queue Preferences Module
    • Service Preferences Module
    • SLA Preferences Module
    • Log Module
    • Output Filter
    • Stats Module
    • Ticket Number Generator Modules
    • Events
    • Ticket Event Modules
    • Events in the OTOBO Standard
    • Examples from Other Packages
    • How to Find Events on Your System
    • Best Practices for Event Modules
    • Dashboard Module
    • Notification Module
    • Ticket Menu Module
    • Root Application Module Layer
    • Network Transport
    • Mapping
    • Invoker
    • Operation
    • OTOBO Daemon
    • OTOBO Scheduler
    • Overview
    • Dynamic Fields Framework
    • Dynamic Field Interaction With Front End Modules
    • How To Extend The Dynamic Fields
    • Create New Dynamic Field
    • Creating a Dynamic Field Functionality Extension
    • Ticket Postmaster Module
    • Process Management
    • Autoload Modules
• How to Publish Your OTOBO Extensions
  • Package Management
    • Package Distribution
    • Package Commands
  • Package Building
    • Package Spec File
    • Example .sopm
    • Package Build
    • Package Life Cycle
  • Package Porting
    • Front End Messages
    • Styling Improvements
    • Encode API Changed
    • LinkObject API Changed
    • Event Handling Changes
• Documentation
  • Documentation Infrastructure
  • reStructuredText Primer
    • Headings
    • Paragraphs
    • Inline Markups
    • Lists
    • Literal Blocks
    • Tables
    • Hyperlinks
    • Images
    • Colored Boxes
  • Style Guide
    • Writing Content
    • Screenshots
    • Capitalization in Documentation
    • Buttons and Screen Names
    • Wording
    • Variable Names
  • Translating the Documentation
• Contributing to OTOBO
  • Sending Contributions
  • Translating
  • Code Style Guide
    • Perl
    • JavaScript
    • HTML
    • CSS
  • User Interface Design
    • Capitalization
  • Accessibility Guide
    • Accessibility Basics
    • Accessibility Standards
    • Implementation guidelines
  • Unit Tests
    • Creating a Test File
    • Selenium Tests
    • Prerequisites for Testing
    • Testing
    • Unit Test API
• Additional Resources
• Documentation History

License

This work is copyrighted by OTRS AG (https://otrs.com), Zimmersmühlenweg 11, 61440 Oberursel, Germany.

Copyright © for modifications and amendments 2019-2020 ROTHER OSS GmbH (https://otobo.de), Oberwalting 31, 94339 Leiblfing, Germany

Terms and Conditions OTRS: Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license can be found on the GNU website.

Terms and Conditions Rother OSS: Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled “COPYING”.

Published by: Rother OSS GmbH, (https://otobo.de), Oberwalting 31, 94339 Leiblfing, Germany.

Authors: OTRS AG (original version), Rother OSS GmbH (https://otobo.de).