Difference between revisions of "Report module"

From InfoEx Help Information
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Requirements|UserLevel=Operation administrator and higher|Connectivity=Online and partial offline}} This document describes how to set up a 'report' step in a wor...")
 
(Settings)
 
(11 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 only}}
 +
[[File:ReportModule.png|300px|thumb|right|Fig. 1: Standard-Today InfoEx report shown within a workflow.]]
 +
[[File:WorkflowReportSettings.png|300px|thumb|right|Fig. 2: Settings for report workflow module]]
  
This document describes how to set up a 'report' step in a workflow.
+
This document describes the functionality of the 'report' workflow module and how to configure it.
==Background==
+
 
A 'report' step allows workflow users to view customized infoEx reports as part of the workflow. No information about the report viewed is submitted to the infoEx server.
+
'''Required permissions:'''
 +
* 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]].
 +
 
 +
'''Required connectivity:'''
 +
* You need to be online to create a new  or edit an existing [[Definitions#WorkflowTemplate|workflow template]].
 +
* You need to be online to read an InfoEx report while executing a [[Definitions#WorkflowInstance|workflow instance]].
 +
 
 +
==Functionality==
 +
A 'report' step allows workflow users to view any standard or customized InfoEx reports as part of the workflow. See [[Documentation_overview#Customizing_reports| Customizing reports]] for more information on how to create your custom InfoEx report.
 +
 
 +
There are no restrictions on the number of report module steps that can be added to a workflow template.
 +
 
 +
No information about the InfoEx reports viewed is submitted to the InfoEx server.
 +
 
 +
It is not possible to view InfoEx reports within a workflow without a live Internet connection.
 +
 
 +
 
 +
==Layout==
 +
The chosen InfoEx report is shown directly within the layout of a workflow (Fig. 1). Note that while it is still possible to use the left click menu for columns to filter, order etc, the layout does not allow you to filter the entire InfoEx report by date or location like you can directly in the report menu.
 +
 
 +
==Settings==
 +
The report 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., 'Wx Fcst' instead of 'Weather Forecast') to keep the navigation bar of the workflow as tidy as possible.
 +
 
 +
* '''Report'''<br/>Choose any of the available InfoEx system or operation report templates.
 +
 
 +
==<span style="color: #CC0000;">Information shared within the InfoEx</span>==
 +
None of the activities done within this workflow module are shared within the InfoEx.
 +
 
 +
==Other workflow modules==
 +
{{ListWorkflowModules|}}
  
==Details of: The '''report''' step and the information required to set one up==
 
{|class="TblSteps"
 
|-
 
|class="StepNum" | report:
 
|[[File:WorkflowReportSettings.png|300px|thumb|right|Fig1. Report settings]]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 select from three generic reports that have been previously defined, or created custom reports. See: 'Customizing reports'|NoteWithImage}}
 
|}
 
 
==Functionality tested by==
 
==Functionality tested by==
* Date: Nov. 16, 2013 / John Kelly / ? Server / Version 3.0.0
+
* Dec. 27, 3013: Pascal Haegeli
  
[[Category:Workflows]]
+
[[Category:Super User]][[Category:Operation Administrator]][[Category:Submission Moderator]][[Category:Workflows]][[Category:Reports]][[Category:Version 3.4.0]]

Latest revision as of 14:01, 30 May 2017

REQUIREMENTS
Permission Submission moderator and higher
Connectivity Online only
Fig. 1: Standard-Today InfoEx report shown within a workflow.
Fig. 2: Settings for report workflow module

This document describes the functionality of the 'report' workflow module and how to configure it.

Required permissions:

Required connectivity:

Functionality

A 'report' step allows workflow users to view any standard or customized InfoEx reports as part of the workflow. See Customizing reports for more information on how to create your custom InfoEx report.

There are no restrictions on the number of report module steps that can be added to a workflow template.

No information about the InfoEx reports viewed is submitted to the InfoEx server.

It is not possible to view InfoEx reports within a workflow without a live Internet connection.


Layout

The chosen InfoEx report is shown directly within the layout of a workflow (Fig. 1). Note that while it is still possible to use the left click menu for columns to filter, order etc, the layout does not allow you to filter the entire InfoEx report by date or location like you can directly in the report menu.

Settings

The report 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., 'Wx Fcst' instead of 'Weather Forecast') to keep the navigation bar of the workflow as tidy as possible.
  • Report
    Choose any of the available InfoEx system or operation report templates.

Information shared within the InfoEx

None of the activities done within this workflow module are shared within the InfoEx.

Other workflow modules

Functionality tested by

  • Dec. 27, 3013: Pascal Haegeli