# JIRA

### JIRA: Overview <a href="#jira-overview" id="jira-overview"></a>

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.

Point to Note: **Jira OAuth** access type is currently supported for **Cloud versions** only. This function is on-demand, so if you'd want to make it available for your organization, please get in touch with our experts at <support@autorabit.com>.

### Integrate JIRA with ARM <a href="#integrate-jira-with-arm" id="integrate-jira-with-arm"></a>

#### Step 1: Store your user's JIRA credential in ARM <a href="#step-1-store-your-users-jira-credential-in-arm" id="step-1-store-your-users-jira-credential-in-arm"></a>

This is an initial step where the user's JIRA credential, such as username and password, is stored in ARM.

1. Log in to your ARM account.
2. Hover your mouse over the **Admin** module and click on the **Credentials** tab.

<figure><img src="/files/q4LEi68EdyhOsp7H2nKT" alt="" width="353"><figcaption></figcaption></figure>

3. Next, click on **Create Credential** from the right navigation bar.

<figure><img src="/files/szzSfFJ89mlj0UiDpGNq" alt=""><figcaption></figcaption></figure>

4. On the next pop-up screen, give a **Credential name**.
5. Choose the **Credential Type** as '**User name with Password.'**
6. Enter your JIRA **username** and **password;** we will store this encrypted.
7. Please double-check that you use your JIRA username instead of the email address that you use to log in to JIRA.
8. Click **Save**.

<figure><img src="/files/Q4bveODIic4apepztaxW" alt="" width="416"><figcaption></figcaption></figure>

{% hint style="warning" %}
**Troubleshooting:**

While registering JIRA with ARM, JIRA fails to connect and results in **"Authentication Failure,"** please use the below steps to re-authenticate the JIRA.

1. Use the **"<https://id.atlassian.com/manage/api-tokens>"** link to generate a new API token.
2. Click on **"Create API Token,"** provide the label name and click on **Create**.
3. The token gets created. You will be able to see the **"Your new API token"** popup; click on the **"Copy to Clipboard."**
4. Use the copied token as a password for creating/updating the credential in ARM.
5. Once updated, please use the same credential to authenticate the JIRA.
   {% endhint %}

#### Step 2: Integrate JIRA with ARM <a href="#step-2-integrate-jira-with-arm" id="step-2-integrate-jira-with-arm"></a>

1. If you're logged out from your account, log in again into ARM with your credentials.
2. Go to **Admin > My Account** section.
3. Click on **New ALM System** under the **ALM Management** section.

<figure><img src="/files/yymu3a6h4rkfvAxFgSeF" alt=""><figcaption></figcaption></figure>

4. Select **ALM type** as '**JIRA'** from the drop-down.

<figure><img src="/files/BhhRFy9DivmoWM1XSSzy" alt="" width="379"><figcaption></figcaption></figure>

5. Enter the **label name** of your own choice.
6. Enter your JIRA subdomain (e.g., *https\://\[subdomain].atlassian.net*) in the **URL** field.
7. Select the same **user's credential** created in **Step 1**.
8. Click **Test Connection** to check if the connection has been authenticated or not. A success message is displayed after the authentication is completed.
9. Click **Save** and your Jira integration are ready.
10. 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.

{% hint style="danger" %}
**Limitation:**

**Jira OAuth** access type is currently supported for **Cloud versions** only. This function is on-demand, so if you'd want to make it available for your organization, please get in touch with our experts at <support@autorabit.com>.
{% endhint %}

### Steps to Configure OAuth in ARM

1. **Create an OAuth App in Atlassian**
   * Go to the Atlassian Developer Console and create a new **OAuth 2.0 (3LO)** app.
   * Enter the **callback URL** provided in ARM.
   * Copy the **Client ID** and **Client Secret**.
2. **Configure in AutoRABIT**
   * In ARM, go to **Admin > My Account**.
   * Scroll to **ALM Settings** and expand the **JIRA** section.
   * Enter the **Client ID**, **Client Secret**, and the **callback URL**.
   * Click **Test Credentials**, then **Save**.
3. **Authorize the Connection**
   * You’ll be redirected to JIRA to log in and approve access.
   * Once authorized, the connection is complete.

<figure><img src="/files/8YXQaIIYBhm8bvmLSdlI" alt="" width="563"><figcaption></figcaption></figure>

{% hint style="info" %}
**Note:** In multi-user environments, ensure that the Jira OAuth application is set to **“Sharing”** in the Atlassian Developer Console (Distribution section). If it remains in **“Not Sharing”** mode, only the app owner will be able to authenticate, and other users may encounter authorization errors during re-authentication.
{% endhint %}

### Mapping JIRA to Salesforce Org/ Version Control <a href="#mapping-jira-to-salesforce-org-version-control" id="mapping-jira-to-salesforce-org-version-control"></a>

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.&#x20;

1. Go to the **Salesforce Org Management(Admin > SF Org Mgmt.)** page.
2. Select the **Salesforce org** for which you like to map the JIRA as a plugin.
3. Under **Salesforce Org- Mappings** tab, choose **JIRA** as ALM type and click on **Mapping**.
4. Select the **label** and the **project**.
5. Click **Save Mappings**. The selected plugin will be mapped with your Salesforce Org.

<figure><img src="/files/PTnPBTNuxt4RMd7wkLUz" alt=""><figcaption></figcaption></figure>

### Configuring JIRA Work items in ARM <a href="#configuring-jira-work-items-in-arm" id="configuring-jira-work-items-in-arm"></a>

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 EZ-Commit <a href="#in-ezcommit" id="in-ezcommit"></a>

In the **EZ-Commit** screen and under the **Post Commit** section, you need to:

1. Select the checkbox: **Update ALM Workitem Status.**
2. Select the **ALM type** as **JIRA.**
3. Select the **ALM Label, project,** and the **sprint** for which the commit is planned.
4. Select the **work item** and the **status**.

<figure><img src="/files/978bwxRXF4lCi1uTZVxY" alt=""><figcaption></figcaption></figure>

5. 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 <a href="#in-ci-job" id="in-ci-job"></a>

{% hint style="info" %}
**Important Notes:**&#x20;

Configuring the Jira work items is applicable to the following CI jobs:

* 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
  {% endhint %}

1. Go to the **Build** section under the **New Create CI Job** screen.
2. Tick the **Map ALM Project (Ex: Jira)** checkbox.

<figure><img src="/files/FMEzSj5XXCMC9SgDJmxi" alt="" width="441"><figcaption></figcaption></figure>

3. Go to the **ALM** section. Here you can configure the work item type status in JIRA ALM to include in the build.
4. Select the **ALM type** as **JIRA.**
5. Select the **ALM Label** and its related **Projects**.

<figure><img src="/files/JvY47KP8ZeTrHXtEQDL3" alt="" width="563"><figcaption></figcaption></figure>

6. 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.

<figure><img src="/files/acLbSZcqbIy2feWTt5LH" alt=""><figcaption></figcaption></figure>

7. 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.
8. Based on the above work item selected, you need to update the status for each work item type. See the screenshot attached.

<figure><img src="/files/uUwLZiulVYr6z21qlcnT" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://knowledgebase.autorabit.com/product-guides/arm/integration-and-plugins/jira.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
