Versions Compared

Version Old Version 9 New Version 10
Changes made by

Andrew Hill (Deactivated)

Andrew Hill (Deactivated)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space SCHUD and version 9.3
EmpUpdateRequest will allow
Panel

The sp:EmpUpdateRequest API method can be used to update the attributes of an employee.

Panel

On This Page:

Panel

Related Pages:

 

Description

The sp:EmpUpdateRequest API method allows any or all of the attributes of an employee to be updated.

 

Some of the fields (

RangeLKs, RegionLKs and

RangeLKs, RegionLKs and PubHols) can only be replaced, not updated, i.e some

Options are

options are mandatory if the corresponding field is supplied (see

later

below).

The sp:EmpUpdateRequest API method works in real time, but there are some extra details of interest:

Note 1:  Because
Note

As some changes can move

Operative Day Boundaries

operative day boundaries (ODBs), there are occasions when jobs would end up spanning ODBs.

  Where

 Where this happens (the most likely case is after changes to shift assignments) those

jobs

jobs will be de-allocated.

Note 2:  After each EmpUpdateRequest
Note

After each sp:EmpUpdateRequest API call, the

Operative’s

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

 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

remove overlaps was switched off, the shuffling operation after

an

an sp:EmpUpdateRequest API call may shuffle it to close up a gap in the schedule.

Note
Note 3: 

If an employee with a

Van Spares

van spares allocation is posted to a different or new FRU, the

Van Spares allocation

van spares allocation does not

take

 take effect in real time.

  Jobs requiring Van Spares

 Jobs requiring van spares will not be booked to this employee until the FRU is restarted.

  The EmpUpdateRequest call

 The sp:EmpUpdateRequest call will succeed but will return SP_OK_VAN_SPARES_NOT_UPDATED (646).

Note 4: 
Note

It is not necessary for the FRU(s) involved in the update to be

Active

active (i.e. running).

 

However, if an FRU is not

Active

active then

some

some sp:EmpUpdateRequest API functionality is unavailable:

  • schedule checks cannot be made in an FRU that is not
Active
  • active (for example, SP_POSTING_WOULD_DEALLOC (247) will not be returned); and
  • schedule operations cannot be made in an FRU that is not
Active
  • 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

Panel

On This Page:

Panel

Related Pages:

 
  • note above).

Definition

The definition of this API is:

Include Page
_API EmpUpdateRequest Definition
_API EmpUpdateRequest Definition

Return Structure

The API returns the standard return structure.

Return Codes

In addition to the Standard Return Codes, the possible Return Codes from this API are:

Include Page
_API EmpUpdateRequest Return Codes
_API EmpUpdateRequest Return Codes