Child pages
  • Install and Configure the CRM Plugin for JIRA
Skip to end of metadata
Go to start of metadata

Step-by-step guide


Install the CRM plugin for JIRA add-on in the standard way as you do for any other Atlassian add-ons. For more details on how to install add-ons, please refer to the Atlassian documentation. A 30 day trial license can be obtained by emailing


Once the plugin is successfully installed, please follow these steps to configure the plugin for use.

  1. Navigate to CRM SETUP->Initial Setup in the left hand panel of JIRA's Administration section.

  2. Clicking on Initial Setup will take you to the page shown below where you should provide your License Key, CRM Credentials and JIRA Custom Fields that will be used by the plugin for linking JIRA issues to the Salesforce CRM Server. The fields on this screen are the minimum you need to configure in order to get the plugin up and running.  Once you fill out these fields, click the 'Update Settings' button.

    The plugin needs a CRM username and password so it can log into the Salesforce CRM server, please specify a Username and Password for it to use.

    Initially the plugin creates three new custom fields in JIRA, these fields are used to link a JIRA issue to one or more records in CRM.  For example the "Account" field is used to link to CRM account records, the "Contact" field is used to link to CRM contact fields etc.  By default these three fields are named "Account", "Contact" and "Case" but feel free to re-name them to whatever you wish.  After a JIRA issue is linked to one or more CRM records, changes made in JIRA to those issues will be immediately copied to CRM.  The plugin has two mechanisms for copying data from Salesforce to JIRA, a custom button in Salesforce that is manually clicked and a cron service that runs on the JIRA server that polls the CRM database for new data.  You can use either of these mechanisms or both if you wish.  A common configuration is to use the custom button to create a new issue in JIRA from a CRM record and then use the cron service to copy changes in that CRM record to JIRA.

    The plugin is initially configured with a default set of fields to copy between JIRA and CRM, you can view and change these settings on the plugin's "JIRA/CRM Field Mappings" setup screen.

  3. You can now edit or create an issue in JIRA and use the new Account, Contact and Case fields to search for and link to existing records in your CRM system. You also have the option to create new Case records in CRM from your JIRA issue. To use these fields in JIRA, click on the plus image next to the field, enter part of the record name in the field that appears and then select one of the matching CRM records. Once you have linked a JIRA issue to a CRM Case, the plugin will copy changes between the JIRA issue and the CRM case as specified by the "JIRA/CRM Field Mappings" settings. By default, Comments and Attachments also copied between JIRA and CRM.

    You will notice when viewing an issue in JIRA that has been linked to CRM, that the plugin displays some values from the CRM record in the Account, Contact and Case fields. These fields are initially configured by default to represent the CRM fields that are normally considered the name of the record, but you can control which fields are displayed using the plugin's "CRM Record Definitions" setup screen. Note that these CRM field values are not stored in JIRA but can be if you wish by adding the appropriate field mappings to the plugin's "JIRA/CRM Field Mappings".

  • No labels