JobInputDetail
A complex data type that describes the job input and output files.
Schema
<xsd:complexType name="JobInputDetail">
<xsd:all>
<xsd:element name="OutputFileVersionName" type="xsd:string"
minOccurs="0"/>
<xsd:element name="ReplaceLatestVersion" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="OutputMaxVersion" type="xsd:int"
minOccurs="0"/>
<xsd:element name="ValueFileType" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Temporary"/>
<xsd:enumeration value="Permanent"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="ValueFileVersionName" type="xsd:string"
minOccurs="0"/>
<xsd:element name="IsBundled" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="RetryOption" type="typens:RetryOptionType"
minOccurs="0"/>
<xsd:element name="MaxRetryCount" type="xsd:int"
minOccurs="0"/>
<xsd:element name="RetryInterval" type="xsd:int"
minOccurs="0"/>
<xsd:element name="MaxVersions" type="xsd:long"
minOccurs="0"/>
<xsd:element name="NeverExpire" type="xsd:boolean"
minOccurs="0"/
<xsd:element name="ArchiveRuleInherited" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="ExpirationAge" type="xsd:int"
minOccurs="0"/>
<xsd:element name="ExpirationDate" type="xsd:dateTime"
minOccurs="0"/>
<xsd:element name="ArchiveOnExpire" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="KeepWorkspace" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="DriverTimeout" type="xsd:int"
minOccurs="0"/>
<xsd:element name="PollingInterval" type="xsd:int"
minOccurs="0"/>
<xsd:element name="DebugInstruction" type="xsd:string"
minOccurs="0"/>
<xsd:element name="SendSuccessNotice" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="SendFailureNotice" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="SendEmailForSuccess" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="SendEmailForFailure" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="AttachReportInEmail" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="OverrideRecipientPref" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="EmailFormat" type="xsd:string"
minOccurs="0"/>
<xsd:element name="RecordSuccessStatus" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="RecordFailureStatus" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="KeepOutputFile" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="ConversionOptions"
type="typens:ConversionOptions" minOccurs="0"/>
<xsd:element name="DataACL" type="typens:ArrayOfString"
minOccurs="0"/>
</xsd:all>
</xsd:complexType>
Elements
OutputFileVersionName
The output file version.
ReplaceLatestVersion
Specifies whether to replace the latest version of the file with the current version.
OutputMaxVersion
The maximum number of versions to keep after a new version is generated.
ValueFileType
Specifies whether a value file is temporary or permanent.
ValueFileVersionName
The value file name.
IsBundled
Specifies whether the output object is bundled with the input object.
RetryOption
The retry settings. Valid values are:
Disabled
VolumeDefault
Specified
MaxRetryCount
The maximum number of retry attempts.
RetryInterval
The interval between retry attempts. Measured in seconds.
MaxVersions
The maximum number of versions to keep in the Encyclopedia volume.
NeverExpire
Specifies whether the item expires.
ArchiveRuleInherited
Specifies whether the archive rules are inherited from another object.
ExpirationAge
Specifies the expiration age for the object.
ExpirationDate
The date when the job expires.
ArchiveOnExpire
Specifies whether the object is archived before it is expired.
KeepWorkspace
Specifies whether to keep or remove the workspace directory after executing the job.
DriverTimeout
The time for the driver to return from executing the job.
PollingInterval
The time interval to get status messages. The minimum value is 10 seconds.
DebugInstruction
The debug instructions.
SendSuccessNotice
Specifies whether success notices are sent if the job succeeds. Used only if OverrideRecipientPref is True.
SendFailureNotice
Specifies whether failure notices are sent if the job fails. Used only if OverrideRecipientPref is True.
SendEmailForSuccess
Specifies whether e-mail notifications are sent if the job succeeds. Used only if OverrideRecipientPref is True. If SendEmailForSuccess is True, e-mail notifications are sent to specified users and groups if the job succeeds. The default value is False.
SendEmailForFailure
Specifies whether e-mail notifications are sent if the job fails. Used only if OverrideRecipientPref is True. If SendEmailForFailure is True, e-mail notifications are sent to specified users and groups if the job fails. The default value is False.
AttachReportInEmail
Specifies whether the output file is attached to the e-mail notification for successful jobs. Used only if OverrideRecipientPref is True. If AttachReportInEmail is True, the output file is attached to the e-mail notification. If False, only a link to the output file is sent. Specify the format for the attachment in the EmailFormat element. The default value is False.
OverrideRecipientPref
Specifies whether e-mail notifications and output attachments are sent according to job settings or user settings. If True, e-mail notifications and output attachments are sent according to job settings. If False, e-mail notifications and output attachments are sent according to user settings. The default value is False. If False, the following elements are ignored:
AttachReportInEmail
SendEmailForSuccess
SendEmailForFailure
SendSuccessNotice
SendFailureNotice
EmailFormat
Specifies the output format of the report attached to the e-mail notification. Valid formats are:
Excel (XLS)
Excel (XLSX)
PDF
PostScript (PS)
Word (DOC)
Word (DOCX)
PowerPoint (PPT)
PowerPoint (PPTX)
RecordSuccessStatus
Specifies whether to record job success notices.
RecordFailureStatus
Specifies whether to record job failure notices.
KeepOutputFile
Specifies whether the generated output file remains in the Encyclopedia volume if the generation request succeeds but the printing request fails. Used if the job is to be generated and printed. If True, the output file remains in the Encyclopedia volume. If False, the output file is deleted if the printing request fails. The default value is False.
ConversionOptions
Specifies options for converting a report object instance (.roi) output to another format.
DataACL
Specifies the access control list (ACL) restricting data privileges.