IBM App Connect passes key data between Jira and other apps – automatically, in real time.
You can use App Connect to connect Jira to your apps by mapping data graphically – without the need for coding – meaning that you can achieve a return on your investment in minutes or hours, not days or months.
This guide shows you how.
If you can’t find what you want, or have comments about the “how to” information, please either add comments to the bottom of this page or send us your comments by email.
Jira is a proprietary issue tracking product developed by Atlassian which allows bug tracking and agile project management.
A typical business scenario
Consider an example data sync scenario where a newly-created incident in ServiceNow with a high urgency rating causes a new issue to be created in Jira and a Slack message to be sent to service engineers about the case details. If the ServiceNow incident was opened with any other urgency, then a task is created in Jira.
How App Connect can help
App Connect users can integrate apps with both the Jira software-as-a-service (SaaS) and on-premises versions, and can integrate with all of the project templates that are available in Jira; for example, templates such as IT Service Desk, Project Management, Recruitment, Document Approval, Lead Tracking, and Procurement, as well as custom templates. IBM App Connect supports all objects (including custom objects) that are defined in a Jira project, and all CRUD operations.
What should I consider first?
You can see a full list of the actions that are available with Jira on the Applications tab on the App Connect Catalog page. To see the trigger events that are available with your Jira account, you first need to connect IBM App Connect to Jira.
Connecting to Jira
You can use the App Connect Catalog / Applications tab to connect to Jira and to manage your connection accounts. Alternatively, you can connect to Jira in the flow editor when you add a Jira event or action to a flow.
To connect App Connect to Jira, you provide the following connection information (shown in the figure below):
- Jira host and port: The domain-specific Jira server URL that you use to log in to the portal. For example, if your domain is xxx, the server URL would be: https://xxx.atlassian.net. (You only need to specify a port if you are connecting to Jira on premises.)
- Username: The user name (email address) that you use to log in to Jira.
- Password: The API token (or password) of your account. API token is the authentication mechanism preferred by Atlassian. Support for Basic authentication using a password is being withdrawn for existing Atlassian customers for cloud deployments on Confluence and Jira, and is unavailable for new Atlassian customers.
You create an API token from your Atlassian account; Security > API token / Create and manage API tokens:
- Click Create API token.
- In the New API token dialog, enter a memorable and concise label for your token and then click Create.
- Before closing the dialog, click Copy to clipboard and then save the API token somewhere secure for future use.
- Network name (optional): Only needed if connecting to an on-premises instance of Jira.
If your Jira instance is in a private network (an on-premises instance of Jira), you’ll need to set up a secure gateway that App Connect will use to securely access the Jira instance.
If you’ve previously used the Secure Gateway Client to set up a network connection for an App Connect application that is on the same private network as the Jira instance, you can use that network connection. If you don’t have such a network connection in place, configure one as described in Configuring a private network for IBM App Connect. Also ensure that the Jira instance’s host and port are defined in the Secure Gateway Client’s access control list.
Tip: Immediately after creating a new Jira connection account, rename the account to something meaningful to you before starting a flow that uses that account. (You cannot rename the account for an application if that account is currently being used in a flow.) To rename an account, click the Accounts options menu [⋮] on the Applications tab, and then select Rename Account.
After creating a new Jira connection account, you can see the available events to trigger a flow by clicking ‘Show configurable events…’ under the account on the Catalog tab; for example:
If the Jira / Create issue action fails and gives error detail containing “Reporter is required.\”, you can enable the action to complete successfully by making Reporter optional in Jira. On the Jira ‘Issues / View Field Configuration’ page
(https://<instance>.atlassian.net/secure/admin/ViewIssueFields.jspa) scroll down to Reporter, and then click ‘Optional’ (to make the field optional). You should see the ‘REQUIRED’ flag next to Reporter disappear. This should be considered a temporary workaround until IBM App Connect is updated to avoid this issue.
For an example of using IBM App Connect with Jira, see the template “Using the For each node and JSONata to process high priority issues” in the Templates gallery of IBM App Connect. (Outside IBM App Connect, you can browse the templates available on the doc page Templates for IBM App Connect.)