Jira Connector Reference
Jira is a powerful project management tool and ticketing system used to help users plan, track, release, and report product issues in order to improve development.
To use Jira Connector with Composer, you must have the Administrator Jira global permission. For more information, see the Jira documentation.
Connections
To connect to a system, whether it is a source of data or the target where you are sending data, you must create a connection with that system’s required credentials. You typically connect to different systems within a flow and can reuse each connection every time you need to connect.
This system requires the following credential information for its connections:
- Connection Name
-
Enter a connection name that will help you remember the details of this connection. You can reuse connections multiple times in a single flow, and in more than one flow, and the credentials are hidden after you create the connection. Therefore, it’s helpful to provide a name that easily identifies this connection from others.
Only you can see the connection. Other users in your Composer app must create their own connections.
- Organization Site URL
-
Enter the URL of the Jira organization containing the sandbox or production environment to which you want to connect. If you do not specify a value in the Organization Site URL field, the connection uses the first URL listed in the
/resources
endpoint of the Atlassian API. Set the Organization Site URL field for every connection if you want the connection to use a specific organization instead of a default organization. For more information about Jira organizations, see the Jira documentation.To connect to a Jira organization via an Atlassian account:
-
In the Connect to your Jira Account window, in the Organization Site URL field, enter the Jira organization URL. For example,
https://orgname.atlassian.net
. -
Click Connect.
An Atlassian window appears, indicating that Composer is requesting access to an Atlassian account. -
In the window, in the Authorize for site dropdown, select the organization you want to use and then click Accept.
Composer is now connected to your Jira organization.
-
- Username
-
The OAuth username that you use to log in to Jira.
- Password
-
The OAuth password that you use to log in to Jira.
Triggers
Each flow starts with either a scheduler or a trigger. Schedulers are set to a default frequency of 15 minutes. Triggers, such as "each time a new record is created", are defined by you and provide multiple options related to the data in your system.
Triggers use a polling process to actively check for new updates from an external system. The polling frequency is 15 seconds.
This system provides the following trigger options:
- New issue with Custom Fields
-
Checks for a new issue with Custom fields created in Jira.
- New issue with Standard Fields only
-
Checks for a new issue with Standard fields created in Jira.
- Update issue with Custom Fields was updated or created
-
Checks for updated or created issues with Custom fields in Jira.
- Update issue with Standard Fields only was updated or created
-
Checks for updated or created issues with Standard fields in Jira.
Polling Frequency
For triggers in this connector, the Polling Frequency field is required. This field enables you to select how often Composer makes a request to the underling system API to look for changes to records in active flows. You can select a different polling frequency for each flow in your organization. With a shorter frequency, the flow executes more often; however, a shorter frequency consumes more API calls. For example, if you have an order management flow, you might require nearly real-time updates, which can be achieved with a 15-second polling interval (which equates to 5760 API calls per day). In contrast, if your flow updates a pricing catalog, you could poll the flow every hour (which equates to 24 API calls per day).
Actions
After you connect to a system and define the trigger or configure a scheduler, you define the actions that the flow performs. For example, you can copy a record between different systems, such as Workday and Salesforce. The actions you can perform depend on which system you are connected to.
This system provides the following actions:
- Create issue with custom fields
-
Creates a new issue within the selected project. Provide a value for the following fields:
-
Project
-
Key
-
Summary
-
Type
-
Status
-
Priority
-
- Update issue with custom fields
-
Updates specified Custom field values. Provide a value for the following fields:
-
Issue ID or Key
-
Notify Users
-
- Update issue with standard fields only
-
Updates specified Standard field values. Provide a value for the following fields:
-
Issue ID or Key
-
Notify Users
-
- Get issue
-
Returns details for a specific issue. Provide a value for Issue ID or Key.
- Add comment to issue
-
Creates and adds a comment to an existing issue. Provide a value for the following fields:
-
Issue ID or Key
-
Comment Text
-
- Create project
-
Creates a new project based on a project type template in Jira. Provide a value for the following fields:
-
Key
-
Name
-
Lead Account ID
-
Project Type Key: The value in this field must begin with an uppercase letter followed by one or more uppercase letters or numbers.
-
- Get project
-
Returns the project details in Jira. Provide a value for Project ID or Key.
- Retrieve project
-
Retrieves the project details for an existing project in Jira. Provide a value for Project ID or Key.
- Retrieve attachments for an issue
-
Returns all attachments for this issue. This returns the files' metadata but not the contents of the files. The files are ordered by the date that they were uploaded. Provide a value for Project ID or Key.
- Retrieve attachment
-
Returns a URL redirect to the raw file for a specified file attachment. Provide a value for Attachment ID.
- Upload an attachment for an issue
-
Uploads an attachment for a Jira issue. Provide a value for the following fields:
-
Issue ID or Key
-
File Name
-
Custom Fields
Using MuleSoft Composer, you can access Standard custom field values in Jira for actions and triggers that you set in the Jira issue.
Custom fields containing the following list components are not currently supported:
-
Text fields (multi-line)
-
Labels
-
Checkboxes
-
Radio buttons
-
Select lists (multiple-choice)
-
Select lists (cascading)
-
User picker