JobProperties
A complex data type that specifies the general job attributes, such as input document file name, output file name, and job execution status.
Schema
<xsd:complexType name="JobProperties">
<xsd:sequence>
<xsd:element name="JobId" type="xsd:string" minOccurs="0"/>
<xsd:element name="JobName" type="xsd:string" minOccurs="0"/>
<xsd:element name="Priority" type="xsd:long" minOccurs="0"/>
<xsd:element name="ResourceGroup" type="xsd:string"
minOccurs="0"/>
<xsd:element name="Owner" type="xsd:string" minOccurs="0"/>
<xsd:element name="JobType" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="RunReport"/>
<xsd:enumeration value="PrintReport"/>
<xsd:enumeration value="RunAndPrintReport"/>
<xsd:enumeration value="ConvertReport"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="State" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Scheduled"/>
<xsd:enumeration value="Pending"/>
<xsd:enumeration value=”Waiting”/>
<xsd:enumeration value="Running"/>
<xsd:enumeration value="Succeeded"/>
<xsd:enumeration value="Failed"/>
<xsd:enumeration value="Cancelled"/>
<xsd:enumeration value="Expired"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="InputFileId" type="xsd:string"
minOccurs="0"/>
<xsd:element name="InputFileName" type="xsd:string"
minOccurs="0"/>
<xsd:element name="RunLatestVersion" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="ParameterFileId" type="xsd:string"
minOccurs="0"/>
<xsd:element name="ParameterFileName" type="xsd:string"
minOccurs="0"/>
<xsd:element name="ActualOutputFileId"type="xsd:string"
minOccurs="0"/>
<xsd:element name="ActualOutputFileName" type="xsd:string"
minOccurs="0"/>
<xsd:element name="RequestedOutputFileName" type="xsd:string"
minOccurs="0"/>
<xsd:element name="OutputFileVersionName" type="xsd:string"
minOccurs="0"/>
<xsd:element name="SubmissionTime" type="xsd:dateTime"
minOccurs="0"/>
<xsd:element name="CompletionTime" type="xsd:dateTime"
minOccurs="0"/>
<xsd:element name="PageCount" type="xsd:long" minOccurs="0"/>
<xsd:element name="OutputFileSize" type="xsd:long"
minOccurs="0"/>
<xsd:element name="RoutedToNode" type="xsd:string"
minOccurs="0"/>
<xsd:element name="DurationSeconds" type="xsd:long"
minOccurs="0"/>
<xsd:element name="StartTime" type="xsd:dateTime"
minOccurs="0"/>
<xsd:element name="NextStartTime" type="xsd:dateTime"
minOccurs="0"/>
<xsd:element name="RequestedHeadline" type="xsd:string"
minOccurs="0"/>
<xsd:element name="ActualHeadline" type="xsd:string"
minOccurs="0"/>
<xsd:element name="NotifyCount" type="xsd:string"
minOccurs="0"/>
<xsd:element name="EventName" type="xsd:string"
minOccurs="0"/>
<xsd:element name="EventType" type="typens:EventType"
minOccurs="0"/>
minOccurs="0"/>
<xsd:element name="EventStatus" type="xsd:string" minOccurs="0"/>
<xsd:element name="EventParameter" type="xsd:string"
minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Elements
JobId
The job ID.
JobName
The name of the job.
Priority
The job priority.
ResourceGroup
The name of the resource group to which a job is assigned, if any.
Owner
The owner of the job.
JobType
The type of job. Valid values are:
RunReport
PrintReport
RunAndPrintReport
ConvertReport
State
The state of the job. Valid values are:
Scheduled
Pending
Running
Succeeded
Failed
Cancelled
Expired
InputFileId
The input file ID.
InputFileName
The input file full name and version number.
RunLatestVersion
Specifies whether to run the latest version of the file.
ParameterFileId
The parameter file ID. Exists only if the parameter file is specified.
ParameterFileName
The parameter file name. Exists only if the parameter file is specified.
ActualOutputFileId
The output file ID that the BIRT iHub generated.
ActualOutputFileName
The output file name that the BIRT iHub generated. This might be different than the RequestedOutputFileName.
RequestedOutputFileName
The requested name for the output file.
OutputFileVersionName
The output file version name.
SubmissionTime
The time the job was submitted.
CompletionTime
The time the job is completed.
PageCount
The number of pages.
OutputFileSize
The size of the output file.
RoutedToNode
The node to which the job is routed.
DurationSeconds
The job duration.
StartTime
The start time.
NextStartTime
The next time the job is scheduled to run. Applies only to scheduled jobs.
RequestedHeadline
The headline for the job.
ActualHeadline
The headline that the BIRT iHub generated.
NotifyCount
The number of notifications sent about the job.
EventName
The name of the job event.
EventType
The job event type.
EventStatus
The job event status.
EventParameter
The parameter for the job event.