Process Activities / Database tab
Parent topic: Database tab

Query Record activity

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



Configure the Query Record activity

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

Good to Know

How to Start

  1. On the Organizer, do one of these:
  2. Do one of these:
    • Add an activity:
      1. In the Process Builder, go to the Activity Library, and open the Database tab.
      2. On the Database tab, drag the Query Record activity onto your process.
    • Change an activity:
      1. In your process, double-click your 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 Query Record .
  3. On the Query Record screen, do one of these.

    For more information, refer to Get Data from a Database.

  4. (Optional) Click Advanced > E-mail Notification .

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

General Configuration

Specifies the general information for a Database activity.



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

Description
Function:
Specifies an optional 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
  • 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 that represents a number of seconds.
Default Value:
600
Accepts Process Data Variables:
No

Database Queries > SQL Command

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



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

Add Token

Opens this Screen:
New Database Access Token
Function of this Screen:
Configures a new access token for a database.

Add

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

Delete

Function:
Deletes the connection in the database table column.

Edit

Function:
Changes the selected item.

Add New Query

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

Parse Custom Attributes to Date Time format
Function:
Changes the specified process data variable to DateTime format.
Accepted 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
Function:
Specifies the record to get from the database.
Accepted 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.



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

Add Token

Opens this Screen:
New Database Access Token
Function of this Screen:
Configures a new access token for a database.

Attribute Name
Function:
Specifies the name of the variable where the selected data is stored.
Accepted Values:
A variable name.
Default Value:
None
Accepts Process Data Variables:
Yes

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

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:
Yes
Example:

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

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

Function:
Shows the items in the list based on the values you enter.
  1. Click Filter .
  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

Back

Function:
Goes to the previous screen.

Database Queries > Stored Procedure

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



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

Add Token

Opens this Screen:
New Database Access Token
Function of this Screen:
Configures a new access token for a database.

Stored Procedure Name
Function:
Specifies the name of your stored procedure.
Accepted Values:
One line of text with no spaces.
Default Value:
None
Accepts Process Data Variables:
Yes
Example:
GetUserDetail

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

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.
  • InputOuput - 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
Parent topic: Database tab

Quick Links:

Send Feedback

Quick Start

Process Activities

eForm Controls

AgilePoint NX Online Help

AgilePoint NX Technical Documentation

Support Portal

AgilePoint

AgilePoint NX

Documentation Updated: December 3, 2015

© 2015 AgilePoint, Inc. All rights reserved.