Get Issue Details activity

An activity that retrieves information about an issue from Jira Software.


Get Issue Details activity

Configure the Get Issue Details activity

To configure the Get Issue Details activity, do the procedure in this topic.

Examples

Prerequisites

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In Process Builder, in the Activity Library, open the Jira Software tab.

    Open JiraSoftware tab
  3. On the Jira Software tab, drag the Get Issue Details activity onto your process.

    Drag Get Issue Details activity

General Configuration

Specifies the basic settings for the Get Issue Details activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

  • Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field NameDefinition

Display Name

Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Function:
Specifies an optional text description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

Get Issue Details Configuration

Specifies the information about the issue to retrieve from Jira Software.

Figure: Get Issue Details Configuration screen

Get Issue Details Configuration screen

Fields

Field NameDefinition

Jira

Function:
Specifies the access token that connects to your Jira Software service.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None
Example:
Refer to:

Create Add Token icon

Opens this Screen:
Access Token for Jira Software
Function of this Screen:
Configure an access token to connect to Jira Software.
Example:
Refer to:

Project

Function:
Specifies the name of the project to retrieve information about the issue.
Accepted Values:
A project name from the list.

When you select the access token from the Jira field, this field shows the project names associated with the access token.

Default Value:
None
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Issue Key or ID

Function:
Specifies the key or ID of the issue from which to retrieve the information.

The issue key and ID come from Jira Software.

Accepted Values:
An issue key or ID from Jira Software.
Default Value:
None
Accepts Process Data Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Store Response In This Variable / Map Response to Application Schema

Function:
Specifies where to store the response from Jira Software.
Accepted Values:
  • Store Response In This VariableSelect this option if you expect Jira Software to return only one data item.

    In the text field, specify a variable to store the data Jira Software returns.

  • Map Response to Application SchemaSelect this option if you expect Jira Software to return more than one data item.

    Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper.

    Use this screen to connect the response to the data model for your process.

Default Value:
Map Response to Application Schema
Accepts Process Data Variables:
  • If you select Store Response In This Variable, you must enter a variable.
  • If you select Map Response to Application Schema, this does not apply.
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?