JobBean

From
(Difference between revisions)
Jump to: navigation, search
(→‎Fields)
Line 9: Line 9:
 
!Name
 
!Name
 
!Type
 
!Type
 +
!Size
 +
!Required
 
!Description
 
!Description
 
|---- bgcolor=#EDEDFF
 
|---- bgcolor=#EDEDFF
 
|Attributes
 
|Attributes
 
|[[AttributeBean]] array
 
|[[AttributeBean]] array
 +
|N/A
 +
|No
 
|A list of name and value pairs, indicating custom attribute values associated with this job.
 
|A list of name and value pairs, indicating custom attribute values associated with this job.
 
|---- bgcolor=#EDEDFF
 
|---- bgcolor=#EDEDFF
 
|CancelState
 
|CancelState
 
|[[CancelState]]
 
|[[CancelState]]
 +
|N/A
 +
|No
 
|A set of possible cancel states the job may be in.
 
|A set of possible cancel states the job may be in.
 
|---- bgcolor=#EDEDFF
 
|---- bgcolor=#EDEDFF
 
|CustomerPK
 
|CustomerPK
 
|String
 
|String
−
|The EService primary key of the customer associated with this job.
+
|9
 +
|Yes
 +
||The EService primary key of the customer associated with this job.
 
|---- bgcolor=#EDEDFF
 
|---- bgcolor=#EDEDFF
 
|CustomerRef
 
|CustomerRef
−
|String
+
|String
 +
|20
 +
|No
 
|A custom reference to the customer.
 
|A custom reference to the customer.
 
|---- bgcolor=#EDEDFF
 
|---- bgcolor=#EDEDFF
 
|DialableAttribute
 
|DialableAttribute
 
|AttributeBean
 
|AttributeBean
 +
|N/A
 +
|No
 
|A single, dialable attribute.  Usually appears on the field device as contact phone number for the job.
 
|A single, dialable attribute.  Usually appears on the field device as contact phone number for the job.
 
|---- bgcolor=#EDEDFF
 
|---- bgcolor=#EDEDFF
 
|Events
 
|Events
 
|[[JobEventBean]] array
 
|[[JobEventBean]] array
 +
|N/A
 +
|No
 
|A list of all the events (state changes) that have occured on this job.
 
|A list of all the events (state changes) that have occured on this job.
 
|---- bgcolor=#EDEDFF
 
|---- bgcolor=#EDEDFF
 
|ExternalAlternateRef
 
|ExternalAlternateRef
 
|[[ExternalRefBean]]
 
|[[ExternalRefBean]]
 +
|N/A
 +
|No
 
|A secondary external reference for the job, where there is a need to store a third primary key for a job.
 
|A secondary external reference for the job, where there is a need to store a third primary key for a job.
 
|---- bgcolor=#EDEDFF
 
|---- bgcolor=#EDEDFF
 
|FieldDevicePK
 
|FieldDevicePK
 
|String
 
|String
 +
|9
 +
|No
 
|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.
 
|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.
 
|---- bgcolor=#EDEDFF
 
|---- bgcolor=#EDEDFF
 
|InvoiceItems
 
|InvoiceItems
 
|[[InvoiceItemBean]] array
 
|[[InvoiceItemBean]] array
 +
|N/A
 +
|No
 
|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.
 
|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.
 
|---- bgcolor=#EDEDFF
 
|---- bgcolor=#EDEDFF
 
|JobType
 
|JobType
 
|String
 
|String
 +
|50
 +
|Yes
 
|The type of job this job is, one of a list created for each organisation during initial setup.
 
|The type of job this job is, one of a list created for each organisation during initial setup.
 
|---- bgcolor=#EDEDFF
 
|---- bgcolor=#EDEDFF
 
|Notes
 
|Notes
 
|[[NoteBean]] array
 
|[[NoteBean]] array
 +
|N/A
 +
|No
 
|A list of the notes created either by the depatcher or the field device worker.
 
|A list of the notes created either by the depatcher or the field device worker.
 
|---- bgcolor=#EDEDFF
 
|---- bgcolor=#EDEDFF
 
|Priority
 
|Priority
 
|int
 
|int
 +
|2
 +
|No
 
|The priority of the job, on whatever scale the organisation is using.
 
|The priority of the job, on whatever scale the organisation is using.
 
|---- bgcolor=#EDEDFF
 
|---- bgcolor=#EDEDFF
 
|ProposedCost
 
|ProposedCost
 
|BigDecimal
 
|BigDecimal
 +
|9
 +
|No
 
|An accurate decimal storage of the expected cost to perform and complete the job.
 
|An accurate decimal storage of the expected cost to perform and complete the job.
 
