Difference between revisions of "Creating a workflow template"

From InfoEx Help Information
Jump to navigation Jump to search
(Details of: Types of workflow steps and the information required to set them up)
(Adding steps to the workflow template)
 
(55 intermediate revisions by 3 users not shown)
Line 2: Line 2:
 
{{Requirements|UserLevel=Operation administrator and higher|Connectivity=Online and partial offline}}
 
{{Requirements|UserLevel=Operation administrator and higher|Connectivity=Online and partial offline}}
  
This document describes how to create a workflow in the infoex system.
+
This document describes how to create a new [[Definitions#WorkflowTemplate|workflow template]] in the InfoEx system.
 +
 
 
==Background==
 
==Background==
A workflow links together user-specified tasks into a logical order so that users can repeatedly move through the same steps.
+
A [[Definitions#WorkflowTemplate|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 consists of two main tasks:
 
* Defining the workflow name and choosing its general features
 
* Adding at least one workflow step
 
  
 +
Creating a workflow template consists of three main steps:
 +
# [[#Creating a workflow template and choosing its general features|Creating a workflow template and choosing its general features]]
 +
# [[#Adding steps to the workflow template|Adding steps to the workflow template]]
 +
# [[#Saving the workflow template|Saving the workflow template]]
  
 
==Step-by-step description==
 
==Step-by-step description==
 +
 +
===Creating a workflow template and choosing its general features===
 +
 
{|class="TblSteps"
 
{|class="TblSteps"
 
|-
 
|-
 
|class="StepNum" | 1.
 
|class="StepNum" | 1.
|login to the infoEx system with an account that has Operation Administrator privileges.
+
|[[File:ManageWorkflowDefinition.png|300px|thumb|right|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).
 
|-
 
|-
 
|class="StepNum" | 2.
 
|class="StepNum" | 2.
|if you are enabled in more than one operation you must select an operation on the first screen after logging in.
+
|[[File:WorkflowSettings.png|300px|thumb|right|Fig. 2: Workflow settings]]Under the column heading 'Workflows' you will see a list of existing workflows (if any) and an {{ButtonBlue | 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.  
 
|-
 
|-
|class="StepNum" | 3.
+
|class="StepNum" | 4.
|TASK 1: Create a new workflow
+
|Enter a meaningful name for the workflow into the 'Name of Workflow' field.
 +
|-
 +
|class="StepNum" | 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 [[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.}}
 +
|-
 +
|class="StepNum" | 6.
 +
|Check the box to Enable a distribution list and then enter email addresses by clicking on the plus symbol.
 +
|}
 +
 
 +
===Adding steps to the workflow template===
  
 
{|class="TblSteps"
 
{|class="TblSteps"
 
|-
 
|-
|class="StepNum" | a.
+
|class="StepNum" | 1.
|Go to the ‘workflows’ selection in the main menu and select ‘manage work flow definitions’. This will take you to the ‘Manage Workflows’ page
+
|[[file:WorkflowStepType.png|300px|thumb|right|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:
 +
{{ListWorkflowModules|}}
 +
{{Note|The [[Context module]] cannot explicitly be added to a workflow. Instead, it is automatically added at the beginning of all workflows.|NoteWithImage}}
 +
 
 +
 
 
|-
 
|-
|class="StepNum" | b.
+
|class="StepNum" | 2.
|You are now presented with two headings: ‘Workflows’ and ‘Add Step’. To create a new workflow select ‘add’ under ‘Workflow’. The ‘Add Workflow’ pop-up window appears.
+
|Click on {{ButtonBlue|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'
 
|-
 
|-
|class="StepNum" | c.
+
|class="StepNum" | 3.
|In the ‘Add Workflow’ pop-up window enter the following information for the new workflow:
+
|Specify the module-specific settings for the workflow step. See the documentation on the individual workflow modules for more information on the available settings:
* Name: A meaningful name of the workflow such as: ‘AM Guide Meeting’
+
{{ListWorkflowModules|Settings}}
* Include Summary: Select this check box if you want a summary screen at the end of the workflow
 
* Progressive Workflow: Select this check box to ensure that the steps of the workflow are presented in order (i.e. no steps are skipped). If this does not matter, leave this option unchecked.
 
{{Note|Once the workflow steps have been completed you can review and edit steps in any order.}}
 
*Locations: Associate the workflow with a location or combination of locations from your location catalogue.
 
{{Note|Click on the text box to get a dropdown with your entire location catalogue. To filter the dropdown start typing the name of the location  }}
 
{{Note|If no locations are visible an operation administrator must first create locations using the location catalogue selection under the  menu (see help documentation for ‘How to add a location to your operation’)}}
 
|-
 
|class="StepNum" | d.
 
|Click on the 'Ok' button at the bottom right of the ‘Add New Workflow’ window to save the workflow settings and close the pop-up window. The new workflow has now been created and is visible in the dropdown menu under    ???
 
|}
 
 
|-
 
|-
 
|class="StepNum" | 4.
 
|class="StepNum" | 4.
|TASK 2: Add a step to the new workflow.
+
|[[file:SaveStepSettings.png|300px|thumb|right|Fig 4: Save step settings]] Click on {{ButtonBlue|Save Step}} to save the module-specific settings for the step that you just added to your workflow.
{|class="TblSteps"
 
 
|-
 
|-
|class="StepNum" | a.
+
|class="StepNum" | 5.
|Ensure that the new workflow you want to add a step to is the one listed under ‘Workflow’. If it is not, use the dropdown list to select the new workflow.
+
|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.}}
 
|-
 
|-
|class="StepNum" | b.
+
|class="StepNum" | 6.
|Select ‘add’ under steps. The ‘Add New Step’ popup window appears .
+
|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.
|-
 
|class="StepNum" | c.
 
|In the ‘Add New Step’ popup window enter the following information:
 
* Name: A meaningful name for the step
 
* [[Type]]: [[File:WorkflowStepType.png|300px|thumb|right|Fig. 1: Workflow Step Types]] Select the type of workflow step from the predefined list. There are seven possible step types.
 
**Context
 
**Webpage
 
**Snowpack
 
**Observation
 
**Report
 
**Hazard comment
 
**Hazard assessment
 
|-
 
|class="StepNum" | d.
 
|Each step type requires you to enter specific baseline information for that step. The different step types, their purpose, and the information they require are listed below.
 
 
|-
 
|-
 +
|class="StepNum" | 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===
==Details of: Types of workflow steps and the information required to set them up==
+
 
 
{|class="TblSteps"
 
{|class="TblSteps"
 
|-
 
|-
|class="StepNum" | Context:
+
|class="StepNum" | 1.
|[[File:ContextPopup.png|300px|thumb|right|Fig. 2: Workflow 'context' settings]]A 'context' step provides information about the workflow itself and offers a place to record the following information:
+
|[[file:SaveWorkflowSettings.png|300px|thumb|right|Fig 5: Save workflow steps and settings]] Click on {{ButtonBlue|Save Workflow}} to save your workflow.  
*The name of the context step (frequently 'Context for [workflow name]'). This provides a name for this step as the user moves through the workflow.
 
*The type of workflow. Only two selections are possible: Nowcast (the context refers to conditions at the present moment); Forecast (the context refers to future conditions).
 
*The date of validity (This is the future date that the workflow is valid until). The default future date is selected by the person who creates the workflow and applies to all workflows of this type.
 
*The time of vailidity (This is the time of day on the future date that the workflow is valid until.) The default time is selected by the person who creates the workflow.
 
{{Note|All context steps will automatically provide a space to record when the workflow was run and the attendance. | NoteWithImage}}
 
{{Note|The date and time of validity can be changed when the workflow is run. | NoteWithImage}}
 
|-
 
|class="StepNum" | Webpage:
 
|[[File:WebpagePopup.png|300px|thumb|right|Fig. 3: Workflow 'webpage' settings]] A 'webpage' step allows the workflow user to view a stored webpage without leaving the application. The following information is required to set it up:
 
*A box is provided so you can set the name of the website step. This provides a meaningful name for this step as the user moves through the workflow.
 
*The url of the website to visit
 
{{Note|Currently you cannot use Google websites. This includes Google Search and YouTube | NoteWithImage}}
 
|-
 
|class="StepNum" | Snowpack:
 
|A 'snowpack' step allows the workflow user to add a snowpack description in narrative form. The following information is required to set it up:
 
*A box is provided so you can set the name of the snowpack step.
 
{{Note|A snowpack description is not the same as a snowpack observation. Snowpack descriptions are narrative interpretations of snowpack structure. Snowpack descriptions are not visible in the infoex report until you specify their inclusion. See ‘Customizing a report’.}}
 
|-
 
|class="StepNum" | Observation:
 
| [[File:ObservationPopup.png|300px|thumb|right|Fig. 4: Workflow 'observation' settings]] An 'observation' step allows you to fill out a customized observation as part of the workflow. The following information is required to set it up:
 
*A box is provided so you can set the name of the observation step.
 
*A list of 'observation types to include' is provided. Select the desired combination of options for the observation you want to make as part of the workflow.
 
*Select the 'time constraint on observations to include'. You can submit all unsubmitted observations for the operation, or limit submission to today's observations only.
 
{{Note|You may wish to limit submissions to today's date if there is a possibility that a saved workflow has stale data from a previous day | NoteWithImage}}
 
|-
 
|class="StepNum" | Reports:
 
|A 'report' step allows you to view a customized infoex report as part of the workflow. The following information is required to set it up.
 
*A box is provided so you can set the name of the Report step.
 
*A dropdown list provides the list of predefined reports that you may select for viewing.
 
{{Note|You can only select reports that have been previously defined. See: 'Creating reports'}}
 
|-
 
|class="StepNum" | Hazard Comment:
 
|A 'hazard comment' step allows you to create and add a comment about avalanche hazard in narrative form to your workflow. The following information is required to set it up:
 
*A box is provided so you can set the name of the hazard comment step.
 
|-
 
|class="StepNum" | Hazard Assessment:
 
| [[File:HazardAssessmentPopup.png|300px|thumb|right|Fig. 5: Workflow 'hazard assessment' settings]]A 'hazard assessment step allows you to create and add a hazard assessment to your workflow. The following information is required to set it up:
 
*A box is provided so you can set the name of the 'hazard assessment' step.
 
*You may select to assess hazard for one or three elevation bands.
 
*You may choose to rate stability, hazard, both, or neither.
 
 
 
 
|}
 
|}
  
 
==Related documents==
 
==Related documents==
 
+
{{PagesWorkflowAdmin}}
* How to add a location to your operation.
 
* Customizing a report
 
  
 
==Functionality tested by==
 
==Functionality tested by==
 +
* Dec. 24, 2013: Pascal Haegeli
  
* not tested
+
[[Category:Super User]][[Category:Operation Administrator]][[Category:Workflows]][[Category:Version 3.4.0]]
 
 
[[Category:Workflows]]
 

Latest revision as of 15:15, 17 November 2019

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 on the plus symbol.

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.


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