kromit/titra-zammad-interface repository overview

⁠titra - Zammad interface

this command line utility connects to the PostgreSQL and MongoDB backends of Zammad and titra to exchange time accounting information between the two. Multiple connection checks are run before the actual data transfer starts to avoid network related errors. The interface will create users and customers used in synchronized tickets in titra. One titra project will be created for every synchronized Zammad ticket. Accounted time will be created as tasks inside these projects.

⁠Docker

the interface can be run in a Docker container available on Docker hub under kromit/titra-zammad-interface.

docker run --rm -it kromit/titra-zammad-interface

to mount a custom settings.json file in the docker container:

docker run --rm -v /path/to/settings.json:/app/settings.json -it kromit/tira-zammad-interface

Alternatively the settings can be passed as environment variables which take precedence over the settings.json values:

docker run --rm -e removeNullEntries=false -it kromit/titra-zammad-interface

⁠Configuration

the interface can be configured by providing a settings.json configuration file or passing these options as environment variables

    {
        "titraMongoURL": "mongodb://user:password@host:27017",
        "zammadPostgresURL": "postgres://user:password@host:5432",
        "importTicketStateIDs": [1,2],
        "removeNullEntries": true,
        "createPublicTitraProjects": true
    }

The following settings are available and expect the values described below:

• titraMongoURL: the full mongo URL to connect to the titra host (e.g. mongodb://user:password@host:27017)
• zammadPostgresURL: the full Postgres URL to connect to the Zammad host (e.g. postgres://user:password@host:5432)
• importTicketStateIDs: an array of ticket state IDs to import, possible values in the Zammad default configuration - 1 (new), 2 (open), 3 (pending reminder), 4 (closed), 5 (merged), 6 (removed), 7 (pending close) (e.g. [1,2]) - attention: when you pass this parameter as environment variable you have to use a string format: ["1","2"]
• removeNullEntries: Boolean value indicating wether to import 0 time accounting entries or not (e.g. true)
• createPublicTitraProjects: Boolean value indicating wether new titra projets will be created as public projects or are only visible to the user assigned to the Zammad ticket (e.g. true)