This page presents information about business objects and their properties, alphabetically from E to Z.

Engineer Object

An Engineer object represents a person who can perform tasks. In a generic sense, the object can also represent a set of people such as a contractor company or a maintenance department, or it might represent equipment such as a truck.

The term Engineer is used mainly in the Service Edge server and logic services. In the UI, the generic term Resource is used more often than Engineer. Engineer and Resource refer to exactly the same object; there is no difference between them except the terminology.

Web Services that Use the Object

ScheduleService

XML Representation

The syntax of an Engineer object is identical to that of a Resource object, except for the top-level element. For more information, see the Resource Object.

<Engineer>
  <Key>...</Key>
  <Revision>...</Revision>
  ...
</Engineer>

Properties

For an explanation of the properties, see the Resource Object.

SXP Identifier

By default, the identifier property of an engineer is the combination of the ID and District properties. In some older databases, the identifier is ID alone.

Group Object

A Group object represents a set of business objects, selected according to the group criterion. All the objects must be of the same type, for example, a group of tasks or a group of assignments.

For a discussion, see Groups.

Web Services that Use the Object

All web services

XML Representation

<Group>
  <Key>****</Key>
  <Revision>1</Revision>
  <Stamp>...</Stamp>
  <Name>MyTaskGroup</Name>
  <Body>...</Body>
  <GroupParameters>
    <GroupParameter>...</GroupParameter>
    ...
  </GroupParameters>
  <GroupType>2</GroupType>
  <ScriptProgID>W6PCustomVCLIb.W6POQLGroupEngine.1</ScriptProgID>
  <IsGroupUnique>true</IsGroupUnique>
  <Paging>...</Paging>
  <LastRefreshTime>...</LastRefreshTime>
</Group>

Properties

Key, Revision, Stamp

See Standard Properties of Business Objects.

Name

The name of the group.

Body

A string containing the OQL code defining the group criteria. The OQL group engine parses the Body and uses the information to select the group members.

GroupParameters

The values of parameter (%1, %2, etc.) that you can include in the OQL syntax of the Body property.

GroupType

The collection ID of the objects that belong to the group.

ScriptProgID

The ProgID of the OQL group engine. The default and only supported value is W6PCustomVCLIb.W6POQLGroupEngine.1.

IsGroupUnique

If the group criteria are defined by using an index, and a given set of index property values matches multiple objects, this property determines the group behavior:

If true, the group returns a single object, randomly selected among the matching objects.
If false, the group returns all the matching objects.

Under rare circumstances, a group may return objects with duplicate values of the index properties even if you specify IsGroupUnique = True. This occurs if you update the objects in the database, and you use the group to retrieve the same objects before you commit the current server transaction. To avoid this limitation, commit the transaction before using the group.

Paging

This property is for internal use only.

LastRefreshTime

The last time that a web operation used the group to request data.
Certain web operations, such as GetAlertsEx and GetNotificationsEx, use this property to request an incremental refresh. The first time you call the web operation, the server returns the complete set of objects in a specified group, together with the time at which the server retrieved the data. The next time you call the same web operation, assign the time value to the LastRefreshTime property of the group. The call then returns only the changes in the group members, instead of the complete data.

SXP Identifier

By default, the identifier property of a group is Name.

Resource Object

A Resource object is identical to an Engineer Object.

The term Resource is used to suggest a more generic interpretation than Engineer. For example, you can define a Resource that represents a contractor who employs multiple engineers. This is called a megaresource. The important characteristic of a megaresource is that it can provide more than one person-hour of work for each hour of clock time. To define a megaresource, you can use the AvailabilityFactor property, and/or the Contractor property and ContractorCapacity objects. For a discussion, see Configuring Contractors in ClickSchedule.

You can define a Resource object that represents a non-human resource, such as a truck. This usage is common in crew scheduling. For a discussion, see Configuring Crews in ClickSchedule.

Web Services that Use the Object

ServiceOptimizationService

XML Representation

