Actuate Information Delivery API operations : SelectJavaReportPage
 
SelectJavaReportPage
Returns a report page formatted in the specified display format indicated by the Page or Component element.
Request schema
<xsd:complexType name="SelectJavaReportPage">
<xsd:sequence>
<xsd:element name="Object" type="typens:ObjectIdentifier"/>
<xsd:choice>
<xsd:element name="Page" type="typens:PageIdentifier"
minOccurs="0"/>
<xsd:element name="Component"
type="typens:ArrayOfNameValuePair"minOccurs="0"/>
</xsd:choice>
<xsd:element name="ViewParameterValues"
type="typens:ArrayOfParameterValue" minOccurs="0"/>
<xsd:element name="OutputFormat" type="xsd:string"
minOccurs="0"/>
<xsd:element name="ViewProperties"
type="typens:ArrayOfNameValuePair" minOccurs="0"/>
<xsd:element name="DownloadEmbedded" type="xsd:boolean"
default="false" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Request elements
Object
The ID of the object from which to select the report page.
Page
The identifier of the page to retrieve.
Component
The name, display name, or ID, and the value of the component from which to retrieve the data.
ViewParameterValues
Include view parameters if defined in the document. This feature is not currently supported for a BIRT report.
OutputFormat
For a BIRT report, the output format can be HTML, rptdocument, or PDF. The default is rptdocument.
ViewProperties
Specifies the layout and contents of a report such as the name of a bookmark name, table of contents, or an object ID. ViewProperties is available to the BIRT render task as the java.util.Map object in the Engine AppContext under the key ServerViewProperties.
DowloadEmbedded
Specifies whether to send the attachment embedded in the body of the SOAP message or in a separate MIME boundary. If True, the response contains the attachment as embedded data. If False, the attachment is in a separate MIME boundary. The default value is False.
Response schema
<xsd:complexType name="SelectJavaReportPageResponse">
<xsd:sequence>
<xsd:element name="PageRef" type="typens:Attachment"/>
<xsd:element name="ConnectionHandle" type="xsd:string"
minOccurs="0"/>
<xsd:element name="OutputProperties"
type="typens:ArrayOfNameValuePair" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Response elements
PageRef
*Contains the following properties of the attachment:
*MimeType
*ContentEncoding
*ContentLength
*Locale
ConnectionHandle
The ID of the report. Supports viewing a report when the report is already in iHub System. Specified in the SOAP header.
OutputProperties
*Applies only if Format is CSV. The properties to include in the search result are:
*EnableColumnHeaders
If True, column headers are included in the search result. The default value is True.
*UseQuoteDelimiter
If True, each data item in the search result is enclosed in double quotes (" "). The default value is True.