New Workflow Wizard

First published on: 02/21/2024/8:33 pm

Launch the New Workflow Wizard 

The New Workflow Wizard is an optional way to quickly set up your workflow with the required details (workflow name, trigger data source, etc.).

Because this wizard configures required settings related to the workflow trigger, the details found in Workflow Trigger Setup will provide more detailed examples and usage. 

If you're not already on the Project Assets page, select the Assets menu option, then choose "Manage All". This displays the Project Assets table, which includes workflows and reports.

To launch the New Workflow Wizard, open the Add menu (marker 1 below) on the right side of the Project Assets toolbar. In this menu, select "Add Workflow" (marker 2 below). 

If you don't know which details your workflow needs, you may configure minimum details (the name) and use the "Save and Skip Setup" button to save the workflow as a blank placeholder.

If you choose NOT to use the wizard, please review the Setting Up Workflow Triggers documentation. 

This wizard and Workflow Trigger Setup configure the same details, so if you complete one section, you may skip the other.  

To configure the new workflow using the wizard, follow the steps below: 

Step 1: Basic Details 

• Enter the workflow name and a description of what it does (see Figure 19).
• The workflow creation method defaults to “Create a New Workflow.”
  • You may select other creation methods from the drop-down menu adjacent to the "Creation Method" field.  

Step 2: Data Source 

• Select a Connector and the Data Type to be supplied to the workflow whenever the workflow is triggered.
  • Note: This section of the wizard is related to workflow triggers. For more details on this setting, see Workflow Trigger Setup.  

Once you select a connector, new Connection Configuration and Data Type choices will be updated in the drop-down menus for those fields.  

You may select an existing Connector Configuration or use the + button to add a new configuration. 

The Data Type field is where you set the type of data that will be fetched or generated when the workflow is triggered.

As an example, the image below shows that the user has already chosen a Data Type for the Shopify Connector: “Get a List of Customers”, with a description of that data type immediately below.   

Step 3: Format Settings 

The data format from the 3rd-party system via the Connector needs to be handled and processed in a way Saltbox understands.

Format settings are how we tell Saltbox what to expect from the 3rd-party system as it’s handled by the Connector. 

In most cases, the system will auto-select the data source format based on the data type selected in the section above.

However, in some general-purpose Connectors, like the SFTP Utility Connector, the user must specify a data source format (e.g., XML or CSV). 

See the image below for an example of an auto-generated configuration. 

Note: This section of the wizard is related to workflow triggers. For more details on this setting, see Workflow Trigger Setup. 

Step 4: Data Source Filters 

Depending on the Data Source chosen, you may be able to add data-related filters. These include settings for including data created between certain dates, data that meets certain object types or content flags, and others.

Filters are defined differently for each Connector to make the most of that Connector’s system. 

For date-based filters, the following advanced options can be provided instead of specific dates: {StartOfPreviousMonth}, {EndOfPreviousMonth}, {StartOfCurrentMonth}, {EndOfCurrentMonth}, {Today}-1...{Today}-n, {Today}+1...{Today}+n, and {Today} 

Note: This section of the wizard is related to workflow triggers. For more details on this setting, see Workflow Trigger Setup.

Step 5: Parameters 

Parameters are usually defined after the workflow has been executed at least once, so it is not covered by this guide.

Because this section of the wizard is related to workflow triggers, you can find more details about this in the Workflow Trigger Setup guide.  

Step 6: Schedule 

Set whether the workflow runs manually or automatically, and when. Typically, this is set to Manual until after the workflow design is complete.

Note: This section of the wizard is related to workflow triggers. For more details on this setting, see Workflow Trigger Setup.  

 When finished with all the new workflow details, save the workflow. 

Next