Planning Scenarios


Intro

Planning scenarios allow you to restrict activities displayed in the Planning List so that the planner can concentrate only on relevant activities. A scenario represents one or multiple regions to which a planner has access.

ERD

The following diagram illustrates how the Planning Scenario object interacts with the Person and Region objects:


Prerequisites

Screen Configuration

Attention: please note that the following screen configuration only needed if a custom screen configuration exists already. If the custom is not using screen configuration there is no need for this prerequisite as it will display automatically.

In order for the Region field to appear in the Planning and Dispatching application, the activity.region.name field must be added to the CSActivitySidebar JSON screen configuration:

"title": "ActivityDetails",
            "fields": [
               "activity.code",
               "activity.subject",
               "activity.executionStage",
               "activity.hazardType",
               "activity.equipment.code",
               "activity.subType",
               "activity.earliestStartDateTime",
               "activity.dueDateTime",
               "activity.startDateTime",
               "activity.endDateTime",
               "activity.timeZoneId",
               "activity.durationInMinutes",
               "activity.travelTimeFromInMinutes",
               "activity.travelTimeToInMinutes",
               "activity.remarks",
               "activity.internalRemarks",
               "activity.internalRemarks2",
               "activity.externalId",
               "activity.responsibles.firstName",
               "activity.responsibles.lastName",
               "activity.serviceCall.leader.firstName",
               "activity.serviceCall.leader.lastName",
               "activity.serviceAssignmentStatus.name",
               "activity.syncStatus",
               "activity.region.name" // Important! This field must be added to the JSON screen configuration
            ]
         },
Collapse

Once the field has been added and the changes saved, the region will appear in the Activity Sidebar.


Settings

Service Regions

Service regions can be created and managed in Planning and Dispatching > General Settings > Service Regions:


Assign Regions

Assign Regions to Activities

An activity can have up to one region assigned. In order to assign a region to an activity, navigate to the Activity Details screen and select a region from the dropdown.


Assign Region to a Service Technician

A region for a technician represents the region in which he/she operates. It is possible to assign multiple regions for a given service technician. Regions for a technician can be assigned in Master Data Management under the technican detail page.


Setup of Scenarios

A scenario represents a set of technicians and activities visible to a given planner. Scenarios can be defined in Admin in the Planning Scenario screen.

From the Planning Scenario screen, select Add to add a new planning scenario.

Then you can define a scenario name and a restriction type.

There are two type of restrictions that can be used: by service regions or custom restrictions.

Setup of Scenario by Service Region

This implies that one or multiple regions can be selected and both activities and when such scenario is in use then:

  • The planning list will display only activities matching one of the selected regions for this scenario
  • The planning board will display only technicians matching at least one of the selected regions for this scenario
  • The activity list will display only activities matching one of the selected regions for this scenario

Setup of Scenario by Custom Restriction

In such case two tabs are displayed: Dispatching Board and Planning List.

Dispatching Board allows you to define a custom set of technicians to be displayed for the given scenario while the activities will be shown accordingly to the region selected in the Planning List tab. In this case, the regions assigned to the technicians are not relevant.

When this scenario is in use, the application will operate as follows:

  • The planning list will display only activities matching one of the selected regions for this scenario in the Planning List tab.
  • The planning board will display only technicians according to the technicians selected in the Displatching Board tab.
  • The activty list will display only activities matching one of the selected regions for this scenario in the Planning List tab.

Assigning Scenarios to Planners

Once a scenario has been created, the scenario can be assigned to one ore more planners by selecting the Manage Access option located in the ... menu.


Scenario as Mandatory or Optional

  Description
Optional In this case a planner can decide to use the scenarios or not. In the event that no scenario is defined, all activities and all technicians are displayed.
Mandatory** In this case a planner have access only to the scenarios for which he/she is authorized. In case no scenario is defined, the planning page will not show any result on both the planning page and the planning list. The planner can switch between assigned scenarios.

**Note: the scenario as mandatory is currently not yet activated and cannot be used. It will be activated in one of the next scheduled releases.


Toggling between Scenarios

A planner can switch between scenarios from the planning page screen, by navigating to Settings and then selecting one of the Planning Scenarios for which access has been granted.


Restriction on Planned Activities on Planning Board

Currently, once an activity is planned on the planning board it becomes visible for all planners, regardless of the region associated with it and the region currently in use by the planner via the scenario.

It is currently planned to restrict this in a future release.