Introduction
The report view in the JOC Cockpit GUI handles generation and visualization of reports configured in the Reports Configuration view.
The reports view provides three sub views.
- The Report Generation view to generate one or more reports
- The Reports view to visualize the generated reports
- The Report Run History view to show the report generations runs in a historical view.
Report Generation view
The Report Generation 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 operation.
| Colum | Description |
|---|---|
| Action | To run the report the action contains the item "Run Report" |
| Name | The name of the report |
| Path | The path to the folder where the report is configured |
| Report Template | The template for the report. The values for ${hits} and ${sort} are substituted with the values from the report configuration. |
| 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. The value can be a absolute value <yyyy-mm> where <yyyy> specifies the year and <mm> specifies the month. The value can be relative with the pattern xy|m|q where
In month from
|
Month-To | The end of the report period. The value can be a absolute value <yyyy-mm> where <yyyy> specifies the year and <mm> specifies the month. The value can be relative with the pattern xy|m|q where
In month To
|
Reports view
The reports view shows the generated reports that have been started manually or by the JITL Job Run Reports.
The reports are grouped by name or by template. When the reports are grouped by name a sub group for the sort highest/lowest is created.
To delete a report open the action menu and select "Delete"
To view the report open the action menu and select "Show Report". Depending on the selected grouping depth, all generated reports are displayed based on the specified frequencies.
The report shows one report card for each interval according to the frequency definition.
E.g. when the report period is one year and the frequency is monthly then the report show 12 cards.
When the report contains more than one frequency the cards can be filtered by the frequency, e.g. to show all cards with the monthly frequency and hide the cards with the weekly frequency.
To hide/view single cards open the "manage cards" view.
Each card shows the result from the report generation. The data will be formatted as it is described in the report configuration. The visualization depends on the report template (e.g. counting workflow, jobs or consider the duration), the parameters like hits and sort.
Each card provides a pie chart, a bar chart and a list chart.
Bar chart
List Chart
Pie Chart
Filter
Filter by date range
The report list can be filtered by the begin of the report period, e.g. to show only reports that have report period started in the last three month.
Example Report Period:
Start Date: 26.02.2024
End Date: 03.03.2024
Filter: "Last 3 Months" (Executed in June 2024)
This filter covers from March 1, 2024, to May 31, 2024.
Conditions for Including Reports: A report is included only if the entire report period falls within the filter range. In the example, the report period (February 26 to March 3) is not fully within the filter range (March 1 to May 31), so the report would not be included.
Filter by template type
The report list can be filtered by the used report template.
Report Run History view
The Report Run History view shows the historical data of all report runs.
A full text search across all columns is available
The display can be filtered according to the status (Successful, Failed, In Progress).
| Column | Description |
|---|---|
| Name | The name of the generated report |
| Controller ID | The controller ID according to the settings in the report configuration |
| Report Template | The report template used in the report configuration. The placeholders for hits and sort are substituted. |
| Status | The current status of the report generation. Possible statuses are Successful, Failed, In Progress. The list can be filtered by status. |
| Frequencies | The frequencies that were assigned in the report configuration. |
| No. of reports | The number of reports that have been created with the report run. E.g a report with a report period "last year" and a frequency "monthly" will create 12 reports. |
| Error Message | If the report run fails this column shows the last error message |
| Month-From | The begin of the report period. Relative values are calculated to absolute values. |
| Month-To | The end of the report period. Relative values are calculated to absolute values. |
| Last Modified | The date when this recorded was modified last. |
...
Overview
Content Tools