<Resource>
  <Key>*******</Key>
  <Revision>15</Revision>
  <Stamp>...</Stamp>
  <Name>Russell Baker</Name>
  <ID>RB1-23-4567</ID>
  <Region>London</Region>
  <District>Paddington</District>
  <Postcode>W2 1AE</Postcode>
  <Calendar>5d X 8h (GMT)</Calendar>
  <EngineerType>Expert</EngineerType>
  <Tools/>
  <Active>true</Active>
  <Skills>
    <EngineerSkill>
      <Key>Upgrades</Key>
      <SkillLevel>1</SkillLevel>
      <Efficiency>0</Efficiency>
    </EngineerSkill>
    <EngineerSkill>
      <Key>Network</Key>
      <SkillLevel>1</SkillLevel>
      <Efficiency>0</Efficiency>
    </EngineerSkill>
    <EngineerSkill>
      <Key>Cabling</Key>
      <SkillLevel>1</SkillLevel>
      <Efficiency>0</Efficiency>
    </EngineerSkill>
  </Skills>
  <TravelSpeed>0</TravelSpeed>
  <Internal>true</Internal>
  <Efficiency>1</Efficiency>
  <MobileClient>false</MobileClient>
  <AvailabilityFactor>1.0</AvailabilityFactor>
  <Latitude>51516314</Latitude>
  <Longitude>-175275</Longitude>
  <GISDataSource>1</GISDataSource>
  <Street/>
  <City/>
  <State/>
  <CountryID>UK</CountryID>
  <Contractor>false</Contractor>
  <ContractorCompanyID/>
  <ContractorTimeResolution/>
  <DefaultCapacity_SO>
  <DefaultDailyCapacity/>
  <DefaultNumberOfTasks/>
  <FixedTravel/>
  <Company />
  <PeriodicEfficiencies />
  <HasDynamicData>false</HasDynamicData>
  <LocationID />
  <Crew>false</Crew>
  <MobileClientSettings />
  <TimePhasedSkills />
  <LastAllocationFinish>2009-03-01T22:00:00</LastAllocationFinish>
  <RelocationSource />
  <CrewForExternalUse>false</CrewForExternalUse>
</Resource>

Properties

The following list describes the commonly used resource properties. Certain additional properties are used only in special applications.

Key, Revision, Stamp

See Standard Properties of Business Objects.

Name

The name of the resource.

ID

A string identifier for the resource.

Continent, CountryID, Region, District

References to the Continent, CountryID, Region, and District dictionaries, indicating the territory to which the resource belongs.

Calendar

A reference to a Calendar object, indicating when the resource is available for work or the shifts that the resource performs.

EngineerType

A reference to the EngineerType dictionary, indicating a category of resources such as Installer or Technician.

Tools

A list of the equipment an engineer has available for use. The elements of the list are references to the Tool dictionary.

Active

If true, the resource is available for scheduling.

Skills

A list of the resource skills. Each element in the list contains a reference to the Skill dictionary, an integer numerical skill level on a user-defined scale, and the resource efficiency when using the skill.

TimePhasedSkills

This property lets you assign skills that vary with time. The property is useful, for example, for resource objects that represent crews. As resources enter or leave the crew, the skills of the crew may change. This can affect the tasks to which the crew can be assigned.

The property is a multivalue containing SkillPhase elements. Each element contains the following nested elements:

StartTime, FinishTime
PeriodicType: The only supported value is 0, meaning non-periodic.
Active: The only supported value is true.
PeriodicStart, PeriodicFinish: Not currently in use.
SkillKey: A reference to the Skill dictionary.
SkillLevel: An integer numerical skill level on a user-defined scale

TravelSpeed

This property is no longer in use. If the system uses street-level routing to estimate an engineer's travel time between two locations, the GIS provides the travel speed information. If the system uses aerial routing, the system uses a default travel speed that depends on the travel distance. For more information, see Geographic Services in ClickSchedule.

Internal

If true, the resource is an employee, as opposed to a contractor.

Efficiency

A measure of the engineer's relative working speed. A value of 1 means that the resource works at a typical or average speed. An efficiency > 1 means that the engineer works faster than average, and < 1 means that the engineer works slower than average.

An efficiency value must be > 0. A default value of 0 means "unassigned"; the system ignores the 0 value and assumes an efficiency of 1.

PeriodicEfficiencies

This property designates that an engineer has a time-phased efficiency. The efficiency value is interpreted in the same way as in the Efficiency property, but it can change over time. For example, an engineer who is a new employee or who returns to work after a long vacation can have low efficiency for a period of time.

