# Jira Integration

OvalEdge supports integration with JIRA, allowing users to track and approve service requests efficiently. JIRA fields can be mapped to corresponding Service Desk fields in OvalEdge, with the flexibility of one-to-one, one-to-many, or many-to-one mappings.

{% hint style="info" %}
The minimum supported JIRA version for OvalEdge integration is JIRA R8.0 or higher.<br>
{% endhint %}

Once integrated, JIRA can be configured as part of the workflow to act as an approver, where requests require JIRA approval to proceed, or simply to track service requests in JIRA without requiring approval.

In OvalEdge, JIRA can be integrated into a specific Service Desk Template using the integration functionality. Once JIRA is set up, metadata from JIRA is fetched, and Service Desk Template fields in OvalEdge are mapped to the corresponding JIRA fields. After mapping, workflows are configured to either use JIRA as an Approver or as a Tracker:

* **Approver:**
  * When JIRA is set as an approver, the service request in OvalEdge will not progress until it is approved in JIRA.
  * If a service request is created in OvalEdge, it awaits approval in JIRA and displays the JIRA ticket ID and status.
  * Once approved or rejected in JIRA, the status is synced back to OvalEdge either by an automated job that runs every 30 minutes or by a manual sync.
    * If approved, the service request is fulfilled in OvalEdge.&#x20;
    * If rejected, the service request is either reopened for further approval or closed.
  * A reopened request will undergo the same approval process in JIRA until it is approved or rejected.
* **Tracker:**
  * If JIRA is used as a tracker, the service request in OvalEdge is mirrored in JIRA without affecting the approval flow in OvalEdge.
  * A JIRA ticket is created, and its ID is displayed in the service request in OvalEdge for reference. However, there is no dependency on JIRA for approval; the ticket is tracked independently in JIRA.

## Set up JIRA in OvalEdge

To configure JIRA in OvalEdge, follow these steps:

1. **Log in to OvalEdge:**
   1. Access the OvalEdge application using your credentials.

2. **Navigate to Integrations:**
   1. Go to **Administration** > **Integrations**.

      <figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2F4jw8Dg1MnX0I8XOHeejb%2Funknown.png?alt=media&#x26;token=70599287-2e4c-4493-8241-1c052309e309" alt=""><figcaption></figcaption></figure>

   2. Click **+ (Add Integration)** button at the top right corner of the page.

   3. An **Add Integration** shutter is displayed. Select the **Integration Type** as Jira from the dropdown lists.

      <figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2FkdWlSFG0mUvznyka2XLy%2Funknown.png?alt=media&#x26;token=da138e90-9b4c-4288-9303-842fb0e5a6d0" alt=""><figcaption></figcaption></figure>

