Versions Compared

Key

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

...

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

...

On This Page:

Table of Contents

Related Pages:

...

Panel

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

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 PubHols) can only be replaced, not updated, i.e some options are mandatory if the corresponding field is supplied (see below).

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

Note

As 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

After each sp:EmpUpdateRequest API 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 sp:EmpUpdateRequest API call may shuffle it to close up a gap in the schedule.

Note

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 sp:EmpUpdateRequest call will succeed but will return SP_OK_VAN_SPARES_NOT_UPDATED (646).

Note

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 sp:EmpUpdateRequest API 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); and
  • 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 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