Stored Procedure activity

An activity that executes database stored procedures

Configure the Stored Procedure activity

To configure the Stored Procedure activity, do the procedure in this topic.

Good to Know

In most text fields, you can use process data variables as an alternative to literal data values.
You can configure whether this activity waits for other activities before it runs.
For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?
This section shows the configuration settings on the configuration screens for this activity. Other configuration settings apply to system activities. For more information, refer to:
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?

How to Start

Open Process Builder.
For information about how to open this screen, refer to Process Builder.
In Process Builder, in the Activity Library, open the Database tab.
On the Database tab, drag the Stored Procedure activity onto your process.

Procedure

Complete the fields on the General Configuration screen.
Click Stored Procedure .
On the Stored Procedure screen, do one of these.
- Complete the fields on theBasic tab.
- Complete the fields on theAdvanced tab.
For more information, refer to Run a Stored Procedure.
(Optional) Click Advanced > Email Notifications .
For more information, refer to Email Notifications screen (Process Activities).

General Configuration

Specifies the basic settings for the Stored Procedure activity.

Fields

Field Name	Definition
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

Stored Procedure > Basic

Specifies where and how the data is changed in the database with a stored procedure.

Fields

Field Name	Definition
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	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: AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 Software Update 1 or higher
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. The value must not contain these special characters: Semicolon (;) Hash (#) Pipe (\|) If the Stored Procedure activity uses any of these special characters in the Value field, use Stored Procedure > Advanced. 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
Create	Function: Creates a parameter for the stored procedure.
Delete	Function: Deletes the parameter for the stored procedure.

Stored Procedure > Advanced

Specifies where and how the data is changed in the database with a SQL query.

Fields

Field Name	Definition
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	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.
SQL	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
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: AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 Software Update 1 or higher