Page History
| Table of Contents |
|---|
Introduction
JS7 - Reports offer aggregated information about past execution of workflows and jobs.
The Reports The report view in the JOC Cockpit GUI handles generation and visualization of reports configured in the Reports Configuration viewoffers to create and to visualize reports. The Configuration view offers to specify Report Configurations, see JS7 - Reports - Configuration.
The reports Reports view provides three the following sub-views.
- The Report Generation Creation view to generate create one or more reports,
- The Reports view to visualize the generated reports,
- The Report Run History view to show display the history of report generations runs in a historical view.
Report
...
Creation View
The view displays available Report Configurations that have been added by the user with the Configuration view:
The Report Generation Creation view list all released reports configured in the Reports Configuration view. In the list it is possible to perform a full text search. The full text search considers all columns. This view is used to generate reports manually. This can be done in a bulk operationdisplays released Report Configurations. User can apply the "Filter results" input field to limit In the number of items displayed. Filtering is performed by matching any columns displayed.
- The view is used to manually create reports. For automated creation of reports see JS7 - Reports - Automation.
- The view offers to create individual reports and to apply bulk operations for a number of reports.
| Colum | Description |
|---|---|
| Action | To run the report the action contains the item "Run ReportReports" |
| Name | The name of the reportReport Configuration |
| Path | The path to the folder where the report is configuredlocation of the Report Configuration |
| Report Template | The template for used to create the report. The values for ${hits} and ${sort} are substituted with the values from the report configurationReport Configuration. |
| Report Frequency | The frequencies that are assigned to the report. For each frequency a separate report run will be executed. |
Month-From | The begin of the report period.Report Period. Absolute values follow the The value can be relative with the pattern xy|m|q where Relative values follow the
In month from Month-From
|
Month-To | The end of the report period.Report Period. Absolute values follow the The value can be relative with the pattern xy|m|q where Relative values follow the
In month Month-To
|
Reports
...
View
The reports view shows the generated reports that displays available reports:
Reports displayed have been started manually created or by the JITL Job Run Reportsuse of JS7 - Reports - Automation.
The reports Reports are grouped by name or by template. When the reports are Report Template. If grouped by name then a sub-group for the sort related sorting (highest/lowest) is created.
To delete a report, open the action menu and select the "Delete" operation.
To view the report, open the action menu and select the "Show Report" operation. Depending on the selected grouping depth, all generated reports are displayed based on the specified applicable frequencies.
Reports are displayed from a The report shows one report card for each interval according to the frequency definition. E.g. when the report period is specified. For example, if the Report Period lasts for one year and the frequency is monthly then the report show will include 12 cards.
When If the report contains more than one frequency the , then report cards can be filtered by the frequency, e.g. for example to show all report cards with the using monthly frequency and to hide the report cards with the using weekly frequency.
To hide/view single show individual report cards, open the "manage cardsManage Cards" sub-view.
Each card shows the result from the of a report generationrun. The data will be formatted as it is described in the report configuration. The visualization depends on the report template (e.g. displayed as specified with the Report Configuration. Visualization is specidfic for the Report Template in use, for example counting workflow, jobs or consider the considering a duration), and is specific for the parameters like hits and sort parameters.
Each report card provides offers display from a pie chart, form a bar chart and from a list chart.
Display of Reports
Bar Chart
Display from a bar chart can look like this:
List Chart
Display from a list chart can look like this:
Pie Chart
Display from a pie chart can look like this:
...
Filtering
...
Filtering by Date Range
Display of reports date rangeThe report list can be filtered by a date range matching the begin or end of the report period, e.g. for example to show only reports that have report period started in the last three monthreports only from a Report Period three months back.
Example Report Period:
Start Date: 26.02.2024
End Date: 03.03.2024
Filter: "Last 3 Months" (Executed in June 2024)
This
The filter covers the time from from March 1, 2024, to May 31, 2024.
Conditions for Including ReportsPrerequisites for inclusion of reports: A report is will be included only if the entire report period falls within the filter range. its period fully or partly overlaps the date range used as a filter. In the example , the report period Report Period (February 26 to March 3) is not fully within the filter overlaps the date range (March 1 to May 31), so the report would not be included.Filter
Filtering by
...
Report Template
The report list can be filtered by the used report template.
Report Run History
...
View
The view displays the history of report runs like this:
The Report Run History view shows the historical data of all report runs.
A full Full text search across all columns is available from the "Filter Results" input field.
Display The display can be filtered according to the report run's execution status (Successfulsuccessful, Failed failed, In Progress in progress).
| Column | Description |
|---|---|
| Name | The name of the generated reportReport Configuration |
| Controller ID | The controller ID according to the settings in the report configurationController ID as specified with the Report Configuration |
| Report Template | The report template Report Template used in the report configuration. The placeholders Report Configuration. Placeholders for hits and sort are substituted. |
| Status | The current status of the report generationcreation. Possible statuses are Successful, Failed, In Progress. The list can be filtered by status.values include successful, failed, in progress. The status can be used to filter reports. |
| Report Frequencies | The frequencies that were assigned in the report configuration. are specified with the Report Configuration |
| No. of reportsReports | The number of reports that have been created with from the report run. E.g a report with a report period For example, a report run using the Report Period "last year" and a frequency "monthly" frequency will create 12 reports. The no number of reports can be 0 as a report will only be created when the if its first period does not exist. To force the a report to be regenerated re-created for a given frequency as a whole, the entire report or at least the report for the first partial period of a frequency must be deleted. |
| Error Message | If the report run fails this , then the column shows the last error message. |
| Month-From | The begin of the report periodReport Period. Relative values are calculated to absolute values. |
| Month-To | The end of the report periodReport Period. Relative values are calculated to absolute values. |
| Last Modified | The date when this recorded was modified of last modification. |
Cleanup
The Purge of the report history cleanup is managed perfomred by the JS7 - Cleanup Service. The Cleanup Service will delete report history entries from the history JS7 - Database that are older than the number of days set in specified with the cleanup.reporting_age settings setting. The default for cleanup.reporting_age setting is 1yvalue is: 365d.
When generating creating reports the , historical data from the database will be exported to csv CSV files in the file system. Each month is represented by one file. The export Export will be skipped for months that for which data already have been exported. The cleanup service Cleanup Service will not remove the csv files. CSV files. It's the user's responsibility to clean-up the file system in order to match storage limits.
The CSV data files are located in: $JETTY_BASE\reporting\data
Overview
Content Tools