Skip to end of metadata
Go to start of metadata

Introduction

A Jira Search activity finds an object at a Jira endpoint and is intended to be used as a source to provide data to an operation. After configuring a Jira connection, you can configure as many Jira activities as you like for each Jira connection.

Creating a Jira Activity

From the design canvas, open the Connectivity tab of the design component palette:

Connectivity tab

Use the Show dropdown to filter on Endpoints, and then click the Jira connection block to display activities that are available to be used with a Jira connection:

Jira activities

To create an activity that can be configured, drag the activity block from the palette to the operation.

For more information about the parts of an operation and adding activities to operations, see Operation Creation and Configuration.

Configuring a Jira Search Activity

Follow these steps to configure a Jira Search activity:

Step 1: Enter a Name and Select a Project

Jira Search Activity Configuration Step 1

  • Name: Enter a name to use to identify the Jira Search 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. When reopening an existing activity configuration, only the selected project is displayed instead of reloading the entire project list.

    • Selected Jira Project: After a project is selected, it is listed here.

    • Search: Enter any part of the project name 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: Click the refresh icon Refresh icon or the word Refresh to reload projects from the Jira endpoint. This may be useful if you have recently added projects 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 project name from Jira.

      • Description: The project description from Jira.

    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.

  • 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

Jira Search Activity Configuration Step 2

  • Select an Object: This section displays objects available in the Jira endpoint. When reopening an existing activity configuration, only the selected object is displayed instead of reloading the entire object list.

    • 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 part of the object name 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: Click the refresh icon Refresh icon or the word Refresh to reload objects from the Jira endpoint. This may be useful if you have recently added objects 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 object name from Jira.

      • Description: The object description from Jira.

    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

Jira Search Activity Configuration Step 3

TIP: Fields with a variable icon 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 query using Jira Query Language (JQL).

  • Max Results: Enter the maximum number of results for your search to return.

  • 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

Jira Search Activity Configuration Step 4

  • Data Schema: The request and response data schemas for Jira are displayed. If the operation uses a transformation, the data schemas are displayed again later during the transformation mapping process, where you can map to target fields using source objects, scripts, variables, custom values, and more.

    The search object request and response data schemas depend on the particular project and object selected. Though there are common fields, the structures depend on the organization of the Jira project and its use of custom fields.

    The Jira connector uses the Jira REST API v3.0. See that documentation for information on the fields used in each object's data schemas.

    • Request:

      Request Schema Field/NodeNotes
      search-issues-requestSearch issue request
      issueThe issue object
      requestThe search request
      jqlThe Jira Query Language (JQL) query string
      maxResultsThe maximum number of results to return
    • Response:

      Response Schema Field/NodeNotes
      create-issues-responseSearch issues response
      expandThe objects to be expanded
      totalThe ID of the created issue
      startAtThe index of the first item to return in a page of results
      maxResultsThe maximum number of results returned
      errorCollectionNode of the error collection (zero or one)
      errorMessagesThe list of error messages returned by the operation
      errorsThe list of errors returned by the operation
      statusStatus
  • Refresh: Click the refresh icon Refresh icon or the word Refresh to regenerate schemas from the Jira endpoint. This action also regenerates the schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

  • 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 an operation's operation settings, which include the ability to chain operations together that are in the same or different workflows.

After a Jira activity has been created, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas. See Activity Actions Menu for details.

Jira Search activities can be used as a source with these operation patterns:

Other patterns are not valid using Jira Search activities. See the validation patterns on the Operation Validity page.

A typical use case is to use a Jira Search activity in the Two-Transformation Pattern. In this example, the first transformation (Jira Search Request) creates a request structure that is passed to the Jira Search activity. The second transformation (Jira Search Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Jira Search Response) and a message is then logged by the Write to Operation Log script:

Jira Search operation

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.

On This Page

Last updated:  Nov 11, 2020

  • No labels