Jira Connector Implementation Details
Jira Connector relies on a named credential and a matching custom setting in order to connect to a Jira instance (either on-premise Jira Server or Jira Cloud).
The Jira instance must comply with the following conditions:
- Jira must be accessible via Internet.
- The access from the Salesforce IP ranges must not be blocked by a firewall.
- The Jira instance must be accessible using HTTPS with TLS 1.1 or TLS 1.2.
- The SSL certificate must be signed by a trusted SSL Root Certificate (no self-signed certificates).
- All intermediate certificates must be available during the SSL handshake.
- The Jira worklogs must be stored in the Jira database (some 3rd party Jira plugins store data to other servers).
The worklog data is structured in worklog periods and worklogs. Worklog periods and worklogs are in a master-detail relationship.
Worklog Object
The Worklog object holds the actual worklog data. It includes all fields that are available in the Jira worklog and, in addition, some Jira issue-specific fields. The following information is available:
| Field | Jira Source Field | Data Type | Description |
|---|---|---|---|
| Name | - | Autonumber W-{000000000} |
- |
| Author | worklog.author.displayName | Text(255) | The Jira user who created the Jira worklog, falls back to worklog.author.name or UNKNOWN for inactive/deleted Jira users. |
| Comment | worklog.comment | Long Text Area(2000) | The comment saved with the Jira worklog, truncated to 2000 characters. |
| Connection | - | Text(255) | The name of the Jira connection. |
| Created | worklog.created | Date/Time | The creation timestamp of the Jira worklog. |
| End | - | Formula(Date/Time) | The end time, calculated by the worklog.started timestamp and the worklog.timeSpentSeconds field. |
| Hours Worked | - | Formula(Number) | The number of worked hours accumulated for this worklog. |
| Issue Components | issue.components | Text(255) | A comma-separated list of Jira issue components. |
| Issue Description | issue.description | Long Text Area(32768) | The description saved with the Jira issue. |
| Issue Id | issue.id | Text(255) | The ID saved with the Jira issue. |
| Issue Key | issue.key | Text(255) | The key ID saved with the Jira issue, is set to UNKNOWN if the issue is not accessible. |
| Issue Summary | issue.summary | Text(255) | The summary saved with the Jira issue, truncated to 255 characters. |
| Issue Type | issue.type | Text(255) | The name of the Jira issue type. |
| Project Key | project.key | Text(255) | The project key saved with the Jira issue, is set to UNKNOWN if the issue is not accessible. |
| Started | worklog.started | Date/Time | The start timestamp of the Jira worklog. |
| Time Spent | worklog.timeSpent | Text(255) | A human-readable time spent string ( 2h 30m). |
| Time Spent Seconds | worklog.timeSpentSeconds | Number(18,0) | The duration tracked for the Jira worklog in seconds. |
| Update Author | worklog.updateAuthor.displayName | Text(255) | The Jira user who updated the Jira worklog, falls back to worklog.updateAuthor.name or UNKNOWN for inactive/deleted Jira users. |
| Updated | worklog.updated | Date/Time | The timestamp specifying when the worklog has been updated by the Update Author. |
| URL | worklog.self | URL | The permalink to the worklog in the Jira UI, falls back to a REST URL if the issue is not accessible. |
| Worklog Id | worklog.id | Text(255) | The ID of the worklog, prefixed with the connection string ( JIRA_10003). This field is used to upsert existing worklogs without knowing their Salesforce ID. |
| Worklog Id (No Prefix) | worklog.id | Text(255) | The ID of the worklog without prefix. |
| Worklog Period | - | Master-Detail(Worklog Period) | The ID of the master worklog period. |
Note
The Jira issue-related fields remain empty if the user who retrieves the worklog data has no access to the related issue.
Info
If required, you can
- add Jira custom fields to the Worklog object
- distribute worklogs to different worklog periods
Worklog Period Object
The Worklog Period object can be used to combine worklogs using your own criteria. JustOn keeps at least one worklog period record per Jira connection.
The worklog period includes the following information:
| Field | Data Type | Description |
|---|---|---|
| Key | Text(255) | A unique identifier, used to upsert existing worklog periods without knowing their Salesforce ID. |
| Connection | Text(255) | The name of the Jira connection. |
Info
If required, you can create additional fields to roll up values from worklogs to worklog periods.