Copy Records activity

An activity that copies a record from one AgilePoint NX entity to another entity.


Copy Records activity

Configure the Copy Records activity

To configure the Copy Records 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 Copy Records activity onto your process.

    Drag Copy Records activity

General Configuration

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

Copy Records Source Configuration

Specifies the AgilePoint NX entity from which to copy the record.

Figure: Copy Records Source Configuration screen

Copy Record Source Configuration screen

Fields

Field NameDefinition

Source Entity Name
Description:
Specifies the name for the source entity from which to copy or move the record.
Allowed Values:
An entity name from the list.
Default Value:
None
Accepts Variables:
No

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

Filter By
Description:
Specifies the type of the ID to filter the record.
Allowed Values:
  • ID
  • Record ID
Default Value:
None

If Record Exists
Description:
Specifies what action to do when the entity record already exists.
Allowed Values:
  • Overwrite - Replaces the record if it exists at the target location.
  • Skip and Proceed - Ignores an error and replaces the record if it exists at the target location.
  • Stop and Throw Exception - Does not replace the record if it exists at the target location and shows an error in the log.
Default Value:
None

Record ID / Unique Record Field Value
Function:
Specifies an ID or a value of the primary field for the record to copy from the AgilePoint NX entity source.
Allowed Values:
One or more record IDs or value of the primary fields for the records from an AgilePoint NX entity separated by semicolons (;).
Default Value:
None
Accepts Variables:
Yes
Limitations:
The Unique Record Field Value option is available in these releases:

Copy Records Target Configuration

Specifies the AgilePoint NX entity to which to copy the record.

Figure: Copy Records Target Configuration screen

Copy Records Target Configuration screen

Fields

Field NameDefinition

Target Entity Name
Description:
Specifies the name of the target AgilePoint NX entity to which to copy or move the record.
Allowed Values:
An entity name from the list.
Default Value:
None
Accepts Variables:
No

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

Store Record ID in This Variable
Description:
Specifies the process data variable that stores the ID of a record you copied or moved.
Allowed Values:
A process data variable that accepts an alphanumeric string with no spaces or special characters.
Default Value:
None
Accepts Variables:
Yes