| Panel | |
|---|---|
On This Page:
Related Pages: |
...
These external data objects and attributes can be updated via ServiceManager, or via the Create Operative SOAP API and the Update Operative SOAP API.
...
Return Codes
In addition to the Standard Return Codes, the possible Return Codes from this API are:
| Include Page | ||||
|---|---|---|---|---|
|
Description
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
SPESDTvalues, 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:
| ServiceOptimizer Attribute Used | Type |
| Use | Free text, whatever was input over the interface |
| Use | 25 character string- alphanumeric unique identifier |
| Use | 50 character string- this is full name i.e. first name and surname together, separated by spaces |
| Use | 50 character string |
| Use | 30 character string- in the US this is typically either a 5 digit zip or the zip+4 |
| Use | 30 character string- in the US this is typically either a 5 digit zip or the zip+4 |
| Use | 50 character string – alphanumeric including spaces and other characters |
| Use | 50 character string – alphanumeric including spaces and other characters |
| Use | 50 character string – alphanumeric including spaces and other characters |
| Use | 50 character string – alphanumeric including spaces and other characters |
| Use | 40 character string |
| Use | 40 character string |
| Use | 20 character string |
| Use | 50 character string - the format for this is a full TZ value e.g. AST-10ADT,M10.5.0,M3.5.0 |
| Use | 40 character string |
| Use | 8 character string |
| Use | 20 character string |
These external data objects and attributes can be updated via ServiceManager, or via the Create Operative SOAP API and the Update Operative SOAP API.
External data that has been created, updated or removed for an operative can then be retrieved by using the sp: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 Standard Return Codes, the possible Return Codes from this API are:
| Include Page | ||||
|---|---|---|---|---|
|