Skip to end of metadata
Go to start of metadata

Introduction

An operation is the smallest unit within a workflow that is independently executed on an agent and recorded by Harmony. Operations are used to define what an integration process should do and when it should be done.

Operations are comprised of a combination of one or more activities, scripts, or transformations:

The specific combination and order of these components must follow the set of valid patterns. For details on these patterns, see Operation Validity.

This page explains the parts of an operation, then covers adding steps to operations, accessing menu options, renaming operations, expanding/collapsing operations, reordering operations, and reusing, removing, or moving operation steps.

Parts of an Operation

Operations are formed by arranging activities, scripts, and transformations within an operation on the design canvas. The operation may consist of only a single script, or the arrangement may form a sequence of steps consisting of one or more activities, scripts, or transformations. The specific combinations that are allowed are described in Operation Validity.

Activities

An activity is a component that is created from a connection and that can be configured to interact with an endpoint. Activities can be used in an operation as either a source or a target and can be configured with data schemas that represent the request and response schemas for the interaction with the endpoint. In addition to being used as an operation step, some activities can also be referenced in scripts (see Endpoints in Jitterbit Script).

For more information about the basics and classifications of connectors, as well as resources for configuring connections and activities by each connector type, see the pages under Connectors

Sources

A source activity is any activity that provides data within an operation, which can then be transferred to a target unchanged or changed by a transformation prior to reaching a target.

Source activities require a data schema only if they will be used as input in a transformation:

  • If the source activity is providing data that will be transformed, it must have a response data schema, which is either automatically provided or can be defined while configuring the activity or transformation.
  • If the source activity is providing data that will not be transformed, a response file schema does not need to be defined, as it is not used in the operation.

Activities that are typically (but not necessarily) used as sources include those with one of these words in the name of the activity:

  • Download
  • Get
  • Read
  • Request
  • Query

Targets

A target activity is any activity that receives data within the operation. This data can come from a source activity, from a transformation, or from other input such as variables or scripts.

Target activities require a data schema only if they are receiving data that has been transformed or if they provide a response that you want to write to another target:

  • If the target activity is receiving data that has been transformed, it must have a request data schema, which is either automatically provided or can be defined while configuring the activity or transformation.
  • If the target activity is receiving data that has not been transformed, a request file schema does not need to be defined, as it is not used in the operation.
  • If a specific type of target activity provides a response, then you can also have a response data schema. If you want to write the response to another target, the response data schema is either automatically provided (SOAP and application activities) or can be defined while configuring the activity or transformation (HTTP). If the target type provides a response, an operation is not required to write the response to another target; that is, a response schema may be provided but can be ignored within the operation if it is not required.

Activities that are typically (but not necessarily) used as targets include those with one of these words in the name of the activity:

  • Add
  • Create
  • Delete
  • Insert
  • Post
  • Put
  • Response
  • Upload
  • Update
  • Upsert
  • Write

Scripts

A script that is created as a project component can be used as a step in an operation to transform data, perform calculations, or perform logic validation. For example, you can use a script before or after an activity to retrieve data and then process script logic, or you can run a validation script before proceeding to a transformation. For more information, see Script Types and Creation.

Transformations

A transformation is a project component that is used as a step in an operation to map or transform inputs to a resulting output by moving data, cleaning data, or applying business logic. After you create a transformation, you must configure it by mapping various inputs, such as source objects, variables, or scripts, to the resulting target output, usually a target data structure. For more information, see Transformations.

Adding Steps to an Operation

Operations are made up of project components consisting of activities, scripts, or transformations. To create operations, you place those components in a workflow on the design canvas as steps of an operation.

Choosing the Component's Location within a New or Existing Operation

The method of adding a component to an operation depends on whether the operation is being newly created or is already existing:

  • New Operation: A component drop zone is displayed on the design canvas wherever you can add a component to create a new operation. In a workflow that does not yet have any operations, the drop zone is displayed at the top of the design canvas by itself. In a workflow that has at least one operation, the drop zone is displayed at the bottom of the design canvas by itself, below the last operation.

  • Existing Operation: Existing operations are displayed on the design canvas with a light gray background. Hovering to the left or right of a component in an existing operation shows a component drop zone wherever you can add a component to an existing operation.

After you have decided on the location, the steps to add the component are different depending on if the component is an activity or a script or transformation, covered next.

Creating Connections, then Adding and Configuring Activities

The design component palette provides access to connectivity resources. Here, connectors provide the interface entering user-provided input such as credentials to create a connection. Within the component palette, the Connectors filter shows the types of connectors that can be configured:

