Difference between revisions of "Creating a workflow template"

From InfoEx Help Information
Jump to navigation Jump to search
(Creating a workflow template and choosing its general features)
(Creating a workflow template and choosing its general features)
Line 33: Line 33:
 
* They determine that previously entered & shared observations are pulled into the workflow in the [[Observations module]]. Only previously entered and shared observation that fall under the hierarchy of the specified location(s) are shown within a workflow.}}
 
* They determine that previously entered & shared observations are pulled into the workflow in the [[Observations module]]. Only previously entered and shared observation that fall under the hierarchy of the specified location(s) are shown within a workflow.}}
 
{{Note|For the majority of users, associating their workflows with their entire [[Location_types_and_symbology#OperationArea|operation area]] (the top parent of your [[Location hierarchy]]) will be the best setup. Only operations with multiple, distinct forecast regions (e.g., consulting companies, highway and railway forecasting operations) will find it meaningful to associate workflows with forecast areas or operating zones.}}
 
{{Note|For the majority of users, associating their workflows with their entire [[Location_types_and_symbology#OperationArea|operation area]] (the top parent of your [[Location hierarchy]]) will be the best setup. Only operations with multiple, distinct forecast regions (e.g., consulting companies, highway and railway forecasting operations) will find it meaningful to associate workflows with forecast areas or operating zones.}}
 
{{Issue|Enable distribution list allows one or more email addresses to be entered to allow emailing of a completed workflow summary after submission of the workflow. However due to Operating System limitations the workflow summary may be too large for this to successfully function. If it fails to send it does so with no error message or other indication that it has not worked |IssueNoImage|64|Mar.19, 2017}}
 
 
|-
 
|-
 
|class="StepNum" | 6.
 
|class="StepNum" | 6.
 
|Check the box to Enable a distribution list and then enter email addresses by clicking below the box.
 
|Check the box to Enable a distribution list and then enter email addresses by clicking below the box.
 
|-
 
|-
 +
{{Issue|Enable distribution list allows one or more email addresses to be entered to allow emailing of a completed workflow summary after submission of the workflow. However due to Operating System limitations the workflow summary may be too large for this to successfully function. If it fails to send it does so with no error message or other indication that it has not worked |IssueNoImage|64|Mar.19, 2017}}
 
|}
 
|}
  

Revision as of 16:29, 19 March 2017

REQUIREMENTS
Permission Operation administrator and higher
Connectivity Online and partial offline

This document describes how to create a new workflow template in the InfoEx system.

Background

A workflow template links together user-specified tasks into a logical order so that users can repeatedly move through the same steps. See Workflow overview for more background information on this feature of the InfoEx application.

Creating a workflow template consists of three main steps:

  1. Creating a workflow template and choosing its general features
  2. Adding steps to the workflow template
  3. Saving the workflow template

Step-by-step description

Creating a workflow template and choosing its general features

1.
Fig. 1: Managing a workflow
Click on WORKFLOWS in the main menu and select ‘Manage workflow definitions’. This will take you to the ‘Manage Workflows’ page of the InfoEx application (Fig. 1).
2.
Fig. 2: Workflow settings
Under the column heading 'Workflows' you will see a list of existing workflows (if any) and an Add New Workflow button. Clicking this button begins creation of a new workflow and opens the central panel of the screen with the title 'Workflow Settings' (Fig. 2). This is the area where you specify the general settings of your workflow.
4. Enter a meaningful name for the workflow into the 'Name of Workflow' field.
5. For workflow modules that involve data submission (Observations module, Snowpack module, Hazard assessment module, Hazard comment module), you need to associate your workflow to a location. Enter one or multiple locations into the 'Locations for Workflow' field by clicking on it and start typing. The dropdown list will show your location catalog filtered to what matches your typing.
NOTE The location(s) associated with workflow are used in two ways:
  • They are the location associated with the data submitted from the Snowpack module, the Hazard assessment module, and the Hazard comment module.
  • They determine that previously entered & shared observations are pulled into the workflow in the Observations module. Only previously entered and shared observation that fall under the hierarchy of the specified location(s) are shown within a workflow.
NOTE For the majority of users, associating their workflows with their entire operation area (the top parent of your Location hierarchy) will be the best setup. Only operations with multiple, distinct forecast regions (e.g., consulting companies, highway and railway forecasting operations) will find it meaningful to associate workflows with forecast areas or operating zones.
6. Check the box to Enable a distribution list and then enter email addresses by clicking below the box.
ISSUE Enable distribution list allows one or more email addresses to be entered to allow emailing of a completed workflow summary after submission of the workflow. However due to Operating System limitations the workflow summary may be too large for this to successfully function. If it fails to send it does so with no error message or other indication that it has not worked
JIRA: -64 (Mar.19, 2017)

Adding steps to the workflow template

1.
Fig 3: Select step type
To add a step to your workflow template, select one of the available modules from the dropdown list under the 'Workflow Steps' section title (Fig. 3). The currently available workflow modules include:
NOTE The Context module cannot explicitly be added to a workflow. Instead, it is automatically added at the beginning of all workflows.
NOTE To ensure meaningful workflows, the following restrictions have been placed on the design of workflow templates:
2. Click on Add New Step add a step of the chosen workflow module to your workflow (Fig. 3). This will add
  • A new step label under the 'Workflow Steps' section title
  • Open the right panel of the screen with the title 'Step Settings'
3. Specify the module-specific settings for the workflow step. See the documentation on the individual workflow modules for more information on the available settings:
4.
Fig 4: Save step settings
Click on Save Step to save the module-specific settings for the step that you just added to your workflow.
5. Repeat steps 1 to 4 until you have created your entire workflow.
NOTE A Context module is automatically added at the beginning of all workflows.
6. To change the order of steps in your workflow, click on the label of your step under the 'Workflow Steps' section title and drag it up or down to the desired location within your workflow.
7. You can specify whether the steps in your workflow need to be completed in strict order (i.e., no skipping steps) by checking the checkbox provided as the last item under the 'Workflow Settings' column.
NOTE Once the workflow steps have been completed in order once you can review and edit steps in any order.

Saving the workflow template

1.
Fig 5: Save workflow steps and settings
Click on Save Workflow to save your workflow.

Related documents

Functionality tested by

  • Dec. 24, 2013: Pascal Haegeli