Workflow Designer Interface

Many of the operations described in this topic can be performed using keyboard shortcuts.



The main parts of Workflow Designer's user interface are as follows:

Sidebar: The sidebar has the following options:

  • File: Click File to open the File menu. See File Menu for information.

  • Info: Click Info to open the Info panel. The Info panel allows you to do the following:

    • Change Title: Change the workflow's title. This changes the title of the workflow's item in ArcGIS. The item is created the first time you save the workflow. If you configure the title before the item is created, your title will be used as the item's title.

    • Change Description: Change the workflow's description. This changes the description of the workflow's item in ArcGIS. The item is created the first time you save the workflow. If you configure the description before the item is created, your description will be used as the item's description.

    • View URL: (saved workflows only) View and copy the workflow's URL. This is the URL of the workflow's item in ArcGIS.

    • Open Item: (saved workflows only) Click View to open the workflow's item in ArcGIS.

    • Change Workflow Type: (on-premises Workflow only) Configure the type of workflow—client workflow or server workflow. Client workflows run in a host application, like VertiGIS Studio Web or ArcGIS Web AppBuilder. Server workflows run on VertiGIS Studio Workflow Server.

    • Run in Sandbox: Run the workflow in the Sandbox, Workflow Designer's built-in test environment.

      To run a workflow in the Sandbox, click Info | Run in Sandbox, configure the Sandbox settings, select the environment, and then click Run Workflow.

    • Modify Deployment Settings: Click Deployment to open the Deployment panel.

      • Client Workflow: For a client workflow, the Deployment panel allows you to view and modify the workflow's host applications.

        Changing a workflow's host applications can break the workflow. If you have already added activities to the workflow, you may have to modify the workflow to make it work in the new environment. For information, see Adapt a Workflow to a New Environment.

      • Server Workflow: For a server workflow, the Deployment panel allows you to view VertiGIS Studio Workflow Server's URL.

    • Configure Translations: Configure translations for the workflow. See Translate Workflows for information.

  • Help: The Help panel has the following:

    • the version of VertiGIS Studio Workflow you are using
    • links to documentation and release notes
    • a link to the VertiGIS Studio Workflow community
    • links to VertiGIS legal and privacy information
  • User: Click the user icon User icon to sign in or out of Workflow Designer.

  • Switch: (cloud Workflow only) Click the switch icon Switch apps to switch to the designer for a different VertiGIS Studio product.

Toolbox: The Toolbox contains activities that you can use to build workflows. An activity is only visible in the Toolbox if it is compatible with the application(s) you chose when you created the workflow. See Create Workflows for more information.

To add an activity to a workflow, drag the activity from the Toolbox to the design surface and connect it to the flowchart.

Use the Toolbox's Filter function to find a particular activity. See Search the Toolbox for an Activity for information.

Tabs: Every workflow in Designer is on its own tab. Click the New tab icon to create a new workflow and open it on a new tab.

A workflow's tab shows the workflow's title. Beside the title is an icon—either or —that you can click to close the workflow and its tab. The circle icon indicates that there are unsaved changes.

Below the workflow's title are breadcrumbs that show your current depth within the workflow. Use the breadcrumbs to navigate up one or morel levels.

Breadcrumbs to navigate the workflow's levels

Design Surface: The design surface is where you design workflows. To design a workflow, drag activities from the Toolbox to the design surface, connect them into a flowchart, and configure their properties.

The design surface has tools to zoom in , zoom out , undo the last change to the flowchart, and redo the last change that you undid using the undo tool.

Properties Panel: The Properties panel shows the properties for the currently selected activity. Click an activity on the design surface to select it and view its properties.

All activities have ID, Display Name, and Description properties. Most activities also have inputs (properties whose values you configure for the workflow to operate on) and outputs (properties that are given a value by the activity when it runs). The inputs and outputs for a particular activity are described on the activity's page in the Activity Reference.

Navigator: The Navigator provides a quick way to navigate workflows. Click an activity in the Navigator to jump to the activity in the flowchart. For more information, see Navigator.

Problems: Click Problems to open the Validation panel. The Validation panel lists the errors, warnings, and information messages for all open workflows. Click a message to navigate the flowchart to the source of the problem. For more information, see Validation Panel.

File Menu

To open the File menu, click File in the sidebar. The File menu has the following options: New, Open, Delete, Open by URL, Save, Save As, Import, and Export.

File | New

The New option creates a new workflow that is a copy of a sample. The Blank Workflow sample creates a blank workflow. The remaining samples perform common tasks, like geocoding, using forms, or sending web requests.

If you are not sure if a sample exists, browse or search the list of samples. The Search function searches the titles, summaries, and descriptions of workflow items in ArcGIS. To search for a sample, type some text that you think might appear in the title, summary, or description in the Search box, and then click Search or press Enter.

For more information, see Methods to Create a Workflow.

File | Open

The Open option opens an existing workflow. To open an existing workflow, click File | Open, select the workflow, and then click Open or press Enter. Alternatively, double-click the workflow. The workflow opens on a new tab in Designer.

You can open a workflow's item in ArcGIS from the Open panel: Click the workflow's action menu and select the option to open it in ArcGIS.

The Open panel has Search, Filter, and Sort functions to help you find a workflow:

File | Delete

The Delete option deletes the selected workflow and its ArcGIS item. To delete a workflow, click File | Delete, find the workflow, select it, and then click Delete or press Enter. Alternatively, double-click the workflow. You will be prompted to confirm.

The Delete panel has Search and Sort functions to help you find a workflow:

File | Open by URL

The Open by URL option opens the workflow with the specified URL. To open a workflow by URL, you must have permission to access the workflow.

The Open by URL option provides an easy way to share workflows between Workflow authors in the same organization. See Share Workflows by URL for information.

File | Save

The Save option saves the current workflow under its existing title. If the workflow has not been saved before, clicking File | Save performs a Save As operation.

File | Save As

The Save As option saves the current workflow under the title you enter and creates an item for the workflow in ArcGIS with the same title. The URL of the new item is used as the workflow's URL. The URL appears on the Info panel in Workflow Designer.

File | Import

The Import option imports a previously exported workflow into Workflow Designer. For more information, see Import and Export Workflows.

File | Export

The Export option exports the current workflow in JSON format. This enables you to move workflows between portals. It also enables you to share with Workflow authors outside your organization. For more information, see Import and Export Workflows.