Versions Compared
Version | Old Version 4 | New Version 5 |
---|---|---|
Changes made by | ||
Saved on |
Key
- This line was added.
- This line was removed.
- Formatting was changed.
EmpUpdateRequest will allow any or all of the attributes of an employee to be updated. Some of the fields (RangeLKs, RegionLKs and PubHols) can only be replaced, not updated, i.e some Options are mandatory if the corresponding field is supplied (see later).
EmpUpdateRequest works in real time, but there are some extra details of interest:
Note 1: Because some changes can move Operative Day Boundaries (ODBs), there are occasions when jobs would end up spanning ODBs. Where this happens (the most likely case is after changes to shift assignments) those jobs will be de-allocated.
Note 2: After each EmpUpdateRequest call, the Operative’s jobs are always shuffled. This will have most effect after changes to shift assignments, start & end locations, travel in own time, and efficiency. However, jobs may be shuffled in all other cases because of pre-existing conditions. For example, if a job has been moved (but not fixed) on the Gantt and Remove Overlaps was switched off, the shuffling operation after an EmpUpdateRequest call may shuffle it to close up a gap in the schedule.
Note 3: If an employee with a Van Spares allocation is posted to a different or new FRU, the Van Spares allocation does not take effect in real time. Jobs requiring Van Spares will not be booked to this employee until the FRU is restarted. The EmpUpdateRequest call will succeed but will return SP_OK_VAN_SPARES_NOT_UPDATED (646).
Note 4: It is not necessary for the FRU(s) involved in the update to be Active (i.e. running). However, if an FRU is not Active then some EmpUpdateRequest functionality is unavailable:
- schedule checks cannot be made in an FRU that is not Active (for example, SP_POSTING_WOULD_DEALLOC (247) will not be returned)
- schedule operations cannot be made in an FRU that is not Active (for example, the schedule will not be relaid out to accommodate a shift assignment change – see Note 2 above).
#define SP_OptUpdateAllowAdd 0x1
#define SP_OptEmpPostingDeallocJobs 0x2
#define SP_OptEmpShiftAssDeallocJobs 0x4
#define SP_OptEmpShiftAssSet 0x10
#define SP_OptEmpPostingSet 0x20
#define SP_OptEmpSkillSet 0x40
#define SP_OptEmpPubHolSetSet 0x800
#define SP_OptEmpRangeLKSet 0x80
#define SP_OptEmpRegionLKSet 0x100
#define SP_OptEmpPattRangeLKSet 0x200
#define SP_OptEmpPattRegionLKSet 0x400
#define SP_OptEmpPattSet 0x1000
Definition
The definition of this API is:
Include Page | ||||
---|---|---|---|---|
|
Return Structure
The API returns the standard return structure.
Return Codes
In addition to the Integration ServiceOptimizer Common Standard Return Codes, the possible Integration ServiceOptimizer Common Return Codes from this API are:
Include Page | ||||
---|---|---|---|---|
|