/
jobInfo
Document toolboxDocument toolbox

jobInfo

Owned by Mickey Bushman
Last updated: Oct 02, 2023 by Jason AndrewVersion comment
jobInfo 
<jobInfo>
	<reEarmark>?</reEarmark>
	<jobID>?</jobID>
	<earmarkType>?</earmarkType>
	<dateEarmarked>?</dateEarmarked>
	<empID>?</empID>
	<ETS>?</ETS>
	<ETA>?</ETA>
	<ETF>?</ETF>
	<totalBreakTime>?</totalBreakTime>
	<breaks>?</breaks>
	<jobCountTentative>?</jobCountTentative>
	<bookLoc>?</bookLoc>
	<bookLocName>?</bookLocName>
	<postcode>?</postcode>
	<teamID>?</teamID>
	<IRUID>?</IRUID>
</jobInfo>
 
JobInfo Definition
FieldTypeDescriptionRequiredValidated
JobIDJobIDID of earmarked job or standard activity.  If a break is being dispatched this value is set to -1(tick) 
earmarkType

 dispEarmarkTypes

Earmark

A job or standalone break that has been earmarked

Unearmark

A job or standalone break has been unearmarked

ReEarmark

A job or standalone break has been reearmarked

SA-Earmark

A standard activity has been earmarked

SA-UnEarmark

A standard activity has been unearmarked

SA-ReEarmark

A standard activity has been re-earmarked


on return, indicates whether this request is an earmark, an unearmark or a re-earmark and whether the item is a job, break (JobID needs to be considered to determine which) OR a standard activity.

If an UnEarmark, only the following fields have valid values: JobID (and BreakName if a break), ReEarmark (SP_False), DateTime, EmpID, JobCountTentative, BookLoc, BookLocName, and Postcode.

  
reEarmark
 boolean

false or 0

False

true or 1

True

Indicates that this item’s ETA has changed, but not its EmpID  
dateEarmarkedspDateTimeTime the work item was earmarked  
empIDEmpIDEmployee it was earmarked to  
ETSspDateTime Time employee should start.  This field is not used for break dispatching  
ETAspDateTime Time employee should arrive.  This field is not used for break dispatching  
ETFspDateTime Time employee should finish.  This field is not used for break dispatching  
jobCountTentativeint

Number of jobs tentatively allocated to this EmpID.  JobCountTentative is a count of jobs that have been allocated to this employee (EmpID), but which he doesn’t yet know about.  Its value depends on the value of the database parameter disp_job_count_tentative_days.  If disp_job_count_tentative_days not present or has the value 0, JobCountTentative is the number of jobs, not including this one being earmarked, that are currently allocated to this EmpID, while he’s posted to the FRU containing this job, between now and the end of the Reactive Working Period (TWP – measured over operative days), whose status is Tentative or is Earmarked but which hasn’t yet been successfully dispatched.  If disp_job_count_tentative_days is non-zero, JobCountTentative only returns the number of jobs for that number of days instead of for the Reactive Working Period.  For example, if disp_job_count_tentative_days is 1, JobCountTentative returns the number of remaining jobs for today.   JobCountTentative is only returned when dispatch is being done in real time mode. If it’s running in batch mode, then JobCountTentative is set to -1

This field is not used for either standard activity or break dispatching, and both these types of work item are excluded from the count.

  
totalBreakTimeunsigned intsum of all durations of included breaks if breaks have been scheduled to be included within the job  
breaks 

only populated if this is a break that is being dispatched. There will only ever be 1 as breaks are dispatched separately.

<breaks>?</breaks> 
<breaks>
	<BreakName>?</BreakName>
	<BreakType>?</BreakType>
	<BreakStart>?</BreakStart>
	<BreakDuration>?</BreakDuration>
</breaks>

break Detail
FieldTypeDescriptionRequiredValidated
BreakNameBreakName (tick)(tick)
BreakType
 breakType

Default

The break is from the defined shift Break specification

Overridden

The break has been overridden by a user

Fixed

The break has been taken so times are actual break times

 (tick)(tick)
BreakStartspDateTimeBreakStart should be set as the date and time the break has/will be taken.(tick)(tick)
BreakDurationint (tick) 

  
bookLocBookLocIDBooking location ID.  It has the value supplied when the job was booked using ApptBookRequest(see 6.3) or JobBookRequest (see 6.6).  This field is not used for stand alone break dispatching  
bookLocNameBookLocNameAny info associated, e.g. IP add/port, Q name.  This field is not used for break dispatching  
postcodePostcodeJob or standard activity Location.  This field is not used for break dispatching  
teamIDTeamIDTeam that EmpID is posted to  
IRUIDRUIDIRU that Team is in