Reporting
- Last UpdatedDec 01, 2024
- 2 minute read
The PMLReport Object is used to run new reports created by the Report Designer in batch. The interface is available on the .NET ReportingAddin assembly which may be imported and used as follows:
import 'ReportingAddin'
handle (1000,0)
endhandle
using namespace 'Aveva.Pdms.Reporting'
!!report = object PMLReport()
For example, to add parameters to a parameterized report:
!argNames = object array()
!argNames[1] = 'param1'
!argValues = object array()
!argValues[1] = 'value1'
!!report.addParameters(!argNames, !argValues)
To add scope to a report for limiting the data to be displayed, overriding existing scope defined in the report:
! ancestorElements = '/ATEST,/BTEST'
!elements = ''
!!report.AddScope(!ancestorElements, !elements)
And to export report as csv file.
!rep1 = object file('C:\rep1.repv')
!csv1 = object file('C:\rep1.csv')
!!report.exportAsCsv(!rep1.fullname(), !csv1.fullname())
Errors loading the report data may be logged by adding a handler to the response event.
The interface has the following methods:
|
Name |
Result |
Purpose |
|
AddParameters(ARRAY argNames, ARRAY argValues) |
No Result |
Adds parameters to report as 2 arrays of argument names and values, which will be used to generate a parameterized report. |
|
AddScope(ARRAY ancestorElements, ARRAY elements) |
No Result |
Specify scope value to filter the data given by array of ancestor elements and array of elements. |
|
AddScope(ARRAY ancestorElements, ARRAY elements, BOOLEAN fully, REAL minX, REAL minY, REAL minZ, REAL maxX, REAL maxY, REAL maxZ) |
No Result |
Specify scope value to filter the data given by array of ancestor elements, array of elements, if limit box is specified then whether it should be considered fully or partially, to construct limit box minX, minY, minZ, maxX, maxY, maxZ. |
|
ExportAsCsv(STRING reportFileName, STRING destinationFilename) |
No Result |
Export report to .csv file. |
|
ExportAsPdf(STRING reportFileName, STRING destinationFilename) |
No Result |
Export report to .pdf file. |
|
ExportAsXlsx(STRING reportFileName, STRING destinationFilename |
No Result |
Export report to .xlsx file. |
|
ExportAsXls(STRING reportFileName, STRING destinationFilename) |
No Result |
Export report to .xls file. |
|
InitializePrinterSetting() |
No Result |
Initialize the printer settings. |
|
OpenReportManager |
No Result |
Opens report manager. |
|
Print(STRINGreportFileName) |
No Result |
Print report with system defined printer settings passing name of report definition file. |
|
PrintDirect(STRING reportFileName) |
No Result |
Print report with user defined printer settings. |
|
PublishToAVEVANET(STRING reportFileName, STRING pdfFilename) |
No Result |
Publishes report to AVEVA AIM in form of .pdf file. |
|
RemoveParameters() |
No Result |
Removes the parameters applied to report. |
|
RemoveScope() |
No Result |
Removes the scope applied to report. |