Within the property, nest a list of PeriodicEfficiency elements, each containing StartTime, FinishTime, and Efficiency.

Run the following SXP to define periodic efficiency.

<SXPSettingUpdate>
<Setting>
<Owner>[Application]</Owner>
<Category>Optimization</Category>
<SubCategory>CalculationUtilitiesProgID</SubCategory>
<Body>W6ScheduleFrameworkUtility.W6TimePhasedEfficiency, W6SFUtil</Body>
</Setting>
</SXPSettingUpdate>

MobileClient

True if the resource uses ClickMobile. See Registering ClickMobile Touch Users and Enabling Saving Login Credentials.

MobileClientWebSettings

A reference to the resource's ClickMobile Touch user template. See Registering ClickMobile Touch Users and Enabling Saving Login Credentials.

Latitude, Longitude

Coordinates of the resource's home base (integers in millionths of a degree).

GISDataSource

The geographic dataset identifier that Service Edge uses to route the resource. The property is provided for historical reasons. In Service Edge, the value of GISDataSource for a geocoded object is nearly always 1.

Street, City, State, Postcode

Address of the resource's home base.

Contractor

True if the resource represents a contractor. For more information about this and the other contractor properties, see Configuring Contractors in ClickSchedule.

ContractorCompanyID

An identifier for a contractor company.

ContractorTimeResolution_SO

The length of the time interval to which ContractorCapacity objects apply. The supported values are Day, Week, and Month. For example, if the value is Week, then each ContractorCapacity reports the capacity of the contractor during a period of one week.

If the schedule policy contains a Gap rule, the capacity resolution unit must be longer or equal to the time resolution on the Periodic tab of the Gap rule. For example, if the Gap resolution is Week, the valid contractor time resolutions are Week and Month.

DefaultCapacity_SO

The default maximum working time of a contractor, in seconds, during the time interval that is defined in the ContractorTimeResolution_SO property.

DefaultDailyCapacity

This property is no longer in use. It is replaced by the DefaultCapacity_SO property. For more information about default capacities, see Configuring Contractors in ClickSchedule.

DefaultNumberOfTasks

The default maximum number of tasks that a contractor can perform, during the time interval that is defined in the ContractorTimeResolution_SO property.

FixedTravel

An average length of time (in seconds) that Service Edge should assume that an engineer travels for each task. This property is useful if the resource represents a contractor who employs many engineers, and you cannot estimate the actual travel time of each engineer. For more information, see Configuring Contractors in ClickSchedule.

AvailabilityFactor

A multiplier for the engineer capacity, that is, for the number of working hours during which an engineer can be assigned during a specified time interval.

The AvailabilityFactor is useful if the resource represents a contractor. For example, if a ContractorCapacity object defines a capacity of 1000 working hours per week, and AvailabilityFactor = 0.9, the actual time that the contractor is available for work is 900 hours.

The default value of this property is 0, which the system interprets as 1. In other words, a value of either 0 or 1 means that the full capacity can be assigned.

Company

This property is a reference to an item in the Company dictionary. The property identifies the company for whom the resource works.

The property is useful in contractor scheduling. For example, you might create several resource objects, each of which represents a geographic region of a contractor company. You can identify the objects as belonging to the same company by assigning the same Company value.

Crew

If true, the resource object represents a crew of resources or a relocated resource.

LastAllocationFinish

The finish time of the resources' last relocation. The system can use the property for purposes such as determining which relocated resources are no longer relevant and can be purged. An event updates this property when the resource is relocated.

RelocationSource

If the resource object represents a relocation, this property is a reference to the original, unrelocated resource.

CrewForExternalUser

If true, the resource represents a crew, as opposed to an individual resource or a relocated resource.

SXP Identifier

By default, the identifier property of a resource is the combination of the ID and District properties. In some older databases, the identifier is ID alone.

ServiceAlert Object

A ServiceAlert object is a notice that the system sends to users. It can contain an alert about a problem that exists in another type of business object.

For example, Service Edge might display alerts about tasks that have scheduling problems. The ClickMobile Touch client might display alerts about emergency tasks.

Web Services that Use the Object

ServiceOptimizationService

XML Representation

