Difference between revisions of "Executing a workflow instance"

From InfoEx Help Information
Jump to navigation Jump to search
(→‎Functionality tested by)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
−
{{Requirements|UserLevel=All users|Connectivity=Online and offline}}
+
{{Requirements|UserLevel=Submission Moderator and higher|Connectivity=Online and offline}}
  
−
This document describes how to use a workflow in the infoex system.
+
This document describes how to start a [[Definitions#WorkflowInstance|workflow instance]] from an existing [[Definitions#WorkflowTemplate|workflow template]] during regular operations.
  
 
==Background==
 
==Background==
−
A workflow links together user-specified tasks into a logical order so that users can repeatedly move through the same steps. The following types of steps are available in workflows:
+
A workflow links together user-specified tasks into a logical order so that users can repeatedly move through the same steps. See the following documents for more background information on workflows:
 +
* [[Workflow overview]]
 +
* [[Creating a workflow template]]
  
−
{|class="TblSteps"
+
Executing a workflow instance involves three main steps:
−
|-
+
# Selecting and initiating the desired workflow
−
|class="StepNum" | Context:
+
# Completing the steps included in the workflow
−
|A 'context' step provides information about the workflow itself and offers a place to record the following information:
+
# Saving and sharing the results of a workflow with the InfoEx community
−
|-
 
−
|class="StepNum" | Webpage:
 
−
|A 'webpage' step allows the workflow user to view a stored webpage without leaving the application.
 
−
|-
 
−
|class="StepNum" | Snowpack:
 
−
|A 'snowpack' step allows the workflow user to add a snowpack description in narrative form.
 
−
|-
 
−
|class="StepNum" | Observation:
 
−
|An 'observation' step allows you to fill out a customized infoex observation as part of the workflow.
 
−
|-
 
−
|class="StepNum" | Report:
 
−
|A 'report' step allows you to view a customized infoex report as part of the workflow.
 
−
|-
 
−
|class="StepNum" | Hazard comment:
 
−
|A 'hazard comment' step allows you to create and add a comment about avalanche hazard in narrative form as part of the workflow.
 
−
|-
 
−
|class="StepNum" | Hazard assessment:
 
−
|A 'hazard assessment step allows you to create and add a hazard assessment as part of the workflow.
 
−
|-
 
−
|}
 
−
Executing a workflow involves two main tasks:
 
−
*Selecting and initiating the desired workflow
 
−
*Saving and sharing the results of a workflow
 
  
−
__NOTOC__
+
==Step-by-step description==
−
{{Requirements|UserLevel= User|Connectivity=Online and partial offline}}
 
  
−
This document describes how to execute a workflow in the infoEx system.
+
===Step 1: Selecting and initiating the desired workflow===
−
 
 
−
==Background==
 
−
 
 
−
 
 
−
==Step-by-step description==
 
  
 
{|class="TblSteps"
 
{|class="TblSteps"
 
|-
 
|-
 
|class="StepNum" | 1.
 
|class="StepNum" | 1.
−
|login to the infoEx system with any valid user account.
+
|[[File:WorkflowMenuStartNew.png|300px|thumb|right|Fig. 1: Workflow menu for starting a new workflow instance.]]From the 'Workflows' menu select the workflow you want to execute and click on 'start new'. You need to be a Submission Moderator to have access to this menu item. The system will now load the necessary information for executing the chosen workflow.
 +
{{Note|It is desirable to have a live internet connection when you initiate a workflow. This allows the system to pre-populate the fields of the [[Snowpack module]], [[Hazard assessment module]] and [[Hazard comment module]] with the information from the last time a workflow was submitted for the location(s) associated with the chosen workflow.}}
 +
{{Note|It is possible to initiate a workflow instance completely offline, but it will be completely empty and you will have to start your assessments completely from scratch.}}
 
|-
 
|-
 
|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:WorkflowProgressSteps.png|300px|thumb|right|Fig. 2: Workflow progress]]After aftert the necessary information has been loaded, the workflow will begin with the first step. The list of workflow steps is presented at the top of the workflow screen below the workflow title.
−
|-
+
 
−
|class="StepNum" | 3.
+
−
|From the 'Workflows' menu select the workflow you want to follow. You may choose either 'start new' or 'view historical'. The rest of this page reviews starting a new instance of a workflow by selecting 'start new'. To view previously completed workflows consult: [[Viewing previously completed workflows]]
 
−
|-
 
−
|class="StepNum" | 4.
 
−
|[[File:WorkflowProgressSteps.png|300px|thumb|right|Fig. 1 Workflow progress]]After selecting 'start new' the workflow will begin with the first step. The list of workflow steps is presented at the top of the workflow screen below the workflow title.  
 
 
|-
 
|-
 
|class="StepNum" | 5.  
 
|class="StepNum" | 5.  

Revision as of 10:05, 31 December 2013

REQUIREMENTS
Permission Submission Moderator and higher
Connectivity Online and offline

This document describes how to start a workflow instance from an existing workflow template during regular operations.

Background

A workflow links together user-specified tasks into a logical order so that users can repeatedly move through the same steps. See the following documents for more background information on workflows:

Executing a workflow instance involves three main steps:

  1. Selecting and initiating the desired workflow
  2. Completing the steps included in the workflow
  3. Saving and sharing the results of a workflow with the InfoEx community

Step-by-step description

Step 1: Selecting and initiating the desired workflow

1.
Fig. 1: Workflow menu for starting a new workflow instance.
From the 'Workflows' menu select the workflow you want to execute and click on 'start new'. You need to be a Submission Moderator to have access to this menu item. The system will now load the necessary information for executing the chosen workflow.
NOTE It is desirable to have a live internet connection when you initiate a workflow. This allows the system to pre-populate the fields of the Snowpack module, Hazard assessment module and Hazard comment module with the information from the last time a workflow was submitted for the location(s) associated with the chosen workflow.
NOTE It is possible to initiate a workflow instance completely offline, but it will be completely empty and you will have to start your assessments completely from scratch.
2.
Fig. 2: Workflow progress
After aftert the necessary information has been loaded, the workflow will begin with the first step. The list of workflow steps is presented at the top of the workflow screen below the workflow title.


5.
Fig. 2 Workflow progress controls
To move between steps use the controls at the top right of the workflow area (see Figure 2).
NOTE Only the advance arrow will be enabled if the workflow design specified 'steps need to be completed in order' (see Creating a workflow template).
6. At any time you can select Discard & Exit from the workflow controls (see Figure 2) this will delete all trace of the workflow execution and no information will be submitted to the infoEx server.
7. At any time you can select Save & Exit from the workflow controls (see Figure 2) this will save a local copy of the workflow execution to date as well as share the saved information between all enabled local computers within an operation. However, no information will be shared with the infoEx server.
8. When the Submit button activates by turning blue Submit you may submit all entered information to the infoEx Server
NOTE Once information is submitted to the infoEx server it will be deleted from all local computers. You may review previously submitted workflows. See: Viewing previously completed workflows
.

Related documents

Functionality tested by

  • Nov. 17, 2013: John Kelly / Training / Version 3.1.0
Retrieved from "http://infoexhelp.avalancheassociation.ca/index.php?title=Executing_a_workflow_instance&oldid=1862"