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.

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

    Drag Batch Insert activity

General Configuration

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

Batch Insert Configuration > Specific Table

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

Figure: Batch Insert Configuration > Specific Table tab

Batch Insert Configuration Specific Table 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..

Repeating Node
Description:
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.
Allowed Values:
A valid XPath to a repeating XML node.
Default Value:
None
Accepts Variables:
Yes
Example:
/pd:myFields/pd:PersonalDetails

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 database table where this activity puts the record.
Allowed Values:
A valid database table name.
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

Remove All Old Records
Description:
Removes all the old records from the database.
Allowed Values:
  • Selected - Enables the remove all old records option.
  • Deselected - Removes the record that satisfy the specified condition.
Default Value:
Deselected

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 Value.

Delete Delete icon
Function:
Deletes the selected row.

Batch Insert Configuration > Stored Procedure

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

Figure: Batch Insert Configuration > Stored Procedure tab

Batch Insert Stored Procedure 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
Limitations:

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

Package Name
Description:
Specifies the name of the package in which to insert the records.
To Open this Field:
  1. On the General Configuration screen, in the Database Type field, select Oracle.
Allowed Values:
A package name from the list.

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

Default Value:
None
Accepts Variables:
No
Limitations:

This field is available in these releases:

Stored Procedure
Description:
Specifies the name of your stored procedure.
Allowed 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 Variables:
No
Example:
GetUserDetail
Limitations:

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

Repeating Node
Description:
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.
Allowed Values:
A valid XPath to a repeating XML node.
Default Value:
None
Accepts Variables:
Yes
Example:
/pd:myFields/pd:PersonalDetails

Parameter Name
Description:
Specifies the parameters for the stored procedure.
Allowed Values:
A valid parameter for the specified stored procedure.
Default Value:
None
Accepts Variables:
No
Example:
OrderNumber

Value/Attr. Name
Description:
Specifies the value of the stored procedure parameter.
Allowed Values:
A valid value for the specified parameter.
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?

In/Out
Description:
Specifies the in/out parameters for the stored procedure.
Allowed 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 Variables:
No

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

Size
Description:
Specifies size of the input parameter for the stored procedure.
Allowed Values:
An integer.
Default Value:
None
Accepts Variables:
No