Promotic

Report - tab of the PmaReport object

Description:
Basic settings of the PmaReport object.
Configurators:
Window titleThe displayed name of the report (window caption). The value of the configurator is transferred into the report template automatically as a system keyword _syst_objecttitle.
This configurator sets the initial value of the Title property.
Macro expression can be used for input ($.text ..) (it is evaluated while setting a property).
sFramePars default valueParameters for the frame where the viewer will be displayed
Entries are in the KeyVal format, for example "target:_blank;".
See the PmViewCreator.Frame property.
Macro expression can be used for input (it is evaluated while the window is opening).

It is a static default setting of entries.
The entries can also be defined dynamically at viewer opening (see the sFramePars parameter in the CreateView method). In this case the static default setting of the object is combined with the entries provided dynamically. If the same information is present on both places, then the dynamical information provided at viewer opening is preferred by the system.
sViewPars default valueIt allows to set the value of report parameters. These parameters are then accessible in the pEvent.Pars parameter of the onReportRequest event.
Each parameter consists of an identifier and a value.
Syntax: "pars:{name1:value1;name2:value2; ...}".
Macro expression can be used for input (it is evaluated while the window is opening).

It is a static default setting of entries.
The entries can also be defined dynamically at viewer opening (see the sViewPars parameter in the CreateView method). In this case the static default setting of the object is combined with the entries provided dynamically. If the same information is present on both places, then the dynamical information provided at viewer opening is preferred by the system.

The relation between Pma object and the report parameters: It is important that it is possible to deliver the Pma object parameter into the report as a report parameter. The basic principle is that the Pma object parameter cannot get inside the report automatically. It is necessary to create the corresponding parameter in the report and set it to the value of the Pma object parameter when opening the report. This can be done by Macro expression $.par, that allows to get the Pma object parameter values in this configurator and use them to create the report parameters.
Example: There are Pma 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("pars:name1:",$.par("name1"),";name2:",$.par("name2"),";") will be evaluated as: "pars:{name1:boiler;name2:temperature;}". By evaluating the macro expression and using the Pma object parameters, the configurator value has been created, setting the report parameter values for report opening.
Saving type of report source templateSpecifies whether the report tempate is saved on the disk in an individual file or directly in the PmaReport object.
0 - the report template is saved in the file on the disk - The report template is saved as an individual file on the disk, see the "Source file of the report template" configurator.
1 - the report template is saved directly in the object - The report template is saved locally in the PmaReport object, see the "Report template saved directly in the object" configurator. Caution! By removing the PmaReport object, the locally stored report is removed as well. By copying the PmaReport object, the locally stored report is copied as well.
Source file of the report templatePath and name 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 PmaReport object.
Report template saved directly in the objectThe content of report template saved directly in the object.
If the report remains unchanged, then it can be advantageous that the content od the report is saved directly in the project (in the *.pra file), without the need to use the external file.
The source file must be formated as described in Source file description of the PmaReport object.
PROMOTIC 9.0.18 SCADA system documentation - MICROSYS, spol. s r.o.

Send page remarkContact responsible person
© MICROSYS, spol. s r. o.