Resources
A resource is a task-performing entity. Examples are technicians, sales staff, drivers, teachers, vehicles, rooms.
omd.domain.s4.Resource
| Attribute | Description |
|---|---|
| id* | The key of the resource, identifying the resource throughout the configuration. |
| territory* | The specification of the territory can be abandoned in an XML upload since the parent node already represents the territory. |
| version | The version of the object. Versions change with every update of the database record. Read chapter Version Control for details. |
| name* | The (short) name of the resource. |
| fullName* | The full name of the resource. |
| postalCode* | The postal code of the departure address of the resource. In case the resources depart from a depot, this is the depot address. If the resources depart from their home addresses, this is the home address. The postal code is used to geocode the task, i.e. to find the (x,y) coordinates for the location. |
| street | The street of the departure address of the resource. In case the resources depart from a depot, this is the depot address. If the resources depart from their home addresses, this is the home address. |
| city | The city of the departure address of the resource. In case the resources depart from a depot, this is the depot address. If the resources depart from their home addresses, this is the home address. |
| country | The country identifier of the departure address of the resource. In case the resources depart from a depot, this is the depot address. If the resources depart from their home addresses, this is the home address. This information is used whenever organizations have resources/teams that cross country borders. Otherwise, the street, postal code and city name are sufficient to identify the location. Country codes are usually an abbreviation of the country name, i.e: BE for Belgium, NL for the Netherlands or DE for Germany. Please refer to the documentation of the Time Distance Module (TDM) for a complete list of supported country codes. |
| phoneNr | The general phone number of the resource. This is usually his mobile phone number, where he is joinable during his working hours. |
| sortValue | A sort value, indicating the default order in which the resource should be displayed in the application. |
| geocode | The geocode is a (x,y) coordinate for a location. Usually, the geocode is determined by the Scheduler and does not have be provided by the interface. Delivering the coordinate with the resource may result in small perfomance gains due to less geocode processsing. |
| maximumWeight | The maximum weight a resource can carry per trip. |
| maximumVolume | The maximum volume a resource can carry per trip. |
| holidayCalendarId | The calendar that specifies the public holidays for this resource. |
| zeroDistanceForDeparture | This flag indicates that the distance to the first stop must be 0. In this case, it is assumed that the resource's trip always starts at the first stop, regardless of the home/depot address. This is particularly useful with employees or third-party contracts with according working hour arrangements. Use the general preference zeroDistanceForDeparture if all territories use the same settings. If specified, the value overrules the zeroDistanceForDeparture preference settings. |
| zeroDistanceForArrival | This flag indicates that the distance from the last stop back to the home/depot address must be 0. In this case, it is assumed that the resource's trip always ends at the last stop, regardless of the home/depot address. This is particularly useful for employee or third-party contracts with according working hour arrangements. Use the general preference zeroDistanceForArrival if all territories use the same settings. If specified, the value overrules the zeroDistanceForArrival preference settings. |
| startWithWorkingHours | This flag indicates that the resource will travel to the first stop in order to start according to the working hours. |
| province | The state or province identifier of the resource's address. States or provinces are not always used, but are frequently used in countries such as the United States. |
| maxWorkload | A maximum workload percentage that is specific to the resource. If not specified, the standard maxWorkload preference value is applicable. |
| This field contains the e-mail address of the resource. If this field is left empty, no e-mails can be sent to the resource. | |
| speedType | This attribute specifies the type of speed settings that are to be used for route calculations. Speed types are defined within the MapSettings.xml document of the map provider. If the speedType is not defined, the speed settings are taken from the standard preferences of the configuration. |
| imageURL | The location from where the icon for this resource can be downloaded. |
| passwd | The password with which the mobile worker will be authenticated when connecting through OMD Mobile. |
| inactive | Indicates if the resource is not active anymore. Deleting resources is usually not possible due to referential integrity. Hence, resources that must not be considered anymore for planning must be marked as inactive. |
| locale | The language settings of a resource can be used during processing of notes and other business-tier functionality. This code is two-parted and complies with ISO-639 and ISO-3166 respectively (e.g. “de_DE” for German/Germany or “de_AT” for German/Austria) |