Host and Run Workflows in Geocortex Web

Host and Run your First Workflow

There are several ways to host a workflow in Geocortex Web, the most common of which is the I Want To menu. The procedure below shows you how to configure the I Want To menu to host and run a workflow.

To use the I Want To menu to host and run a workflow:

Step 1: Configure the menu item

  1. In Geocortex Web Designer, click I Want To Menu in the Configure Components panel.

  2. Click Add Menu Item.

  3. In the Title box, type the text that you want to appear as an item in the I Want To menu, for example, Inspect Hydrant.

    If you want to use the name of the workflow as the menu item's title, skip this step. The title will automatically be set when you select the workflow.

  4. Optionally enter a description to appear under the Title.

  5. Click Select Icon and choose an icon to show beside the menu item's text, for example, .

  6. In the Command box, start typing the name of the workflow that you want the app to host.

    A list of the workflows with matching names displays.

    To see the workflows that you own, search for your user name.

  7. Select the workflow from the list.

    The JSON to run the workflow displays.

  8. If you want to hide the menu item completely when it is not available, rather than having it grayed out, turn on Hide when Disabled.

    Menu items are unavailable when the app is in a state that prohibits the item's command from running.

  9. If you want the user to be able to toggle the menu item between two states, turn on Can be Toggled and configure the alternate state.

    The alternate state can have a different title, description, and icon than the default state, and you can modify the menu item's behavior by changing the command or its configuration. For example, you could configure the default state to run a workflow that requires network connectivity, and configure the alternate state to run an offline version of the workflow.

  10. Press Ctrl+S on your keyboard or click File | Save to save the app.

Step 2: Run the workflow

  1. Run the app.

  2. Click I Want To () and select the menu item () .

    The workflow runs.

    Workflow running in a Geocortex Web app

Recommended Hosting Methods

Geocortex Web offers several methods to host and run workflows:

The recommended hosting method depends on the inputs that the workflow takes. Workflow inputs are values that the host application passes to the workflow for the workflow to operate on. For more information, see Workflow Inputs.

The following recommendations prevent the situation in which the user has to select a feature or map location to run a workflow that doesn't require a feature or map location:

For more information about inputs, see Workflow Inputs.

The procedure below shows how to add an I Want To menu item that runs a workflow. For instructions on adding items to other types of menus, refer to the Geocortex Web Designer Help.

Use the I Want To Menu to Host and Run a Workflow

To configure a Geocortex Web app to host and run a workflow from the I Want To menu:

Step 1: Configure the I Want To menu

  1. In Geocortex Web Designer, click I Want To Menu in the Configure Components panel.

  2. Click Add Menu Item.

  3. In the Title box, type the text that you want to appear as an item in the I Want To menu, for example, Inspect Hydrant.

    If you want to use the name of the workflow as the menu item's title, skip this step. The title will automatically be set when you select the workflow.

  4. Optionally enter a description to appear under the Title.

  5. Click Select Icon and choose an icon to show beside the menu item's text, for example, .

  6. In the Command box, start typing the name of the workflow that you want the app to host.

    A list of the workflows with matching names displays.

    To see the workflows that you own, search for your user name.

  7. Select the workflow from the list.

    The JSON to run the workflow displays. The JSON has the required arguments for the selected workflow, with the exception of any inputs.

  8. If the workflow takes design-time inputs, type the inputs into the inputs property in the command's JSON.

    The input keys must match the input names used in the workflow.

    Example workflow inputs specified in the command's JSON

  9. If you want to hide the menu item completely when it is not available, rather than having it grayed out, turn on Hide when Disabled.

    Menu items are unavailable when the app is in a state that prohibits the item's command from running.

  10. If you want the user to be able to toggle the menu item between two states, turn on Can be Toggled and configure the alternate state.

    The alternate state can have a different title, description, and icon than the default state, and you can modify the menu item's behavior by changing the command or its configuration. For example, you could configure the default state to run a workflow that requires network connectivity, and configure the alternate state to run an offline version of the workflow.

  11. Press Ctrl+S on your keyboard or click File | Save to save the app.

Step 2: Run the workflow

  1. Run the app.

  2. Click I Want To () and select the menu item () .

    The workflow runs.

    Workflow running in a Geocortex Web app

© 2019 Latitude Geographics Group Ltd. All Rights Reserved.

Documentation Version 5.12