Stored Procedure (PostgreSQL) activity

Configure the Stored Procedure activity

Prerequisites

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

Good to Know

To send an email notification, click Advanced > Email Notifications .
For more information, refer to Email Notifications screen (Process Activities).
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 PostgreSQL tab.
On the PostgreSQL tab, drag the Stored Procedure activity onto your process.

General Configuration

Specifies the basic settings for the Stored Procedure activity.

Good to Know

Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

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

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

Stored Procedure Configuration > Request Parameters

Specifies the input values for the stored procedure that runs in PostgreSQL.

Fields

Field Name	Definition
PostgreSQL	Description: Specifies the access token that connects to your PostgreSQL service. Allowed Values: A list of access tokens configured for your environment. Default Value: None
Create	Opens this Screen: Access Token for PostgreSQL Function of this Screen: Configure an access token to connect to PostgreSQL.
Schema	Description: Specifies the name of the schema where the stored procedure executes. Allowed Values: A schema from the list. When you select the access token from the PostgreSQL field, this field shows the schemas associated with the access token. Default Value: None 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?
Stored Procedure Name	Description: Specifies the name of the stored procedure to run in PostgreSQL. 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
Map Request To App Schema	Description: Maps the data for the stored procedure from the PostgreSQL data model to your process schema. Allowed Values: Click the Schema Mapping button to open the Schema Mapper screen. Use this screen to connect the request to the data model for your process. Default Value: None Example: Refer to: (Example) Schema Mapper

Stored Procedure Configuration > Response Parameters

Maps the response data from PostgreSQL to your process schema.

Fields

Field Name	Definition
PostgreSQL	Description: Specifies the access token that connects to your PostgreSQL service. Allowed Values: A list of access tokens configured for your environment. Default Value: None
Create	Opens this Screen: Access Token for PostgreSQL Function of this Screen: Configure an access token to connect to PostgreSQL.
Schema	Description: Specifies the name of the schema where the stored procedure executes. Allowed Values: A schema from the list. When you select the access token from the PostgreSQL field, this field shows the schemas associated with the access token. Default Value: None 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?
Stored Procedure Name	Description: Specifies the name of the stored procedure to run in PostgreSQL. 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
Map Response To App Schema	Description: Maps the response data from the stored procedure in PostgreSQL to your process schema. Allowed Values: Click the Schema Mapping button to open the Schema Mapper. Use this screen to connect the response to the data model for your process. Default Value: None Example: Refer to: (Example) Schema Mapper