Skip to end of metadata
Go to start of metadata

Introduction

A Jira Search Dashboard activity returns a list of dashboards 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 Dashboard Activity

Follow these steps to configure a Jira Search Dashboard activity:

Step 1: Enter a Name and Specify Settings

Jira Search Dashboard Activity Configuration Step 1

  • Name: Enter a name to use to identify the Jira Search Dashboard activity. The name must be unique for each Jira Search Dashboard activity and must not contain forward slashes (/) or colons (:).

    • Dashboard Name: The name of the Jira dashboard. Leave blank to return all dashboards.
  • Max Results: Enter the maximum number of results for your search to return. Leave blank to return all results.

  • 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

Jira Search Dashboard 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 dashboard 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. Refer to the API documentation for information on the schema fields.

    • Request:

      Request Schema Field/NodeNotes
      dashboardNode of the dashboards (zero or one)
      dashboardNameThe dashboard name
      maxResultsThe maximum number of results returned
      accountIdThe account ID
      ownerThe dashboard owner
      groupnameName of the group the dashboard is shared with
      ProjectIdThe Jira project ID
      orderByOrder the results by a field. Name is the default
      startAtThe index of the first item to return
      expandList of additional items to include in the response
      <...>Additional fields
    • Response:

      Response Schema Field/NodeNotes
      dashboardNode of the dashboards (zero or one)
      selfURL of the Jira dashboard
      nextPageThe ID of the created issue
      maxResultsThe maximum number of results returned
      startAtThe index of the first item to return
      totalTotal count of dashboards returned
      isLastIndicates if the item is the last result
      valuesNode of the values (one or more)
      descriptionDescription of the dashboard
      idID of the dashboard
      isFavouriteReturns true if the dashboard is a favorite, else returns false
      <...>Additional fields
  • 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 Dashboard 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 Dashboard activities can be used as a source with these operation patterns:

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

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

Jira Search Dashboard 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