activity

Activity defines what is to be scheduled. Activities can be things such as service calls, work breaks or private appointments where a resource is not available for work. An activity could be split, prioritized, deprioritized or treated in a special way in relation to other activities.

Syntax:

[ DynamicComponentDependency ] activity ActivityName {
[ TimeSpanUOM ] [ TimeZoneOverride ] [ ChangeDetection ] [ CustomChangeHandler ] [ UrlPropertySetting ] #SqlDml.QueryBlock ;
}

Mandatory columns

Column Name Data Type Description Default Value
id String(32) Defines a unique id for the activity.

Optional columns

Column Name Data Type Description Default Value
activity_class_id String(10) Defines the type of activity. CALL
activity_type_id String(32) Describes the type of activity. E.g. service call. Default
appointed Number (0 = False, 1 = True) Defines whether this activity represents an appointment that has been booked.
auto_duration Number (minutes by default) Defines the estimated duration of the activity, as determined automatically using the Schedule Archive.
auto_duration_enabled Number (0 = False, 1 = True) Defines whether an auto_duration should be used for this activity.
base_value Double Defines the basic marginal value of scheduling this activity compared to not scheduling it.
calendar_id String(32) Defines the id of the calendar to use when applying SLA times to this activity.
colour String(9) Used for display purposes.
contract_id String(32) Defines the id of the contract that this activity relates to.
cost_of_split Double Defines the cost incurred each time the activity is split.
customer String(100) Defines the customer that this activity relates to.
date_time_created Date Defines the date time the activity was created.
date_time_open Date Defines the date and time the activity was opened to be processed.
description String(2000) Describes the activity if required.
do_on_location_incentive Double Defines how activities at the same location should be scheduled.
duration Number (minutes by default) Defines an alternative option for where duration is taken from
end_location_id String(32) Defines the location at which the activity ends.
external_ref String(40) Defines a string used by the EA to identify this activity.
interrupt Number (0 = False, 1 = True) Defines whether this activity is allowed to be used to split an activity where split_allowed is set to true.
interrupt_multiplier Double Defines a multiplier that is applied to the cost_of_split of a splittable activity when interrupted by this activity.
interrupt_priority Number Defines the priority of this activity when considering whether to use it to interrupt a splittable activity. This is compared to the split_minimum_priority on the splittable activity.
last_visited_date_time Date For a REPEATABLE activity used with a modelling pattern, this is the last time a visit to the activity occurred.
location_id String(32) Defines the location where the activity is to take place.
maximum_displaceable_priority Number When appointment booking for this activity, the engine will attempt to displace any other activities of this priority or less.
min_split Number (minutes by default) Defines the minimum on site duration for any visit to a split activity.
modelling_pattern_id String(32) Defines the unique identifier for the modelling pattern.
priority Number Defines the priority of this activity. The greater the number the greater the priority.
reactive Number (0 = False, 1 = True) Defines whether the activity is reactive. Used in conjunction with the Schedule Distribution Service.
separation_group_id String(32) Defines the id of the separation group this activity belongs to.
service_level String(100) Used for information and reporting only. Has no impact on scheduling.
split_allowed Number (0 = False, 1 = True) Defines whether the activity is allowed to split.
split_minimum_priority Number Defines the minimum split priority required for this activity to be split, and the minimum interrupt priority required for another activity to be able to interrupt this activity.
time_zone String(32) Defines the id of the time zone related to this activity.


            activity Activity {{SelectName}} {
               SELECT
                     ..                  id,
                  -- optional columns
                     ..                  activity_class_id,
                     ..                  activity_type_id,
                     ..                  appointed,
                     ..                  auto_duration,
                     ..                  auto_duration_enabled,
                     ..                  base_value,
                     ..                  calendar_id,
                     ..                  colour,
                     ..                  contract_id,
                     ..                  cost_of_split,
                     ..                  customer,
                     ..                  date_time_created,
                     ..                  date_time_open,
                     ..                  description,
                     ..                  do_on_location_incentive,
                     ..                  duration,
                     ..                  end_location_id,
                     ..                  external_ref,
                     ..                  interrupt,
                     ..                  interrupt_multiplier,
                     ..                  interrupt_priority,
                     ..                  last_visited_date_time,
                     ..                  location_id,
                     ..                  maximum_displaceable_priority,
                     ..                  min_split,
                     ..                  modelling_pattern_id,
                     ..                  priority,
                     ..                  reactive,
                     ..                  separation_group_id,
                     ..                  service_level,
                     ..                  split_allowed,
                     ..                  split_minimum_priority,
                     ..                  time_zone
               FROM {{sourceTableName}}
               WHERE ...;
            }

Note:   All selected columns must have correct aliases that match a IFS Scheduling Activity.

ActivityName

Syntax:

<Identifier>


This page is generated from IFS Developer Studio at 2021-08-13 08:48.