Update Record (Database) activity

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


Update Record activity

Configure the Update Record activity

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

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

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

    Drag Update Record activity

General Configuration

Specifies the basic settings for the Update Record activity.

Figure: General Configuration screen

General Configuration screen

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

Database Type
Description:
Specifies the type of database to be used.
Allowed Values:
  • SQL Server
  • MySQL
  • Oracle
Default Value:
SQL Server

Connection Timeout (Seconds)
Description:
Specifies the number of seconds permitted to complete an action before the connection stops.
Allowed Values:
An integer.

Represents

  • A number of seconds
Default Value:
600
Accepts Variables:
No

Update Record Configuration > Tables tab

Specifies the information about a table to change one or more records in database.

Figure: Update Record Configuration > Tables tab

Update Record Configuration Tables tab

Fields

Field NameDefinition

Database
Description:
Specifies the access token that connects to your database.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Variables:
No

Create Add Token icon
Opens this Screen:
Access Token for Database
Function of this Screen:
Configure an access token to connect to a database..

Schema
Description:
Specifies your database schema.
Allowed 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
Description:
Specifies the name of the table in which to change the records.
Allowed Values:
A table name from the list.

When you select the schema from the Schema field, this field shows the table names associated with the schema.

Default Value:
None
Accepts Variables:
No
Example:
TblInvoice

Include Synonyms in the list Include Synonyms in the list icon
Description:
Specifies whether to show the synonyms that exist in the database in the Table Name list.
Allowed Values:
  • Selected - Shows the synonyms in the Table Name list.
  • Deselected - Does not show the synonyms in the Table Name list.
Default Value:
None

Condition (SQL Formula)
Description:
The SQL WHERE clause that tells which database records to change.
Allowed Values:
A valid SQL WHERE clause.
Default Value:
None
Accepts Variables:
Yes
Example:
InvoiceNumber <= 3452

Column Name
Description:
Shows a list of column names from the table in the database. You can use the column names from this field to specify the condition in the Condition field.

When you select a table name from the Table Name field, this field shows the column names associated with the specified table.

Allowed Values:
A column name from the list.
Default Value:
None

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

Update Record Configuration > Columns And Data tab

Specifies the information about the columns to change one or more records in a database.

Figure: Update Record Configuration > Columns And Data tab

Update Record Configuration Columns And Data tab

Prerequisites

Fields

Field NameDefinition

Database
Description:
Specifies the access token that connects to your database.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Variables:
No

Create Add Token icon
Opens this Screen:
Access Token for Database
Function of this Screen:
Configure an access token to connect to a database..

Column Name
Description:
Specifies the name of the database column.
Allowed Values:
A valid database column name.
Default Value:
None
Accepts Variables:
No
Example:
CustomerName

Value
Description:
Specifies the value for the column.
Allowed Values:
A valid column value.
Default Value:
None
Accepts Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Create Create icon
Function:
Adds a row for the Column Name and Column Value.

Delete Delete icon
Function:
Deletes the selected row.

Create Create icon
Function:
Adds a row for the Column Name and Value.

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