<ServiceAlert>
  <Key>...</Key>
  <Revision>...</Revision>
  <Stamp>...</Stamp>
  <UserNames>...</UserNames>
  <CustomDestination>...</CustomDestination>
  <GeographicDestinations>
    <GeographicDestination>
      <Region>...</Region>
      <District>...</District>
      <Team>...</Team>
    </GeographicDestination>
    ...
  </GeographicDestinations>
  <AlertSource>...</AlertSource>
  <RelatedTask>...</RelatedTask>
  <RelatedEngineer>...</RelatedEngineer>
  <RelatedAssignment>...</RelatedAssignment>
  <ServiceAlertStatus>...</ServiceAlertStatus>
  <ServiceAlertType>...<ServiceAlertType>
  <CreationTime>...</CreationTime>
  <ExpectedDueDate>...</ExpectedDueDate>
  <Importance>...</Importance>
  <Description>...</Description>
  <Latitude>...</Latitude>
  <Longitude>...</Longitude>
  <GISDataSource>...</GISDataSource>
  <CountryID>...</CountryID>
  <RelatedOperationalActivity>...</RelatedOperationalActivity>
  <RelatedRosterShift>...</RelatedRosterShift>
  <RelatedRosterDemand>...</RelatedRosterDemand>
  <SnoozeTime>...</SnoozeTime>
  <Region>...</Region>
  <District>...</District>
  <Team>...</Team>
  <RelatedVacationCalendar>...</RelatedVacationCalendar>
  <InnerType>...</InnerType>
  <MobileKey>...</MobileKey>
  <Urgency>...</Urgency>
  <ReferencedTask>...</ReferencedTask>
  <ReferencedAssignment>...</ReferencedAssignment>
  <Color>...</Color>
  <Priority>...</Priority>
  <Title>...</Title>
  <ImageName>...</ImageName>
  <ActionKey>...</ActionKey>
  <ActionMobileKey>...</ActionMobileKey>
  <ActionObjectType>...</ActionObjectType>
  <ActionScript>...</ActionScript>
  <ActionSettings>...</ActionSettings>
  <ActionType>...</ActionType>
  <ActionURL>...</ActionURL>
  <ActionViewName>...</ActionViewName>
  <EnableActionButton>...</EnableActionButton>
  <EnableDismissButton>...</EnableDismissButton>
  <EnableSnoozeButton>...</EnableSnoozeButton>
  <OpenUI>...</OpenUI>
  <ActionText>...</ActionText>
  <WidgetScript>...</WidgetScript>
  <WidgetSettings>...</WidgetSettings>
  <ButlerStatus>...</ButlerStatus>
</ServiceAlert>

Properties

Key, Revision, Stamp

See Standard Properties of Business Objects.

UserNames

An application-specific list of user names to whom the alert is relevant.

CustomDestination

An application-specific entity to which the alert is relevant.

GeographicDestinations

A list of navigation nodes to which the alert is relevant. Use this property if alerts are sometimes relevant to multiple nodes. If the alerts are relevant to a single node, you can improve performance by using the single-valued Region, District, and Team properties.

AlertSource

The name of an application or agent that generated the alert.

RelatedVacationCalendar, ReferencedTask, ReferencedAssignment

The key of an object to which the alert applies.
These properties have a data type of Key. Unlike most Key properties, they do not enforce referential integrity. It is possible to delete a Task, for example, without deleting a ServiceAlert that references the Task.

RelatedEngineer, RelatedOperationalActivity

The key of an object to which the alert applies.
These properties have a data type of Key. They enforce referential integrity.

RelatedAssignment, RelatedTask

The key of an object to which the alert applies.
These properties have a data type of Long rather than Key. They do not enforce referential integrity. The properties are supported for backward compatibility with existing applications. In new applications, use ReferencedTask and ReferencedAssignment, which have a Key data type.

ServiceAlertStatus

The alert status. The value is a reference to an item in the ServiceAlertStatus dictionary, such as Active or Acknowledged. See Dictionary Items.

Note

The out-of-the-box values of this dictionary should not be changed or deleted.

ServiceAlertType

The alert type. The value is a reference to an item in the ServiceAlertType dictionary. See Dictionary Items.

CreationTime

The date and time at which the alert was created.

