Back to documentation
SettingsRoles1 min read

Creating a role

OverviewThis article explains when to use creating a role, what the focused step is designed to achieve, and what to review before confirming the action.When to use thisUse this article when you are adding something new

Work Planner DocumentationApril 11, 2026

Overview

This article explains when to use creating a role, what the focused step is designed to achieve, and what to review before confirming the action.

When to use this

Use this article when you are adding something new and want a clearer explanation of the fields and decisions on the create flow.

How it fits into the flow

Creating a role sits within Settings / Roles. It is designed to work alongside related articles such as Editing role permissions, Roles list, so users can move through the workflow without relying on one giant reference page.

Main actions

  • Review the context shown in the dialog so you are acting on the correct record or selection.
  • Choose the options that control how the action should run before you confirm it.
  • Finish the action and then check the parent screen for the result or any follow-up work.
  • Common on-screen actions include Create Role, Cancel, Update Role.

Important fields

  • Role Name: Use lowercase letters, numbers, underscores, or hyphens only.
  • Role Name: Look for input such as “e.g., manager, editor”.
  • Validation: Name: Required. Text value. Maximum 255 characters. Follow the required format. Must be unique.
  • Validation: Permissions: Optional. One or more values can be supplied.

Related articles

May 28, 2026 • 3 min read

Equipment on Jobs and Worksheets

Where equipment is assigned, how it shows on the Planner, on worksheet cards, and on a job, and how the filters use it.

Read article
May 28, 2026 • 2 min read

Equipment Popup

How to add, edit, or view a single piece of equipment using the popup that opens from the equipment list and selectors.

Read article
May 28, 2026 • 2 min read

Equipment List

How to manage the equipment list under Settings and what each column on the page is showing you.

Read article