Get Entity Permissions activity

An activity that retrieves the permissions from an entity.

Configure the Get Entity Permissions activity

Prerequisites

AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v9.0 or higher.

Good to Know

For more information, refer to Permission Groups, Roles, and Task Participants.
To send an email notification, click Advanced > Email Notifications .
For more information, refer to Email Notifications screen (Process Activities).
In most text fields, you can use process data variables as an alternative to literal data values.
You can configure whether this activity waits for other activities before it runs.
For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?
This section shows the configuration settings on the configuration screens for this activity. Other configuration settings apply to system activities. For more information, refer to:

How to Start

Open Process Builder.
For information about how to open this screen, refer to Process Builder.
In Process Builder, in the Activity Library, open the AgilePoint NX tab.
On the AgilePoint NX tab, drag the Get Entity Permissions activity onto your process.

General Configuration

Specifies the basic settings for the Get Entity Permissions activity.

Good to Know

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

Fields

Field Name	Definition
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

Field Name

Definition

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:

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 Entity Permissions Configuration

Specifies the configuration to retrieve the permissions from an entity.

Fields

Field Name	Definition
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	Opens this Screen: Access Token for AgilePoint NX Function of this Screen: Configure an access token to connect to AgilePoint NX.
Standard Entity / Custom Entity	Description: Specifies whether to show standard (out-of-the-box) entities or custom entities in the Entity list. Allowed Values: Standard Entity - Shows standard (out-of-the-box) entities in the Entity list. Custom Entity - Shows custom entities in the Entity list. Default Value: Standard Entities
Entity	Description: Specifies the name of the entity to retrieve the permissions. Allowed Values: An entity from the list. When you select the access token from the AgilePoint NX field, this field shows the entities 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 Schema – Select this option if you want to map the information from the AgilePoint NX data model to your process schema. Click the Schema Mapping 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 Variable – Select 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?