Jira Connection¶
Introduction¶
A Jira connection, created using the Jira connector, establishes access to Jira. Once a connection is configured, you can create instances of Jira activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).
Create or Edit a Jira Connection¶
A new Jira connection is created using the Jira connector from one of these locations:
- The design component palette's Connections tab (see Design Component Palette).
- The Global Connections page (see Create a Global Connection in Global Connections).
An existing Jira connection can be edited from these locations:
- The design component palette's Connections tab (see Design Component Palette).
- The project pane's Components tab (see Component Actions Menu in Project Pane Components Tab).
- The Global Connections page (see Edit a Global Connection in Global Connections).
Configure a Jira Connection¶
Each user interface element of the Jira connection configuration screen is described below.
Tip
Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket
[
into the field or by clicking the variable icon to display a list of the existing variables to choose from.
-
Connection Name: Enter a name to use to identify the connection. The name must be unique for each Jira connection and must not contain forward slashes
/
or colons:
. This name is also used to identify the Jira endpoint, which refers to both a specific connection and its activities. -
Hostname: Enter the Jira hostname. The name can be preceded by either
https://
orhttp://
. If not provided,https://
is assumed. -
Username: Enter the Jira username.
-
Instance Type: Select an instance type from the list, either Jira Cloud or Jira On-premise:
-
Jira Cloud: Connect to Jira Software Cloud.
-
Jira On-premise: Connect to Jira Server or Jira Data Center.
-
-
Jira Server Version: When Jira On-premise is selected as the Instance Type, select the version of Jira Server or Jira Data Center to use, either 8.22.3 or 9.4.3.
-
Auth Type: Select the authentication type for the Jira instance, either API Token or Password. This option is visible only when Jira On-premise is selected as the Instance Type. If Jira Cloud is selected as the Instance Type, you must enter an API token for authentication.
-
API Token: Enter the API token for the Jira instance.
-
Password: Enter the password for the Jira instance.
-
Use Proxy Settings (Private Agent Only): When using a Private Agent, this setting can be selected to use Private Agent proxy settings.
-
Test: Click to verify the connection using the provided configuration.
-
Save Changes: Click to save and close the connection configuration.
-
Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.
-
Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component Dependencies, Deletion, and Removal). A message asks you to confirm that you want to delete the connection.
Next Steps¶
After a Jira connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).
Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions Menus in Connector Basics.
These activity types are available:
-
Search: Retrieves object data from a Jira project and is intended to be used as a source in an operation.
-
Issue: Creates, updates, or deletes an issue in a Jira project and is intended to be used as a target in an operation.
-
Create: Creates object data in a Jira project and is intended to be used as a target in an operation.
-
Update: Updates object data in a Jira project and is intended to be used as a target in an operation.
-
Search Dashboard: Retrieves dashboard data from Jira and is intended to be used as a source in an operation.
-
Delete: Deletes object data from Jira and is intended to be used as a target in an operation.
-
Transition: Retrieves or updates Jira issues and is intended to be used as a target in an operation.
-
Search Filter: Retrieves filter data from Jira and is intended to be used as a source in an operation.