ExpectedDueDate

The date and time by which the detected problem needs to be resolved, for example, the due date of a task.

Importance

The importance of the alert, on a user-defined numerical scale.

Description

A description of the alert.

Latitude, Longitude, GISDataSource, CountryID

The coordinates and geographic parameters to which the alert applies.

SnoozeTime

The earliest time at which to display the alert. To display the alert immediately, set the SnoozeTime to the alert creation time.

Region, District, Team

A navigation node to which the alert applies.

InnerType

The content type of the ServiceAlert object. The possible values are:

0 for most alerts

1 for an alert generated by the Send Butler Notification action, available in generic events and Proactive Business Monitoring.

MobileKey

An identifier that the ClickMobile client uses to identify new objects that are not yet stored in the database. For more information about this property, see Editing ClickMobile Touch Forms.

Urgency

The urgency of the alert, on a user-defined integer scale.

Color

The background color of the alert display. The value is a decimal or hexadecimal RGB color value, in one of the following formats:
rgb(16,119,193)
#1077c1
If you do not assign this property, the system displays a default color.

Priority

The priority of the alert, on a user-defined integer scale.

Title

A display title for the alert.

ImageName

An icon file that the alert displays.

The following ServiceAlert properties are not currently in use:

ActionData
ActionKey
ActionMobileKey
ActionObjectType
ActionScript
ActionSettings
ActionText
ActionType
ActionURL
ActionViewName
ButlerStatus
EnableActionButton
EnableDismissButton
EnableSnoozeButton
OpenUI
WidgetScript
WidgetSettings

SXP Identifier

By default, the identifier property of a ServiceAlert object is Key.

ServiceNotification Object

A ServiceNotification object is an information notice about another type of business object.

Service Edge can display notifications such as assignment updates and deletions.

Web Services that Use the Object

ServiceOptimizationService

XML Representation

<ServiceNotification>
  <Key>...</Key>
  <Revision>1</Revision>
  <Stamp>...</Stamp>
  <UserNames>...</UserNames>
  <CustomDestination>...</CustomDestination>
  <GeographicDestinations>
    <GeographicDestination>
      <Region>...</Region>
      <District>...</District>
    </GeographicDestination>
    ...
  </GeographicDestinations>
  <NotificationSource>...</NotificationSource>
  <RelatedTask>...</RelatedTask>
  <RelatedEngineer>...</RelatedEngineer>
  <RelatedAssignment>...</RelatedAssignment>
  <ServiceNotificationStatus>...</ServiceNotificationStatus>
  <ServiceNotificationType>...<ServiceNotificationType>
  <CreationTime>...</CreationTime>
  <ExpectedDueDate>...</ExpectedDueDate>
  <Importance>...</Importance>
  <Description>...</Description>
  <Latitude>...</Latitude>
  <Longitude>...</Longitude>
  <GISDataSource>...</GISDataSource>
  <CountryID>...</CountryID>
</ServiceNotification>

Properties

Key, Revision, Stamp

See Standard Properties of Business Objects.

UserNames

An application-specific list of user names to whom the notification is relevant.

CustomDestination

An application-specific entity to which the notification is relevant.

GeographicDestinations

A list of navigation nodes to which the notification is relevant.

NotificationSource

The name of an application or agent that generated the notification.

RelatedTask, RelatedEngineer, RelatedAssignment

References to objects to which the notification applies.

ServiceNotificationStatus

The notification status. The value is a reference to an item in the ServiceNotificationStatus dictionary, such as Active or Acknowledged. See Dictionary Items.

ServiceNotificationType

The notification type. The value is a reference to an item in the ServiceNotificationType dictionary. See Dictionary Items.

CreationTime

The date and time at which the notification was created.

ExpectedDueDate

The date and time by which an issue needs to be resolved, for example, the due date of a task.

Importance

The importance of a notification, on a user-defined numerical scale.

Description

A description of the notification.

Latitude, Longitude, GISDataSource, CountryID

The coordinates and geographic parameters to which the notification applies.

SXP Identifier

By default, the identifier property of a ServiceNotification object is Key.

Setting Object

A Setting object is a system configuration setting. Settings are typically, but not necessarily, displayed in the Service Edge administration interfaces.

