Workflow installation

Installing workflows allows you to provide and use a controlled version of the workflow. Only parameters left unlocked in such workflows can be configured when launching. Installed workflows are available for use from the Installed Workflows subfolder under the Workflows menu.

To create a workflow installer, or to directly install the workflow, click on the Installation... button at the bottom of the workflow editor (keyboard shortcut Shift + Alt + I).

At the end of this process, you will have the option to install the workflow directly to your Workbench or to create an installer file, which can be used to install the workflow on any compatible CLC Workbench or CLC Server. If you are logged into a CLC Server and are a member of a group with appropriate permissions, you will also have the option to install the workflow directly on the CLC Server.

Information about the workflow

In the Create Installer dialog, you are prompted for information about the workflow (figure 14.89). After the workflow is installed, this information will be visible in the Workflow Manager, as described in Managing workflows.

The information requested when creating a workflow installer is described below. The workflow name and organization information are required. Other fields are optional.

Author name
The name of the workflow author.
Author email
The email address of workflow author.
Author homepage
A URL.
Organization
(Required) The organization name. This is used as part of the workflow id (Managing workflows).
Workflow name
(Required) The name of the workflow, as it should appear under the Workflows menu after installation. Changing this does not affect the name of the original workflow (as appears in your Navigation Area). This name is also used as part of the workflow id (Managing workflows).
ID
The workflow id. This is created using information provided in other fields. It cannot be directly edited.
Workflow icon
An icon to use for this workflow in the Workflows menu once the workflow is installed. Icons use a 16 x 16 pixel gif or png file. If your icon file is larger, it will automatically be resized to fit 16 x 16 pixels.
Workflow version
A major and minor version for this workflow. This version will be visible via the Workflow Manager after the workflow is installed, and will be included in the history of elements generated using this workflow. The version of the workflow open in the Workflow Editor, from which this installer is being created, will also be updated to the version specified here.
Workflow description
A textual description of the workflow. After installation, this is shown in the Description tab of the Workflow Manager (Managing workflows) and is also shown in a tooltip when the cursor is hovered over the installed workflow in the Workflows menu in the Toolbox panel at the bottom left of the Workbench. When a copy of the installed workflow is made, this text is included in the Description field of the Element Info view in the Workflow Editor.

Image create_installer_information_filled_in
Figure 14.89: Provide information about the workflow that you are creating an installer for.

Reference data input handling

If data elements have been configured in the workflow, a "Reference data" step is included in the Create Installer wizard, where the handling of each input can be specified (figure 14.90). Options are offered for ignoring the data that has been specified (Ignore), or bundling the data with the workflow installer (Bundle).

Ignore
The data elements are not included in the installer.

Note: When Ignore is selected for a locked input, the specified data elements must be accessible, in the same location, to the system the installed workflow is run on. It will not be possible to run the workflow otherwise.

Bundle
The data elements are included in the workflow installer.

When installing a workflow with bundled data, you are prompted for a location to save the data to. If the workflow is installed on a CLC Server, the data elements are saved automatically, as described in the CLC Server manual.

Notes:

  • Bundling large data elements will result in a large workflow installer.
  • Every time a workflow with bundled data is installed, a new copy of the data will be saved. Thus, if the input is not locked, it can be more convenient to choose Ignore, and to copy the data to a location accessible from the system the workflow will be run on.

Image bundle_reference_data-combined
Figure 14.90: Bundling data with the workflow installer.

Installation options

The final step asks you to indicate whether to install the workflow directly to your Workbench or to create an installer file, which can be used to install the workflow on any compatible CLC Main Workbench or CLC Server (figure 14.91). If you are logged into a CLC Server and are a member of a group with appropriate permissions, you will also have the option to install the workflow directly on the CLC Server.

Image create_installer_location
Figure 14.91: Select whether the workflow should be installed to your CLC Workbench or an installer file (.cpw) should be created. Installation to the CLC Server is only available if you are logged in as a user with permission to administer workflows on the CLC Server.