AlayaCare Roles
Executive Summary
AlayaCare Roles is where administrators control which screens and actions each AlayaCare role can use in the integration. The roles themselves are defined in AlayaCare and are brought in with Refresh from AlayaCare; here you open a role and grant or revoke its permissions, organised by menu group and menu title. The permissions list on each screen's documentation (View, Read-only, and so on) is what appears in this dialog. An Export produces a spreadsheet matrix of every permission against every role so that the full set of assignments can be reviewed at once.
Key Features
- Refresh the list of roles from AlayaCare (new roles are added, changed ones are updated, and roles that no longer exist in AlayaCare are removed here along with their permissions)
- Filter roles by portal section and description
- Open a role and grant or revoke individual permissions, browsing by menu group
- Grant or revoke all permissions for a menu group in one click
- Export a matrix of permissions by role to Excel
Typical Workflow
- Click Refresh from AlayaCare to make sure the list of roles is current.
- Use Filter Section and Filter Description and click Apply Filter to find the role.
- Click the edit icon on the row (or right-click the row and choose Edit).
- Select a group in the Menu Groups list, then tick or untick permissions in the grid. Use Grant All Permissions For Group or Revoke All Permissions For Group to change a whole group at once.
- Repeat for other menu groups, then click Save. Nothing is stored until Save is clicked.
Available Permissions
The following permissions are available to be assigned to AlayaCare Roles:
| Attribute | What It Controls |
|---|---|
| View | Open the page |
Main Grid
The grid lists the roles brought in from AlayaCare, 14 rows per page.
| Column | Description |
|---|---|
| AC ID | The role's AlayaCare ID. |
| Portal Section | The AlayaCare portal the role belongs to: Admin Portal Roles, Office Portal Roles, Field Portal Roles, or Client Portal Roles. |
| Description | Role description as shown in AlayaCare. |
| Code | Role code (name) in AlayaCare. |
| Manage Records | Edit icon for the row. |
Main Grid Filters
| Filter | Purpose |
|---|---|
| Filter Section | Pick a portal section: Admin Portal Roles, Office Portal Roles, Field Portal Roles, or Client Portal Roles. |
| Filter Description | Show roles whose code contains the text. |
Click Apply Filter to refresh the list. Use Clear Filter to reset filters.
Actions
| Button | Description |
|---|---|
| Refresh from AlayaCare | Reads the roles from AlayaCare and synchronises the list. See Processing Overviews. |
| Export | Saves a spreadsheet of permissions by role. See below. |
| Apply Filter / Clear Filter | Apply or reset the filters. |
| Edit icon (row) | Opens the role's permissions dialog. |
| Edit (right-click a row) | Same as the edit icon. |
The Export (sheet "ACLsForRoles") has one column per role, ordered by portal section and then AlayaCare ID, with the portal section, role description, role code, and AlayaCare ID as the four header rows. Each row below is a permission, grouped by menu group and menu title, with the columns Menu Grouping, Menu Title, Action Description, and Action Documentation. A tick mark shows that the role has the permission.
Dialog Components
Role Permissions
Opens from the edit icon or right-click Edit. The title shows the portal section and role description.
| Control | Description |
|---|---|
| Menu Groups list | Select one menu group to show its permissions in the grid. The first group is selected when the dialog opens. |
| Grant All Permissions For Group | Ticks every permission in the selected group, except those whose description contains "readonly". |
| Revoke All Permissions For Group | Unticks every permission in the selected group, except those whose description contains "readonly". |
| Permissions grid | Columns: tick box, Menu Title (rows are grouped under it), the action description, and the action documentation. Tick a row to grant the permission to the role. |
| Save | Grants the newly ticked permissions and revokes the newly unticked ones across all menu groups, then closes the dialog. |
| Cancel | Closes without saving. |
Processing Overviews
This section describes what happens after you confirm a processing action.
Refresh from AlayaCare
- The system signs in to AlayaCare. If sign-in fails, the refresh stops without a message.
- It reads all employee roles from AlayaCare. If AlayaCare reports an error, that message is shown and nothing changes.
- A role not yet known is added with its description, code, and portal section (Admin, Office, Field, or Client). A known role whose description, code, or portal section differs is updated.
- Any role held here that AlayaCare no longer returns is deleted, together with every permission assigned to it.
- The list is reloaded.