The WiseTime Patrawin Connector is currently under development, and is not ready for production use. This notice will be removed once the connector is deemed production-ready.
The WiseTime Patrawin Connector connects WiseTime to Patrawin, and will automatically:
- Create a new WiseTime tag whenever a new case is created in Patrawin
- Create a new WiseTime tag whenever a new client is created in Patrawin
- Record a new time registration in Patrawin whenever a user posts time to WiseTime
In order to use the WiseTime Patrawin Connector, you will need a WiseTime Connect API key. The WiseTime Patrawin Connector runs as a Docker container and is easy to set up and operate.
WiseTime posts time to a temporary table in the Patrawin db. Patrawin has a service broker that will transfer the data written to the temp database to the rigth tables in the patrawin db. This needs to be set up in Patrawin according to this setup guide.
Configuration is done through environment variables. The following configuration options are required.
| Environment Variable | Description |
|---|---|
| API_KEY | Your WiseTime Connect API Key |
| PATRAWIN_JDBC_URL | The JDBC URL for your Patrawin database |
| PATRAWIN_DB_USER | Username to use to connect to the Patrawin database |
| PATRAWIN_DB_PASSWORD | Password to use to connect to the Patrawin database |
The following configuration options are optional.
| Environment Variable | Description |
|---|---|
| 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 Patrawin tags. Defaults to /Patrawin/ (trailing slash is required). Use / for root folder. |
| TAG_UPSERT_BATCH_SIZE | Number of tags to upsert at a time. A large batch size mitigates API call latency. Defaults to 500. |
| DATA_DIR | If set, the connector will use the directory as the location for storing data to keep track of the Patrawin cases and clients that it has synced. By default, WiseTime Connector will create a temporary dir under /tmp as its data storage. |
| RECEIVE_POSTED_TIME | If unset, this defaults to LONG_POLL: use long polling to fetch posted time. Optional parameters are WEBHOOK to start up a server to listen for posted time. DISABLED no handling for posted time |
| TAG_SCAN | If unset, this defaults to ENABLED: Set mode for scanning external system for tags and uploading to WiseTime. Possible values: ENABLED, DISABLED. |
| WEBHOOK_PORT | The connector will listen to this port e.g. 8090, if RECEIVE_POSTED_TIME is set to WEBHOOK. Defaults to 8080. |
| LOG_LEVEL | Define log level. Available values are: TRACE, DEBUG, INFO, WARN, ERROR and OFF. Default is INFO. |
| ADD_SUMMARY_TO_NARRATIVE | When true, adds total worked time, total chargeable time and experience weighting (if less than 100%) to the narrative when posting time to Patrawin. Defaults to false. |
| TIMEZONE | The timezone to use when posting time to Patrawin, e.g. Australia/Perth. Defaults to UTC. |
| HEALTH_CHECK_INTERVAL | A number of minutes given for importing data from pending time table to Patrawin tables before health check fails. Defaults to 5 minutes. |
| ALERT_EMAIL_ENABLED | Enable email alerts |
| ALERT_EMAIL_INTERVAL_HH_MM | Email alerts interval hours, minutes ie 05:30 for 5 hours and 30 minutes |
| ALERT_RECIPIENT_EMAIL_ADDRESSES | string that represents list of recipient addresses |
| ALERT_SENDER_EMAIL_ADDRESS | Email alerts sender email address |
| ALERT_EMAIL_SENDER_USERNAME | Email alerts sender username. Often an be the same as sender email address |
| ALERT_EMAIL_SENDER_PASSWORD | Email alerts sender password |
| ALERT_MAIL_SMTP_HOST | Email alerts smtp host address |
| ALERT_MAIL_SMTP_PORT | Email alerts smtp port |
| ALERT_STARTTLS_ENABLE | Set to true for email alerts smtp host that supports TLS |
| ALERT_MAIL_SMTP_SOCKET_FACTORY_PORT | Port for access via ssl will be defaulted to ALERT_MAIL_SMTP_PORT if not set |
| ALERT_MAIL_SMTP_SOCKET_FACTORY_CLASS | Socket factory class is required for SSL. It will be defaulted to javax.net.ssl.SSLSocketFactory if not set |
| ACTIVITY_TYPE_SCAN | If unset, this defaults to ENABLED: Set mode for scanning external system for activity types and uploading to WiseTime. Possible values: ENABLED, DISABLED. |
| ACTIVITY_TYPE_BATCH_SIZE | Number of activity types to upsert at a time. A large batch size mitigates API call latency. Defaults to 500. |
The connector needs to be able to read from the ARENDE_1, KUND_24, BEHORIG_50 and FAKTURATEXTNR_15 tables, and call the post_time stored procedure in the Patrawin database.
The easiest way to run the Patrawin Connector is using Docker. For example:
docker run -d \
--restart=unless-stopped \
-v volume_name:/usr/local/wisetime-connector/data \
-e DATA_DIR=/usr/local/wisetime-connector/data \
-e API_KEY=yourwisetimeapikey \
-e PATRAWIN_JDBC_URL="jdbc:sqlserver://HOST:PORT;databaseName=DATABASE_NAME;ssl=request;useCursors=true" \
-e PATRAWIN_DB_USER=dbuser \
-e PATRAWIN_DB_PASSWORD=dbpass \
wisetime/wisetime-patrawin-connector
To receive alert emails you need to add alert emails settings, for example:
docker run -d \
--restart=unless-stopped \
-v volume_name:/usr/local/wisetime-connector/data \
-e DATA_DIR=/usr/local/wisetime-connector/data \
-e API_KEY=yourwisetimeapikey \
-e PATRAWIN_JDBC_URL="jdbc:sqlserver://HOST:PORT;databaseName=DATABASE_NAME;ssl=request;useCursors=true" \
-e PATRAWIN_DB_USER=dbuser \
-e PATRAWIN_DB_PASSWORD=dbpass \
-e ALERT_EMAIL_ENABLED=true \
-e ALERT_EMAIL_INTERVAL_HH_MM=05:00\
-e ALERT_RECIPIENT_EMAIL_ADDRESSES=recipient@email.com \
-e ALERT_SENDER_EMAIL_ADDRESS=sender@email.com \
-e ALERT_EMAIL_SENDER_USERNAME=senderusername \
-e ALERT_EMAIL_SENDER_PASSWORD=senderpassword \
-e ALERT_MAIL_SMTP_HOST=smtp.host.name \
-e ALERT_MAIL_SMTP_PORT=smtp_port \
-e ALERT_STARTTLS_ENABLE=true \
wisetime/wisetime-patrawin-connector
If you are using RECEIVE_POSTED_TIME=WEBHOOK: Note that you need to define port forwarding in the docker run command (and similarly any docker-compose.yaml definition). If you set the webhook port other than default (8080) you must also add the WEBHOOK_PORT environment variable to match the docker ports definition.
The Patrawin 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.
To build a Docker image of the WiseTime Patrawin Connector, run:
make docker