Skip to end of metadata
Go to start of metadata

Introduction

The project pane's Workflows tab is one of two tabs accessible in the project pane. (The other tab is the Components tab.)

The Workflows tab displays a hierarchically organized tree view of an open project's workflows, operations, and other components referenced within each operation.

Hierarchical Tree

In a project, workflows are at the highest hierarchical level, followed by operations, and then by other components used as steps within an operation (made up of activities, transformations, or scripts).

This structure is represented in an open project's Workflows tab, where workflows appear at the top with a workflow icon  to the left of the workflow. Workflows are expandable to reveal operations indented below each workflow. Operations are expandable to reveal the components referenced as steps within each operation. Both workflows and operations are auto-assigned numbers to represent their position in the tree:

When each workflow and operation is expanded, all workflows, operations, and operation steps are displayed.

Searching

To search within the Workflows tab, use the search box to enter a single keyword or keyword string. The hierarchical tree is automatically expanded to show workflows and components where the keyword string appears. The keyword string becomes bold (if not already) and purple within the name of the workflow or component:

To clear the search, click the remove icon .

Expanding and Selecting Items

To expand or collapse workflows or operations, click the disclosure triangles   next to the workflow or operation.

As you work on projects, Cloud Studio remembers the display states that a given user was last using for a given project, including whether the items in the project pane are expanded or collapsed.

Click a workflow to select it and open it on the design canvas. A selected workflow is displayed with a purple name and gray background:

When a workflow is expanded, click an operation within the workflow to select it and auto-scroll to it on the design canvas. A selected operation is displayed with a gray background:

When an operation is expanded, click an operation step within the operation to select it and auto-scroll to it on the design canvas. A selected operation is displayed with a gray background:

Viewing Validity Errors

When using the Highlight Invalid Items option on the design canvas, the names of invalid workflows, operations, and other components appear in italics and the color red. When selected, an invalid workflow is displayed with a pink background.

If the workflow or component is implicitly invalid, an error icon  is also displayed:

You can view the validation errors associated with invalid workflows and components as described in Workflow ValidityOperation Validity, and Component Validity

Actions Menus

To open a menu of actions to take on each workflow or component, do one of these:

  • Right-click the item.
  • Hover over the item, and then click the actions menu icon .

The actions available in each menu depend on the context and vary according to the item.

Workflow Actions Menu

The workflow actions menu includes these actions:

Menu ItemDescription

Deploy deploys the workflow and any components it is dependent on (see Workflow Deployment).

Configurable Deploy opens the deployment screen, where you can select project components to deploy (see Workflow Deployment).

Rename positions the cursor on the workflow 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 workflow is dependent on (see Workflow Dependencies and Deletion).

View Logs opens the operation log screen, which includes logs for any operations contained in the workflow that have been deployed and executed, as well as any operations linked from the workflow that have been deployed and executed (see Operation Logs).

Delete permanently deletes the workflow (see Workflow Dependencies and Deletion).

Component Actions Menu

Some actions are available only on certain types of components, as detailed in the subsections below:

  • Operations: The actions menu for operations (shown in the left image) has unique items such as Settings, Run, and View Logs and unique sub-menus for Deploy. It also includes common actions such as Cut, Copy, Rename, View Dependencies, Delete, and Remove.
  • Activities, Scripts, and Transformations: The actions menus for these components share the same actions, including View/Edit, Cut, Copy, Deploy, Rename, View Dependencies, Delete, and Remove (shown in an activity's actions menu in the right image).

Operation Actions Menu

Activity Actions Menu


Operations

These items are available in an operation's actions menu:

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

Activities, Scripts, and Transformations

The actions menus for these components share the same actions:

Menu ItemDescription

View/Edit opens the configuration screen for the component. For details on configuration, refer to the respective component under ConnectorsScripts, or Transformations.

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

Deploy shows these menu actions:

  • Deploy: Deploys the component and any components it is dependent on (see Component Deployment).
  • Configurable Deploy: Opens the deployment screen, where you can select components to deploy (see Component Deployment).

Rename positions the cursor on the component name for you to make any edits as necessary. You can also double-click a component name to enter rename mode.

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

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

Reordering Workflows and Operations

Workflows and operations can be reordered by dragging and dropping them in the project tree.

Reordering Workflows

To reorder workflows, drag a workflow to another location in the project tree:

This action has a cascading effect of renumbering both the workflows and the operations contained within each workflow.

Reordering Operations

To reorder operations, drag an operation name to another location within or between workflows in the project tree:

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

  • No labels