Get App Permissions activity

An activity that retrieves the permissions from an app.


Get App Permissions activity

Configure the Get App Permissions activity

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 AgilePoint NX tab.

    AgilePoint NX tab
  3. On the AgilePoint NX tab, drag the Get App Permissions activity onto your process.

    Drag Get App Permissions activity

General Configuration

Specifies the basic settings for the Get App Permissions 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

Description:
Specifies the activity name that shows in your process.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts 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

Description:
Specifies an optional text description for your activity.
Allowed Values:
More than one line of text.
Default Value:
None
Accepts Variables:
No

Get App Permissions Configuration

Specifies the configuration to retrieve the permissions from an app.

Figure: Get App Permissions Configuration screen

Get App Permissions Configuration screen

Fields

Field NameDefinition

AgilePoint NX

Description:
Specifies the access token that connects to your AgilePoint NX environment.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Variables:
No

Create Add Token icon

Opens this Screen:
Access Token for AgilePoint NX
Function of this Screen:
Configure an access token to connect to AgilePoint NX.

App

Description:
Specifies the name of the app to retrieve the permissions.
Allowed Values:
An app from the list.

When you select the access token from the AgilePoint NX field, this field shows the apps associated with the access token.

Default Value:
None
Accepts Variables:
Yes

Map Response To App Schema / Store Response In This Variable

Description:
Specifies where to store the response from AgilePoint NX.
Allowed Values:
  • Map Response To App SchemaSelect this option if you want to map the information from the AgilePoint NX data model to your process schema.

    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.

    Because the query can return more than one result, the parent node in the external data source must be mapped to a node in the AgilePoint NX process schema that is a repeating schema element. The child nodes in both data models must also be mapped, but child nodes in AgilePoint NX inherit the repeating behavior from their parent node.

  • Store Response To This VariableSelect this option if you want to store the information from AgilePoint NX to a variable in the AgilePoint NX app.

    In the text field, specify a variable that accepts an alphanumeric string in JSON format.

Default Value:
Map Response To App Schema
Accepts 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?