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.
It is possible to capture, and store, external data against an Operative so that this data can then be managed using ServiceManager as a single point of update, if so desired. Data types are presented as ‘external data objects’ providing a grouping of ‘external data attributes’.
Each data object defines:
- An identifier
- A display name
- The FRU(s) where this object may be populated
Each data attribute defines:
- an identifier (note that this must be unique across the system, and not just unique to the object it belongs to)
- a display name
- a display sequence (to order the list in the operative screens)
- the object it belongs to
- a value type (integer, float, string, Boolean)
- an optional mapping to a defined ServiceOptimizer operative attribute (one of the SPESDT values, see below)
- an optional default value
- a numeric minimum value (for integer/float types)
- a numeric maximum value (for integer/float types)
- a maximum number of decimal places (for float types)
- a maximum number of characters (for string types)
- the string value for true (for Boolean types) e.g. ‘On’, ‘Yes’, ‘True’
- a string value for false (for Boolean types) e.g. ‘Off’, ‘No’, ‘False’
- whether the data type is mandatory or optional
The available mappings to defined ServiceOptimizer attributes are as follows:
SPESDT value | ServiceOptimizer attribute used | Type |
SPESDT_Specified | Use <value> | Free text, whatever was input over the interface |
SPESDT_EmpID | Use EmployeeRef | 25 character string- alphanumeric unique identifier |
SPESDT_Name | Use Name | 50 character string- this is full name i.e. first name and surname together, separated by spaces |
SPESDT_Surname | Use Surname | 50 character string |
SPESDT_HomePostcode | Use HomePostcode | 30 character string- in theUSthis is typically either a 5 digit zip or the zip+4 |
SPESDT_WorkPostcode | Use WorkPostcode | 30 character string- in theUSthis is typically either a 5 digit zip or the zip+4 |
SPESDT_Address1 | Use Address1 | 50 character string – alphanumeric including spaces and other characters |
SPESDT_Address2 | Use Address2 | 50 character string – alphanumeric including spaces and other characters |
SPESDT_Address3 | Use Address3 | 50 character string – alphanumeric including spaces and other characters |
SPESDT_Address4 | Use Address4 | 50 character string – alphanumeric including spaces and other characters |
SPESDT_Phone1 | Use Phone1 | 40 character string |
SPESDT_Phone2 | Use Phone2 | 40 character string |
SPESDT_Pager | Use Pager | 20 character string |
SPESDT_WorkTZ | Use WorkTZ | 50 character string - the format for this is a full TZ value e.g. AST-10ADT,M10.5.0,M3.5.0 |
SPESDT_Team | Use Team | 40 character string |
SPESDT_FRU | Use FRU | 8 character string |
SPESDT_Depot | Use Depot | 20 character string |
These external data objects and attributes can be updated via ServiceManager, or via the EmpCreate/EmpUpdate interfaces (see 15.1and 15.2) above.
External data that has been created, updated or removed for an operative can then be retrieved by using the GetChangedEmpRequest interface.
Definition
The definition of this API is:
| Include Page | ||||
|---|---|---|---|---|
|
Return Structure
The API returns a non-standard return structure.
| Include Page | ||||
|---|---|---|---|---|
|
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 | ||||
|---|---|---|---|---|
|