Promotic
WikipediaLinkedInYoutubeTwitterFacebook

Report - page of object PmReport

Description:
Basic settings of PmReport object
Configuration items:
Window titleThe displayed name of the report (window caption). The value of the configurator is transfered into the report template automatically as a system keyword _syst_objecttitle.

This configurator sets the initial value of the property Title.

Macro expression can be used for input ($.text ..) (it is evaluated while setting a property).

sOptions default valueThe parameters transfered to the viewer. These define where and how to open the viewer.

Entries with assigned value are separated by a semicolon, for example "target:_blank;modal:1;".

For detailed description see sOptions.

Macro expression can be used for input (it is evaluated while the window is opening).

 
It is a static default setup of entries. The entries can also be defined dynamically at viewer opening, see the sOptions parameter in the OpenView method. In such case the static default setup of the object is combined with the entries provided dynamically. If the same information is present on both places, the dynamical information provided at viewer opening is preferred by the system.
sParams default valueAllows to set the value of report parameters. These parameters are then accessible in the pEvent.Pars parameter in onReportRequest event. Each parameter consists of an identifier and a value.

Syntax: "par:name1=value1;par:name2=value2; ...".

Macro expression can be used for input (it is evaluated while the window is opening).

 
It is a static default setup of entries. The entries can also be defined dynamically at viewer launch, see the sParams parameter in the OpenView method. In such case the static default setup of the object is combined with the entries provided dynamically. If the same information is present on both places, the dynamical information provided at viewer opening is preferred by the system.
 
The relation between PROMOTIC object and the report: It is important that it is possible to deliver the PROMOTIC object parameter into the report as a report parameter. The basic principle is that the PROMOTIC object parameter cannot get inside the report autoamtically. It is necessary to create the corresponding parameter in the report and set it to the value of the PROMOTIC object parameter when opening the report. This can be done by Macro expression $.par, that allows to get the PROMOTIC object parameter values in this configurator and use them to create the report parameters.

Example: There are PROMOTIC object parameters "name1" and "name2" with the values "boiler" and "temperature". The values of these parameters are to be delivered to the report parameters of the same names when the report is opened. The macro expression: $.join("par:name1=",$.par("name1"),";par:name2=",$.par("name2"),";") will be evaluated as: "par:name1=boiler;par:name2=temperature;". By evaluating the macro expression and using the PROMOTIC object parameters, the configurator value has been created, setting the report parameter values for report opening.

Saving type of report source templateDetermines if the report tempate is saved on disc in an individual file or directly in the PmReport object.
0 - the report template is saved in a file on disc - The report template is saved as an individual file on disc, see the configurator Source file of the report template.
1 - the report template is saved directly in the object - The report template is saved locally in the PmReport object, see the configurator Report template saved directly in the object. CautionBy removing the PmReport object, the locally stored report is removed as well. By copying the PmReport object, the locally stored report is copied as well.
Source file of the report templatePath and filename of the source file containing the report template.

It is recommended to use the PROMOTIC path syntax - see PROMOTIC path to files and folders.

The source file must be formated as described in Source file description of the PmReport object.

Report template saved directly in the objectThe content of report template saved directly in the object. If the report remains unchanged, it can be advantageous that the content od the report is saved directly in the project (*.PRA file), without the need to use the external file on disc.

The source file must be formated as described in Source file description of the PmReport object.

© MICROSYS, spol. s r. o.Tavičská 845/21 703 00 Ostrava-Vítkovice