Skip to end of metadata
Go to start of metadata

Introduction

A Snowflake Delete activity deletes table and view data on a Snowflake connection and is intended to be used as a target to consume data in an operation. After configuring a Snowflake connection, you can configure as many Snowflake activities as you like for each Snowflake connection.

Creating a Snowflake 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 Snowflake connection block to display activities that are available to be used with a Snowflake connection:

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

Accessing Menu Actions

After a Snowflake activity has been added to an operation, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas:

  • Project Pane: In the Workflows or Components tab of the project pane, hover over an activity name and click the actions menu icon to open the actions menu.

  • Design Canvas: Within the operation, click an existing activity block to open the actions menu.

Each of these menu actions is available:

  • View/Edit: Opens the activity configuration screen for you to configure the activity. For details, see Configuring a ServiceNow Delete Activity later on this page.

  • Delete: Permanently deletes the activity. A message asks you to confirm that you want to delete the activity.

  • Rename: Positions the cursor on the activity name in the project pane for you to make edits.

  • View Dependencies: Changes the view in the project pane to display any other parts of the project that the activity is dependent on.

  • Remove: Removes the activity as a step in the operation without deleting it from the project. (This is available only from the actions menu on the design canvas.) When you remove an activity that is adjacent to a transformation and schemas are provided within that activity, the schemas are no longer referenced by the transformation. Removed components can be accessed or permanently deleted from the project pane.

  • Deploy: Deploys the activity and any components it is dependent on.

  • Configurable Deploy: Opens the deployment screen, where you can select project components to deploy.

  • Add to Group: Opens a prompt to create a new custom group or to add the component to an existing group.

  • Duplicate: Creates a copy of the activity as a new, unreferenced component. On creating the component copy, the cursor is positioned on the component name within the project pane for you to rename the component.

Configuring a Snowflake Delete Activity

Follow these steps to configure a Snowflake Delete activity:

  • Step 1: Select a Snowflake Object
  • Step 2: Review Data Schema

Step 1: Select a Snowflake Object

Snowflake Delete Activity Configuration Step 1

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

  • Select an Object: This section displays tables and views available in the Snowflake endpoint. When reopening an existing activity configuration, only the selected tables and views are displayed instead of reloading the entire list.

    NOTE: For information on Snowflake views, see Overview of Views in the Snowflake documentation.

    • Selected Snowflake Object: After a table or view object is selected, it will be listed here.

    • Search: Enter any part of the table or view name into the search box to filter the list of objects. The search is not case-sensitive. If the list of tables and views are already displayed within the table, the table results will be 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 tables and views from the Snowflake endpoint. This may be useful if you have recently added tables to the Snowflake instance. This action refreshes all metadata used to build the table of tables and views displayed in the configuration.

    • Select an Object: Within the table, click anywhere on a row to select a table or view. Only one table or view can be selected. The information available for each table or view is fetched from the Snowflake endpoint:

      • Name: The table or view name from Snowflake.
      • Type: The object type from Snowflake.

    TIP: Snowflake Developer Instances are known to "go to sleep" if you haven't recently logged in to the Snowflake UI or used the instance. If the table does not populate with available objects, first ensure that the Snowflake instance is active, and then ensure you are connected to it by reopening the Snowflake 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 continue to the next step and temporarily store the configuration. 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: Review Data Schema

Snowflake Delete Activity Configuration Step 2

  • Data Schema: The request and response data schemas for Snowflake will be displayed.

    NOTE: The enclosingChar can be either a single quote character ('), or double quote character ("). To use the single quote character, use either the octal (\047) or the hex (0x27) representations or use the double single-quoted escape (''). When a field contains this character, escape it using the same character.

    • Request:

      Request Schema Field/NodeNotes
      whereClause[Internal Snowflake stage, table name, or path][request-stageName]
      columnNamePath or prefix under which the data will be uploaded on the Snowflake stage
      conditionData file contents, in CSV format, that is to be staged for uploading to the Snowflake table
      valueDestination file name to be used on the Snowflake stage
    • Request:

      Request Schema Field/NodeNotes
      whereClause[Internal Snowflake stage, table name, or path][request-stageName]
      columnNamePath or prefix under which the data will be uploaded on the Snowflake stage
      conditionData file contents, in CSV format, that is to be staged for uploading to the Snowflake table
      valueDestination file name to be used on the Snowflake stage
    • Response:

      Response Schema Field/NodeNotes
      numberOfRowsDeletedCount of rows deleted
      errorMessageError message response

    If the operation uses a transformation, the data schemas will be 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 Snowflake connector uses the Snowflake JDBC Driver and the Snowflake SQL commands.

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

  • 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 a Snowflake Delete 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.

Snowflake Delete activities can be used as a target with these operation patterns:

Other patterns are not valid using Snowflake Delete activities. See the validation rules on the Operation Validity page.

A typical use case is to use a Snowflake Delete activity in the Two-Transformation Pattern.

In this example, an FTP Read activity (Read) reads from a server and passes it to the first transformation (Transform Read). The first transformation creates a request structure that is passed to the Snowflake Delete activity. The second transformation (Transform Write) receives the response structure, which is then written to a variable by a Variable Write activity (Write):

Example

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:  Jan 15, 2020

  • No labels