Skip to end of metadata
Go to start of metadata

Introduction

An Amazon Redshift Query activity finds an object at Amazon Redshift and is intended to be used as a source to provide data to an operation. After configuring an Amazon Redshift connection, you can configure as many Amazon Redshift activities as you like for each Amazon Redshift connection.

Creating an Amazon Redshift Activity

From the design canvas, open the Connectivity tab of the design component palette:

Connectivity tab

Use the Show dropdown to filter on Endpoints, and then click the Amazon Redshift connection block to display activities that are available to be used with an Amazon Redshift connection:

Amazon Redshift activities

To create an activity that can be configured, drag the activity block from the palette to the operation.

For more information about the parts of an operation and adding activities to operations, see Operation Creation and Configuration.

Configuring an Amazon Redshift Query Activity

Follow these steps to configure an Amazon Redshift Query activity:

Step 1: Enter a Name and Select a Schema

Amazon Redshift Query Activity Configuration Step 1

  • Name: Enter a name to use to identify the Amazon Redshift Query activity. The name must be unique for each Amazon Redshift Query activity and must not contain forward slashes (/) or colons (:).

  • Select a Schema: This section displays schemas available in the Amazon Redshift endpoint. When reopening an existing activity configuration, only the selected schema is displayed instead of reloading the entire schema list.

    • Selected Schema Name: After a schema is selected, it is listed here.

    • Search: Enter any part of the schema name into the search box to filter the list of schemas. The search is not case-sensitive. If schemas are already displayed within the table, the table results are filtered in real time with each keystroke. To reload schemas from the endpoint when searching, enter search criteria and then refresh, as described below.

    • Refresh: Click the refresh icon Refresh icon or the word Refresh to reload schemas from the Amazon Redshift endpoint. This may be useful if you have recently added schemas to Amazon Redshift. This action refreshes all metadata used to build the table of schemas displayed in the configuration.

    • Selecting a Schema: Within the table, click anywhere on a row to select a schema. Only one schema can be selected. The information available for each schema is fetched from the Amazon Redshift endpoint:

      • Schema: The schema from Amazon Redshift.

    TIP: If the table does not populate with available schemas, the Amazon Redshift connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Select an Object

Amazon Redshift Query Activity Configuration Step 2

  • Select an Object: This section displays objects available in the Amazon Redshift endpoint. When reopening an existing activity configuration, only the selected object is displayed instead of reloading the entire object list.

    • Selected Schema Name: The schema name selected in the previous step is listed here.

    • Select Object Name: After an object is selected, it is listed here.

    • Search: Enter any part of the object name into the search box to filter the list of objects. The search is not case-sensitive. If objects are already displayed within the table, the table results are filtered in real time with each keystroke. To reload objects from the endpoint when searching, enter search criteria and then refresh, as described below.

    • Refresh: Click the refresh icon Refresh icon or the word Refresh to reload objects from the Amazon Redshift endpoint. This may be useful if you have recently added objects to Amazon Redshift. This action refreshes all metadata used to build the table of objects displayed in the configuration.

    • Selecting an Object: Within the table, click anywhere on a row to select an object. Only one object can be selected. The information available for each object is fetched from the Amazon Redshift endpoint:

      • Object Name: The object name from Amazon Redshift.

      • Type: The object type from Amazon Redshift.

      • Catalog: The object catalog from Amazon Redshift.

    TIP: If the table does not populate with available objects, the Amazon Redshift connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 3: Build Your Query

Amazon Redshift Query Activity Configuration Step 3

TIP: Fields with a variable icon Variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

The Build Your Query step is used to set conditions on a query using the object fields and apply paging to a query.

  • Search: Enter any part of a field name into the search box to filter the list of fields for the selected object. The search is not case-sensitive. The listed results are filtered in real time with each keystroke.

  • Refresh: Click the refresh icon Refresh icon or the word Refresh to reload fields of the object from the ServiceNow endpoint.

  • Select All: When using the search box to filter, you can use this checkbox to select all visible fields at once.

  • Select Fields: Select the checkboxes of the fields you want included in the query to have them automatically added to the SELECT statement in the Query String. You can also Select All of the fields at once using the checkbox.

  • Conditions: To add conditional clauses, use the fields below as input to help construct the clauses, which then appear in the Query String text box.

    • Object: Field: Use the dropdown to select a field from the selected object.

    • Operator: Use the dropdown to select an operator that is appropriate for the field data type:

      OperatorLabelDescription
      =Equals
      !=Not equals
      LIKE 'string'LikeLike string
      LIKE 'string%'Starts withStarts with string
      LIKE '%string'Ends withEnds with string
      LIKE '%string%'ContainsContains string
      <Less than
      <=Less or equal
      >Greater than
      >=Greater or equal
    • Value: Enter the desired value to use with the dropdown selections.

      TIP: When using global variables in the conditions of a WHERE clause, it is recommended to specify a default value so that script testing is possible. Otherwise, since global variables obtain their value at runtime, the syntax may be invalidated during testing or no data may be returned if no default value is specified.

    • Add: Click to automatically construct the clause based on the dropdown selections and entered value. The conditional clause is added to the Query String text box.

    • Remove All: Click to remove all entered conditional clauses.

  • Paging: To add a paging clause (a limit on the number of records with an optional record offset), you can use the dropdown to set the paging limit and the field to enter an offset. If an offset is not specified, it defaults to 0. A single paging clause is supported. If paging clause is not included, all records are returned.

    • Apply: Click to automatically construct the clause based on the dropdown selections and entered value. The automatically constructed paging clause appears in the the Query String text box.

    • Remove: Click to remove a paging clause that has been applied.

  • Query String: As you select fields, specify conditions, and set paging, the query statement in this text box is autopopulated with the selected fields, conditions, and paging limits.

  • Test Query: Click to validate the query. If the query is valid, a sample of up to 10 records retrieved from the query is displayed in a table. If the query is not valid, relevant error messages are displayed. The query must be valid and validated through this button in order to enable the Next button.

    Amazon Redshift Query Activity Configuration Test Query

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 4: Review the Data Schema

Amazon Redshift Query Activity Configuration Step 4

  • Data Schema: The response data schema for Amazon Redshift is displayed. If the operation uses a transformation, the data schema is displayed again later during the transformation mapping process, where you can map to target fields using source objects, scripts, variables, custom values, and more.

    The Amazon Redshift connector uses the Amazon Redshift JDBC Driver and Amazon Redshift SQL Commands. Refer to the Amazon Redshift documentation and the Amazon Redshift System Overview documentation for additional information.

  • Refresh: Click the refresh icon Refresh icon or the word Refresh to regenerate schemas from the endpoint. This action also regenerates the schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next Steps

After configuring an Amazon Redshift Query activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure an operation's operation settings, which include the ability to chain operations together that are in the same or different workflows.

After an Amazon Redshift activity has been created, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas. See Activity Actions Menu for details.

Amazon Redshift Query activities can be used as a source with these operation patterns:

Other patterns are not valid using Amazon Redshift Query activities. See the validation patterns on the Operation Validity page.

A typical use case is to use an Amazon Redshift Query activity in the Transformation Pattern. In this example, the Amazon Redshift Query activity generates a response structure that is received by the transformation (Amazon Redshift Query Response), which is then written to a variable by a Variable Write activity (Write Amazon Redshift Query Response) and a message is then logged by the Write to Operation Log script:

Amazon Redshift Query operation

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.

On This Page

Last updated:  Mar 30, 2020

  • No labels