3. **Enter Integration Details:**

   <figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2FSLGpaN84QX3IddAFXBv9%2Funknown.png?alt=media&#x26;token=ff896329-5f5a-4c5a-b71f-63eac0fad0f0" alt=""><figcaption></figcaption></figure>

   1. **Integration Name**: Provide a name for the integration (e.g., JIRA).
   2. **Connector Description**: Add the connector description.
   3. **JIRA Server**: Enter the JIRA instance URL (e.g., <https://ovaledgeservicedesk.atlassian.net>).
   4. **Username**: Input the username associated with the JIRA server.\
      \
      **Note**: To integrate JIRA with OvalEdge, the user linked to the API token must at least have Create Issues or Browse Projects permissions. These permissions allow the user to create issues and perform other actions through the API.
   5. **JIRA API Token**: Provide the secure token for accessing the JIRA API.\
      \
      **Note**: The provided token is exclusive to the OvalEdge application and is not valid for other applications.
   6. **Select Authentication Type**:
      1. Choose the authentication type for verifying user identity:
         1. Basic
         2. Bearer
   7. **Version**: Enter the JIRA server version details, whether installed on a dedicated server (on-premise) or in the cloud.\
      \
      **Note**: The minimum TLS version must be 1.2 for the two applications to integrate. For Basic and Bearer authentication, use the same configurations and parameters.

4. **Validate and Save:**
   1. Click **Validate** to verify the connection details.

      <figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2FkkVha7SCBiy9mI79A9ja%2Funknown.png?alt=media&#x26;token=be93f6e2-ad60-4d10-bcde-7591d7f7b1db" alt=""><figcaption></figcaption></figure>
   2. Click **Save** to store the integration. The saved details will be displayed under the JIRA tab.
   3. After the integration is saved, metadata from the JIRA server will be fetched.
   4. Map the **Service Desk Template fields** with corresponding **JIRA fields**.
   5. Add the mapped fields to approval workflows as needed.

## Mapping Fields

### **Mapping JIRA Fields with Service Desk Template Fields in OvalEdge**

The mapping process in OvalEdge links JIRA fields to the fields in the Service Desk Template within OvalEdge. This allows service requests raised in OvalEdge to be pushed to JIRA, ensuring consistency between both systems. Depending on the use case, the mapping can be one-to-one, one-to-many, or many-to-one.

### **Steps to Map JIRA Fields with Service Desk Template Fields**

#### **Access Service Desk Templates**

1. Go to **Administration > Service Desk Administration > Service Desk Templates**.

   <figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2FgXxoOMmi7BN8QTp2qkOU%2Funknown.png?alt=media&#x26;token=187fc924-799f-4fde-8e1e-03b16496e0d1" alt=""><figcaption></figcaption></figure>

2. Click on the template name to configure the field mapping. This opens the template page displaying **Template Details**. Click the **Ticketing System Integration** tab.

   <figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2FwLXHhI9gEIovbCXTfktG%2Funknown.png?alt=media&#x26;token=62bfeeef-4641-43d0-8a7f-dc5485880cb6" alt=""><figcaption></figcaption></figure>

#### **Open Integration Settings**

1. Click on the Integrations Button:
   1. On the template page, click the **Integrations** button in the top right corner. This opens the **Add Integration** window.

      <figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2FSPZwcH7KhPYjahSQrZ2Y%2Funknown.png?alt=media&#x26;token=cc045681-6b3d-4b28-bbcc-48aaccbea59e" alt=""><figcaption></figcaption></figure>

#### **Configure Integration Details**

<figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2FsNKt3Psg7J1o52tpDfdt%2Funknown.png?alt=media&#x26;token=d8e4e430-deb6-4c68-a6dc-c74c9ee75cc1" alt=""><figcaption></figcaption></figure>

1. Enter Integration Name:
   1. In the Integration Name field, enter the name of the integration (e.g., "JIRA Integration for IT Requests").\`
2. Enter Description:
   1. In the Description field, briefly explain the integration (e.g., "Maps IT support tickets from OvalEdge to JIRA for tracking and resolution").
3. Select Integration System:
   1. From the Integration System dropdown, select **JIRA**. Other available options might include ServiceNow and Azure DevOps.
4. Select Integration Project Mapping:
   1. Select the relevant project in JIRA to which the integration should be linked.
5. Select the Issue Type Specification:&#x20;
   1. Specify the type of issue associated with the integration within JIRA, such as Task, Bug, Gap, Feature, etc.

#### **Define Statuses**

<figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2FG9Hxw4yUwDC3mEZbkZoy%2Funknown.png?alt=media&#x26;token=33611ab0-9cc3-47d6-85ae-47a9b9b8b0b3" alt=""><figcaption></figcaption></figure>

1. Approved Statuses:
   1. In the Approved Statuses field, specify the statuses that signify approval (e.g., Approved).
2. Rejected Statuses:
   1. In the Rejected Statuses field, specify the statuses that signify rejection (e.g., Rejected).

#### **Map Fields Between OvalEdge and JIRA**

<figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2FxeotP2EQCv1xKDJS5HKt%2Funknown.png?alt=media&#x26;token=1fed3360-16d6-41f9-a78c-d9fbad0e187e" alt=""><figcaption></figcaption></figure>

1. Select Service Desk Template Fields:
   1. From the dropdown in the Mapper Fields section, select fields from the Service Desk Template. These are the fields defined in the OvalEdge template (e.g., Priority, Request Type).\
      \
      **Example**: To map the "Priority" field in OvalEdge to the JIRA field, select Priority from the dropdown.
2. Include Name Option:
   1. Select the Include Name checkbox to use the selected Service Desk field as a label in JIRA.\
      \
      **Example**: If the OvalEdge field Priority is mapped to the JIRA field Ticket Type, and Include Name is checked, it will appear in JIRA as **Priority: High**.
3. Select JIRA Fields:
   1. From the dropdown, select the JIRA fields to map (e.g., Ticket Type, Request Priority).\
      \
      **Example**: To map the Priority field in OvalEdge to the Ticket Type field in JIRA, select Ticket Type.

#### **Add Mappings**

1. Click on Add Mapping:
   1. Once both the Service Desk Template and JIRA fields are selected, click **Add Mapping**. This establishes the connection between the two fields.

      <figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2F1ZhHln4bN8FzpEhsEBy3%2Funknown.png?alt=media&#x26;token=7ec840b2-826e-4259-9abb-9e118d33446c" alt=""><figcaption></figcaption></figure>

2. Mapping can be done as follows:
   * One Service Desk field to One JIRA field.
   * One Service Desk field to Multiple JIRA fields.
   * Multiple Service Desk fields to one JIRA field.

#### **Save the Mapping**

<figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2FuQPBqbhjDFIF70X1TrWp%2Funknown.png?alt=media&#x26;token=9060db76-0db3-4440-8af7-45fef8f4b7bf" alt=""><figcaption></figcaption></figure>

1. Verify and Save:
   1. Review the field mappings to ensure accuracy.
   2. Click **Save** to save the integration and mapping details. These will now be displayed under the Integration section of the template.

#### **Manage Integration Settings**

1. Edit, Inactivate, or Delete Integration:
   1. After saving, inactivate or delete the integration as needed.

      <figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2Fi8SdsfmxDSSD8tEa53w2%2Funknown.png?alt=media&#x26;token=ee93b4c5-18b5-420a-bc32-3597e0d36206" alt=""><figcaption></figcaption></figure>

### **Example of Field Mapping**

* **Service Desk Field**: Priority (e.g., High, Medium, Low)
* **Mapped JIRA Field**:  Priority
* **Result in JIRA**: If the Priority is set to High in the Service Request for that template, the corresponding JIRA ticket will have the Priority field set to High.

## Configuring Workflows

### **Configuring Workflows for JIRA in Service Desk Templates**

Workflows in Service Desk Templates allow specifying approvers for service requests. A new workflow can be created, or an existing one can be utilized. JIRA and other external tools, such as Azure DevOps, can be integrated into the workflow. These external tools can function either as approvers for service requests or simply as tools to track the requests from OvalEdge.

**JIRA in Workflows:**

* **JIRA as Approver**: The service request will not progress until approved.
* **JIRA for Ticket Tracking**: The service request information is captured in JIRA, but the request proceeds independently without waiting for approval.

### Steps to Configure JIRA for Approvals or Ticket Tracking

#### Access the Template Workflow

1. Navigate to Service Desk Templates.

   <figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2FeQAbPs07lHvhwBfMiJ45%2Funknown.png?alt=media&#x26;token=9f35cdf2-5872-46f8-aadb-e6c83fd61f68" alt=""><figcaption></figcaption></figure>

   1. Go to **Administration > Service Desk Administration > Service Desk Templates**.
   2. Select the template that includes the JIRA integration.
   3. Click on the **Workflow** tab in the template.
2. Configure JIRA as an Approver.

   <figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2FmS1N4UMAg5lsX2Ac7279%2Funknown.png?alt=media&#x26;token=6849fff1-b036-40d9-8b8d-c170a77d051f" alt=""><figcaption></figcaption></figure>

   1. Add JIRA as an Approver:
      * In the workflow, for the approval level where the ticket should be approved in Jira, select the approval action as “Approve in Jira”.
      * Upon selecting **Approve** in JIRA, the **Status** field is automatically updated based on the selected action.
   2. Select Jira as Approver:
      1. In the **Approver** dropdown, choose **Jira** as the approver.
   3. Map JIRA:
      1. In the Mapper dropdown, select the Jira mapper that was configured for this template. This links the service request to the JIRA system for approval.
   4. Save the Configuration:
      1. After entering all the details, click Save. JIRA is now set as the approver for all service requests of this template. The requests will not proceed until the selected approver approves them.
3. Alternate Step: Configure JIRA for Ticket Tracking Only

   <figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2FbiEMbfNj2gAHzsey3EEB%2Funknown.png?alt=media&#x26;token=ff4634fe-bbff-4af5-a05d-9279c5ae6bbe" alt=""><figcaption></figcaption></figure>

   1. Track Service Requests in JIRA:
      1. If tracking of the service request in JIRA is required without an approval step, the approval action and actor can be anyone.
      2. In the **Track Ticket Via** dropdown, select JIRA.
   2. Save the Configuration:
      1. After entering the required information, click Save. The service requests raised in OvalEdge will be tracked in JIRA, but there will be no dependency on JIRA for the request to proceed.

## Verify the JIRA Integration in OvalEdge

This process ensures that the JIRA integration in OvalEdge is functioning correctly by verifying:

1. **Automatic Ticket Creation in JIRA** – When a service request is raised in OvalEdge, a corresponding ticket should be created in JIRA.
2. **Status Synchronization** – When the status of a JIRA ticket is updated, the corresponding service request status in OvalEdge should reflect the exact change.

### Raise a Service Request in OvalEdge

1. Log in to **OvalEdge** and navigate to the **Data Catalog** module.

2. Locate and select the **data object** (e.g., a Report) for which a service request needs to be created. Example: **Report – Group By Threshold**<br>

   <figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2Fb8qUB7sI4bxv0MQu3qLd%2Funknown.png?alt=media&#x26;token=50b146bd-0161-4bfb-b9c9-d25021329cf4" alt=""><figcaption></figcaption></figure>

3. Click on the selected **data object** to open its **summary page**.

   <figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2FcWklDb2yCnaFV4d8FXmh%2Funknown.png?alt=media&#x26;token=b665b070-27be-4981-b76a-628d69ea2ad2" alt=""><figcaption></figcaption></figure>

4. Click on the **9 Dots** Menu and select Raise a **Service Request > Report Data Quality Issue**.

5. The **Service Request** page is displayed. Click **Continue**.

   <figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2FZbwRogaXPaAbUGntEKEi%2Funknown.png?alt=media&#x26;token=fe1d83f0-54a7-4e18-a72e-282f2abd1efd" alt=""><figcaption></figcaption></figure>

6. Enter the required information in the service request form, including:

   <figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2FhnN25LSYYg8L6RFT3gTw%2Funknown.png?alt=media&#x26;token=3812a039-c91d-414e-bf56-677337eea1e4" alt=""><figcaption></figcaption></figure>

   1. **Summary** – Provide a clear title for the request.
   2. **Description** – Add details explaining the purpose of the request.
   3. **Priority** – Set the urgency of the request (High, Medium, Low).
   4. Other template fields are filled as needed by the requester.

7. Click **Submit** to create the service request in OvalEdge.

   <figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2FS08Z2s5Wq5hGkpGoBLIK%2Funknown.png?alt=media&#x26;token=316ba724-a36c-40e0-bd43-a361598acdaa" alt=""><figcaption></figcaption></figure>

8. Click **Done** to generate the Request Summary. Later, click **Finish**.

   <figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2FbqnXMZUzksPm9nhsIA8L%2Funknown.png?alt=media&#x26;token=a7b05705-f5fc-4087-bd26-2fcee1d3d25b" alt=""><figcaption></figcaption></figure>

### Verify JIRA Ticket Creation

1. After the service request is created, navigate to the **Service Desk > My Requests** in OvalEdge.

   <figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2F6oBJSlv8re4p55XlNjuc%2Funknown.png?alt=media&#x26;token=e8e84500-2ac8-4e32-868a-890e8f16f28e" alt=""><figcaption></figcaption></figure>
2. Open the newly created **Service Request ID** to review the details.

   <figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2FzHh59yYVy5uwNVBSTdIJ%2Funknown.png?alt=media&#x26;token=f3cdc0f1-a9a1-4914-9e2a-f291cddeb9bd" alt=""><figcaption></figcaption></figure>
3. Check if a corresponding **JIRA ticket** has been automatically created.
   1. The JIRA **Integration ID** should be displayed in the service request details.

      <figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2FVcof2iA4XmamHNBhLWUb%2Funknown.png?alt=media&#x26;token=ade948a6-5507-4fe5-a754-069f858e407f" alt=""><figcaption></figcaption></figure>

   2. Navigate to **JIRA** and verify that the ticket exists under the specified **JIRA project**.

      <figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2FP9XrNw7VIy4OGCqrwEH7%2Funknown.png?alt=media&#x26;token=3a4106d2-ba72-4e4e-a864-3e5937cc8357" alt=""><figcaption></figcaption></figure>

### Verify Status Synchronization

1. In **JIRA**, locate the ticket created from the OvalEdge service request.
2. Change the ticket status from **To Do** to **In Progress**.

   <figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2F2ZBHY9cfdauN6npvuSLz%2Funknown.png?alt=media&#x26;token=891fc27a-9e79-42df-8cb7-bfde5fdcfa1a" alt=""><figcaption></figcaption></figure>
3. Navigate back to **OvalEdge** and check the service request status.
4. Confirm that the status change in **JIRA** is reflected in the **OvalEdge Service Desk** for the corresponding service request.

   <figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2FREGCl2pYYyIgNTeszfXP%2Funknown.png?alt=media&#x26;token=4ffb71e7-854f-4c98-bb5d-16a70e073dd4" alt=""><figcaption></figcaption></figure>

### Outcome

* A JIRA ticket is automatically created when a service request is raised in OvalEdge.
* Status changes in JIRA are synchronized with the corresponding service request in OvalEdge.

***

Copyright © 2025, OvalEdge LLC, Peachtree Corners, GA, USA.