Workflow Management

First published on: 07/24/2023/11:31 pm

Introduction 

Workflows are the backbone of every Saltbox Integration project.

A workflow defines and orchestrates the steps required to perform specific business processes, and each workflow is integral to a project’s success.  

This guide explains how to perform these workflow management tasks: 

• Adding a new workflow 

• Deleting a workflow 

• Copying a workflow 

• Renaming a workflow 

Video: Manage Workflows for Saltbox Integrations

Getting Started 

To access and manage project workflows:

• Open the project.
• Open the Assets menu
• Select Manage All from the drop-down list. 

You'll see the Project Assets table with every workflow and report associated with the project. 

Adding a New Workflow 

From the right side of the project assets title bar, press the plus button (+) to expand the add menu.

Press Add Workflow from the drop-down menu to launch the "Add Workflow" wizard. 

To learn how to populate a new workflow with relevant properties (i.e., name, data source, format, etc.), please refer to "Adding a New Workflow".

Deleting a Workflow 

• Select the workflow you want to delete by clicking within the empty space of that row.

  • Don't click on the linked workflow name, as that will open the workflow.

  • The row will turn yellow when selected. (marker 1 below). 

• Press the delete button  on the project assets toolbar (marker 2 below).  

• A "Delete Workflow" confirmation message will pop up.

• Enter the name of the workflow to be deleted exactly as it appears in Saltbox (marker 3 below).

  • Saltbox’s audit log will track this change, so adding comments to explain the decision may prove useful in the future.

• Press the "Confirm" button (marker 4 below) when finished. 

Copying a Workflow 

Copying a workflow lets you include all the configured details as a starting point for a new workflow.

This is useful in several situations, such as:  

• The workflow logic for another use case is very similar but requires minor adjustments.  

• The workflow trigger executes the same logic but on a different connection configuration (i.e., the same workflow logic for US and European orders, but the trigger points to different web stores and fulfillment centers).  

To copy a workflow: 

• Select the workflow you’d like to copy by clicking within the empty space of that row.

  • Don't click on the linked workflow name, as that will open the workflow.

  • The row will turn yellow once selected (marker 1 below).

• Press the Copy button on the project assets toolbar (marker 2 below). 

• Fill out and confirm the field details in the new workflow wizard (image below). 

  • Workflow name (marker 3 below) 

  • Workflow description (marker 4 below) 

  • Creation method (marker 5 below)

  • Workflow to copy from (marker 6 below) will be set automatically based on your previous selection, but you can change these details 

• Press the Save button (marker 7 above) to save the new workflow.

• A green notification indicates the workflow was successfully copied. 

• A yellow notification indicates that the workflow engine is running and further action is required.

  • You must restart the engine before you can use the workflow.

Renaming a Workflow 

Renaming a workflow will change its URL. This requires you to update existing “route workflow” actions. 

To rename a workflow:  

• Select the workflow by clicking within the empty space of that row.

  • Don't click on the linked workflow name, as that will open the workflow.

  • The row will turn yellow once selected (marker 1 below). 

• Press the Edit button on the project assets toolbar (marker 2 below). 

• The "Rename Workflow" window will prompt you to create a new name for the existing workflow (marker 3 below). 

• Press the Save button when done (marker 4 below). 

• Upon success, a green message will confirm the name change. 

Previous

Next