Jira Search activity

Introduction

A Jira Search activity, using its Jira connection, retrieves object data from a Jira project and is intended to be used as a source to provide data in an operation.

Create a Jira Search activity

An instance of a Jira Search activity is created from a Jira connection using its Search 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 Search 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 Search activity

Follow these steps to configure a Jira Search activity:

Step 1: Enter a name and select a project
Provide a name for the activity and select a project.
Step 2: Select an object
Select an object.
Step 3: Specify settings
Specify the search criteria.
Step 4: Review the data schemas
Any request or response schemas are displayed.

Step 1: Enter a name and select a project

In this step, provide a name for the activity and select a project. 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 Search activity and must not contain forward slashes / or colons :.
Select a Project: This section displays projects available in the Jira endpoint.
- Selected Jira Project: After a project is selected, it is listed here.
- Search: Enter any column's value into the search box to filter the list of projects. The search is not case-sensitive. If projects are already displayed within the table, the table results are filtered in real time with each keystroke. To reload projects from the endpoint when searching, enter search criteria and then refresh, as described below.
- Refresh: Reloads projects from the Jira endpoint. This may be useful if projects have been added to Jira. This action refreshes all metadata used to build the table of projects displayed in the configuration.
- Selecting a project: Within the table, click anywhere on a row to select a project. Only one project can be selected. The information available for each project is fetched from the Jira endpoint:
  - Name: The name of the project.
  - Description: The description of the project.
Tip

If the table does not populate with available projects, 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.
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: Select an object

In this step, select an object. Each user interface element of this step is described below.

Select an Object: This section displays objects available in the Jira endpoint.
- Selected Jira Project: The jira project selected in the previous step is listed here.
- Selected Jira Object: After an object is selected, it is listed here.
- Search: Enter any column's value into the search box to filter the list of objects. The search is not case-sensitive. If objects are already displayed within the table, the table results are filtered in real time with each keystroke. To reload objects from the endpoint when searching, enter search criteria and then refresh, as described below.
- Refresh: Reloads objects from the Jira endpoint. This may be useful if objects have been added to Jira. This action refreshes all metadata used to build the table of objects displayed in the configuration.
- Selecting an object: Within the table, click anywhere on a row to select an object. Only one object can be selected. The information available for each object is fetched from the Jira endpoint:
  - Name: The name of the object.
  - Description: The description of the object.
Tip

If the table does not populate with available objects, the Jira connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.
Back: Click to temporarily store the configuration for this step and return to the previous step.
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 3: Specify settings

In this step, specify the search criteria. Each user interface element of this step 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.

JQL: Enter the search criteria using Jira query language (JQL) syntax. global variables are supported in the JQL statement.

Note

You can use the JQL field to specify multiple projects (beyond the project specified in Step 1).
Max results: Enter the maximum number of results returned in a page in the response. If a maximum value is not provided, all records for the selected object are returned and pagination is not applied.
Start at: Enter the index of the first item to be returned in the page.
Back: Click to temporarily store the configuration for this step and return to the previous step.
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 4: 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.

Note

Data supplied in a transformation takes precedence over the activity configuration.

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 Search 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 Search activities can be used as a source with these operation patterns:

Transformation pattern
Two-target archive pattern (as the first source only)
Two-target HTTP archive pattern (as the first source only)
Two-transformation pattern (as the first or second source)

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.