Skip to end of metadata
Go to start of metadata

Introduction

The design canvas is the central area when you open a project that serves as the primary workspace where you visually design integrations. This page covers elements of the user interface that are present along the top of the design canvas, as well as key concepts to understand while working on the design canvas.

To access the design canvas, first open a project. In an open project, the design canvas is the central area located to the right of the project pane and to the left of the component palette, below the project toolbar:

Design Canvas Header

These elements are present along the top of the design canvas:

  • Workflow Tabs: Workflows are accessed from tabs along the top of the design canvas. Additional workflows can be created by clicking the new workflow icon The new workflow opens in a new tab within the design canvas. Workflows are numbered sequentially in the order they are created, as 1.0, 2.0, 3.0, etc. If you reorder workflows, this numeric sequence adjusts accordingly (see Reordering Workflows in Workflow Creation and Design).

  • Save Status: The auto-save status is displayed in the top left of the design canvas. These statuses are available:
    • Saved: All project items are saved as currently configured.
    • Saving: The project is currently being saved. This status occurs only after changes have been made.
  • Last Deployed: The date and time that any part of the project was last deployed is displayed. If no parts of the project have yet been deployed, nothing is displayed here.
  • Collapse All Operations or Expand All Operations: Toggles the display of all operations within the current workflow to a condensed or expanded view (see Expanding or Collapsing Operations in Operation Creation and Configuration).
  • Highlight Invalid Items: Toggles the display of invalid items (see Workflow ValidityOperation Validity, or Component Validity, respectively).
  • Deploy/Migrate: The orange deploy/migrate icon opens a menu where you can choose to deploy the entire project, configure project components to deploy, or migrate the project (see Project Deployment and Project Migration).

Design Canvas Layout

The primary function of the design canvas is to have a workspace where you visually design workflows. Each workflow is made up of a collection of operations that is used as a tool for your convenience to help segregate different parts of the project. For information on designing workflows, see Workflow Creation and Design.

Selecting Items

Click a component on the design canvas to select it.

A selected operation is displayed with a purple border outlining the selected operation:

A selected operation step or email component is displayed with a purple border outlining the selected component:

Operation Toolbar

These icons are displayed in the operation toolbar, located in the top right of an operation:

IconDescription

Opens the Schedules tab of the operation settings (see Operation Schedules).

This icon is displayed only when an operation already has an assigned schedule.

Deploys the operation and any components it is dependent on (see Deploying in Operation Deployment and Execution).

Opens the deployment screen, where you can select project components to deploy (see Deploying in Operation Deployment and Execution).

Collapses the operation into a smaller, condensed view (see Expanding or Collapsing Operations in Operation Creation and Configuration).

This icon is displayed only when the operation is expanded.

Expands the operation into the standard view (see Expanding or Collapsing Operations in Operation Creation and Configuration).

This icon is displayed only when the operation is collapsed.

Opens the operation actions menu, described next.

Operation Status

After an operation has been successfully submitted to the operation queue, the real-time operation status is reported in the lower left of an operation.

For details, see Operation Status in Operation Deployment and Execution.

Actions Menus

Actions menus accessible from the design canvas include those for deploy/migrate, components, and component drop zones.

Deploy/Migrate Actions Menu

Click the orange deploy/migrate icon in the top right of the design canvas to open a menu with these actions:

  • Deploy: Deploys the entire project (see Project Deployment).
  • Configurable Deploy: Opens the project deployment screen, where you can select project components to deploy (see Project Deployment).
  • Migrate: Opens the project migration screen, where you can choose the target environment (see Project Migration).

Component Actions Menu

To open an operation's actions menu, do one of these:

  • Right-click anywhere on the operation toolbar.
  • Click the actions menu icon  in the top right of an operation.

To open the actions menu for another component on the design canvas, including operation steps (activities, transformations, or scripts) and email notifications, do one of these:

  • Right-click the operation step or email notification.
  • Hover over the operation step or email notification, and then click the actions menu icon .

Some actions are available only on certain components. The images below display actions menus for an operation (left image) and for an activity (right image):

Operation Actions Menu

Activity Actions Menu


  • View/Edit: Opens the configuration screen for an activity, transformation, script, or email notification. For details on configuration, refer to the respective component under Connectors, TransformationsScripts, or Notifications.
  • 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).
    The Settings menu item is available only in operations actions menus.
  • Cut: Places a copy of the component on your clipboard and deletes the original component from the project (see Component Reuse).
  • Copy: Places a copy of the component on your clipboard (see Component Reuse).
  • Duplicate: For operations, 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.
    For activities, transformations, scripts, and email notifications, Duplicate creates a new, unreferenced component using the same configuration as the original component (see Component Reuse).
  • Deploy: Shows these menu actions:
    • Deploy: Deploys the component and any components it is dependent on (see Component Deployment).
    • Run: Runs an already-deployed operation and any downstream (linked) operations (see Operation Deployment and Execution). This action is available only on operations.
    • Deploy and Run: Deploys and runs the operation and any downstream (linked) operations (see Operation Deployment and Execution). This action is available only on operations.
    • Configurable Deploy: Opens the deployment screen, where you can select components to deploy (see Component Deployment).
  • 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). This action is available only on operations.
  • Rename: Positions the cursor on the operation name for you to make edits. This action is available only on operations.
  • View Dependencies: Changes the view in the project pane to display any other parts of the project that the specific component is dependent on (see Component Dependencies, Deletion, and Removal).
  • Add to Group: Opens a dialog to create a new custom group or to add the component to an existing group (see Component Groups).
  • Delete: Permanently deletes the component (see Component Dependencies, Deletion, and Removal).
  • Remove: Removes references to the component from the design canvas (see Component Dependencies, Deletion, and Removal).

Component Drop Zone Actions Menu

To open the actions menu for a component drop zone on the design canvas, do one of these:

  • Right-click the component drop zone.
  • Hover over the component drop zone, and then click the actions menu icon .

These menu actions are displayed:

  • New Script: Creates a new script as a step in the operation (see Script Types and Creation).
  • New Transformation: Creates a new transformation as a step in the operation (see Transformation Creation and Configuration).
  • Paste: Creates a duplicate of an activity, script, operation, or email notification that is on your clipboard as a new, unreferenced component (see Component Reuse).

    The default name of the new component uses the name of the original component appended with - Copy. Subsequent duplicates are further appended with an incremented number in parentheses.

Renaming Workflows, Operations, and Operation Steps

To rename a workflow, double-click the name in the workflow tab along the top of the design canvas:

To rename an operation, click the name in the operation:

To rename steps within an operation, click the name in the operation:

Reordering Operations

Operations in the same workflow can be reordered by dragging and dropping them on the design canvas.

Click and hold anywhere on an operation to pick it up and drag it above or below other operations within the workflow:

This action has a cascading effect of renumbering the operations above or below it in the project tree.

  • No labels