Each connector is represented by a connector folder icon, beneath which is the connector name. Click a connector to open a configuration screen to create a new connection for access to a particular data resource:

For detailed instructions on configuring a connection, see the specific connection under Connectors. Each time you create a new connection, you must do so from the connector folder icons accessible in the Connectors filter.

Once you have created a connection, it is shown in the Endpoints filter. Click a connection to reveal the types of activities — interactions with an endpoint — that can be configured for that connection.

An endpoint refers to a specific connection and its activities, which are configured as sources (to provide data) or targets (to consume data) in a project. For reference, this diagram shows the relationship between connectors, connections, activities, and endpoints:

To create an instance of an activity, place an activity type on the design canvas by dragging it or copying it to a component drop zone:

Once an activity is created, you can double-click it to configure it as described for each specific activity under Connectors.

Adding and Configuring Transformations or Scripts

You may also want to add transformations or scripts to an operation. Transformations are used when you want to transform data prior to reaching its target. Scripts can be used within transformations on target fields and nodes to apply specified logic or conditions to the data. Scripts can also be used as optional steps within an operation for a variety of purposes, such as error handling or looping through data records.

To add a new transformation or script directly to an operation, right-click or click the actions menu on a drop zone and select New Script or New Transformation:

When you add a script or transformation, its configuration screen opens automatically. For details on configuration, see Transformations and Scripts, respectively.

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.

Operation Actions Menu

After an operation is created, menu actions for that operation are accessible from these locations:

These actions are available from all operation actions menus:

Menu ItemDescription

Settings opens the operation settings, containing three tabs:

  • Schedules: Create and apply schedules to automatically run operations (see Operation Schedules).
  • Actions: Configure actions to take on success or failure of the operation (see Operation Actions).
  • Options: Set options such as when the operation will time out, what to log and the timeframe for logging, when the operation will run, or whether to use chunking (see Operation Options).

Cut places a copy of the operation on your clipboard and deletes the original operation from the project (see Operation Reuse).

Copy places a copy of the operation on your clipboard (see Operation Reuse).

Deploy shows these menu actions:

Run runs an already-deployed operation and any downstream (linked) operations (see Operation Deployment and Execution).

View Logs opens the operation log screen, which includes logs for this operation and any child operations that have been deployed and executed (see Operation Logs).

Rename positions the cursor on the operation name for you to make any edits as necessary.

View Dependencies changes the view in the project pane to display any other parts of the project that the specific operation is dependent on (see Operation Dependencies, Deletion, and Removal).

Delete permanently deletes the component (see Operation Dependencies, Deletion, and Removal).

Remove removes references to the component from the design canvas. This action is functional only when used on an operation that is in a workflow (see Operation Dependencies, Deletion, and Removal).

These actions are available only from the activity actions menus accessible from the project pane's Components tab and the design canvas:

Menu ItemDescription


Duplicate shows these menu actions (see Operation Reuse):

  • With Step References: Duplicates the operation only. The duplicate operation contains references to each of the original operation steps. 
  • With Step Copies: Duplicates the operation and components referenced as operation steps. New components are created for each operation step and are referenced by the duplicated operation.

Add to Group opens a dialog to create a new custom group or to add the component to an existing group (see Component Groups).

Renaming Operations and Operation Steps

When you create a new operation, its default name is New Operation. Subsequent new operations with default names are appended with an incremented number in parentheses. Operation names within a project must be unique and must not contain forward slashes (/) or colons (:) to be valid.

Operations and operation steps can be renamed from these locations:

Operation steps can also be renamed from their individual configuration screens.

Expanding or Collapsing Operations

When an operation is created, it is expanded by default. Operations can be collapsed or expanded individually or all at once:

  • Collapsing an Individual Operation: To collapse an individual operation, click the collapse icon  in the operation toolbar:

    Collapsing an operation displays the operation in a smaller, condensed view:

  • Expanding an Individual Operation: To expand an individual operation when it is collapsed, click the expand icon  in the operation toolbar.
  • Collapsing All Operations: To collapse all operations in a workflow, click the design canvas collapse icon  at the top of the design canvas. This displays all operations in the workflow in a smaller, condensed view:

  • Expanding All Operations: To expand all operations in a workflow when they are collapsed, click the design canvas expand icon  at the top of the design canvas.

Reordering Operations

Operations can be reordered within or between workflows from the project pane's Workflows tab (see Reordering Operations in Project Pane Workflows Tab).

Operations can be reordered within the same workflow from the design canvas (see Reordering Operations in Design Canvas).

  • No labels