otrs-turbo/README.md

OTRS Turbo

REST API client and ticket dashboard for OTRS / Znuny.

Setup Customer User API Integration (LDAP support)

To retrieve customer users from external backends like LDAP or Active Directory, you must install custom Generic Interface operations on the OTRS server.

1. Copy Perl Backend Modules

Copy the custom Perl modules from the otrs-backend-modules folder to your OTRS server:

• Copy otrs-backend-modules/CustomerUserSearch.pm to: /opt/otrs/Kernel/GenericInterface/Operation/CustomerUser/CustomerUserSearch.pm

• Copy otrs-backend-modules/CustomerUserGet.pm to: /opt/otrs/Kernel/GenericInterface/Operation/CustomerUser/CustomerUserGet.pm

(Note: Create the directory /opt/otrs/Kernel/GenericInterface/Operation/CustomerUser/ if it does not exist).

2. Copy XML Configuration Registration

Copy the configuration registration XML file to enable the new operation endpoints in OTRS system configuration:

• Copy otrs-backend-modules/CustomerUserGenericInterface.xml to: /opt/otrs/Kernel/Config/Files/XML/CustomerUserGenericInterface.xml

3. Rebuild OTRS Configuration

Run the following commands on the OTRS server as the otrs user to apply the changes:

# Rebuild the system configuration database
/opt/otrs/bin/otrs.Console.pl Maint::Config::Rebuild

# Reset permissions (if needed)
/opt/otrs/bin/otrs.SetPermissions.pl

# Delete OTRS cache
/opt/otrs/bin/otrs.Console.pl Maint::Cache::Delete

4. Enable Operations in your Web Service

1. Log in to the OTRS/Znuny Admin interface.
2. Go to Web Service Management and select your web service (e.g., GenericTicketConnectorREST).
3. Add the two operations:
   • CustomerUserSearch (Controller: CustomerUser::CustomerUserSearch)
   • CustomerUserGet (Controller: CustomerUser::CustomerUserGet)
4. Configure the route mappings for these operations:
   • CustomerUserSearch -> RequestMethod: POST, Route: /CustomerUserSearch
   • CustomerUserGet -> RequestMethod: POST, Route: /CustomerUserGet
5. Save the web service.