Introduction

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

Reports are created from predefined Report Templates. The templates individually implement which data will be processed when creating a report. Report Templates can be parameterized There are predefined report templates. The template determines which data is analysed for the report. All templates can be parameterised with the number of hits and the sorting (Highesthighest/Lowestlowest).  

Report Templates

At this stage It is not possible for users to create their own implementations for reports.

Find below the list of Report Templates that ship with JS7.

Prerequisites

Reports are created from a Java class that can be configured to use Java options. It is recommended to use the -Xmx<number><unit> option to limit Java heap space consumption. The default value is -Xmx64M., see JS7 - Settings.

Memory consumption depends on

• the Report Template,
• the frequency:  short frequencies such as a weekly interval will consume less memory than long frequencies such as a yearly interval,
• the value for the number of "Hits",
• the value for "Step Overlap": small values will consume more memory. The Step Overlap is configured for the "Top n periods with highest/lowest number of workflow/job executions" Report Templates.
• the duration of job/workflow runs for the "Top n periods

...

• with highest/lowest number of

...

Counts workflows that are failed. A workflow is considered as failed when the order have leaved the workflow and is failed.

• workflow/job executions" Report Templates.
• the number of distinct workflows/jobs, that are considered for counting, for example for the number of failed workflows.
• the number of distinct Agents in reports based on the "Top n Agents with highest/lowest number of parallel job executions" Report Templates.

Example: A report based on the "Top n periods with highest/lowest number of workflow/job executions" Report Template will consume more memory when using the frequency "Yearly" instead of "Monthly" or with a Step Overlap of 1m instead of 60m.

Report Templates

Report Template: Top n workflows with highest/lowest number of failed executions

The Report Template counts failed workflow executions:

• A workflow execution is considered being failed if the order leaves the workflow with an unsuccessful outcome, for example if an order is cancelled or if a JS7 - Finish Instruction is used indicating unsuccessful outcome.
• A workflow execution is not considered being failed just because some job failed, for example if a JS7 - Retry Instruction is used a later retry of a job can be successful. Instead, the resulting history status of an order is considered.

Report Template: Top n jobs with highest/lowest number of failed executions

Counts jobs that are failed. A job is considered as failed when the job execution ends with an error.

The Report Template counts failed job executions.

• Shell job execution is considered being failed based on a job's exit code and optionally output to the stderr channel.
• JVM job execution is considered being failed based on the job's outcome that can hold exceptions.

Report Template: Top n

...

Agents with highest/lowest number of parallel job execution

Counts The Report Template counts parallel job execution for agentsexecutions with Agents. A job execution A Job1 is considered as parallel with job execution B when

• A starts after B starts and before B ends or
• A ends after B starts and before B ends. 

in parallel to Job2 if

• Job1 starts after Job2 has started and before Job2 will end or
• Job1 ends after Job2 is started and before Job2 will end.

Report Template: Top n high criticality jobs with highest/lowest number of failed executions

Counts failed jobs that have a criticality of "crititcal"

The Report Template counts failed executions of jobs with criticality critical. The criticality is a job attribute, see JS7 - Job Instruction.

Counting is performed similar to Report Template: Top n jobs with highest/lowest number of failed executions.

Report Template: top n workflows with highest/lowest number of failed executions for cancelled orders

...

Counts failed jobs that for The Report Template counts failed workflow executions due to orders that have been cancelled after the job failed.

The cancel operation is applied to an order by user intervention .

Report Template: Top n workflows with highest/lowest need for execution time

This report The Report Template considers the duration of workflows that have been ended successfully. successful workflow executions. Failed workflow executions will not be considered.

Report Template: Top n jobs with highest/lowest need for execution time

This report The Report Template considers the duration of jobs that have been ended successfully. successful job executions. Failed job executions will not be considered.

Report Template: Top n periods with highest/lowest number of

...

job executions

This report The Report Template divides the reporting time Reporting Period into periodssteps. The length duration of the period a step is determined by the "Period LengthStep Duration" setting in the report configuration JS7 - Reports - Configuration. The start of the next period step is determined by the "Period Step Overlap" setting in the report configuration Report Configuration.

Example: 

• Period LengthStep Duration: 5m
• Period Step Overlap: 2m
  • 00:00:00-00:05:00
  • 00:07:0002-00:12:0007
  • 00:14:0004-00:19:00 09

The number of jobs started in execution is counted per periodstep.

Report Template: Top n periods with highest/lowest number of workflows executions

This report The Report Template divides the reporting time Reporting Period into periodssteps. The length duration of the period a step is determined by the "Period LengthStep Duration" setting in the report configuration JS7 - Reports - Configuration. The start of the next period step is determined by the "Period Step Overlap" setting in the report configuration Report Configuration.

The number of orders started in execution is counted per periodstep.

Report Template: Top n jobs with highest/lowest number of successful executions

Counts workflows that are successfully ended. A workflow is considered as successful when the order have leaved the workflow and is successful.

The Report Template counts jobs that completed successfully. Failed jobs are not considered.

For possible reasons of job failure see Report Template: Top n jobs with highest/lowest number of failed executions.

Report Template: Top n workflows with highest/lowest number of successful executions

Counts jobs that are successfully ended. A job is considered as successful when the job ended without error.

The Report Template counts workflows that completed successfully. Failed workflow executions are not considered.

For reasons of workflow failure see Report Template: Top n workflows with highest/lowest number of failed executions.