ReportDefn Class Properties
In this section, the ReportDefn class properties are presented in alphabetical order.
Description
Use the Description property to return a description for the report definition.
This property is effectively read-only.
Description
Use the DestinationPrinter property to specify a printer for the generated report.
This property is read/write.
Description
Use the FolderName property to specify a folder name for the generated report to be posted to.
This property is read/write.
Description
This property sets the report output destination as a string. This property must be set before calling the ProcessReport method. When ProcessReport is called, it places the generated report files in the directory specified by this property.
If this property is not set prior to calling the ProcessReport method, the report processing directory and the value returned by the OutDestination property depends on the setting of the psxp_usedefaultoutdestination property. The psxp_usedefaultoutdestination property, which is set on the Report Definition - Properties page, is used to set a compatibility mode with pre-8.50 PeopleTools versions.
See Setting Report Properties.
This property is effectively write-only.
Important! While this property is read/write, your PeopleCode program should read this property only if the program set the property first. Reading the property before it has been explicitly set produces unexpected results.
Description
This property returns the type of device specified for the output of the report definition, as a string.
This property returns the output destination value set on the Report Definition-Output page; it is not used internally to determine the output type. It can be used in a PeopleCode program to determine how to process and produce report output (for example, whether to call Publish, how to set OutDestination).
This property is effectively read-only.
Description
Use this property to specify a number representing a process instance for running the report.
In certain circumstances—for example, when running report using a Process Scheduler server—a process instance number is required for setting drilling URLs in the report output. In these cases, you must set the ProcessInstance property prior to calling the ProcessReport method.
This property is read/write.
Example
&ProcessInstance=PSXPQRYRPT_AET.PROCESS_INSTANCE;
&oRptDefn.ProcessInstance = &ProcessInstance;
&oRptDefn.ProcessReport("", "", %Date, "");
Description
Use the ReportFileName property to specify the file name for the generated report as a string. When this property is set, it overrides the setting of the UseBurstValueAsOutputFileName property.
This property is read/write.
Description
This property returns the status of the report definition as a string. Valid values are:
|
Value |
Description |
|---|---|
|
A |
The report definition is active and can be run. |
|
I |
The report definition is inactive and cannot be run. |
|
P |
The report definition is in progress and cannot be run. This is the default value. |
This property is read-only.
Description
Use the UseBurstValueAsOutputFileName property to specify different names for all the files that result from bursting. This property takes a Boolean value: true, the report output files are named BurstValue.Extention. False is the default value.
Note: If the ReportFileName property is set, it overrides the setting of this property.
This property is read/write.