Contract Lines

omd.domain.s5.ContractLine

Attribute	Description
id*	The identifier of the contract line. Make sure that the identifier is unique within the entire configuration.
line*	The line indicator, i.e. the position of the line within the contract.
contract*	The reference to the contract.
serviceObject	A reference to the service object related to this contract line.
contractType	A reference to the type of this contract line.
requiredResource	This value indicates the id of the resource that must perform the task. The required resource is a hard restriction and results in an exception if the user tries to assign it to another resource.
preferredResource	This value indicates the name of the resource that should normally perform the task. Depending on the requirement of the organization, The Scheduler may disregard the preferred resource and assign the task to another resource if the costs are lower. See the Preferences section of the Technical Reference Guide for further details on how to define the preferred behaviour. Note that the mismatch of the assigned and preferred resource can result in additional costs. Therefore, assignment to another resource must be justified by a lower overall cost.
backupResource	If specified, the Scheduler regards this resource as a second option. If the assignment to the backup engineer is cheaper, the Scheduler will assign the task to the backup.
skill	This value indicates the skill that is required to perform this task. The Scheduler will only consider resources that have this skill. The value * means that every resource is capable of performing this task. If the implementation of the Scheduler requires to handle more than one skill for each task, this field can be used to express a constraint as a logical expression. Logical expressions can contain logical and (&&), logical or (||) and logical negation (!) predicates as well as parentheses for cascaded logical expressions.
estimatedDuration*	The estimated duration is defined in minutes. The value is used during the planning process to build a realistic planning for the resource performing the task. The estimatedDuration should not exceed 480 minutes, except when Task Splitting is used.
remarks	Informational remarks that are associated with this task.
weight	The weight of the item(s) being delivered.
volume	The volume of the item(s) being delivered.
requiresParts	This flag, consisting of a true or false value, indicates whether the task requires spare parts or not.
planAutomatically	if this field contains a "true" value, the task should be planned automatically by the Scheduler. If no value is specified, the task must be planned by the planner or by a batch run.
minimumResources	The task may have to be executed by a number of resources, depending on requirements. The minimum number of resources must be greater or equal to 1 and defaults to 1.
maximumResources	The task may have to be executed by a number of resources, depending on requirements. The minimum number of resources must be greater or equal to 1 and defaults to 1.
acceptBeyondLatest	This flag indicates if planning algorithms should evaluate insertion points after the latest datetime. If true, algorithms will use the standard preference AcceptBeyondLatestDay to determine if planning after latest is acceptable. If false, any planning algorithm must accept the latest datetime. In this case, the standard preference is overruled. Default is true.
taskType	This information is used to distinguish tasks. For example, a resource might have to deliver products or perform maintenance. Both activities can be distinguished by providing a different type. Note that this information is irrelevant to the planning engine. If the type of task puts a limitation on the resource candidates, use the skill attribute instead.
floating	A task is floating if it can be performed anywhere in the field. During calculations, the address of a floating task is determined by the address of the predecessor.
extra	Extra fields contain customer-specific information. Customer-specific information can be used during reports and other parts of the life-cycle of a task, but do not contain planning-relevant information. All values must be stored as attributes in an XML element called Data, for example:
subGroup	Indicates the sub-division of a group, i.e. tasks belonging to subGroups need to be performed by distinct resources. This is frequently the case when two or more resources have to be on-site at the same location to perform work together.
taskGroupId	In some planning environments, it is necessary to bundle tasks into one sequential block. Rather than defining a series of task dependencies, these tasks can be identified by a unique task group id. The planning engine will attempt to plan these tasks into a single trip, if possible.
resourcesRequired	The number of resources that are required for this task. In most cases, this number will be used to split the task into several tasks per resource, keeping a total equal to the original estimated duration. These tasks are then intended to be performed in parallel.
amount	Specifies the number of items that are to be processed. If not specified, a default value of 1 is used. If the task is related to several machines or items to be processed, this column may specify the exact amount of items. The number of items may be considered during reports.
imageURL	The location from where the icon for this task can be downloaded.
frequency	The yearly frequency with which visits are to be planned. A frequency of 1 indicates a visit once per year, a frequency of 52 indicates a visit every week. A frequency of 0 indicates that no visits should be generated, i.e. the contract line is currently inactive.
initialStatus	The code of the initial status for a task which is generated for this contract line.
timeFrame	Used to determine the amount of days around the calculated next plan date. These boundaries are stored within the earliest/latest fields of the next task.
lastVisit	The date when the last visit was performed.