Query Record (Database) activity

An activity that executes dynamic SQL statements or calls stored procedures to get database data.


Query Record activity

Configure the Query Record activity

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

    Drag Query Record activity

Procedure

  1. Complete the fields on the General Configuration screen.
  2. Click Query Record Query Record icon.
  3. On the Query Record screen, do one of these.
  4. (Optional) Click Advanced Advanced icon > Email Notifications E-mail Notifications icon.

    For more information, refer to Email Notifications screen (Process Activities).

General Configuration

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

Query Record Configuration > SQL Command

Specifies where and how the data is retrieved from the database with a SQL query.

Figure: Query Record Configuration > SQL Command tab

Query Record SQL Command 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 Name
Description:
Specifies your process 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:
  • This field does not apply to MySQL databases.

Table Name
Description:
Specifies the name of the database table where this activity gets the records.
Allowed Values:
A valid database table name.
Default Value:
None
Accepts Variables:
Yes

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

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

Add Add icon

Opens this Screen:
Variable and Query Window
Function of this Screen:
Specifies the SQL query that executes when the activity runs.

Delete Delete icon
Function:
Deletes the connection in the database table column.

Edit Edit icon

Function:
Changes the selected item.

Add New Query Add New Query icon
Function:
Creates a mapping to a database table column from the schema.

Parse Custom Attributes to Date Time format
Description:
Changes the specified process data variable to DateTime format.
Allowed Values:
  • Deselected - The process data variable stays in its default data format.
  • Selected - Changes the process data variable to DateTime format.
Default Value:
Selected

Return First Row of Query
Description:
Specifies the record to get from the database.
Allowed Values:
  • Selected - Specifies to get the first record in the database column.
  • Deselected - The query gets the last record.
Default Value:
Deselected

Variable and Query Window

Specifies the SQL query that executes when the activity runs.

Figure: Query Record > SQL Command tab

Query Record SQL Command 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 Name
Description:
Specifies your process 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:
  • This field does not apply to MySQL databases.

Attribute Name
Description:
Specifies the name of the variable where the selected data is stored.
Allowed Values:
A variable name.
Default Value:
None
Accepts Variables:
Yes
Example:
RecordCount

Data Type
Description:
Shows the data type of the selected node.
Allowed Values:
  • String
  • Integer
  • DateTime
  • Double
  • Short
  • Float
  • Decimal
  • Boolean
Default Value:
String

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 Views in the list Include Views in the list icon
Description:
Specifies whether to show the views that exist in the database in the Table Name list.
Allowed Values:
  • Selected - Shows the views in the Table Name list.
  • Deselected - Does not show the view in the Table Name list.
Default Value:
None

SQL Select Query
Description:
The SQL statement that executes on the database when this activity runs.
Allowed Values:
A valid SQL SELECT query.
Default Value:
None
Accepts Variables:
Yes
Example:
SELECT ShowName FROM EventList WHERE showID = 1001

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

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

Back Back icon

Function:
Goes to the previous screen.

Query Record Configuration > Stored Procedure

Specifies where and how the data is retrieved from the database with a stored procedure.

Figure: Query Record Configuration > Stored Procedure tab

Query Record 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 Name
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.

Stored Procedure Name
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:

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