Jira Connector

The Jira connector supports a single integration source for multiple projects.

This topic provides details for the Jira connector, including:

  • Connector Overview

    • The name of the .NET assembly file

    • The connection methodology

    • Use case scenarios

  • Connector Operation

    • Details for creating an Integration Source and Outbound Actions.

    • Architectural and functional details that ensure the running of the use case through the Inbound and Outbound action functionality of the Integration Platform.

  • Field Mappings

    • Details on mandatory fields, restricted fields, and how to map list item field values.

    • Examples for using transforms, profile maps and resolution rules.

  • Ongoing Operation

    • Steps for creating a Jira issue from an ASM Call or from a ASM workflow task.

    • How the updates are handled between the Jira issue and ASM call/task.

    • How to cancel the Jira issue from ASM and how to close the ASM call/task from Jira.

The Alemba®.Connector.Jira.icnf needs to be configured before using the Jira Connector. For assistance configuring the ICNF file, contact your Account Manager to engage an Alemba® Professional Services Consultant.

For compatibility and version support details, refer to the ASM Connector Matrix.

You should familiarize yourself with the information in Installing Connectors before installing any connectors, and read the Integration topics for more information on how to configure them.

Connector Overview

You can create an issue in Jira from a call or task in Alemba Service Manager™. The Jira issue is synchronized with its originating ASM call or task, so that changes made in either product can be reflected in both products.

You can use this connector with Jira Cloud or the installed version.

The Jira connector:

  • Sends transactions to the Jira REST API to perform actions such as creating issues in Jira, updating fields and comments in the issue, and updating issue status.

  • Retrieves transactions from Jira at polling intervals (ASM Connector Service) to perform actions such as updating fields or adding notes to the ASM call or task.

The type of action performed is part of the Integration Platform settings, creating adequate transactions, ensuring proper communication, and maintaining reconciled information between ASM and Jira.

This connector can be used with the cloud version of Jira and the installed version.

Use Case Scenario

The interoperability concept can be broken down into several use cases that are listed in the table below.

Connector Description

The table below provides a description of the Jira Connector.

Information fields

Name

Connector name

Atlassian JIRA Connector

Third-party application

Atlassian Jira

Assembly

Alemba®.Connector.Jira.dll

Configuration file

Alemba®.Connector.Jira.icnf

Operation Method

Jira REST API

Connection Parameters

Connection parameters

Description

URL

The address for the Jira system. For Jira Cloud, enter the web address. For installed Jira, use the server address.

https://myJIRAsystem.atlassian.net

https://myJIRAserver

Login ID

The Username of a Jira user, not their email address. This user must have sufficient rights to the project(s) and issue type(s), as well as issue create, edit and transition permissions.

Password

The password of the user defined in the Login ID.

Action and Communication Protocol

The connector allows issues to be created in Jira based on information sent by ASM. The creation and update of issues relies on actions being implemented between Jira and ASM. These actions are supported by a particular communication protocol composed of a set of specific transactions, as illustrated below.

  • ASM sends a Create message to initiate an action for Jira to perform.

  • Both ASM and Jira can send Update messages to each other when required.

  • ASM can send Notify messages to Jira when required.

  • ASM can send a Cancel message to stop any further processing of the issue in Jira.

  • A Complete message is sent by Jira when the issue is successfully completed.

Connector Requirements

Ensure the port for the REST API is open in the firewall. The default port is 443 for https.

Ensure the content type application/json is accessible through the firewall.

The Alemba®.Connector.Jira.icnf needs to be configured before creating the Integration Source for Jira. Developer Notes for the Jira ICNF are available for developers experienced in customizing ICNF files. For assistance with the ICNF file, contact your Account Manager to engage an Alemba® Professional Services Consultant.

Installation

No install is required for this connector. This connector is visible in the Integration module, ready to be configured.

Diagnostics

The connector has the facility to trace information. The data can be obtained through Polling tracing or Application tracing.

Additional Information

This connector does not include any Federated CMDB population functionality.

Connector Operation

Steps required to make the Jira connector available for use:

  1. Verify the REST API is Accessible from the ASM server.

  2. Configure the Alemba®.Connector.Jira.icnf file, as explained here.

  3. Configure ASM Core with a Source for Jira.

  4. Configure ASM Core for Outbound actions.

Verify the REST API is Accessible

In a web browser, enter the endpoint address from the connector source connection details and append /rest/api/2/serverInfo. (case sensitive)

https://myJIRAsystem.atlassian.net/rest/api/2/serverInfo

The following page should be returned:

If this page is not returned there may be a blocked port on the firewall. Contact your Network Administration team to resolve.

The Jira connector requires the configured port to be open on the firewalls between servers, including application/json messages. The default ports are 80 for http and 443 for https.

Configure a Source for Jira

Before you start

The Alemba®.Connector.Jira.icnf file needs to be configured before creating the Source for Jira. For assistance configuring the ICNF file, contact your Account Manager to engage an Alemba® Professional Services Consultant.

  1. Select ≡ > Admin > Integration.

  2. In the Explorer pane, under Integration, select Sources.

  3. Select the button on the toolbar. In the pop up window, select Atlassian JIRA Connector from the drop-down list.

  4. In the Integration Source Details window, complete the details.

Name
Type a name for the integration source

Status

This field is pre-filled with the Active status

Connector

This field is pre-filled with the Connector type

Assembly.TypeName

This field is pre-filled based on the selected connector as defined in the Connector DLL, and is read-only

JIRA Credentials

URL

Type the address for the Jira system. For Jira Cloud enter the web address. For installed Jira use the server address.

Login ID

Enter the Username of a Jira user. This user needs access to the project(s) and issue type(s), as well as issue create, edit and transition permissions.

Password

Enter the password of the user defined in the Login ID.

Further fields are displayed on this window, but you do not need to complete them at this stage.

  1. Select the button on the toolbar to test the connection.

  2. After 3 failed login attempts Jira may block the account and require a 'CAPTCHA' validation before unblocking it. Use a web browser to log into Jira with that login ID to complete the validation, and then attempt another test connect from the connector source.

  3. Save the details.

If the Source details are later changed, the ASM Connector Service must be restarted in order for the changes to take effect.

Configure the Outbound Actions

Outbound Actions are used by calls that are forwarded externally and by External Supplier tasks that are forwarded externally. The outbound action is selected by matching the external supplier and/or contract in the call or task to the external supplier and/or contract in the Outbound Action.

Outbound Action Tasks do not use these settings, and instead contain their own set of mappings which are configurable through the task in the workflow template.

Before you start

The Outbound Actions checkbox must be enabled in the Integration Platform Settings.

The integration Source for the Jira connector must be configured.

  1. Select ≡ > Admin > Integration.

  2. In the Explorer pane, under Integration, select Outbound Actions.

  3. In the Filter by Source field, select the Jira source name from the drop-down list; for example if you created a source with the title "My Jira Connector", this will be displayed in the list.

  4. All available outbound actions are listed in the browse table. Choose the one you want to work with and then select .

  5. The Outbound Action Type [action name] window appears.

  6. To create a new mapping select New

  7. To edit an existing mapping, select the mapping and then select Open

  8. In the Mapping window, complete the details.

Name
Type a name for the mapping. This name appears in the Mappings table.

Screen Set

Select a call or External Supplier task screen set from the multi-tiered list. The screen set determines the fields that will be available for this mapping under the Fields - Outgoing and Fields - Incoming tabs.

Call screen set

Select to enable the Outbound Action to trigger when a call is forwarded externally. Call screen sets are defined by your system administrator.

External Supplier screen set