Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ColumDescription
ActionTo run the report the action contains the item "Run ReportReports"
NameThe name of the Report Configuration
Path

The path to the location of the Report Configuration

Report TemplateThe template used to create the report. The values for ${hits} and ${sort} are substituted with the values from the Report Configuration.
Report FrequencyThe frequencies that are assigned the report. For each frequency a separate report run will be executed.

Month-From

The begin of the Report Period.

Absolute values follow the <yyyy>-<mm> pattern in which yyyy specifies the year and mm specifies the month.

Relative values follow the <n><y>|<m>|<q> pattern using the placeholders

  • n: count
  • y: year
  • q: quarter
  • m: month

In Month-From

  • the month is always 1 if y is specified,
  • the month is one of 1, 4, 7, 10 if q is specified.

Month-To

The end of the Report Period.

Absolute values follow the <yyyy>-<mm> pattern in which yyyy specifies the year and mm specifies the month.

Relative values follow the <n><y>|<m>|<q> pattern using the placeholders

  • n: count
  • y: year
  • q: quarter
  • m: month

In Month-To

  • the month is always 12 when y is specified,
  • the month is one of the values 3, 6, 9, 12 if q is specified.

...

Reports displayed have been manually created or bgy by use of JS7 - Reports - Automation.

...

To view the report, open the action menu and select the "Show Report" operation. Depending on the grouping depth, reports are displayed based on applicable frequencies.


Image RemovedImage Added


Reports are displayed from a card for each interval according to the frequency specified. For example, if the Report Period lasts for one year and the frequency is monthly then the report will include 12 cards.

...

Display can be filtered according to the report run's execution status (successful, failed, in progress).


ColumnDescription
NameThe name of the Report Configuration
Controller IDThe Controller ID as specified with the Report Configuration
Report TemplateThe Report Template used in the Report Configuration. Placeholders for hits and sort are substituted.
StatusThe current status of report creation. Possible values include successful, failed, in progress. The status can be used to filter reports.
Report FrequenciesThe frequencies that are specified with the Report Configuration
No. of Reports

The number of reports that have been created from the report run. For example, a report run using the Report Period "last year" and a "monthly" frequency will create 12 reports.

The number of reports can be 0 as a report will only be created if its first period does not exist. To force a report to be re-created for a given frequency, 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, then the 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 of last modification.

...

Purge of the report history is perfomred by the JS7 - Cleanup Service. The Cleanup Service will delete report history entries from the JS7 - Database that are older than the number of days specified with the cleanup.reporting_age setting. The default value is: 1y 365d.

When creating reports, historical data from the database will be exported to CSV files in the file system. Each month is represented by one file. Export will be skipped for months for which data already have been exported. The Cleanup Service will not remove 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