Stored Procedure (PostgreSQL) activity

An activity that runs a stored procedure in PostgreSQL.


Stored Procedure activity

Configure the Stored Procedure activity

Prerequisites

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 the Process Builder, in the Activity Library, open the PostgreSQL tab.

    Open Insert Records tab
  3. On the PostgreSQL tab, drag the Stored Procedure activity onto your process.

    Drag Stored Procedure activity

General Configuration

Specifies the basic settings for the Stored Procedure activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

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

Fields

Field NameDefinition

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

Function:
Specifies an optional text description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

Stored Procedure Configuration > Request Parameters

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

Figure: Stored Procedure Configuration > Request Parameters screen

Stored Procedure Configuration Request Parameters screen

Fields

Field NameDefinition

PostgreSQL

Function:
Specifies the access token that connects to your PostgreSQL service.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None

Create Add Token icon

Opens this Screen:
Access Token for PostgreSQL
Function of this Screen:
Configure an access token to connect to PostgreSQL.

Schema

Function:
Specifies the name of the schema where the stored procedure executes.
Accepted 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

Function:
Specifies the name of the stored procedure to run in PostgreSQL.
Accepted 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 Process Data Variables:
No

Map Request To App Schema

Function:
Maps the data for the stored procedure from the PostgreSQL data model to your process schema.
Accepted Values:
Click the Schema Mapping Schema Mapping icon 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:

Stored Procedure Configuration > Response Parameters

Maps the response data from PostgreSQL to your process schema.

Figure: Stored Procedure Configuration > Response Parameters screen

Stored Procedure Configuration Response Parameters screen

Fields

Field NameDefinition

PostgreSQL

Function:
Specifies the access token that connects to your PostgreSQL service.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None

Create Add Token icon

Opens this Screen:
Access Token for PostgreSQL
Function of this Screen:
Configure an access token to connect to PostgreSQL.

Schema

Function:
Specifies the name of the schema where the stored procedure executes.
Accepted 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

Function:
Specifies the name of the stored procedure to run in PostgreSQL.
Accepted 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 Process Data Variables:
No

Map Response To App Schema

Function:
Maps the response data from the stored procedure in PostgreSQL to your process schema.
Accepted Values:
Click the Schema Mapping Schema Mapping icon 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: