JobBean
From
Description
This bean is an extension of the JobTemporalIDBean, and contains all information related to the functional details of a EService job, excluding customer details such as name, location, etc. Jobs can be created using a JobBean, provided that the Customer primary key passed in is that of a customer already existing on EService.
Fields
The data fields of this object are identical to the fields of a JobTemporalIDBean, with the additional fields listed below.
Name | Type | Description |
---|---|---|
Attributes | AttributeBean array | A list of name and value pairs, indicating custom attribute values associated with this job. |
CancelState | CancelState | A set of possible cancel states the job may be in. |
CustomerPK | String | The EService primary key of the customer associated with this job. |
CustomerRef | String | A custom reference to the customer. |
DialableAttribute | AttributeBean | A single, dialable attribute. Usually appears on the field device as contact phone number for the job. |
Events | JobEventBean array | A list of all the events (state changes) that have occured on this job. |
ExternalAlternateRef | ExternalRefBean | A secondary external reference for the job, where there is a need to store a third primary key for a job. |
FieldDevicePK | String | The primary key of the field device. During job creation, populating this field with a valid value will cause EService to automatically assign the job to that field worker. |
InvoiceItems | InvoiceItemBean array | A list of all "invoice worthy" items associated with a job, after it has reached state "COMPLETED". Contains resources used on the job, plus payments received. |
JobType | String | The type of job this job is, one of a list created for each organisation during initial setup. |
Notes | NoteBean array | A list of the notes created either by the depatcher or the field device worker. |
Priority | int | The priority of the job, on whatever scale the organisation is using. |
ProposedCost | BigDecimal | An accurate decimal storage of the expected cost to perform and complete the job. |
Signature | byte array | The signature captured at Job Sgnoff. The bytes are in pairs of X and Y coordinates, with a singular 255 value indicating a break between one coordinate and the next, with no line linking them. |
Status | JobStatus | An enumerated list of possible states for the job, excluding CancelState. |
WhenCommitmentStart | Calendar | The date and time the job is scheduled to start. |
WhenCommitmentEnd | Calendar | The date and time the job is scheduled to end. |
AfterHoursApproved | boolean | Indicates whether this job is after hours approved. |
DeadInField | boolean | Indicates the job is dead in the field (not received by the field worker within the specified timeout limit). |
RecallPending | boolean | Indicates the job is about to be recalled, and is awaiting confirmation from the field worker. |
UpdatePending | boolean | Indicates there is an update to be sent to the field worker. |