Web Services Reference › Sequences › SoftwareJobProperties

SoftwareJobProperties

This sequence defines the properties that can be set for a software job.

xsd:string softwareJobId

The UUId identifying the software job.

xsd:string softwareJobName

The display name of the software job.

xsd:string softwarePackageId

The UUID identifying the software package with which this job is associated.

xsd:string softwarePackageName

The name of the software package with which this job is associated.

xsd:string softwarePackageVersion

The version of the software package with which this job is associated.

SoftwarePackageType softwarePackageType

The type of the software package with which this job is associated.

xsd:string softwarePackageProcedureId

The UUID identifying the software package procedure with which this job is associated.

xsd:string softwarePackageProcedureName

The name of the software package procedure with which this job is associated.

DateTime executionDate

The Date and Time when the job are to be executed.

DateTime createdDate

The date and time at which the job was created.

xsd:long timeoutHours

The time in hours after which time, if the job has been unable to complete, the job will cease attempts to complete.

SoftwareJobType softwareJobType

The type of the software job.

SoftwareJobState softwareJobState

The current state of the software job.

SoftwareJobStartupTime startWhen

The range for this parameter is by default 3-168 hours. If, for example, the value 1 hour is selected, it will immediately be replaced by 3 hours by the system. The default value is 7 days (168 hours).

SoftwareJobPermissionMask permissionMask

The permissions applicable to this software job.

SoftwareJobBootMask bootBeforeMask

This element indicates the reboot options requested for the software job before the job is executed.

SoftwareJobBootMask bootAfterMask

This element indicates the reboot options requested for the software job after the job is executed.

SoftwareJobOperationMask operationMask

Properties for the operation of the software job.

xsd:string userParameters

This parameter contains user-defined parameters for the job.

SoftwareJobStatusCounters jobStatusCounters

A summary of the status counts for the targets of this software job.

xsd:long internalMask

Internal mask for software job properties.

xsd:long orderNumber

If the software job is part of a job container, this value represents the order number of the job within its container.

xsd:long promptTimeoutHours

This indicates the number of hours for which a user prompt should be displayed before forced execution of the job. The default value is 1 day. This parameter should be set to a value that does not exceed the timeout value for the job.

SoftwareJobTask softwareJobTask

The task-type that the software job has been asked to complete.

xsd:string deliveryCalendar

The name of a Unicenter delivery calendar to be used for scheduling the job. The calendar works as ordinary Unicenter calendars, to control the days, dates and times when delivery is permitted. The time cells not set on in the Unicenter Calendar thus define the exclusion intervals.

If you try to define a calendar, the name of which is unknown to Unicenter, the job will not be created.

DateTime deliveryDate

The Date and time at which the job was delivered.

xsd:long cause

The job error or status cause. This indicates a return code or identifier.

xsd:string causeParam

The message ID of the message that explains the error (if any) associated with this software job.

SoftwareJobRenewState renewState

Indicates the current state of the job, if it has been renewed.

Remarks

None