ReportRequest
Use the ReportRequest data type to define the settings needed to run a
report. Note that allowable values for attributeFormat will vary according
to the type of template used (for example, PDF templates can only generate PDF output.)
Fields Provided by ReportRequest
| Field | Description |
|---|---|
|
String attributeCalendar |
The formatting calendar to use for the report request. Valid values are: "Gregorian", "Arabic Hijrah", "English Hijrah", "Japanese Imperial", "Thai Buddha", and "ROC Official". |
|
String attributeFormat |
The output format of the requested report. See Values for attributeFormat. |
|
String attributeLocale |
The locale selection for the report. Example: fr-FR |
|
String attributeUILocale |
The locale selection for the user-interface. Example: fr-FR. Required when parameter input from the user-interface is not English. |
|
String attributeTemplate |
The template to apply to the report. For example: Employeelisting.rtf. |
|
String attributeTimeZone |
Specifies the time zone to use for the request, using a supported Java time zone ID. For example: "America/Los_Angeles". |
|
boolean byPassCache |
True indicates to bypass document cache. |
|
BIPDataSource dynamicDataSource |
If the data source for the report is not defined, you can dynamically define it. See BIPDataSource. |
|
boolean flattenXML |
True indicates that the XML is to be flattened. This flag is used for the Analyzer for Microsoft Excel because Excel requires XML data type to be flattened. |
|
ParamNameValues parameterNameValues |
The parameter name-value pairs to be used in the submission of this report request, passed through the ParamNameValues data type. See ParamNameValues. |
|
String reportAbsolutePath |
The absolute path to the report in the Publisher repository. For example: /HR Manager/HR Reports/Employee Listing.xdo. |
|
byte[] reportData |
If you are providing the data directly for the report use this element to pass the data. |
|
String reportOutputPath |
Specifies the output path for the generated report. |
|
String reportRawData |
If raw XML data is used for the report, this element contains the XML data. |
|
integer sizeOfDataChunkDownload |
If you set flattenXML to true, or if you do not want to chunk the data, set this parameter to -1 to return all data back to the client. |
|
MetaDataList XDOPropertyList |
See MetaDataList. |