Delete Record (Database) activity

An activity that deletes one or more database records in a database table.


Delete Record activity

Configure the Delete Record activity

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

Examples

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 Database tab.

    Open Database tab
  3. On the Database tab, drag the Delete Record activity onto your process.

    Drag Delete Record activity

Procedure

  1. Complete the fields on the General Configuration screen.

    For more information, refer to Configure General Options for a Database activity..

  2. Click Delete Record Delete Record icon.
  3. Configure Delete Record screen.

    For more information, refer to Delete Database Records in a Database.

  4. (Optional) Click Advanced Advanced icon > Email Notifications E-mail Notifications icon.

    For more information, refer to Configure E-mail Notifications for Any Activity.

General Configuration

Specifies the basic settings for the Delete Record activity.

Figure: General Configuration screen

General Configuration screen

Fields

Field Name Definition

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

Database Type

Function:
Specifies the type of database to be used.
Accepted Values:
  • SQL Server
  • MySQL
  • Oracle
Default Value:
SQL Server

Connection Timeout (Seconds)

Function:
Specifies the number of seconds permitted to complete an action before the connection stops.
Accepted Values:
An integer, representing a number of seconds.
Default Value:
600
Accepts Process Data Variables:
No

Delete Record

Specifies where and how to delete the records from the database.

Figure: Delete Record screen

Delete Record screen

Fields

Field Name Definition

Database

Function:
Specifies the access token that connects to your database.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Process Data Variables:
No
Example:
Refer to:

Create Add Token icon

Opens this Screen:
Access Token for Database
Function of this Screen:
Configure an access token to connect to a database..
Example:
Refer to:

Schema

Function:
Specifies your database schema.
Accepted Values:
A schema name from the list.

When you select a database, the schemas associated with the database show in this field.

Default Value:
None

Table Name

Function:
Specifies the table from which to delete your database records.
Accepted Values:
A valid database table name.
Default Value:
None
Accepts Process Data Variables:
No
Example:
TblInvoice

Condition (SQL Formula)

Function:
The SQL WHERE clause that tells which database records to change or delete.
Accepted Values:
A valid SQL WHERE clause.
Default Value:
None
Accepts Process Data Variables:
Yes
Example:
InvoiceNumber <= 3452

Column Name

Function:
Specifies the name of the database column.
Accepted Values:
A valid database column name.
Default Value:
None
Accepts Process Data Variables:
No
Example:
CustomerName

Filter Filter icon

Function:
Shows the items in the list based on the values you enter.
  1. Click Filter Filter icon.
  2. On the filter screen, select your operator.
  3. Enter the values to show in your list.
Accepted Values:
  • Is equal to
  • Is not equal to
  • Starts with
  • Contains
  • Does not contain
  • Ends with
Default Value:
Is equal to