zAgileConnect requires connectors to be installed in both Salesforce as well as JIRA.
It also requires HTTPS connectivity between Salesforce and JIRA. This may be a critical consideration if your JIRA instance is behind the firewall and does not have allow any external access.
This section will describe the installation and configuration of the JIRA plugin.
zAgileConnect plugin for JIRA communicates with its corresponding Salesforce connector to facilitate issue creation and collaboration across the two applications.
- OAuth for access to Salesforce Case information
- Posting of comments to related Case(s)
- Posting of attachments to related Case(s)
- Posting of Issue events to Salesforce Chatter
- Charts displaying various metrics related to Accounts, Cases and related JIRA Issues.
Please note that zAgileConnect is specific to JIRA versions. Please check with zAgile Support to ensure its compatibility with the version of your JIRA instance
Before configuring the plugin, you will need the following information:
- JIRA Admin privileges
- Salesforce user/pwd that will be used for generating an OAuth token. Calls from JIRA to Salesforce for posting comments, attachments, etc. will be made on behalf of this ID, using the token captured here.
- List of Case attributes for copying into specific Issue fields
- List of Issue events that will be posted to Salesforce Chatter
- Interval for refreshing reports to be used in Support dashboards in JIRA
Please note that this configuration requires HTTPS connectivity between Salesforce and JIRA. If JIRA is installed behind the firewall, then a port will need to be opened up for accessibility from Salesforce. The communication is done using HTTPS, therefore, a Salesforce-approved SSL certificate is also required. Salesforce provides guidelines with respect to whitelisted IP addresses that may be used for restricting such accesses to JIRA. The details of such a configuration are outside the scope of this document. For more information, please contact zAgile Support via support at zAgile.com.
The installation and setup of the JIRA plugin involves the following steps:
Uploading the plugin using UPM
Using the JIRA Universal Plugin Manager (UPM), upload the zAgileConnect plugin (add-on) for JIRA directly from the Atlassian Marketplace
Once installed, the plugin offers a number of configuration options (shown below). Some of these are optional and the following section will describe each one.
OAuth Client Settings
Please refer to Creating a Connected App to enable JIRA OAuth to complete the OAuth setting in JIRA and authenticate Salesforce to JIRA
Field mapping - Mapping Case properties into JIRA Issue fields
Beginning with zAgileConnect 1.4, you can also map Case fields directly into JIRA Issue fields, rather than reference them for display only (as show above). This may be useful, for example, if you want to carry over text fields such as environment into Issue Environment or capture Case ID in Issue Label (for searching in JIRA). As shown below, the mapping configuration panel provides best matches based upon field types, however you may select your own fields for mapping purposes. Its important to note that the field data types must be compatible. It is possible to copy checkbox and radio button-type fields from Salesforce into text fields in JIRA. In some such cases, actual values (True, False) of the fields are copied over as text. However, for the sake of consistency, it is best to maintain type compatibility between the fields.
Please note that this mapping is one-way, i.e. from Salesforce to JIRA. You may choose to update these fields whenever the corresponding values in Salesforce are updated. However, any updates in JIRA will not carry over to Salesforce.
Chatter Events Configuration - Configuring Issue Events for posting to Salesforce Chatter
In JIRA, you can configure specific Issue events for posting to Salesforce Chatter. This allows anyone in Salesforce following a Case to be updated on specific events related to the Issue which is linked to the Case. This configuration provides a comprehensive list of Issue events which may be selected for such tracking in Salesforce.
Once a selection is made, all selected events associated with Case-related Issues will be posted to Salesforce Chatter (as shown below).
Configuring refresh rate for Reports related to Salesforce-JIRA linked entities
zAgileConnect provides packaged reports that leverage data captured from Salesforce related to Case, Account, Contact, etc. and its relationship with JIRA Issues. This option provides for the selection of time interval for refreshing the report data. The reports are compiled from the cached data in JIRA Active Objects that corresponds to Issues, their relationships with Cases and Accounts.
Automatically closing Case when Issue is closed
You can also choose to automatically update Case status when a related Issue is closed. You can turn on the option as well as specify the value of the Case status to be updated.
Automatically update Issue(s) on Case update
When mapping Case fields to JIRA Issue fields, this option, when enabled, will update corresponding Issue fields whenever Case fields are updated. Otherwise, the values will be carried over only when the Issue was first created from Case. This may be useful, especially, if the mapped fields may not have any values at the time Case is created.
Backup & Restore
zAgileConnect plugin for JIRA captures and stores Case and Account information related to JIRA issues in JIRA's Active Objects. You can use the options here to backup and restore this data. While JIRA handles this data when migrating or upgrading JIRA, it is strongly recommended that explicit backups be made of this data, independent ot JIRA operations.