Web Services that Use the Object

ServiceOptimizationService

XML Representation

<Setting>
  <Key>12345</Key>
  <Revision>1</Revision>
  <Stamp>...</Stamp>
  <Owner>[Application]</Owner>
  <Category>Logic Domains</Category>
  <SubCategory>MyLogicDomain</SubCategory>
  <Name />
  <Body>...</Body>
</Setting>

Properties

Key, Revision, Stamp

See Standard Properties of Business Objects.

Owner, Category, SubCategory, Name

Classifications or identifiers of the settings. Owner, Category, and SubCategory are mandatory. Name is optional.

Body

The setting value, typically a plain-text string or an XML string.

References

By default, the identifier of a setting is the combination of the Owner, Category, and SubCategory properties, plus the Name property if it is assigned. For more information about the reference syntax, see References to Business Objects.

Task Object

This object is a service task that an engineer must perform.

Web Services that Use the Object

ScheduleService

XML Representation

<Task>
  <Key>33558</Key>
  <Revision>12</Revision>
  <Stamp>...</Stamp>
  <CallID>WO42</CallID>
  <Number>1</Number>
  <EarlyStart>2009-03-15T09:00:00</EarlyStart>
  <DueDate>2009-03-15T18:00:00</DueDate>
  <LateStart>2009-03-15T14:00:00</LateStart>
  <Priority>1</Priority>
  <Status>Open</Status>
  <Customer>Customer A</Customer>
  <Calendar></Calendar>
  <Region>London</Region>
  <District>Paddington</District>
  <Postcode>W2 1AE</Postcode>
  <PreferredEngineers/>
  <ContractType/>
  <OpenDate>2009-03-14T11:23:08</OpenDate>
  <ContactDate>2009-03-14T09:00:00</ContactDate>
  <ConfirmationDate>2009-03-14T09:00:00</ConfirmationDate>
  <TaskType>Computer</TaskType>
  <Duration>5400</Duration>
  <RequiredEngineers/>
  <NumberOfRequiredEngineers>1</NumberOfRequiredEngineers>
  <RequiredSkills1>
    <TaskRequiredSkill1>
      <Key>Data Storage</Key>
      <SkillLevel>1</SkillLevel>
    </TaskRequiredSkill1>
  </RequiredSkills1>
  <RequiredSkills2/>
  <EngineerType></EngineerType>
  <RequiredEngineerTools/>
  <Critical>false</Critical>
  <TimeDependencies/>
  <EngineerDependencies/>
  <AppointmentStart>2009-03-15T10:00:00</AppointmentStart>
  <AppointmentFinish>2009-03-15T12:00:00</AppointmentFinish>
  <ContactName></ContactName>
  <ContactPhoneNumber></ContactPhoneNumber>
  <Latitude>51516314</Latitude>
  <Longitude>-175275</Longitude>
  <GISDataSource>1</GISDataSource>
  <Street/>
  <City/>
  <State/>
  <IsCrewTask>false</IsCrewTask>
  <CountryID>UK</CountryID>
  <IsScheduled>false</IsScheduled>
  <CustomerEmail/>
  <ExcludedEngineers/>
  <RequiredCrewSize/>
  <InJeopardy>false</InJeopardy>
  <Pinned>false</Pinned>
  <JeopardyState/>
  <DispatchDate/>
  <CustomerReference/>
  <AdditionalTravel_SO/>
 </Task>

Properties

The following list describes the commonly used task properties. Certain additional properties are used only in special applications.

Key, Revision, Stamp

See Standard Properties of Business Objects.

CallID, Number

String and integer identifiers of a task, respectively.

In a multistage task, each constituent task must have the same CallID and a different Number.

EarlyStart, LateStart, DueDate

The earliest and latest times to start the task, and the target time to finish the task.

Priority

The importance of a task, on a user-defined integer scale.

Typically, a low numerical value such as 1 means a high priority. A high value such as 10 means low priority. The reason is that in common usage, people say "first priority" when they mean the highest priority. Another way to remember this is that you perform tasks in sequence of priority: you perform Priority 1 tasks first, Priority 2 second, etc. It is possible to reverse this interpretation, however, and use high numerical values to mean high priority.

Status

A reference to an item in the TaskStatus dictionary, such as Open, Scheduled, or Complete.

