Dispatching

DispOutput is the main Web Service for the Dispatch Client. This web service is responsible for pushing out the messages to the customer's endpoint which should be created, by consuming the dispatchClient.wsdl.

Definition

Web Service

<ns2:DispOutputRequest>
<jobInfo>
<loginRequest>
<databaseUser>?</databaseUser>
<password>?</password>
<spUser>?</spUser>
</loginRequest>

<jobID>?</jobID>
<earmarkType>?</earmarkType>
<reEarmark>?</reEarmark>
<dateEarmarked>?</dateEarmarked>
<empID>?</empID>
<ETS>?</ETS>
<ETA>?</ETA>
<ETF>?</ETF>
<jobCountTentative>?</jobCountTentative>
<totalBreakTime>?</totalBreakTime>

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

<bookLoc>?</bookLoc>
<bookLocName>?</bookLocName>
<postcode>?</postcode>
<teamID>?</teamID>
<IRUID>?</IRUID>
</jobInfo>
</ns2:DispOutputRequest>

<ns2:DispOutputResponse>
<resultCode>?</resultCode>
</ns2:DispOutputResponse>

Description

WebService Name	Type	Req?	Description
DatabaseUser	string	Y	For an Oracle database use the Schema name, for a SQL Server database the username will actually be the database name.
password	string	Y	Password for the ServiceOptimizer user below
spUser	string	Y	Valid ServiceOptimizer user
jobID	SP_JobID		ID of earmarked job or standard activity. If a break is being dispatched without a job or SA this value is set to -1
earmarkType	SP_EarmarkType		Indicates whether this request is an earmark, an unearmark or a re-earmark and whether the item is a job, standard activity, or standalone break. If an UnEarmark, only the following fields have valid values: JobID, ReEarmark (SP_False), DateTime, EmpID, JobCountTentative, BookLoc, BookLocName, and Postcode.
dateEarmarked	SP_DateTime		Time the work item was earmarked
empID	SP_empID		Employee it was earmarked to
ETS	SP_DateTime		Time employee should start. This field is not used for standalone break dispatching
ETA	SP_DateTime		Time employee should arrive. This field is not used for standalone break dispatching
ETF	SP_DateTime		Time employee should finish. This field is not used for standalone break dispatching
jobCountTentative	int		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 SPDS_Tentative or is SPDS_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 the value SP_JobCountTentativeNull. This field is not used for either standard activity or standalone break dispatching
totalBreakTime
BreakName	SP_BreakName		Name of the break
BreakType	SP_BreakType		Type of break. If a BreakType = SPEBT_Default the break is one as defined in the base shift definition. If the BreakType = SPEBT_Overridden the break has been overridden by a shift override. If the BreakType = SPEBT_Fixed the break has been fixed in place via either the Gantt or the SP_EmpSetActualBreakTimes() API.
BreakStart	SP_DateTime		The start time of the break
BreakDuration	Unsigned int		The amount of time allowed in the schedule for this break
bookLoc	SP_BookLoc		Booking location ID. It has the value supplied when the job was booked using SP_BookAppt() (see[1]) or SP_BookJob() (see[1]). This field is not used for standalone break dispatching
bookLocName	SP_BookLocName		Any info associated, e.g. IP add/port, Q name. This field is not used for standalone break dispatching
postcode	SP_Postcode		Job or standard activity Location. This field is not used for standalone break dispatching
teamID	SP_TeamID		Team that EmpID is posted to
IRUID	SP_RUID		IRU that Team is in

Browser not supported