JobInputDetail
A complex data type that describes the job input and output files.
Elements
InputFileVersionName
String. Optional. The input file version.
OutputFileVersionName
String. Optional. The output file version.
ReplaceLatestVersion
Boolean. Optional. Specifies whether to replace the latest version of the file with the current version.
OutputMaxVersion
Int. Optional. The maximum number of versions to keep after a new version is generated.
ValueFileType
String. Optional. The type of a value file. If present, the value is either Temporary or Permanent.
ValueFileVersionName
String. Optional. The value file name.
IsBundled
Boolean. Optional. Specifies whether the output object is bundled with the input object.
RetryOption
RetryOptionType. Optional. The retry settings. Valid values are:
*Disabled
*VolumeDefault
*Specified
MaxRetryCount
Int. Optional. The maximum number of retry attempts.
RetryInterval
Int. Optional. The interval between retry attempts. Measured in seconds.
MaxVersions
Long. Optional. The maximum number of versions to keep in the Encyclopedia volume.
NeverExpire
Boolean. Optional. Specifies whether the item expires.
ArchiveRuleInherited
Boolean. Optional. Specifies whether the archive rules are inherited from another object.
ExpirationAge
Int. Optional. Specifies the expiration age for the object.
ExpirationDate
DateTime. Optional. The date when the job expires.
ArchiveOnExpire
Boolean. Optional. Specifies whether the object is archived before it is expired.
KeepWorkspace
Boolean. Optional. Specifies whether to keep or remove the workspace directory after executing the job.
DriverTimeout
Int. Optional. The time for the driver to return from executing the job.
PollingInterval
Int. Optional. The time interval to get status messages. The minimum value is 10 seconds.
DebugInstruction
String. Optional. The debug instructions.
SendSuccessNotice
Boolean. Optional. Specifies whether success notices are sent if the job succeeds. Used only if OverrideRecipientPref is True.
SendFailureNotice
Boolean. Optional. Specifies whether failure notices are sent if the job fails. Used only if OverrideRecipientPref is True.
SendEmailForSuccess
Boolean. Optional. 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
Boolean. Optional. 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
Boolean. Optional. 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
Boolean. Optional. 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
String. Optional. 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
Boolean. Optional. Specifies whether to record job success notices.
RecordFailureStatus
Boolean. Optional. Specifies whether to record job failure notices.
KeepOutputFile
Boolean. Optional. 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
Obsolete since iHub release2.
DataACL
ArrayOfString. Optional. Specifies the access control list (ACL) restricting data privileges.