ExecuteReport

Triggers the execution of a report in synchronous mode. If you specify WaitTime, BIRT iHub sends a response within the specified time. Otherwise, BIRT iHub sends a response when the request is complete or, if progressive viewing is enabled, when the first page is complete. Specify FileType in the SOAP header for all execute, submit, and view IDAPI requests.

Request elements

JobName

String. The name of the job.

InputFileName

String. The name of the input executable file. Specify either InputFileName or InputFileId.

InputFileId

String. The ID of the input executable file. Specify either InputFileId or InputFileName.

InputFile

Attachment. Specifies that the input executable file is an attachment in the response. Valid only if the value of SaveOutputFile is False.

OutputFormat

String. The display format for the output file.

SaveOutputFile

Boolean. Specifies whether to use the RequestedOutputFile setting. If False, BIRT iHub ignores RequestedOutputFile. If True and RequestedOutputFile is missing, BIRT iHub reports an error.

RequestedOutputFile

NewFile. The name to use for the output file. Required for persistent jobs.

ParameterValues

ArrayOfParameterValue. The array of parameter values choice with which to overwrite the default parameter values:

ParameterValuesFileName

The name of the report object value (.rov) file to create. If specified, BIRT iHub creates a persistent ROV. Otherwise, BIRT iHub creates a temporary ROV. Specify either ParameterValuesFileName or ParameterValuesFileId.

ParameterValuesFileId

The ID of the ROV to create. If specified, BIRT iHub creates a persistent ROV. Otherwise, BIRT iHub creates a temporary ROV. Specify either ParameterValuesFileId or ParameterValuesFileName.

IsBundled

Boolean. Specifies whether the report is bundled. If True, the report is bundled. If False, the report is not bundled. The default value is False.

OpenServerOptions

OpenServerOptions. The open server options to use. Valid options are:

KeepWorkingSpace

DriverTimeout

PollingInterval

ProgressiveViewing

Boolean. Specifies whether to enable progressive viewing. True enables progressive viewing. The default value is True.

WaitTime

Int. The number of seconds BIRT iHub waits before sending a response to the report generation request. Use WaitTime to provide the ability to cancel a synchronous report generation request. The default value is 150 seconds.

Response elements

Status

ExecuteReportStatus. Indicates the execution status of a synchronous job. One of the following values:

Done

Failed

FirstPage

Pending

ErrorDescription

String. The description of the error. Returned if Status is Failed.

OutputFileType

String. Sets the file type for the output file.

ObjectId

String. The object ID of the report.

ConnectionHandle

String. The ID of the report. Supports viewing a report when the report is already in iHub System. Specified in the SOAP header.