Skip to end of metadata
Go to start of metadata

Introduction

This page explains the parts of a transformation, then covers creating a new transformation and accessing the menu options that are available once a transformation is created.

If you don't want to transform data and instead pass through data unchanged, you don't need to add a transformation. Valid operation patterns are provided in Validation Patterns under Operation Validity.

Parts of a Transformation

A transformation consists of source and target schemas that have been defined in the transformation and the transformation mapping that generates the output. A transformation does not include the input or output data itself.

Source and Target Schemas

A source schema is required only when an adjacent source activity provides input data that needs to be transformed. A target schema is always required.

Source and target schemas can be either defined within the transformation or provided by an adjacent activity, with schemas defined within the transformation taking precedence. Schemas provided by adjacent activities are not part of the transformation. More information about schemas is provided under Schemas.

Input and Output Data

A transformation does not include the input or output data itself. Any of these inputs can be used to supply data to the transformation:

  • Variables
  • Custom (hard-coded) values
  • Script logic on a target field or condition node
  • Data from a source activity

These inputs can be used by themselves or in combination with other inputs. If input data from an adjacent source activity needs to be mapped or transformed, a source schema defining the structure of the input data must be provided.

The output of the transformation is the result of the target mapping. This resulting data must conform to a target schema, consisting of a minimum of one field. The transformation must map to at least one field in the target schema to result in output data from the transformation. For details on completing a mapping, see Transformation Mapping.

Creating a Transformation

Creating a new transformation is done by adding a transformation to a new or existing operation on the design canvas.

To add a transformation to an operation, click the component block to open a menu of actions. From the menu, select New Transformation:

A transformation block will automatically be added to the operation and the transformation configuration screen will open in mapping mode for you to configure the transformation mapping. For details on completing the mapping, see Transformation Mapping.

NOTE: Operation steps may be configured in any order. However, note that a schema defined in a transformation takes precedence over a schema provided in an adjacent activity. Whether you choose to define a schema within a transformation or as part of an activity depends on your use case. For more information, see When to Use a Schema.

Accessing Menu Actions

After a transformation is created, menu actions for that transformation are accessible from the project pane and from the design canvas:

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

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

Each of these menu actions is available:

  • View/Edit: This opens the transformation configuration screen in mapping mode for you to configure the transformation mapping. For details on completing the mapping, see Transformation Mapping.
  • Delete: This is used to permanently delete the transformation (see Component Dependencies, Deletion, and Removal).
  • View Dependencies: This changes the view in the project pane to display any other parts of the project that the transformation is dependent on (see Component Dependencies, Deletion, and Removal).
  • Remove: Available only from the actions menu on the design canvas, this removes the transformation as a step in the operation without deleting it from the project. Although the transformation is not deleted, note that transformations where one or both schemas are provided by an adjacent activity are not able to be reused; removing this type of transformation from an operation is permanent. Removed components can be accessed or permanently deleted from the project pane (see Component Dependencies, Deletion, and Removal).

    NOTE: When you remove a transformation, if schemas are provided by an adjacent activity, they will no longer be referenced by the transformation.
  • Deploy: This deploys the transformation and any components it is dependent on (see Component Deployment).
  • Configurable Deploy: This opens the deployment screen, where you can select project components to deploy (see Component Deployment).
  • Add to group: This opens a prompt to create a new custom group or to add the component to an existing group. Custom groups are an organizational tool to help organize a project (see Component Groups).
On This Page

Last updated:  Jun 11, 2020

  • No labels