Property | Type | Length | Description | Req? |
---|
type | string | SS: See Valid Values | Employee Type SS Field: empAttr.type SS Valid Values: "Employee", "Crew", "ContractCrew", "MAXPLUS1" |
|
name | string | SS: 50 | Operative first name SS Field: empAttr.name |
|
surname | string | SS: 50 | Operative last name SS Field: empAttr.surname |
|
jobTitle | string | SS: 24 | Operative job title SS Field: empAttr.jobTitle |
|
efficiency | integer |
| How efficient is the employee? Value is used as a multiplier on the job duration. More efficient engineers will take less time to do the job. Value must be between (inclusive) 10 and 999. Normal value is 100 SS Field: empAttr.efficiency | Yes |
homePostcode | string SS: Postcode (string) | SS: 30 SM: 10 | Home post code SS Field: empAttr.homePostcode |
|
workPostcode | string SS: OptPostcode | SS: 30 SM: 10 | Work post code SS Field: empAttr.workPostcode |
|
maxOvertime | unsigned integer |
| What is the maximum amount of planned overtime that can be used for this employee? Values must be between (inclusive) 0 and 999. SS Field: empAttr.maxOvertime | Yes |
informLeadTime | unsigned int |
| Normally the range of allowed values for InformLeadTime is held in the ServiceOptimizer database (i.e. between (inclusive) sp083.min_value and sp083.max_value where name = “TIL”). If either of these is not in the database, then the supplied value of InformLeadTime must be between 0 and 9999 respectively. If no informLeadTime is set for the employee then the FRU or system level ILT parameter will be used. SS Field: empAttr.informLeadTime | |
earmarkedJobsMax | unsigned int |
| The maximum number of jobs that can be earmarked at any one time for this employee. Must be between (inclusive) 1 and 99. If no value is set then the system/FRU levels are used. SS Field: empAttr.earmarkedJobsMax | |
TZType | string SS: EmpTZType (string) | SS: See Valid Values | Time Zone Type SS Field: empAttr.TZType SS Valid Values: "None", "Supplied", "Home", "Depot", "RU", "MAXPLUS1" | |
workTZ | string SS: EmpTZType (string) | SS: See Valid Values | WorkTZ is a TimeZone of the form ‘Mountain’, ‘Eastern’ ‘Greenwich’. The chosen value must exist in the ServiceOptimizer database. SS Field: empAttr.workTZ SS Valid Values: "None", "Supplied", "Home", "Depot", "RU", "MAXPLUS1" | |
available | Boolean |
| Should the employee be schedulable. SS Field: empAttr.available | |
defaultStartLoc | object |
| Default starting location for an operative for a day. Property | Type | Length | Description |
---|
locType | string SS: EmpLocType (string) | SS: | SS Field: empAttr.defaultStartLoc.locType SS Valid Values: "Home", "Work", "Depot", "Supplied", "None" | postCode | string SS: OptPostcode (string) | SS: 30 SM: 10 | SS Field: empAttr.defaultStartLoc.postCode |
|
|
defaultEndLoc | object |
| Default end location for an operative for a day. Property | Type | Length | Description |
---|
locType | string SS: EmpLocType (string) | SS: See Valid Values | SS Field: empAttr.defaultEndLoc.locType SS Valid Values: "Home", "Work", "Depot", "Supplied", "None" | postCode | string SS: OptPostcode (string) | SS: 30 SM: 10 | SS Field: empAttr.defaultEndLoc.postCode |
|
|
defaultLKCLoc | object |
| Default Local Knowledge Centre for an operative for a day Property | Type | Length | Description |
---|
locType | string SS: EmpLocType (string) | SS: See Valid Values | SS Field: empAttr.defaultLKCLoc.locType SS Valid Values: "Home", "Work", "Depot", "Supplied", "None" | postCode | string SS: OptPostcode (string) | SS: 30 SM: 10 | SS Field: empAttr.defaultKCLoc.postCode |
|
|
showOperativeStatus | Boolean |
| SS Field: empAttr.showOperativeStatus | |
showTravelStatus | Boolean |
| SS Field: empAttr.showTravelStatus | |
address1 | string SS: EmpAddress (string) | SS: 50 | SS Field: empAttr.address1 | |
address2 | string SS: EmpAddress (string) | SS: 50 | SS Field: empAttr.address2 | |
address3 | string SS: EmpAddress (string) | SS: 50 | SS Field: empAttr.address3 | |
address4 | string SS: EmpAddress (string) | SS: 50 | SS Field: empAttr.address4 | |
phone1 | string SS: PhoneNum (string) | SS: 40 | SS Field: empAttr.phone1 | |
phone2 | string SS: PhoneNum (string) | SS: 40 | SS Field: empAttr.phone2 | |
pager | string SS: PagerNum (string) | SS: 20 | SS Field: empAttr.pager | |
handHeldAdd1 | string SS: HandHeldAddress (string) | SS: 10 | SS Field: empAttr.handHeldAdd1 | |
handHeldAdd2 | string SS: HandHeldAddress (string) | SS: 10 | SS Field: empAttr.handHeldAdd2 | |
currentHandHeld | string SS: CurrentHandHeldNum (unsigned integer) |
| SS Field: empAttr.currentHandHeld | |
printer | string SS: EmpPrinterName | SS: 10 | SS Field: empAttr.printer | |
vehicleCapacity | unsigned integer |
| SS Field: empAttr.vehicleCapacity | |
TOTA | integer |
| must be between (inclusive) 0 and 1440 SS Field: empAttr.TOTA | |
TOTB | integer |
| must be between (inclusive) 0 and 1440 SS Field: empAttr.TOTB | |
freezeTheDayLeadTime | string SS: FreezeTheDayLeadTime (unsigned integer) |
| both FreezeTheDayLeadTime and FreezeTheDayTimeOfDay should be supplied or both should not be supplied. If only one is supplied, either SP_FDLT_NOT_SUPPLIED (586) or SP_FDT_NOT_SUPPLIED (587) will be returned. In a call of EmpUpdateRequest, both can be supplied or neither can be supplied. Also, only one of them can be supplied as long as the other is already set for this operative. SS Field: empAttr.freezeTheDayLeadTime | |
freezeTheDayTimeOfDay | string SS: spTime (string) | SS: 15 | SP_TIME_INVALID (29) (29) will be returned if the supplied FreezeTheDayTimeOfDay isn’t between 0000 and 2400. Example: "14:15" SS Field: empAttr.freezeTheDayTimeOfDay | |
customKWVs | object | 2 | The two Keywords that can be supplied in CustomKWVs are HourlyRate and OvertimeRate
Property | Type | Length | Description |
---|
keyword | string SS: CustomKeyword | SS: min 1, max 10 | SS Field: empAttr.customKWVs.keyword | value | string SS: CustomValue | SS: min 1, max 20 | SS Field: empAttr.customKWVs.value |
| |