# Connecting Your ALM

{% hint style="warning" %}
**Important Note:** The actions described here are available **only to Org Administrators**. General ARM users cannot access ALM Management.
{% endhint %}

## Why Integrate an ALM? <a href="#overview" id="overview"></a>

AutoRABIT can connect to popular **Application Lifecycle Management (ALM)** platforms—Jira, Azure DevOps, IBM RTC, CA Agile Central (Rally), and VersionOne—to:

* Surface active and inactive sprints in one place.
* Sync work-item status automatically during merges, commits, and CI jobs.
* Enforce release governance with smart-commit patterns and webhook automation.

The **ALM Management** page (added in ARM 21.6) lives under **Admin** and lets you register new ALM connections, set integration rules, and manage repository mappings.

***

## Register an ALM <a href="#registering-an-alm" id="registering-an-alm"></a>

1. Log in to ARM as an administrator.
2. Navigate to **Settings › ALM Mgmt**.
3. Click **Register ALM**.<br>

   <figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2F999W4tAm7px4gzcvxwu8%2Fimage.png?alt=media&#x26;token=86522128-6bf3-4149-8d79-33e33d65454b" alt=""><figcaption></figcaption></figure>
4. Fill the form:

   **IBM RTC, CA Agile Central, Salesforce, ServiceNow VersionOne, or Azure DevOps**\
   \
   ![](https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FMBDhlcfngJStXbZyHm6M%2Fimage.png?alt=media\&token=103be71a-dc2c-4bb1-8c81-24dde7618ab9)<br>

   * **ALM Name** – friendly label.
   * **ALM Type** – choose the platform.
   * **ALM URL** – base server URL.
   * **Credentials** – select stored credentials (see [Credential Manager](https://knowledgebase.autorabit.com/product-guides/arm/troubleshoot/how-tos/create-users-credentials)).

   **Jira**\
   \
   ![](https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FRf3LyatvnRXHRPn0ONp2%2Fimage.png?alt=media\&token=34c42818-3e8b-470c-8355-a17951c15d5c)

   * **ALM Name** – friendly label.
   * **ALM Type** – *Jira*.
   * **Access Type** –
     * **Standard** – enter **ALM URL** and credentials.
     * **OAuth** – pick **OAuth**, click **Validate & Save**, and grant access in the Jira pop-up.

{% hint style="info" %}

* Jira **OAuth** is supported for **Cloud** editions only.
* OAuth appears only after you register Jira OAuth credentials in **ALM Settings**. Learn how [here](https://knowledgebase.autorabit.com/product-guides/arm/arm-administration/user-management/manage-users-account-settings).
* **Access Token** expires after 1 hour; **Refresh Token** after 90 days.

{% endhint %}

5. Click **Test Connection** to verify access, then **Save**.

{% hint style="info" %}
**Troubleshooting Authentication**\
An *Authentication Failed* error on the EZ-Commit screen often stems from VPN issues or outdated credentials.

1. Go to **My Account › ALM Configuration**.

2. Click **Test Connection** to re-authenticate.

3. If it still fails, create a new credential and relink the ALM.
   {% endhint %}

4. The new ALM appears in the **ALM List**.
   * Toggle **AR Comments** to disable AutoRABIT-generated comments in Jira.
   * For Jira, you can switch **Access Type** between *Standard* and *OAuth* and click **Re-Authenticate** when tokens expire.

{% hint style="info" %}
**Limitation:** Jira OAuth is Cloud-only and enabled on request. Contact **<support@autorabit.com>** if you need it.
{% endhint %}

***

## Integration Settings <a href="#integration-settings" id="integration-settings"></a>

Configure how work items are shown and filtered:

1. **Display work items from inactive sprints** – include backlog items.
2. **Enable global filter criteria on work items** – add column filters as needed.
3. Click **Save Settings**.\ <br>

   <figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FPEprlN8tFThldm9qxhar%2Fimage.png?alt=media&#x26;token=0809e132-ccce-412e-9d90-6989e3205206" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
To remove a field’s filter, click the trash-can icon next to the rule.
{% endhint %}

***

## Smart Commits <a href="#smart-commits" id="smart-commits"></a>

Define the pattern AutoRABIT uses to parse work-item references in commit messages—for example:

```

git commit -m "\[PROJECT-123] add README"

```

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FzvGpsWGDkZOyJmVK6UQw%2Fimage.png?alt=media&#x26;token=bbce24c6-1cd7-4c1a-a1aa-4076c25a32b6" alt="Smart Commits pattern settings" width="488"><figcaption></figcaption></figure>

* **Enable auto update on webhook** – reveals a webhook URL you can add to your VCS so external commits update the ALM automatically. See setup guides [here](https://knowledgebase.autorabit.com/product-guides/arm/arm-features/webhooks).
* Optionally **sync external smart commits** made outside AutoRABIT.

***

## Merge request settings/ Repository Mappings <a href="#repository-mappings" id="repository-mappings"></a>

Repository mappings let AutoRABIT update ALM work-item status after a successful merge.

{% hint style="info" %}

* A mapping is **required** for smart-commit syncing.
* Status changes apply **only** to merges performed through merge requests.

{% endhint %}

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2F37cZTyMD4FBVoG8mHoAo%2Fimage.png?alt=media&#x26;token=de2d1eb5-ac66-4f79-8969-322a0647a33a" alt="" width="563"><figcaption></figcaption></figure>

1. Choose the version-control **Repository**.
2. Select the **Source Branch** (click *Register here* if it’s missing).
3. Pick the **ALM Project**.
4. In **ALM Work Item Status**, define:
   * **Work Item Type**
   * Current status
   * Target status after merge<br>

     <figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FKt9cg1gAiCNSKydvoeJV%2Fimage.png?alt=media&#x26;token=a69705d3-af43-4e8a-b322-8bdd5be61269" alt="" width="375"><figcaption></figcaption></figure>
5. Click **Save**.

{% hint style="info" %}
Branches and repos you **can’t** access won’t appear in the dropdowns.
{% endhint %}

6. Suppress ALM email noise by listing addresses in **Notify exception status updates to**.\ <br>

   <figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FHZT8ZQYBb88hpdhVy8x5%2FScreenshot%202025-08-16%20at%2010.01.11%E2%80%AFPM.png?alt=media&#x26;token=5a26e753-c404-47fc-8dab-dd9c520d40bb" alt="" width="563"><figcaption></figcaption></figure>

### For Salesforce as ALM <a href="#registering-an-alm-1" id="registering-an-alm-1"></a>

1. Log in to ARM as an administrator.
2. Navigate to Settings **› ALM**.
3. Click **Register ALM**.\\

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2F42BtnDFh8ky57VomsonV%2Fimage.png?alt=media&#x26;token=e5974003-3c55-4f4d-b4f2-05ab684e627e" alt=""><figcaption></figcaption></figure>

1. Fill the form:
   1. **ALM Name** – friendly label.

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FfprJMzsBX8izVGURNBt4%2Fimage.png?alt=media&#x26;token=77911257-ede3-4c7b-a335-d809fe8365bc" alt="" width="188"><figcaption></figcaption></figure>

**Field Mapping for Work Item Updates in Salesforce**

b. Salesforce Org Select the Salesforce Org from your list of registered orgs where the work item updates should be applied.

c. Custom Object / Work Item Type Choose the Custom Object that represents your Work Items (e.g., User\_Story\_\_c, Bug\_\_c). This is where the Work Item ID will be updated.

d. Title Field Map the field that represents the project or feature to which the Work Item belongs. This is usually a custom text field like Project\_\_c.

e. Assignee Field Select the custom field that stores the user assigned to the Work Item. This allows AutoRABIT to track ownership of the User Story or Bug.

f. Status Field Choose the custom field that reflects the current status of the Work Item (e.g., New, In Progress, Ready for QA, Closed). This field can be updated automatically based on the commit action.

g. Comment Field Select the custom field where commit-related comments should be posted. The system will populate this with detailed commit information after the action is performed. **1. Select Post Commit Action** Under the Post Commit section, select:

**2. Update ALM Work Item Status**

**Configure ALM Fields** Fill in the required fields to ensure the correct ALM Work Item is updated post-commit:

**ALM Type**: Choose the integrated ALM tool (e.g., Salesforce).

* ALM Label: Select the applicable label for this commit operation.
* ALM Project: Pick the project or module name (e.g., User Story, Bug).
* ALM Work item: Select the Work Item ID you wish to update.
* ALM Work Item Status: Choose the new status you want to set (e.g., To Do, In Progress, Done).
* Current Status: Shows the status of the item (e.g., In Testing).\\

  ![](https://knowledgebase.autorabit.com/~gitbook/image?url=https%3A%2F%2F1912836914-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F9vAxMuDrkUkB4OXlH9CL%252Fuploads%252FKvHx2ZEBlAb77Vz4EAcI%252Fimage.png%3Falt%3Dmedia%26token%3D1a66279e-12b8-4862-b8ff-ffb6b58cdd0a\&width=768\&dpr=3\&quality=100\&sign=716a9e77\&sv=2)

![](https://knowledgebase.autorabit.com/~gitbook/image?url=https%3A%2F%2F1912836914-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F9vAxMuDrkUkB4OXlH9CL%252Fuploads%252F6pZoIGCNNDXXzjoE8YjB%252Fimage.png%3Falt%3Dmedia%26token%3D5362b6f3-08c5-4b37-a6fb-58868db6f707\&width=768\&dpr=3\&quality=100\&sign=bea94eb\&sv=2)

**Complete the Commit** Click Commit after configuring all required fields. The system will:

* Perform the commit action.
* Post-commit, automatically update the ALM Work Item to the new selected status.
* Add relevant commit information to the comment field (if configured), including metadata, user, and validation results.

**Sample Outcome Post Commit Comment Format:** The selected Work Item will reflect the updated status in your ALM tool and include commit metadata like:

\[Message] \[\*\*\*\*\*\*\*\*\*\*\*\*]# Saas tool Integration-2

\[Repository] \*\*\*\*\*\*\*\*\*\*;

\[Branch] 18235\_test

\[Revision] 3637289

\[Committed by] \*\*\*\*\*\***@**.com

\[Committed metadata members] {Apex Class=\[A000, A0000]}

\[Pre-validation Results]

Label Name = \*\*\*\*\*\*\*\*\*\***.**\*\*

Apex Test Results = NA

Static Analysis = NA

Deployment Org = NA

Overall Validate Deployment Status = NA

Approved By = ***.@***\*\*\*.com
