Update Record (Data Entities) activity

An activity that changes a record in AgilePoint NX entity.


Update Record activity

Configure the Update Record activity

To configure the Update 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 the Process Builder, in the Activity Library, open the Data Entities tab.

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

    Update Record activity

General Configuration

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

Update Record Configuration

Maps request data from your process to the AgilePoint NX entity field when you change a record. You can work with standard entities or custom entities.

Figure: Update Record Configuration screen

Update Record Configuration screen

Fields

Field NameDefinition

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

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:

Record ID / Unique Record Field Value

Function:
Specifies an ID or a value of the primary field for the record to change in an AgilePoint NX entity.
Accepted Values:
A record ID or a value of the primary field for the record from an AgilePoint NX entity.
Default Value:
None
Accepts Process Data Variables:
Yes
Limitations:
The Unique Record Field Value option is available in these releases:

Request Mapping

Function:
Connects your process schema to the entity fields.
Accepted Values:
Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper screen.

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

Default Value:
None
Example:
Refer to:

Store Record ID in This Variable

Function:
Specifies the process data variable that stores the ID of a record you create or change.
Accepted Values:
A process data variable that accepts an alphanumeric string with no spaces or special characters.
Default Value:
None
Accepts Process Data Variables:
Yes