Introduction

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

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

Report Configurations are used 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.

Managing Report Configurations

The Report Configuration includes to specify the following items:


Explanations:

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

Month FromBegin of the Report Period. Absolute and relative values can be specified. Absolute values follow the <yyyy>-<mm> pattern in which yyyy specifies the year and mm specifies the month. Relative values 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. Absolute and relative values can be specified. Absolute values follow the <yyyy>>-<mm> pattern in which yyyy specifies the year and mm specifies the month. Relative values 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

Highest
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 report can be filtered by the Controller ID
HitsSpecifies the number of top entries in the report10

Step Duration

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.top n periods with highest/lowest number of workflows executions

The Report Period is divided into steps in order to count the orders/jobs that run during these steps. Each next step will start at Start Time+Step Overlap and will end at End Time+Step Overlap of the current step. Each step lasts for the duration specified with the Step Duration setting.

Example:

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

Step Duration: 5

Step Overlap: 5



  • No labels