Retrieve Record activity

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


Retrieve Record activity

Configure the Query Record activity

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

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 Data Entities tab.

    AgilePoint Data Entities tab
  3. On the Data Entities tab, drag the Retrieve Record activity onto your process.

    Query Record activity

General Configuration

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

Query Record Configuration

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

Figure: Retrieve Record Configuration screen

Retrieve Record Configuration screen

Fields

Field NameDefinition

Entity

Function:
Specifies the name for your entity from the list.
Accepted Values:
An entity name from the list.
Default Value:
None
Example:
Refer to:

Standard Entities / Custom Entities

Function:
Specifies whether to show standard (out-of-the-box) entities or custom entities in the Entity Name list.
Accepted 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

Function:
Specifies whether to retrieve information of the record based on record ID or value of the primary field for the record in an entity.
Accepted 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:

Value

Function:
Specifies the entity ID or record ID from the AgilePoint NX entity source whose information to get.
Accepted Values:
A valid entity ID or record ID from an AgilePoint NX entity.
Default Value:
None
Accepts Process Data Variables:
Yes

Map Response to AgilePoint Schema

Function:
Maps AgilePoint NX entity fields to your process schema.
Accepted Values:
Click the Schema Mapping Schema Mapping icon 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: