Query Records (PostgreSQL) activity

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

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

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 from which to retrieve the records.

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?

Table Name

Function:

Specifies the name of the table from which to retrieve the records.

Accepted 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

Function:

Specifies the SQL WHERE clause to retrieve the records from PostgreSQL.

Accepted Values:

A valid SQL WHERE clause.

Default Value:

None

Example:

InvoiceNumber <= 3452

Column Name

Function:

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.

Accepted Values:

A column name from the list.

Default Value:

None

Filter

Function:

Shows the items in the list based on the values you enter.

To Open this Field:

1. Click Filter .
2. On the filter screen, select your operator.
3. Enter the values to show in your list.

Accepted Values:

• Is equal to
• Is not equal to
• Starts with
• Contains
• Does not contain
• Ends with

Default Value:

Is equal to

Order By

Function:

Specifies the name of the column to sequence the query results.

Accepted 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 Process Data Variables:

No

Sort By

Function:

Specifies the sort order for the records.

Accepted Values:

• Ascending - Sorts the records in ascending order.
• Descending - Sorts the records in descending order.

Default Value:

Ascending.

Row Limit

Function:

Specifies the maximum number of records to retrieve from PostgreSQL.

Accepted Values:

An integer up to 10,000.

Default Value:

10,000

Accepts Process Data Variables:

No

Map Request To App Schema

Function:

Maps the record data from the PostgreSQL data model to your process schema.

Accepted 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