Jira Transition activity¶
Introduction¶
A Jira Transition activity, using its Jira connection, retrieves or updates Jira issues and is intended to be used as a target to consume data in an operation.
Create a Jira Transition activity¶
An instance of a Jira Transition activity is created from a Jira connection using its Transition activity type.
To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an activity instance in Component reuse.
An existing Jira Transition activity can be edited from these locations:
- The design canvas (see Component actions menu in Design canvas).
- The project pane's Components tab (see Component actions menu in Project pane Components tab).
Configure a Jira Transition activity¶
Follow these steps to configure a Jira Transition activity:
-
Step 1: Enter a name and select an operation
Provide a name for the activity and select an operation. -
Step 2: Review the data schemas
Any request or response schemas are displayed.
Step 1: Enter a name and select an operation¶
In this step, provide a name for the activity and select an operation. Each user interface element of this step is described below.
-
Name: Enter a name to identify the activity. The name must be unique for each Jira Transition activity and must not contain forward slashes
/
or colons:
. -
Select an Operation: This section displays operations available in the Jira endpoint.
-
Selected Operation: After an operation is selected, it is listed here.
-
Search: Enter any column's value into the search box to filter the list of operations. The search is not case-sensitive. If operations are already displayed within the table, the table results are filtered in real time with each keystroke. To reload operations from the endpoint when searching, enter search criteria and then refresh, as described below.
-
Refresh: Reloads operations from the Jira endpoint. This may be useful if operations have been added to Jira. This action refreshes all metadata used to build the table of operations displayed in the configuration.
-
Selecting an operation: Within the table, click anywhere on a row to select an operation. Only one operation can be selected. The information available for each operation is fetched from the Jira endpoint:
-
Name: The name of the operation.
-
Description: The description of the operation.
-
Tip
If the table does not populate with available operations, the Jira connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.
-
-
Optional settings: Click to expand this optional setting:
- Fail the operation on error: Select to force an operation to return an
Error
operation status when the response payload from the Jira API contains a non-successful status code. When unselected (default), the response payload must be checked to determine its success in Jira.
- Fail the operation on error: Select to force an operation to return an
-
Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.
-
Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.
-
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.
Step 2: Review the data schemas¶
Any request or response schemas are displayed. Each user interface element of this step is described below.
-
Data schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.
The Jira connector uses the Jira REST API v3 for the Jira Cloud instance type and Jira REST API v2 for the Jira On-premise instance type. Refer to the API documentation for information on the schema nodes and fields.
-
Refresh: Regenerates schemas from the Jira endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.
-
Edit: Allows you to enter the editor for the data schema. The editor allows you to add, delete, and reorganize nodes and fields and change their data types. All newly added nodes and fields are set to
[0, 1]
cardinality. Changes made to the data schemas must be acceptable to the endpoint and should be made only after consulting any available documentation for the endpoint. -
Back: Click to temporarily store the configuration for this step and return to the previous step.
-
Finished: Click to save the configuration for all steps and close the activity configuration.
-
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.
Next steps¶
After configuring a Jira Transition activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.
Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity actions menu in Connector basics.
Jira Transition activities can be used as a target with these operation patterns:
- Transformation pattern
- Two-transformation pattern (as the first or second target)
To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.
When ready, deploy and run the operation and validate behavior by checking the operation logs.