Difference between revisions of "Hazard comment module"

From InfoEx Help Information
Jump to navigation Jump to search
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
{{Requirements|UserLevel=Operation administrator and higher|Connectivity=Online and partial offline}}
+
{{Requirements|UserLevel=Submission moderator and higher|Connectivity=Online and partial offline}}
  
This document describes the purpose of a 'hazard comment' in a workflow, and how to set one up.
+
This document describes the functionality of the 'hazard comment' workflow module and how to properly configure if for a workflow.
==Background==
 
A 'hazard comment' step provides an area to comment on avalanche hazard in a generalized way.
 
  
==Details of: The '''hazard comment''' step and the information required to set one up==
+
Required permissions:
{|class="TblSteps"
+
* You need to be a Operation administrator to create a [[Definitions#WorkflowTemplate|workflow template]].
|-
+
* You need to be a Submission moderator to initiate a [[Definitions#WorkflowInstance|workflow instance]].
|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.
 
|-
 
  
 +
==Functionality==
 +
The hazard comment workflow module allows users to enter a free-form description of the current avalanche problems and the resulting avalanche hazard. It is intended as a low-tech alternative to the [[Hazard assessment module]]. It is only possible to have either single hazard comment or a single hazard assessment step in your workflow, not both.
 +
 +
Any workflow template with a hazard comment module step will automatically have a [[Context module]] step added at the beginning of the workflow.
 +
 +
Any workflow template with a hazard comment module step will automatically have a [[Workflow summary]] step added at the end of the workflow. This summary allows users to review their observations and assessments before they are submitted to the InfoEx.
 +
 +
The assessments submitted to the InfoEx via the hazard comment module are associated with the location specified in the entry form of the individual observation.
 +
 +
It is possible to complete the hazard comment step in a workflow without internet connectivity.
 +
 +
==Layout==
 +
[[File:HzdCommentModule.png|300px|thumb|right|Fig. 1: Hazard comment workflow module]]
 +
 +
==Settings==
 +
[[File:HzdCommentModuleSettings.png|300px|thumb|right|Fig. 2: Hazard comment workflow module settings]] The hazard comment workflow module has the following settings (Fig. 2):
 +
 +
* '''Name'''<br/>Name of the workflow step shown in the header of the workflow. It is recommended that you choose a short name (e.g., 'Av Hzd' instead of 'Avalanche Hazard') to keep the navigation bar of the workflow as tidy as possible.
 +
 +
==Other workflow modules==
 +
{{ListWorkflowModules|}}
  
|}
 
 
==Functionality tested by==
 
==Functionality tested by==
* Date: Nov. 15, 2013 / John Kelly / QA Server / Version 3.0.0
+
* Dec. 24, 2013: Pascal Haegeli
  
[[Category:Workflows]]
+
[[Category:Super User]][[Category:Operation Administrator]][[Category:Submission Moderator]][[Category:Offline]][[Category:Workflows]][[Category:Version 3.4.0]]

Revision as of 19:13, 27 December 2013

REQUIREMENTS
Permission Submission moderator and higher
Connectivity Online and partial offline

This document describes the functionality of the 'hazard comment' workflow module and how to properly configure if for a workflow.

Required permissions:

Functionality

The hazard comment workflow module allows users to enter a free-form description of the current avalanche problems and the resulting avalanche hazard. It is intended as a low-tech alternative to the Hazard assessment module. It is only possible to have either single hazard comment or a single hazard assessment step in your workflow, not both.

Any workflow template with a hazard comment module step will automatically have a Context module step added at the beginning of the workflow.

Any workflow template with a hazard comment module step will automatically have a Workflow summary step added at the end of the workflow. This summary allows users to review their observations and assessments before they are submitted to the InfoEx.

The assessments submitted to the InfoEx via the hazard comment module are associated with the location specified in the entry form of the individual observation.

It is possible to complete the hazard comment step in a workflow without internet connectivity.

Layout

Fig. 1: Hazard comment workflow module

Settings

Fig. 2: Hazard comment workflow module settings

The hazard comment workflow module has the following settings (Fig. 2):

  • Name
    Name of the workflow step shown in the header of the workflow. It is recommended that you choose a short name (e.g., 'Av Hzd' instead of 'Avalanche Hazard') to keep the navigation bar of the workflow as tidy as possible.

Other workflow modules

Functionality tested by

  • Dec. 24, 2013: Pascal Haegeli