Antylogic
DemoApp login

399 operational guides

Docs sections
DocsTeam
Device

Define required roles for a service

Set the minimum and recommended staffing levels a service needs so managers can check whether planned employees cover the shift before it starts.

In this article

Use this guide when a location manager needs to define which staff roles a service requires. In the Harbor Soho demo, the flow starts from the Soho lunch service in the Services calendar.

Each requirement connects one staff role to a minimum count and a recommended count. Antylogic compares those requirements with planned staff assignments and reports coverage warnings or problems.

Before you start

  • You are signed in with an active organisation and location, such as Harbor Demo Group and Harbor Soho.
  • You have service management access and can view staff roles for the location.
  • The service is a calendar event with `kind=service`, or you are creating a new service from the Services calendar.
  • The location has staff roles available for selection.
  • For a public service, a floor plan and catalogue are selected before saving. Internal services do not require those fields.
  • The service being edited has not already started and is not in the past according to the service editor.

Instructions

  1. 1.

    Open the service editor

    From the Services calendar, open the service you want to plan, such as Soho lunch service, or create a new service from the services preset. Existing services load their details, required roles and staff assignments.

  2. 2.

    Open Required roles

    Select the Required roles tab in the service form. The table shows one row per role requirement, with Role, Minimum and Recommended values.

  3. 3.

    Add or update a requirement

    Select Add requirement to create a row. The app starts the row with an available staff role and sets Minimum and Recommended to 1. Choose the role, then set the minimum acceptable coverage and the recommended target coverage.

  4. 4.

    Save the service

    Save after reviewing the role requirements. New services send the requirements with the service bundle, non-recurring services update the bundle, and recurring services ask for the update scope before saving.

  5. 5.

    Review coverage

    Open the Staff tab to understand the effect of the requirements. A role below the minimum count creates a coverage problem; a role that meets the minimum but falls below the recommended count creates a warning.

Validations and limits

  • Each row must have a selected staff role.
  • The same staff role can appear only once for the same service.
  • In the app UI, Minimum and Recommended must be whole numbers from 1 to 999.
  • Saving also validates the service title and start/end range.
  • Public services must include a layout and catalogue before saving.
  • The saved requirement list is authoritative: roles omitted from the service bundle payload are removed from the event.
  • This action applies only to service calendar events, not private events, staff schedules or other calendar event types.
  • If there are no available roles, or every role is already used for the service, Add requirement is disabled.

Expected result

The service stores one requirement per role and uses those requirements to compare planned staff assignments against minimum and recommended coverage.

Related articles