Report parameters - j5 - 30 - Help - Hexagon

j5 Framework Help

Language
English
Product
j5
Search by Category
Help
j5 Version
30

The available report parameters are determined by what is configured in the report template. If parameters have been configured in the template, the report designer should provide information on the parameter names and supported values. In order to use the Report Parameters tab, it is important to know what has been configured in the report template.

To add a parameter to the report:

  1. Select Add ADDicon

  2. In the Name field, specify the name of the parameter, as defined in the report template.

  3. Use the Value field to indicate the value, field or expression that defines that parameter.

The YYYY-MM-DD HH:MM.SS format must be used for date parameters in order for j5 to correctly translate the data. Where dynamic date parameters are needed, these should be configured using a Business Intelligence and Reporting Tools (BIRT) Javascript expression. In this case, the value should be prefixed with ‘javascript:’ and formatted accordingly.

The following parameters are available for IndustraForm reports:

  • Start: The start date and time of the report. The information on the report is from this point in time.

  • End: The end date and time of the report. The information on the report ends at this point in time.

  • ScheduledTime: The date and time the report is created.

  • ScheduleLogid: The logbook ID of the schedule associated with the report.

  • ReportConfigLogid: The logbook ID of the report’s configuration.

  • DistListLogid: The logbook ID of the distribution list associated with the report.

  • Area: The area path defined in the distribution list configuration. If an area path is not defined in the distribution list configuration, the area path of the IndustraForm is used.

When these parameters are used as cell IDs in the IndustraForm template, the parameter values are displayed as initial values in these cells. Please note that you cannot use these parameters as custom parameters on the Report Parameters tab.