Delete Record (Data Entities) activity

An activity that deletes a record from AgilePoint NX entity.


Delete Record activity

Configure the Delete Record activity

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

    Delete Multiple Records activity

General Configuration

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

Delete Record Configuration

Specifies a record to delete from an AgilePoint NX entity.

Figure: Delete Record Configuration screen

Delete 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 delete from 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:

Store Number Of Records Deleted

Function:
Specifies a process data variable that stores the number of records that have been deleted.

Each time a record is deleted, the variable increases by 1.

Accepted Values:
A process data variable.
Default Value:
None
Accepts Process Data Variables:
Yes