Retrieve Record activity

An activity that gets a record from an AgilePoint NX entity.

Configure the Query Record activity

To configure the Query Record activity, do the procedure in this topic.

Prerequisites

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

Good to Know

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.
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:
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?

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 Data Entities tab.
On the Data Entities tab, drag the Retrieve Record activity onto your process.

General Configuration

Specifies the basic settings for the Retrieve Record 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

Query Record Configuration

Maps response data from the entity field to your process to get the record.

Figure: Retrieve Record Configuration screen

Fields

Field Name	Definition
Entity	Description: Specifies the name for your entity from the list. Allowed Values: An entity name from the list. Default Value: None Example: Refer to: (Example) Store Data from an eForm in Data Entities with a Data Entities Activity
Standard Entities / Custom Entities	Description: Specifies whether to show standard (out-of-the-box) entities or custom entities in the Entity Name list. Allowed Values: Standard Entities - Shows standard (out-of-the-box) entities in the Entity Name list. Custom Entities - Shows custom entities in the Entity Name list. Default Value: Standard Entities
Query By	Description: Specifies whether to retrieve information of the record based on record ID or value of the primary field for the record in an entity. Allowed Values: Record ID - Retrieves information of the record in an entity based on the record ID. Unique Record Field Value - Retrieves information of the record in an entity based on the value of the primary field. Default Value: Record ID Limitations: This field is available in these releases: AgilePoint NX OnDemand (public cloud) AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v8.0 or higher
Value	Function: Specifies the entity ID or record ID from the AgilePoint NX entity source whose information to get. Allowed Values: A valid entity ID or record ID from an AgilePoint NX entity. Default Value: None Accepts Variables: Yes
Map Response to AgilePoint Schema	Description: Maps AgilePoint NX entity fields to your process schema. Allowed Values: Click the Schema Mapping button to open the Schema Mapper screen. Use this screen to connect the response to the data model for your process. Default Value: None Example: Refer to: (Example) Schema Mapper