- 04 Nov 2022
- 4 Minutes to read
- Updated on 04 Nov 2022
- 4 Minutes to read
ARM-JIRA integration automatically posts updates to Jira tickets when you run validations and deployments, with a link back to the full report in ARM. It makes tracking the status of your user stories and support tickets faster and easier. Tasks can be organized by project, allowing an organization to track issues within projects transparently.
To put it simply: JIRA allows you to track any kind of unit of work (be it an issue, bug, story, project task, etc.) through a predefined workflow. However, in order to integrate JIRA as a plugin with ARM, it does require some steps in ARM to get it configured. The below section will help you out to get JIRA configured in ARM in easy steps.
Integrate JIRA with ARM
Step 1: Store your user's JIRA credential in ARM
This is an initial step where the user's JIRA credential, such as username and password, is stored in ARM.
- Log in to your ARM account.
- Hover your mouse over the Admin module and click on the Credentials tab.
- Next, click on Create Credential from the right navigation bar.
- On the next pop-up screen, give a Credential name.
- Choose the Credential Type as 'User name with Password.'
- Enter your JIRA username and password; we will store this encrypted.
- Please double-check that you use your JIRA username instead of the email address that you use to log in to JIRA.
- Click Save.
- Use the "https://id.atlassian.com/manage/api-tokens" link to generate a new API token.
- Click on "Create API Token," provide the label name and click on Create.
- The token gets created. You will be able to see the "Your new API token" popup; click on the "Copy to Clipboard."
- Use the copied token as a password for creating/updating the credential in ARM.
- Once updated, please use the same credential to authenticate the JIRA.
Step 2: Integrate JIRA with ARM
- If you're logged out from your account, log in again into ARM with your credentials.
- Go to Admin > My Account section.
- Click on New ALM System under the ALM Management section.
- Select ALM type as 'JIRA' from the drop-down.
- Enter the label name of your own choice.
- Enter your JIRA subdomain (e.g., https://[subdomain].atlassian.net) in the URL field.
- Select the same user's credential created in Step 1.
- Click Test Connection to check if the connection has been authenticated or not. A success message is displayed after the authentication is completed.
- Click Save and your Jira integration are ready.
- Once you log in, JIRA is integrated with your ARM account, and you can start logging bugs and issues with just one click directly to JIRA.
Mapping JIRA to Salesforce Org/ Version Control
Once you are done registering the plugins with ARM, make sure you map the JIRA ALM type with your required Salesforce Org/ Version Control. Mapping will help you manage a seamless and accurate Salesforce change management process directly from within your Jira projects and teams.
- Go to the Salesforce Org Management(Admin > SF Org Mgmt.) page.
- Select the Salesforce org for which you like to map the JIRA as a plugin.
- Under Salesforce Org- Mappings tab, choose JIRA as ALM type and click on Mapping.
- Select the label and the project.
- Click Save Mappings. The selected plugin will be mapped with your Salesforce Org.
Configuring JIRA Work items in ARM
You and your team members have a provision to perform actions on Jira issues or update the JIRA work items while running a commit or during a CI job.
In the EZ-Commit screen and under the Post Commit section, you need to:
- Select the checkbox: Update ALM Workitem Status
- Select the ALM type as JIRA.
- Select the ALM Label, project, and the sprint for which the commit is planned.
- Select the work item and the status.
- Once the changes are committed to the version control system, the status of the ALM work item is updated and reflected in your ALM system.
In CI Job
- Package from Version Control
- Deploy from Version Control
- Deploy from the SFDX branch to a Salesforce Org
- Install an Unlocked Package from Version Control Branch
- Go to the Build section under the New Create CI Job screen.
- Tick the Map ALM Project (Ex: Jira) checkbox.
- Go to the ALM section. Here you can configure the work item type status in JIRA ALM to include in the build.
- Select the ALM type as JIRA.
- Select the ALM Label and its related Projects.
- The active sprint(s) for the above-selected Project will be available in the Sprint drop-down. ARM has given provisions for you to update multiple sprints related to tasks or bugs and update the status on the go when running the CI Job. You can select either one of the sprints or if you wish to update the status for all the sprints, leave it as default, i.e., keep 'All Active Sprints' in the selected mode.
- Select the Work Item type. Here you can select multiple work items that you like the update the status in your ALM. To use all the work item types, keep the 'All Work Item Type' option selected by default.
- Based on the above work item selected, you need to update the status for each work item type. See the screenshot attached.