Stored Procedure (Amazon Redshift) activity

An activity that runs a stored procedure in Amazon Redshift.


Stored Procedure activity

Configure the Stored Procedure activity

Examples

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

    Open Amazon Redshift tab
  3. On the Amazon Redshift 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

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 tab

Specifies the input values for the stored procedure that runs in Amazon Redshift.

Figure: Stored Procedure Configuration > Request Parameters tab

Stored Procedure Configuration Request Parameters tab

Fields

Field NameDefinition

Amazon Redshift

Description:
Specifies the access token that connects to your Amazon Redshift service.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None

Create Add Token icon

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

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 Amazon Redshift 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 Amazon Redshift.
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 Amazon Redshift data model to your process schema.
Allowed 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 tab

Maps the response data from Amazon Redshift to your process schema.

Figure: Stored Procedure Configuration > Response Parameters tab

Stored Procedure Configuration Response Parameters tab

Fields

Field NameDefinition

Amazon Redshift

Description:
Specifies the access token that connects to your Amazon Redshift service.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None

Create Add Token icon

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

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 Amazon Redshift 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 Amazon Redshift.
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 Amazon Redshift to your process schema.
Allowed 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: