Setting a time frame for an ExecuteReport response
Use ExecuteReport with WaitTime to set a time frame for a response to a report generation request. WaitTime requests a response from BIRT iHub within a specific period of time, even if report generation has not started or is incomplete. WaitTime specifies the minimum time BIRT iHub waits before it returns a response.
To avoid performance issues associated with frequent server time-outs, make WaitTime long enough for a typical report to generate. The ExecuteReport response is Pending if WaitTime is less than the time required to generate the first page of a progressive report or the time required to complete a non-progressive report.
The following example sets the wait time to 1 second and ProgressiveViewing to False. Using these settings, BIRT iHub returns a status message to the client if the entire report does not generate in 1 second.
<SOAP-ENV:Body>
<ExecuteReport>
<JobName>Detailed_Data</JobName>
<InputFileName>/detail.rptdesign</InputFileName>
<SaveOutputFile>true</SaveOutputFile>
<RequestedOutputFile>
<Name>detail.rptdocument</Name>
<AccessType>Shared</AccessType>
</RequestedOutputFile>
<IsBundled>false</IsBundled>
<ProgressiveViewing>false</ProgressiveViewing>
<WaitTime>1</WaitTime>
</ExecuteReport>
</SOAP-ENV:Body>
The response includes the status of the report generation request, the ObjectId, and the output file type.
<SOAP-ENV:Body>
<ExecuteReportResponse>
<Status>Pending</Status>
<OutputFileType>RPTDOCUMENT</OutputFileType>
<ObjectId>435</ObjectId>
</ExecuteReportResponse>
</SOAP-ENV:Body>
An ExecuteReport request with WaitTime set returns one of the following report request status messages:
Done means that report generation succeeded.
Pending means that the report is either in the queue or in the process of generating.
Failed means that the request to cancel did not succeed because of authorization errors or another reason.
FirstPage means the first page of a progressive report is complete and the report is continuing to generate.