Customer

The name of the customer or site.

Calendar

A reference to a Calendar object that defines when the task can be performed.

Continent, CountryID, Region, District

References to the Continent, CountryID, Region, and District dictionaries, indicating the territory to which the task belongs.

PreferredEngineers, RequiredEngineers, ExcludedEngineers

References to resources that are preferred, required, or excluded for performing the task.

ContractType

A reference to an item in the ContractType dictionary, for example, Maintenance Agreement or Warranty Service.

Some typical uses of this property are to set a default DueDate for the task, to assign a default Priority, or for general information.

OpenDate, ContactDate, ConfirmationDate, DispatchDate

The dates when the task entered the system, when the customer was contacted, when the task was confirmed, and when the task was dispatched to a resource.

TaskType

A reference to an item in the TaskType dictionary, such as Installation or Plumbing.

Duration

The time (in seconds) that a task is normally expected to take.

NumberOfRequiredEngineers

The number of resources required to perform a task. The only supported value of this property is 1. To implement tasks that require multiple resources, see ClickSchedule Multiperson Tasks and Configuring Crews in ClickSchedule.

RequiredSkills1, RequiredSkills2

Lists of resource skills that are required for a task. If you have only one of the list skills per task, you can use RequiredSkills1 and ignore RequiredSkills2. You might use both properties to represent alternative skill sets or more and less important skills, respectively.

The lists contain TaskRequiredSkill elements, each containing a nested Key element referencing the Skill dictionary, and an integer SkillLevel on a user-defined scale.

EngineerType

A reference to an item in the EngineerType dictionary, such as Plumber or Electrician, representing the type of required resource.

RequiredEngineerTools

A list of tools that the resource requires. The list contains RequiredEngineerTool elements that reference items in the Tool dictionary.

Critical

If true, and the task object is part of a multistage task, the property means that if the task cannot be scheduled, then no other task objects in the multistage task are scheduled.

TimeDependencies, EngineerDependencies

Time and engineer dependencies between the stages of a multistage task. For more information, see Configuring Multistage Tasks in ClickSchedule.

AppointmentStart, AppointmentFinish

The start and finish of an appointment for the task, that is, the earliest and latest times that are permitted for an assignment start.

ContactName, ContactPhoneNumber, CustomerEmail

The name, phone number, and email address of a customer contact.

CustomerReference

The name of a customer or site. The value is a reference to an item in the Customer dictionary.

Latitude, Longitude

Coordinates of the task (integers in millionths of a degree).

GISDataSource

The geographic dataset identifier that Service Edge uses to route the resource. The property is provided for historical reasons. In Service Edge, the value of GISDataSource for a geocoded object is nearly always 1.

Street, City, State, Postcode

Address of the task.

IsCrewTask

If true, the task requires a crew of resources.

RequiredCrewSize

The number of resource crew members that the task requires.

IsScheduled

True if the task has an assign

InJeopardy

True if the task is considered to be in jeopardy, that is, at risk of not being acceptably scheduled or completed.

JeopardyState

An explanation of why the task is in jeopardy. The value is a reference to an item in the JeopardyState dictionary, such as Understaffed or Engineer_Is_Late.

Pinned

If true, the assignment of the task must not be changed.

AdditionalTravel_SO

An additional duration, in seconds, that the system adds to the routing travel time before the task. The additional duration represents the time for parking or other overhead activities before starting the task.

SXP Identifier

By default, the task identifier is the combination of the CallID and Number properties.

UserSetting Object

A UserSetting object stores configuration options or data that apply to a particular user. For example, a UserSetting might store the display preferences that a user has selected in the Service Edge user interface.

Web Services that Use the Object

ServiceOptimizationService

XML Representation

The syntax of a UserSetting is identical to that of a Setting. In some web operations, the top-level element is called Setting. In other web operations, it is called UserSetting. For the syntax details, see the Setting Object.

<UserSetting>
  <Key>...</Key>
  <Revision>...</Revision>
  ...
</UserSetting>

Properties

The properties of the UserSetting object are the same as those of the Setting Object.

SXP Identifier

By default, the identifier of a user setting is the combination of the Owner, Category, and SubCategory properties, plus the Name property if it is assigned.