Batch Insert activity

An activity that puts more than one new database record into a database table


Batch Insert activity

Configure the Batch Insert activity

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

    Drag Batch Insert 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 Batch Insert Batch Insert icon.
  3. On the Batch Insert screen, do one of these.

    For more information, refer to Put More than One Record into a Database Table.

  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 Batch Insert 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

Batch Insert > Specific Table

Specifies where and how to insert the new database records into the database.

Figure: Batch Insert > Specific Table tab

Batch Insert Specific Table tab

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:

Repeating Node

Function:
Specifies an XPath to the root of a repeating element in a schema where all the data are stored. These data will be inserted into the database during the insert operation.
Accepted Values:
A valid XPath to a repeating XML node.
Default Value:
None
Accepts Process Data Variables:
Yes
Example:
/pd:myFields/pd:PersonalDetails

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 name of the database table where this activity puts the record.
Accepted Values:
A valid database table name.
Default Value:
None
Accepts Process Data Variables:
No
Example:
TblInvoice

Remove All Old Records

Function:
Removes all the old records from the database.
Accepted Values:
  • Selected - Enables the remove all old records option.
  • Deselected - Removes the record that satisfy the specified condition.
Default Value:
Deselected

Before insert, remove records that meets following conditions

Function:
Removes the records from the database that satisfies the specified condition. This remove operation is performed before the insert operation.
Accepted Values:
A valid SQL condition after WHERE clause.
Default Value:
None
Accepts Process Data Variables:
Yes
Example:
InvoiceNumber < 1467

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

Value

Function:
Specifies an XPath to a single node within the specified repeating schema element.
Accepted Values:
A valid XPath.
Default Value:
None
Accepts Process Data Variables:
Yes
Example:
${/pd:AgilePoint/pd:Products/pd:ComponentName}

Create Create icon

Function:
Creates a mapping to a database table column from the schema.

Delete Delete icon

Function:
Deletes the connection in the database table column.

Batch Insert > Stored Procedure

Specifies where and how to put more than one record into the database with a stored procedure.

Figure: Batch Insert > Stored Procedure tab

Batch Insert Stored Procedure tab

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
Limitations:

AgilePoint NX OnDemand (public cloud), or AgilePoint NX Private Cloud or AgilePoint NX OnPremises v7.0 Software Update 1 or higher.

Repeating Node

Function:
Specifies an XPath to the root of a repeating element in a schema where all the data are stored. These data will be inserted into the database during the insert operation.
Accepted Values:
A valid XPath to a repeating XML node.
Default Value:
None
Accepts Process Data Variables:
Yes
Example:
/pd:myFields/pd:PersonalDetails

Stored Procedure

Function:
Specifies the name of your stored procedure.
Accepted Values:
A stored procedure from the list.

When you select a schema, the stored procedures associated with the schema show in this field.

Default Value:
None
Accepts Process Data Variables:
No
Example:
GetUserDetail
Limitations:

Stored procedures associated with the schema is available in these releases:

Parameter Name

Function:
Specifies the parameters for the stored procedure.
Accepted Values:
A valid parameter for the specified stored procedure.
Default Value:
None
Accepts Process Data Variables:
No
Example:
OrderNumber

Value/Attr. Name

Function:
Specifies the value of the stored procedure parameter.
Accepted Values:
A valid value for the specified parameter.
Default Value:
None
Accepts Process Data 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?

In/Out

Function:
Specifies the in/out parameters for the stored procedure.
Accepted Values:
  • Input - Specifies that the parameter is an input value for the stored procedure.
  • Output - Specifies that the parameter is an output value for the stored procedure.
  • InputOutput - Specifies that the parameter can be input/output value for the stored procedure.
  • ReturnValue - Specifies that the parameter is a return value for the stored procedure.
Default Value:
None
Accepts Process Data Variables:
No

Data Type

Function:
Specifies the SQL server data type of the specified parameter for the stored procedure.
Accepted Values:
  • String
  • Integer
  • DateTime
  • Double
  • Short
  • Float
  • Decimal
  • Boolean
Default Value:
None

Size

Function:
Specifies size of the input parameter for the stored procedure.
Accepted Values:
An integer.
Default Value:
None
Accepts Process Data Variables:
No