Difference between revisions of "Context module"

From InfoEx Help Information
Jump to navigation Jump to search
(Settings)
 
(12 intermediate revisions by 2 users not shown)
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 offline}}
  
This document describes the purpose of a 'context' step in a workflow, and how to set one up.
+
This document describes the functionality of the 'context' workflow module and how to properly configure if for a workflow.
  
 
+
'''Required permissions:'''
This document describes the functionality of the 'snowpack' workflow module and how to properly configure if for a workflow.
 
 
 
Required permissions:
 
 
* You need to be a Operation administrator to create a [[Definitions#WorkflowTemplate|workflow template]].
 
* 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]].
 
* You need to be a Submission moderator to initiate a [[Definitions#WorkflowInstance|workflow instance]].
 +
 +
'''Required connectivity:'''
 +
* You need to be online to create a new or edit an existing [[Definitions#WorkflowTemplate|workflow template]].
 +
* If you are online when you initiate a [[Definitions#WorkflowInstance|workflow instance]] the fields will be prefilled from the last workflow instance with the same location(s). Once the workflow instance has been loaded, you can complete the workflow in an offline mode.
 +
* You can initiate a [[Definitions#WorkflowInstance|workflow instance]] when you are offline, and the fields will be filled with the latest cached information on the computer. This will be up to date unless workflows have been submitted using other computers since you were last online on the computer you are currently using.
 +
* If you submit whilst offline the workflow will be uploaded to the InfoEx server the next time you are online. WARNING: If the internet connection is lost whilst this is being done, the workflow will not be submitted and you will lose the data.
  
 
==Functionality==
 
==Functionality==
 
A 'context' step provides background information about a workflow including information on when each instance of the workflow was executed, the span of validity of the information entered during its execution and information on who participated in the workflow session.
 
A 'context' step provides background information about a workflow including information on when each instance of the workflow was executed, the span of validity of the information entered during its execution and information on who participated in the workflow session.
 +
 +
It is not possible to explicitly add a context step to a workflow. However a context step is automatically added to any workflow that includes a step that submits observations to the InfoEx server ([[Observations module]], [[Snowpack module]], [[Hazard assessment module]], [[Free form module]], [[Avalanche control module]], [[Run list module]]  or [[Hazard comment module]]).
  
 
==Layout==
 
==Layout==
[[File:ContextModule.png|300px|thumb|right|Fig. 1: Context workflow module at the beginning of a workflow with data submission.]]
+
[[File:ContextModule.png|300px|thumb|right|Fig. 1: Context workflow module at the beginning of a workflow with data submission.]] The context workflow step consists of the following fields:
 +
 
 +
* '''Assessment Date and Time'''<br/>Date and time when assessment was started.
 +
{{Note|This is the date and time that is associated with the observation in the [[Snowpack module]], [[Hazard assessment module]] and [[Hazard comment module]] steps in this workflow.|NoteWithImage}}
 +
 
 +
* '''Assessment type'''<br/>Specifies whether the current assessment is a nowcast or a forecast.
 +
 
 +
* '''Valid Until Date and Time'''<br/>If the current assessment is a forecast, these fields allow you to specify until when the forecast is valid (i.e., expiry date and time).
 +
{{Note|Please note that the valid until date and time does not have any effect on how the information submitted through the workflow is presented in the InfoEx.|NoteWithImage}}
 +
 
 +
* '''Users Present'''<br/>This field allows users to indicate who produced the assessment or record an attendance list for the meeting. All users associated with your operation are listed in the dropdown list of this field.
  
 
==Settings==
 
==Settings==
Line 32: Line 47:
 
All of these settings simply specify the default values that are presented when the workflow is executed. However, the content of these fields can be changed during individual workflows.
 
All of these settings simply specify the default values that are presented when the workflow is executed. However, the content of these fields can be changed during individual workflows.
  
==Details of: The '''context''' step and the information required to set one up==
+
==<span style="color: #CC0000;">Information shared within the InfoEx</span>==
{|class="TblSteps"
+
None of the information entered in this workflow module are shared within the InfoEx.
|-
 
|class="StepNum" | Context:
 
|[[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:
 
*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 'Valid Until' date (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 'Valid Until' time (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 field to record when the workflow was run and who attended the workflow session. | NoteWithImage}}
 
{{Note|The date and time of validity can be changed when the workflow is run. | NoteWithImage}}
 
|}
 
  
 
==Other workflow modules==
 
==Other workflow modules==
Line 49: Line 54:
  
 
==Functionality tested by==
 
==Functionality tested by==
* Dec. 24, 2013: Pascal Haegeli
+
* Dec. 27, 2013: Pascal Haegeli
  
 
[[Category:Super User]][[Category:Operation Administrator]][[Category:Submission Moderator]][[Category:Offline]][[Category:Workflows]][[Category:Version 3.4.0]]
 
[[Category:Super User]][[Category:Operation Administrator]][[Category:Submission Moderator]][[Category:Offline]][[Category:Workflows]][[Category:Version 3.4.0]]

Latest revision as of 09:54, 10 November 2017

REQUIREMENTS
Permission Submission moderator and higher
Connectivity Online and offline

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

Required permissions:

Required connectivity:

  • You need to be online to create a new or edit an existing workflow template.
  • If you are online when you initiate a workflow instance the fields will be prefilled from the last workflow instance with the same location(s). Once the workflow instance has been loaded, you can complete the workflow in an offline mode.
  • You can initiate a workflow instance when you are offline, and the fields will be filled with the latest cached information on the computer. This will be up to date unless workflows have been submitted using other computers since you were last online on the computer you are currently using.
  • If you submit whilst offline the workflow will be uploaded to the InfoEx server the next time you are online. WARNING: If the internet connection is lost whilst this is being done, the workflow will not be submitted and you will lose the data.

Functionality

A 'context' step provides background information about a workflow including information on when each instance of the workflow was executed, the span of validity of the information entered during its execution and information on who participated in the workflow session.

It is not possible to explicitly add a context step to a workflow. However a context step is automatically added to any workflow that includes a step that submits observations to the InfoEx server (Observations module, Snowpack module, Hazard assessment module, Free form module, Avalanche control module, Run list module or Hazard comment module).

Layout

Fig. 1: Context workflow module at the beginning of a workflow with data submission.

The context workflow step consists of the following fields:

  • Assessment Date and Time
    Date and time when assessment was started.
NOTE This is the date and time that is associated with the observation in the Snowpack module, Hazard assessment module and Hazard comment module steps in this workflow.
  • Assessment type
    Specifies whether the current assessment is a nowcast or a forecast.
  • Valid Until Date and Time
    If the current assessment is a forecast, these fields allow you to specify until when the forecast is valid (i.e., expiry date and time).
NOTE Please note that the valid until date and time does not have any effect on how the information submitted through the workflow is presented in the InfoEx.
  • Users Present
    This field allows users to indicate who produced the assessment or record an attendance list for the meeting. All users associated with your operation are listed in the dropdown list of this field.

Settings

Fig. 2: Workflow 'context' settings

The context 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., 'Intro' instead of 'Introduction') to keep the navigation bar of the workflow as tidy as possible.
  • Default Assessment Type
    Specifies the default setting for the assessment type for the workflow. Only two selections are possible
    • Nowcast: The assessment that examines the current conditions
    • Forecast: The assessment provides a forecast for the near future
  • Valid until - Default date
    Specifies the default date of validity/expiry date of a forecast assessment relative to the assessment date. Options for the setting include Current day or + x days.
  • Valid until - Default time
    Specifies the default time of day of validity/expiry date of a forecast assessment.

All of these settings simply specify the default values that are presented when the workflow is executed. However, the content of these fields can be changed during individual workflows.

Information shared within the InfoEx

None of the information entered in this workflow module are shared within the InfoEx.

Other workflow modules

Functionality tested by

  • Dec. 27, 2013: Pascal Haegeli