WiseTime Jira Connector
- Create a new WiseTime tag whenever a new Jira issue is created
- Record a work log entry against the matching Jira issue whenever a user posts time to WiseTime
- Update the Jira issue total worked time when posted time is received
In order to use the WiseTime Jira Connector, you will need a WiseTime Connect API key. The WiseTime Jira Connector runs as a Docker container and is easy to set up and operate.
Configuration is done through environment variables. The following configuration options are required.
|API_KEY||Your WiseTime Connect API Key|
|JIRA_JDBC_URL||The JDBC URL for your Jira database|
|JIRA_DB_USER||Username to use to connect to the Jira database|
|JIRA_DB_PASSWORD||Password to use to connect to the Jira database|
The following configuration options are optional.
|CALLER_KEY||The caller key that WiseTime should provide with post time webhook calls. The connector does not authenticate Webhook calls if not set.|
|TAG_UPSERT_PATH||The WiseTime tag folder path to use for Jira tags. Defaults to
|TAG_UPSERT_BATCH_SIZE||Number of tags to upsert at a time. A large batch size mitigates API call latency. Defaults to 500.|
|PROJECT_KEYS_FILTER||If set, the connector will only handle Jira issues from the configured Jira project keys.|
|DATA_DIR||If set, the connector will use the directory as the location for storing data to keep track on the Jira issues it has synced. By default, WiseTime Connector will create a temporary dir under
|TIMEZONE||The timezone to use when posting time to Jira if the default timezone is not available in Jira's database, e.g.
The connector needs to be able to read from the
jiraissue tables, and write to the
sequence_value_item tables of the Jira database.
Running the WiseTime Jira Connector
The easiest way to run the Jira Connector is using Docker. For example:
docker run -d \ -p 8080:8080 \ --restart=unless-stopped \ -v volume_name:/usr/local/wisetime-connector/data \ -e DATA_DIR=/usr/local/wisetime-connector/data \ -e API_KEY=yourwisetimeapikey \ -e JIRA_JDBC_URL="jdbc:mysql://host:port/jira_database?useUnicode=true&characterEncoding=UTF8&useSSL=false" \ -e JIRA_DB_USER=dbuser \ -e JIRA_DB_PASSWORD=dbpass \ wisetime/jira-connector
The Jira connector runs self-checks to determine whether it is healthy. If health check fails, the connector will shutdown. This gives us a chance to automatically re-initialise the application through the Docker restart policy.
Logging to AWS CloudWatch
If configured, the Jira Connector can send application logs to AWS CloudWatch. In order to do so, you must supply the following configuration through the following environment variables.
|AWS_ACCESS_KEY_ID||AWS access key for account with access to CloudWatch|
|AWS_SECRET_ACCESS_KEY||Secret for the AWS access key|
|AWS_REGION||AWS region to log to|
To build a Docker image of the WiseTime Jira Connector, run: