Configure Crew Shell

Before you can use Crew Shells, set up the core parameters that control how they work in NextGen FSM. This process involves defining key details like user and resource types, activating Crew Shells for specific operation centers, and managing user permissions. After you complete these steps, you can create and manage your new crew types.

Prerequisites

Make sure you meet these prerequisites before you start:

• License: You must have an activated license for the Crew Shells module.

• System Knowledge: Understand the different user and resource types in NextGen FSM and the Operation Centers where you plan to use Crew Shells.

Access Crew Shell Configuration

To get started, navigate to the Crew Shell interface (Main Menu > Core > Resource Management > Crew Shell > Crew Shell Configuration). This interface has two tabs: Crew Shell Configuration and Crew Shell Activation for Operation Centers.

Define Core Crew Shell Parameters

On the Crew Shell Configuration tab, set the fundamental rules for your crew shells.

• User Type: Select a user type for your crew shells. We recommend that you choose a user type related to mobile users.

• Resource Type: Select a resource type to assign to your crew shells.

• Automatic Workshift Confirmation: Check this box to automatically confirm workshifts you create. Drag and drop them on the calendar. This saves you a manual confirmation step.

• Integration API Base Workshift: Select a default work shift for your crew shells when an API requests one without specifying a shift.

• Daily Plan Bar Color: Choose a color for the bars that represent crew members on your daily and multi-day plans.

• Default Forced Outcome: Select a default outcome for activities assigned to empty crew shells in the past. An automated system task uses this rule.

• Number of Days for Closure: Enter a negative number (such as -1 for yesterday) to tell the system how many days in the past it should look for empty crew shells to apply a default outcome.

Activate Crew Shells for Operation Centers

On the Crew Shell Activation for Operation Centers tab, you can decide where to use Crew Shells.

• Activate an Operation Center: By default, all operation centers are deactivated. To activate one, drag and drop it from the Deactivated Operation Centers list to the Activated Operation Centers list.

• Deactivate an Operation Center: To deactivate a center, drag and drop it back to the Deactivated Operation Centers list.

Manage Crew Shell Permissions

You can set permissions to control what different users can do with Crew Shells. These permissions are organized into two groups.

Crew Shell Configuration Section Permissions

These permissions control access to the Crew Shell Configuration form (Configuration > Core > Resource Management > Crew Shell > Crew Shell Configuration).

• View: Allows access to view the Crew Shell Configuration Form. If you have this permission but not the Edit permission, you can only view the configuration. The Save and Confirm buttons are turned off, which prevents any changes. This permission is not used in APIs.

• Edit: Allows access to and editing of the Crew Shell Configuration Form. With this permission, you can change configuration properties and activate or deactivate Operation Centers. The Save and Confirm buttons are turned on. This permission is not used in APIs.

Crew Shell Section Permissions

These permissions control a user's access to the Crew Shell Monitor and related functionalities.

• View: Allows access to the Crew Shell Monitor from the menu and the Daily Plan. Without this permission, Crew Shells isn’t visible in the Daily Plan or Virtual Daily Plan, including the filter section, warnings, and display options. If you have this permission, you can view Crew Shells in the Daily Plan or Virtual Daily Plan and view Crew Shell properties in the Crew Shell Monitor, but not skills and addresses. This permission is required for GET requests of Crew Shells, Crew Shell Skills, Crew Shell Addresses, and Crew Shell Members via API.

• Edit: Allows you to edit a Crew Shell, its addresses (departure and arrival points), add or remove skills, and add or remove Crew Members. This permission is required for POST and PATCH requests of Crew Shells, Crew Shell Skills, Crew Shell Addresses, Crew Shell Members, Allocate and Deallocate Members via API.

• Workshifts View: Allows access to the Crew Shell Calendar from the menu and the Daily Plan. Without this permission, the view/edit calendar menu item remains hidden. If you have this permission but not the Edit permission, you can’t create, edit, or delete a calendar. This permission is not used in APIs, because creating Crew Shell calendars is tied to resource calendar permissions.

• Workshifts Edit: Allows you to create, edit, and delete a calendar. This permission is not used in APIs, because creating Crew Shell calendars is tied to resource calendar permissions.

Permission Dependencies

Some Crew Shell permissions have dependencies on standard permissions:

• Crew Shell Monitor:

  • Crew Shell: View requires Resource: View permission.

  • Crew Shell: Edit requires Resource: View and Resource: Edit permissions.

• Crew Shell Calendar:

  • Crew Shell Workshift: View requires Resource: View, Resource Work Calendar: View, and WO OC Change permissions.

  • Crew Shell Workshift: Edit requires Resource: View, Resource Work Calendar: View, Resource Work Calendar: Edit, WO OC Change, and Daily And Multiday Plan: Scheduling permissions.

• Daily Plan and other features:

  • Standard permissions are required, along with the relevant Crew Shells: View permission, to operate with Crew Shells in the Daily Plan.

Configure the End-of-Day Closure Task for Empty Crew Shells

An automated system task helps you manage activities assigned to empty crew shells from past days.

To turn on this task, add the following configuration to your company properties:

company.job=CORE-CrewShellWorkDayClosure
company.job.CORE-CrewShellWorkDayClosure.mode=EVERY_TIME
company.job.CORE-CrewShellWorkDayClosure.queueName=<QUEUE_NAME>
company.job.CORE-CrewShellWorkDayClosure.task=+/core/bl/crewshell/scheduling/workday/task/BTCrewShellMassiveWorkDayClosure
company.job.CORE-CrewShellWorkDayClosure.description=Crew shell work day closure task
company.job.CORE-CrewShellWorkDayClosure.user=[system]

The system task processes activities based on these conditions:

• The activities are scheduled to empty Crew Shells.

• The associated Crew Shell shift ends on or before the current system date minus the number of days specified in the Number of days in the past for forced outcome closure parameter in the Crew Shell Configuration settings.

The task automatically does the following:

1. Applies the default outcome you set in the Crew Shell Configuration to any past activities assigned to empty crew shells.

2. Creates a user accounting entry for the crew shell.

Recap and Next Steps

You have now learned how to configure the main parameters, activate Crew Shells for specific Operation Centers, and manage user permissions within NextGen FSM. This comprehensive setup ensures your Crew Shells are correctly integrated into your resource management and scheduling workflows.

You can now:

• View and Manage Crew Shells in the Daily Plan: See how Crew Shells are utilized in the daily scheduling context.

• Manage Crew Shell Calendar: Understand and manage the work schedules for your Crew Shells.

• Manage Crew Shell Members: Learn how to assign and manage individual technicians within a Crew Shell.