|---- bgcolor=#EDEDFF
 
|---- bgcolor=#EDEDFF
 
|Signature
 
|Signature
 
|byte array
 
|byte array
 +
|~3000
 +
|No
 
|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.
 
|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.
 
|---- bgcolor=#EDEDFF
 
|---- bgcolor=#EDEDFF
 
|Status
 
|Status
 
|[[JobStatus]]
 
|[[JobStatus]]
 +
|N/A
 +
|No
 
|An enumerated list of possible states for the job, excluding [[CancelState]].
 
|An enumerated list of possible states for the job, excluding [[CancelState]].
 
|---- bgcolor=#EDEDFF
 
|---- bgcolor=#EDEDFF
 
|WhenCommitmentStart
 
|WhenCommitmentStart
 
|Calendar
 
|Calendar
 +
|N/A
 +
|Yes
 
|The date and time the job is scheduled to start.
 
|The date and time the job is scheduled to start.
 
|---- bgcolor=#EDEDFF
 
|---- bgcolor=#EDEDFF
 
|WhenCommitmentEnd
 
|WhenCommitmentEnd
 
|Calendar
 
|Calendar
 +
|N/A
 +
|Yes
 
|The date and time the job is scheduled to end.
 
|The date and time the job is scheduled to end.
 
|---- bgcolor=#EDEDFF
 
|---- bgcolor=#EDEDFF
 
|AfterHoursApproved
 
|AfterHoursApproved
 
|boolean
 
|boolean
 +
|1
 +
|No
 
|Indicates whether this job is after hours approved.
 
|Indicates whether this job is after hours approved.
 
|---- bgcolor=#EDEDFF
 
|---- bgcolor=#EDEDFF
 
|DeadInField
 
|DeadInField
 
|boolean
 
|boolean
 +
|1
 +
|No
 
|Indicates the job is dead in the field (not received by the field worker within the specified timeout limit).
 
|Indicates the job is dead in the field (not received by the field worker within the specified timeout limit).
 
|---- bgcolor=#EDEDFF
 
|---- bgcolor=#EDEDFF
 
|RecallPending
 
|RecallPending
 
|boolean
 
|boolean
 +
|1
 +
|No
 
|Indicates the job is about to be recalled, and is awaiting confirmation from the field worker.
 
|Indicates the job is about to be recalled, and is awaiting confirmation from the field worker.
 
|---- bgcolor=#EDEDFF
 
|---- bgcolor=#EDEDFF
 
|UpdatePending
 
|UpdatePending
 
|boolean
 
|boolean
 +
|1
 +
|No
 
|Indicates there is an update to be sent to the field worker.
 
|Indicates there is an update to be sent to the field worker.
 
|}
 
|}

Revision as of 02:16, 18 August 2005

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 Size Required Description
Attributes AttributeBean array N/A No A list of name and value pairs, indicating custom attribute values associated with this job.
CancelState CancelState N/A No A set of possible cancel states the job may be in.
CustomerPK String 9 Yes The EService primary key of the customer associated with this job.
CustomerRef String 20 No A custom reference to the customer.
DialableAttribute AttributeBean N/A No A single, dialable attribute. Usually appears on the field device as contact phone number for the job.
Events JobEventBean array N/A No A list of all the events (state changes) that have occured on this job.
ExternalAlternateRef ExternalRefBean N/A No A secondary external reference for the job, where there is a need to store a third primary key for a job.
FieldDevicePK String 9 No 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 N/A No 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 50 Yes The type of job this job is, one of a list created for each organisation during initial setup.
Notes NoteBean array N/A No A list of the notes created either by the depatcher or the field device worker.
Priority int 2 No The priority of the job, on whatever scale the organisation is using.
ProposedCost BigDecimal 9 No An accurate decimal storage of the expected cost to perform and complete the job.
Signature byte array ~3000 No 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 N/A No An enumerated list of possible states for the job, excluding CancelState.
WhenCommitmentStart Calendar N/A Yes The date and time the job is scheduled to start.
WhenCommitmentEnd Calendar N/A Yes The date and time the job is scheduled to end.
AfterHoursApproved boolean 1 No Indicates whether this job is after hours approved.
DeadInField boolean 1 No Indicates the job is dead in the field (not received by the field worker within the specified timeout limit).
RecallPending boolean 1 No Indicates the job is about to be recalled, and is awaiting confirmation from the field worker.
UpdatePending boolean 1 No Indicates there is an update to be sent to the field worker.
Retrieved from "http://www.econz.org/index.php?title=JobBean&oldid=1063"
MediaWiki Appliance - Powered by TurnKey Linux