Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Introduction

JS7 - Reports offer aggregated information about past execution of workflows and jobs.

Report Configurations are managed in the Automation/Reports section system folder of the Configuration View view.

Configured reports Report Configurations are used as input for report generation. When reports are generated, the reports are created according to the specifications made in the report configuration regarding report template, hit, sorting, reporting period and frequency.

Generated reports can be viewed after generation in the Reports View

Inventory View

List of Reports

The list of reports shows all configured reports that can be used for report generation.

Image Removed

Report Configuration

for creation of reports. They include to specify:

  • Report Template
  • Report Period
  • Report Frequency
  • number of hits,
  • sorting for highest/lowest

Reports are visbile in the Reports view

Inventory View

Displaying Report Configurations

The list of Report Configurations shows the items that users added for creation of reports.

Image Added

Managing Report Configurations

The Report Configuration includes to specify the following items for a report:

Image RemovedImage Added


Explanations:

...

FieldPurposeDefault
NameIdentifies the report Report Configuration by its unique name
TitleThe title to describe describes the report Report Configuration in more detail
Report TemplateThe template that should be used when generate the templateSpecifies one of the JS7 - Reports - Templates that will be applied when creating the report
IntervalThe report period Report Period is defined by an interval of month-from and month-to. It is possible to define the report period relative a Report Period by using presets like such as "Last Year" or using Unit/From/Count.
Example: Unit: Year, From: 3, Count: 2 will set month-from to the january 3 years back and month-to to december 2 year back.

Month FromStart Begin of the report period. The Report Period. Absolute and relative values can be absolute or relativespecified. Absolute values are follow the <yyyy>-<mm> where  pattern in which yyyy specifies the year and <mm> mm specifies the month. Relative values are xy|m|q where x specifies a count make use of the <n><y>|<m>|<q> pattern in which n specifies the count, y: year offset, m: month offset, q: quarter offset. If y is used, then the month is always 1. If q is used, then the month is one of 1, 4, 7, 10.
Month To

End of the

report period. The

Report Period. Absolute and relative values can be

absolute or relative

specified. Absolute values

are <yyyy>

follow the <yyyy>>-<mm>

where

 pattern in which yyyy specifies the year and

<mm>

mm specifies the month. Relative values

are xy|m|q where x

make use of the <n><y>|<m>|<q> pattern in which n specifies a count y: year offset, m: month offset, q: quarter offset. If y is used, then the month is always 12. If q is used, then the month is one of 3, 6, 9, 12.

 

The month before now.
Sort

Highest: The report will return the top n highest values.

Lowest: The report will return the top n lowest values.

HighestFrequencies

The report period will be split into the given frequencies. Possible values are
Weekly, every 2 weeks, monthly, every 3 months,  every 6 months, yearly, every 3 years.
For each split a report is generated.

Report Frequency

The Report Frequency divides the Report Period into equal units of time, for example months, and creates reports per unit

Examples for frequencies include:

  • weekly
  • every 2 weeks
  • monthly
  • every 3 months
  • every 6 months
  • yearly
  • every 3 years

Controller IDData used for the Controller IDThe report can be filtered by the controller Controller ID
HitsSpecifies the number of top entries in the report10

Step Duration

The length of  a step used by the report templates 
  • top n periods with highest/lowest number of workflows executions
  • top n periods with highest/lowest number of workflows executions
5

Step Overlap

The Report Template divides the Reporting Period into steps. The duration of a step is determined by the "Step Duration" setting in the JS7 - Reports - Configuration. The start time of the next step is determined by the "Step Overlap" setting in the Report Configuration.

Step OverlapThe Period Step of  the next period used by the report templates 

top n periods with highest/lowest number of workflows executions

  • top n periods with highest/lowest number of workflows executions
  • In these reports, the reporting period The Report Period is divided into steps in order to count the orders/jobs that run in during these steps. The Each next step starts will start at start+step_overlap and ends at end+step_overlap Start Time+Step Overlap and will end at End Time+Step Overlap of the current step. Each step has a duration of "step duration"lasts for the duration specified with the Step Duration setting.

    Example:Example

    • Step Duration: 5m
    • Step Overlap: 2m
      • 00:00-00:05
      • 00:02-00:07
      • 00:04-00:09

    Step Duration: 5

    Reports View

    Step Overlap: 5