Manage Workflows

Workflows are stored in the Workflows tab in the left-hand side menu. The available states for the workflows are:

  • Active
  • Active with Unpublished Changes
  • Inactive

To identify the current state of the workflow, simply check the Status column in the Workflows page, when the toggle is in on position it means that a workflow is in active state, when it is in off position, it means that the workflow has been de-activated. Moreover, a workflow can have a notepad icon next to the workflow name - this indicates the the workflow is in an active state, but some changes are unpublished. Additionally, you can view the full list of workflows, who last published the workflow and when, how many steps a workflow includes, and how many decisions the workflow will make. If you’ve added tags to your workflow, they will appear on the workflow’s tile as well.

Workflow Management Options

You can conduct the following actions on workflows from the Workflow Manager pages. Different types of workflows have different available actions, which you can learn more about here

To manage the current state of the workflow, use the slider on the left side of the workflow tile - next to workflow name. You can move the slider to the right (green) to activate workflows or to the left (grey) to deactivate workflows.

To find the options menu for a workflow:

  1. Navigate to Workflows page.
  2. Find the workflow you’d like to modify by looking for it in the search bar or scrolling within the list of workflows.
  3. Click on the ellipsis on the right side of the workflow’s tile.

A dropdown menu will appear. Menu items include the following actions:

Activate Workflows

Inactive workflows can be activated by clicking the status toggle to turn it to the on position. If the toggle is grayed out you won't be able to change the workflow state to active - this means that some required information is missing from the workflow. You can hover over the toggle, and it will provide information about what is missing. When activating workflows, double check that any configurations for connections, plugins, or steps are correct by testing as many elements as you are able to. Properly tested configurations avoid future workflow errors or failures.

Deactivate Workflows

Active workflows can be deactivated if you want to stop creating jobs for those workflows and do not wish to edit the workflow further.

To deactivate an active workflow, simply click the status toggle to turn it to the off position.

The workflow will still be visible in the Workflows page, where you can modify or reactivate the workflow as needed.

Run Workflow

You can manually run active workflows and provide specific trigger information in order to force the workflow to create a new job outside of regular trigger behavior.

To manually run a workflow:

  1. From the Workflows page, click the ellipsis on the right hand side of the workflow card.
  2. Select the Run Workflow option.
  3. Provide any trigger input parameters, then click the Run Workflow button to confirm. The new job created by this manual run will open in a new window.

Workflow Builder

Workflow builder enables you to either create brand new workflow, and view or edit an existing workflows. You can edit both active and inactive workflows. Once changes are made on an active workflow they are saved imiedietally as Unpublished Changes, you can find out more about active workflows with unpublished changes here.

To edit an existing active or inactive workflow:

  1. From the Workflows page, click the ellipsis on the right hand side of the workflow card.
  2. Select Edit in Builder button.
  3. The current version of the workflow will be opened in the Workflow Builder. This workflow will have the same configurations as the active or inactive workflow you're editing, but will not run or create any jobs until you click the Publish Changes button. If you want to save the new changes without activating the workflow, exit out of the Workflow Builder but do not publish changes. The changes will be saved as Unpublished Changes, which you can test, edit further or publish when you're ready.

To edit your unpublished changes for an active workflow:

  1. From the Workflows page, click the ellipsis on the right hand side of the workflow card.
  2. Select the Edit in Builder option.
  3. The Workflow Builder will display a tile on top of the workflow editing space, advising that you're Editing Unpublished Changes - it also allows you to view the currently active version of the workflow by moving the toggle to View Active position. Modify the workflow workflow as needed, then test it. You can exit out of the builder if you prefer not to publish the workflow changes right away.

Multiple Editors

Make sure only one Insight account holder is editing a given workflow at a time. Multiple editors on the same workflow can lead to unexpected behavior, or worse, unsaved hard work. Check with your team to make sure you’re clear to work on a workflow.

Export Workflows

Workflows can be exported to a .icon file. You can achieve this by selecting Export Active for an active workflow, or opening the Workflow Control Panel (by clicking on a workflow name on the Workflows page), then clicking on the ellipsis on the right side of the workflow’s tile and selecting Export option. The .icon files then can be imported to your InsightConnect account.

Discard Changes

Unpublished changes can be discarded by following the steps below:

  1. From the Workflows page, click the ellipsis on the right hand side of the workflow card.
  2. Select the Discard Changes option.

Update Plugins

To keep your workflows up to date with the latest versions of the plugins, pick the Update Plugins option from the menu opened by clicking the ellipsis on the right side of the workflow’s tile.

This will open a window with a list of plugins that are eligible to be updated. There are parts to that list:

  • Auto Update: will automatically update all the plugins selected from the list. It updates the plugins where minor or patch version has been updated.
  • Manual Update - will list all the plugins for which a new major version is available. Due to the major version change, it is likely that the input or output schema has changed - therefore these must be updated manually, to address any changes needed within your workflow to support/use the new schema.

Delete Workflows

Draft and inactive workflows can be deleted from the workflow manager. Deleting a workflow does not delete any connections or plugins used within the workflow.

To delete a workflow:

  1. From the Workflows page, click the ellipsis on the right hand side of the workflow card.
  2. Select the Delete Workflow option. If this option is not available you might need to select Discard Changes option first, then try again.
  3. Confirm that you want to permanently delete the workflow by clicking the Yes, Delete button.