Query Records (PostgreSQL) activity

An activity that retrieves one or more records from PostgreSQL.


Query Records activity

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

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

    Drag Query Records activity

General Configuration

Specifies the basic settings for the Query Records 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

Query Records Configuration

Specifies the information about the records to retrieve from PostgreSQL.

Figure: Query Records Configuration screen

Query Records Configuration screen

Fields

Field NameDefinition

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 Add Token icon
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 from which to retrieve the records.
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?

Table Name
Description:
Specifies the name of the table from which to retrieve the records.
Allowed Values:
A table name from the list.

When you select the schema from the Schema field, this field shows the table names associated with the schema.

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?

Condition
Description:
Specifies the SQL WHERE clause to retrieve the records from PostgreSQL.
Allowed Values:
A valid SQL WHERE clause.
Default Value:
None
Example:
InvoiceNumber <= 3452

Column Name
Description:
Shows a list of column names from the table in PostgreSQL. You can use the column names from this field to specify the condition in the Condition field.

When you select a table name from the Table Name field, this field shows the column names associated with the specified table.

Allowed Values:
A column name from the list.
Default Value:
None

Filter Filter icon
Function:
Shows the items in the list based on the values you enter.
To Open this Field:
  1. Click Filter Filter icon.
  2. On the filter screen, select your operator.
  3. Enter the values to show in your list.
Allowed Values:
  • Is equal to
  • Is not equal to
  • Starts with
  • Contains
  • Does not contain
  • Ends with
Default Value:
Is equal to

Order By
Description:
Specifies the name of the column to sequence the query results.
Allowed Values:
A column name from the list.

When you select the table from the Table Name field, this field shows the columns for the table.

Default Value:
None
Accepts Variables:
No

Sort By
Description:
Specifies the sort order for the records.
Allowed Values:
  • Ascending - Sorts the records in ascending order.
  • Descending - Sorts the records in descending order.
Default Value:
Ascending.

Row Limit
Description:
Specifies the maximum number of records to retrieve from PostgreSQL.
Allowed Values:
An integer.

Range:

  • 1-10000
Default Value:
10,000
Accepts Variables:
No

Map Request To App Schema
Description:
Maps the record data from the PostgreSQL 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: