Skip to content
D
Documentation

Roles

reference
8 min readUpdated

Roles

A role defines which parts of PAMS a person can access through a hierarchical Sections matrix. Use roles to organise access permissions rather than to maintain business records.

If you need to…Go to
Check what the role list offersUnderstand the role surfaces
Open a role or start a new oneFind and open a role
Set a role's access permissionsCreate or maintain role permissions
Continue after savingAfter saving a role
Resolve an unavailable action or missing historyResolve role problems

Before you start

Role controls depend on both your permissions and the record you opened. The list shows New only when role creation is allowed. The edit link requires edit permission, and Delete requires delete permission and an inactive row. A system role is a role whose name and permission matrix are disabled and whose record actions are hidden.

Find and open a role

Use the Roles list to inspect role records, open a permitted record, start a new role, export the list, or remove an inactive role.

Prerequisites

  • You have access to security administration.
  • You know whether the role you want to remove is inactive.

Steps

  1. Open the Roles list.

  2. Choose the action that matches your task.

    If you need to…Action
    Start a roleSelect New.
    Open a permitted existing roleSelect its row.
    Open a permitted existing role through its edit linkSelect the edit link in the role's row.
    Prepare list dataSelect Export.
    Remove an inactive roleSelect Delete on the inactive row.
    Close the export choicesSelect Cancel.
The Roles list with its available actions and visible rows
The new-role screen after selecting New
The export choices with Export and Cancel

Result: You have the selected role screen, the new-role screen, the export choices, the or the deletion confirmation on screen.

Next, review the role surfaces before creating or maintaining permissions.

Confirm deletion of an inactive role

When Delete opens the confirmation for an inactive role, confirm the deletion only for the intended record.

Prerequisites

  • The deletion confirmation is open.
  • The inactive role is the intended record.

Steps

  1. Read Are you sure you want to delete?.
  2. Confirm the deletion choice.

Result: The application shows Data Deleted Successfully.

Understand the role surfaces

The Roles area has a list surface for finding records and a role surface for identifying a role and changing its access. The role surface also provides saved history for eligible roles.

SurfaceWhat it is forWhat you can identify
Role listLocate and act on role recordsThe list shows Role Name and Active columns
List toolsAdjust or prepare the listRefresh, Table Layout, Settings, filters, grouping, and export choices
Role identityName the roleRole Name; the value is disabled for a system role
Permission matrixSet access by section and access typeAll, the hierarchical Sections tree, and access-type choices
Permission groupsMove between permission areasConfiguration, Security, and Other
Tree toolsFind or change the matrix viewExpand all and Collapse all
HistoryReview saved changesAfter saving a non-system role, select Last Modifications
Supporting popupComplete list actionsThe shared popup used by export and confirmation surfaces

The new-role access matrix shows these columns:

Matrix columns
Modules
View
New
Edit
Delete
Import
Export
Enable Editing
Print
Validate

Its visible module names include Dashboard, Tasks, Activities, Sales, Projects, Accounts, Contacts, Invoices, Payments, Letters of guarantee, Products, Project management, Purchasing, Warehouse, Reports, Payables, job profitability, and Tickets.

The list's data columns come from the saved layout, so work from the headers visible in your list. The list grid appears when a saved layout is available. Filters and grouping are part of the configurable list surface.

Use these surfaces to create a role or maintain an existing role.

Create or maintain role permissions

A role permission record combines a role name with access choices in the hierarchical Sections matrix. Create a role when you need a new permission set; maintain a saved non-system role when you need to change or copy an existing set.

Create a role

When New opens the new-role screen, complete the role.

Prerequisites

  • The new-role screen is open.
  • You know the name that identifies the permission set.

Steps

  1. In Role Name, enter the role name.
  2. Select Configuration, Security, or Other to open the corresponding permission tree.
  3. Select Expand all when you need to see the hierarchy.
  4. Select Collapse all when you need to reduce the hierarchy.
  5. Use All to select all applicable permissions in the displayed matrix.
  6. Select the applicable access types for the required Sections.
  7. Select Save to validate and save the role while staying on the record.
  8. Select Save and Close to validate, save, and leave the page.

If Role Name is empty, the form shows This Field Is Required. If its value contains an unsupported character, the form shows Just '_'‘-''.' And '&' Characters Accepted.

Result: The saved role remains on screen after Save, or the application leaves the page after Save and Close. A successful save shows Data saved Successfully.

Maintain an existing role

For a saved non-system role with a permitted edit surface, copy the role or change its permissions. System roles have their identity, matrix, and record actions restricted by the screen.

Prerequisites

  • A saved non-system role is open.
  • The role has a permitted edit surface.

Steps

  1. Select Copy new role to copy the existing role into a new-role flow.

  2. In the new-role flow, change Role Name when the copy needs a different name.

  3. Select the permission tree to maintain.

    If you need to maintain…Select
    Configuration permissionsConfiguration
    Security permissionsSecurity
    Other permissionsOther
  4. Adjust the applicable Sections and access-type selections.

  5. Choose the save action that matches your next step.

    If you need to…Select
    Save without leaving the recordSave
    Save and leave the recordSave and Close
    Review saved historyLast Modifications after saving a non-system role

Result: The maintained role is saved, or the copied permissions are available in a new role record. A successful save shows Data saved Successfully.

To prepare list data, use the export procedure.

Export the role list

After opening the Roles list, use the export popup to prepare the list data.

Prerequisites

  • The Roles list is open.
  • The list contains data to export.

Steps

  1. Select Export on the Roles list.

  2. Choose the required filter or grouping settings in the export surface.

  3. Choose the export outcome.

    If you need to…Select
    Start the exportExport
    Close the choices without exportingCancel

When the list has no exportable data, the application shows NO Data to Export.

Result: The export starts, the export choices close without exporting, or the empty-list message remains on screen.

Resolve role problems

Use the condition that matches what you see rather than looking for a control on a different role surface.

What you seeWhat it meansWhat to do
New is unavailableCreation is controlled by the list permission and subscription limitConfirm that role creation is allowed, then return to the Roles list
Delete is unavailable on a rowThe row is not inactive, or delete permission is unavailableOpen an inactive row or ask an administrator to review the permission
Role Name or the matrix is disabledThe role is a system roleUse a non-system role for editable permissions
Record actions are hiddenThe opened role is a system roleReturn to the Roles list and open a permitted non-system role
Last Modifications is missingThe role is new or a system roleSave a non-system role, then reopen its history
The list grid is missingNo saved list layout is availableAsk an administrator to review the list layout
Saving shows This Role Name Already ExistsThe role name is already in useChange Role Name, then select Save again
A required-name validation appearsRole Name is emptyEnter a value in Role Name
The name validation appears as Just '_'‘-''.' And '&' Characters AcceptedThe name contains a character the form does not acceptReplace the unsupported character in Role Name
Delete asks Are you sure you want to delete?The application is waiting for the deletion choiceConfirm the deletion only when the inactive role is the intended record; otherwise select Cancel

Return to the Roles list after an empty export

When the export shows NO Data to Export, return to the Roles list.

Prerequisites

  • NO Data to Export is on screen.

Steps

  1. Return to the Roles list.

Result: The Roles list is on screen.

Select data before retrying an export

After returning to the Roles list from an empty export, select data before retrying.

Prerequisites

  • The Roles list is open.

Steps

  1. Select data in the Roles list.

Result: The list has data ready for export.

After saving a role

After a non-system role is saved, review its history with Last Modifications or return to the Roles list to find the record and continue working with its permissions.

Was this page helpful?

Need help using the product?