Updating workflows

After installing a new version of a CLC Workbench, workflows may need to be updated before they can be used. Three situations are described in this section:

Updating workflows stored in the Navigation area

When you open a workflow stored in the Navigation Area that needs to be updated, an editor will open listing the tools that need to be updated, along with additional information about the changes to the tools (figure 14.111).

Image workflowupdateeditor
Figure 14.111: The workflow update editor lists tools and parameters that will be updated.

To update the workflow, click on the OK button at the bottom of the editor.

The updated workflow can be saved under a new name, leaving the original workflow unaffected.

Updating installed and template workflows automatically

Most installed workflows and template workflows can be updated automatically. To do this, open the Workflow Manager:

        Utilities | Manage Workflows (Image WorkflowManage_16_n_p)

or click on the "Workflows" button (Image workflows_16_n_p) in the toolbar, and select "Manage Workflows..." (Image WorkflowManage_16_n_p) from the menu that appears.

A red message is displayed for each workflow that needs to be updated. An individual workflow can be updated by selecting it and then clicking on the Update... button. Alternatively, click on the Update All Workflows button to carry out all updates in a single action (figure 14.112).

Image manage_workflows_migrate
Figure 14.112: A message in red text indicates a workflow needs to be updated. The Update button can be used to update an individual workflow. Alternatively, update all workflows that need updating by clicking on the Update All Workflows button.

When you update a workflow through the Workflow Manager, the old version is overwritten.

To update a workflow you must have permission to write to the area the workflow is stored in. Usually, you will not need special permissions to do this for workflows you installed. However, to update template workflows, distributed via plugins, the CLC Workbench will usually need to be run as an administrative user.

When one or more installed workflows or template workflows needs to be updated, you are informed when you start up the CLC Workbench. A dialog listing these workflows is presented, prompting you to open the Workflow Manager (figure 14.113).

Image workflow_update_available
Figure 14.113: A dialog reporting that an installed workflow needs to be updated to be used on this version of the Workbench.

Updating installed workflows that cannot be updated automatically

Automatic updating of an installed workflow is not always possible. The most common situation where this is experienced is after updating to a new major version line14.3.

When this is the case, the following route can be taken to get an updated version of the workflow:

  1. Open a version of the CLC Workbench where the workflow can be run.
  2. Create a copy of the installed workflow. This can be done by:

    • Right-clicking on the name of a workflow under the Workflows tab in the Toolbox at the bottom left side of Workbench, and choosing the "Open Copy of Workflow" option in the menu that appears (figure 14.114), or by opening the Workflow Manager, selecting the installed workflow, and clicking on the "Open Copy of Workflow" button.

      Image opencopyworkflow
      Figure 14.114: Open a copy of an installed workflow by right-clicking on its name under the Workflows tab in the Toolbox and choosing the "Open Copy of Workflow" option from the menu.

    • Save the workflow copy.

    • Close the older Workbench.

    • Open the newer Workbench.

    • Open the workflow copy that was saved earlier and click on the OK button if you are prompted to update the workflow.

    • Checking that the updated workflow has been updated correctly and then save it.

    • Install the workflow or make a workflow installer for later installation.

If the above process does not work when upgrading directly from a much older software version, it may be necessary to upgrade step-wise by upgrading the workflow in sequentially higher major versions of the Workbench.


Footnotes

... line14.3
"Major version line" refers to the first digit in the version number. For example, versions 25.0 and 23.0.2 are part of the same major release line (25). Version 26.0 is part of a different major version line (26).