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.

Reports can be generated manually created using the JOC Cockpit Report view or automatically using a JITL Job in a workflow that is scheduled periodically Reports view. In addition, they can be created automatically using the JS7 - JITL RunReportJob Job Template. Users can create workflow and job using the Job Template that can be scheduled for begin of month.

JITL RunReportJob

The purpose of the RunReportJob Job Template is to generate to create reports that are defined with the Reports system folders in the report section of the configuration Configuration view.

  • Language:  java Java
  • Name of Java Class:   com.sos.jitl.jobs.runreports.RunReportJob
  • Documentation: JS7 - JITL RunReportJob

JITL Authentication

The JITL RunReportJob makes use of the JS7 - REST Web Service API. To access the API it is required to configure an account for authentication, see JS7 - JITL Common Authentication

The account needs the following permissions to create reports:

  • sos:products:joc:reports:manage  
  • sos:products:joc:reports:view 


ArgumentsParameters

NameDescription
report_paths

List of reports to be generated

A list of report paths. The items are seperated by semicolon. All reports that are in the list will be generated. Entries for reports that do not exist are ignored. When a report is listed twice, it will generated once

paths pointing to the location of report configurations for which reports should be created

Items in the list are separated by semicolon. Reports will be created for all list items. List items for non-existing report configurations will be ignored. If the same report configuration is specified more than once, then it will be used just once.

If both report_paths argument and report_folders argument are not used, then reports for all report configurations will be created.If neither report_paths nor report_folders is set, all reports are generated. 

report_folders

List of folders with reports to be generatedholding report configurations for which reports should be created

Items in the list are separated by semicolon. Reports will be created for all list items. List items for non-existing report configurations will be ignored. If the same report configuration is specified more than once, then it will be used just once. This can occur if a report configuration is found in the report_paths argument and in a folder specified by the report_folders argument.

Folders will be A list of folders that contain folder names. The items are seperated by semicolon. All reports found in the given folders will be generated. If a report is listed more than once, it is generated once. E.g .when a report is found in the list of report_paths and in a folder. A folder is processed recursively if the name ends with: /*

If neither both report_paths nor argument and report_folders is set, all reports are generated.

Creating a workflow to automate the report generation

Create a new workflow and assign one job to the workflow. 

Specify the value for the agent to any available standalone agent or agent cluster.

Image Removed

Open the wizard to assign the RunReport JITL-Job

Image Removed

argument are not used, then reports for all report configurations will be created.

Adding a Workflow to automate Creation of Reports

Users can add a workflow that holds a single job to create reports.

Image Added



The wizard is available to assign the job the JITL RunReportJob Job Template:

Image Added


It is not required to configure job argumentsClick the Submit Button. It is not necessary  to configure parameters for the job. The default behavior is to create all reports. 

Reports that have already been created Existing reports will not be created againoverwritten.

Schedule Report generation

Create a schedule and assign the schedule to the workflow.  

Image Removed

Assign the workflow

Image Removed

Adding a Schedule to automate Creation of Reports

A schedule can be created like this:

Image Added


The schedule is assigned a the workflow:

Image Added


The schedule specifies start times. In the following example reports will be created on the first day of Assign the run-time. In this example the reports will be generated the first day of any month at 12:00:00:

Image ModifiedJS7 - JITL RunReportJob