Retrieving job properties using GetJobDetails
Use GetJobDetails to retrieve the properties of a job stored in an Encyclopedia volume. An Encyclopedia volume administrator uses GetJobDetails to retrieve the properties of any job in the Encyclopedia volume. A nonadministrative user can use GetJobDetails for a job he submits. If a nonadministrative user sends GetJobDetails for a job he did not submit, BIRT iHub returns a security error.
GetJobDetails retrieves job properties using the elements you specify in the request. The following list describes the available elements:
JobAttributes returns general job attributes, including JobId, JobName, Priority, Owner, JobType, and InputFileName or ID. JobAttributes always returns in the response to GetJobDetails.
InputDetail returns details about input parameters.
Schedules returns schedule information.
PrinterOptions returns the printer settings, if available.
NotifyUsers returns the users to notify, if any.
NotifyGroups returns the groups to notify, if any.
NotifyChannels returns the channels to notify, if any.
DefaultOutputFileACL returns the output file ACL templates.
Status returns the job status.
Query returns definitions of columns available to this report. It also returns filtering criteria and other information.
ReportParameters returns the report parameter values. BIRT iHub reads the report parameters from the report object value (.rov) file associated with the job.
The following example shows a response to a GetJobDetails request that includes JobAttributes:
<SOAP-ENV:Body>
<GetJobDetailsResponse>
<JobAttributes>
<JobId>58</JobId>
<JobName>Latest Results</JobName>
<Priority>1000</Priority>
<Owner>Administrator</Owner>
<JobType>RunReport</JobType>
<State>Succeeded</State>
<InputFileId>973</InputFileId>
<InputFileName>/ltor.rptdesign;1</InputFileName>
<ParameterFileId>1045</ParameterFileId>
<ParameterFileName>
/$$$TempROVs/_441c_f0b808e4.ROV;1
</ParameterFileName>
<ActualOutputFileId>1046</ActualOutputFileId>
<ActualOutputFileName>/ltor.rptdocument;26
</ActualOutputFileName>
<RequestedOutputFileName>ltor.rptdocument
</RequestedOutputFileName>
<SubmissionTime>2008-09-20T21:59:16</SubmissionTime>
<CompletionTime>2008-09-20T21:59:17</CompletionTime>
<PageCount>5</PageCount>
<OutputFileSize>26640</OutputFileSize>
<RoutedToNode>pinetree</RoutedToNode>
<DurationSeconds>1</DurationSeconds>
<StartTime>2008-09-20T21:59:16</StartTime>
<NotifyCount>1</NotifyCount>
<RunLatestVersion>false</RunLatestVersion>
</JobAttributes>
</GetJobDetailsResponse>
</SOAP-ENV:Body>