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 with the number of hits and the sorting (highest/lowest). 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 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

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

The Report Template counts parallel job executions with Agents. A Job1 is considered 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

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

The Report Template counts failed workflow executions due to orders that have been cancelled.

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

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

The Report Template considers the duration of successful workflow executions. Failed workflow executions will not be considered.

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

The Report Template considers the duration of successful job executions. Failed job executions will not be considered.

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

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 of the next step is determined by the "Step Overlap" setting in the Report Configuration.

Example: 

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

The number of jobs in execution is counted per step.

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

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 of the next step is determined by the "Step Overlap" setting in the Report Configuration.

The number of orders in execution is counted per step.

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

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

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.