Antylogic
DemoApp login

399 operational guides

Docs sections
DocsTeam
Device

Create employee role

Create a reusable employee role for Harbor Soho with a required name and Color plus an optional description, ready to use later in staff records, services and calendars.

In this article

Employee roles give managers a shared vocabulary for floor, kitchen, bar and shift-lead responsibilities before those roles are reused across operational planning.

Creating a role only creates the employee role record for the active location. It does not create staff members, assign employees, link users or grant access permissions.

Before you start

  • You are signed in with an active organisation and location selected.
  • The active location exists; in the GB demo runtime this is Harbor Soho in Harbor Demo Group.
  • Your account has staff-roles:manage for the active location.
  • Your account has staff-roles:view when opening or returning to the Employee roles table.

Instructions

  1. 1.

    Open Employee roles

    Open Employees and roles for the active location, then switch to Employee roles. Use the table to check existing role names, descriptions and employee counts before creating another role.

  2. 2.

    Start Create role

    Select Create role. The app opens Create employee role with empty Name, Description and Color fields, plus Cancel and Create role actions.

  3. 3.

    Complete the details

    Enter the role name, add a description if useful, and select a Color. For Harbor Soho documentation captures, use Shift lead with the description Coordinates the Soho lunch service and the success colour.

  4. 4.

    Create the role

    Select Create role. After a successful save, the app shows Role created, returns to Employee roles and reloads the role list.

  5. 5.

    Handle blocked states

    If access is missing, the create action is hidden or the create screen shows a no-access state. If the location context is missing, the form shows Location not found. If saving fails, the entered values remain in the form and the app shows Unable to create role.

Validations and limits

  • Name is required after spaces are trimmed.
  • Description is optional and is not saved when left blank after trimming.
  • Color is required by the app and by the current backend create action.
  • The app offers Gray, Blue, Indigo, Purple, Pink, Orange, Green, Yellow and Red role colours.
  • The created role is associated with the backend location context, not with any client-supplied location_id.
  • Invalid direct API JSON returns HTTP 400.

Expected result

The employee role is created for Harbor Soho, the staff_roles list cache is invalidated, and the Employee roles table reloads with the role available for later staff and planning workflows.

Related articles