Settings — Portal documentation

Access

How an administrator reaches the screen, and what has to be true for it to open.

Element What it decides Permissions

Navigation Side menu → Settings. Me:settings.access

Header

What the band states before anything below it is actionable.

Element What it decides Permissions

Title “Settings”, with a line naming the areas set up. —

Inside an area The title becomes the area's name, with a back control. —

Main actions

What can be added, area by area.

Element What it decides Permissions

Add item Each area has its own; there is none for the page as a whole, because an item means nothing without its area. Me:settings.edit

Table

The areas the organisation configures, each a list of the same shape.

Element What it decides Permissions

Departments & locations Name, code, and whether visits can be booked into it. —

Visit types Name, duration, who can deliver it, and which forms it asks for. —

Booking order The order a booking asks for patient, visit type, provider, location and time. Client:booking.custom

Roles & permissions What each role is allowed to see and do. —

Theme Primary and secondary colour, logo, and the header band. Client:branding

Row actions

What can be done to one item.

Element What it decides Permissions

Edit item Opens the item, stating what the change affects before it is saved. Me:settings.edit

Remove Asks to confirm. Refused while anything still uses the item, naming what does. Me:settings.editData:removable

Errors

Not yet written from the code.

API calls

Not yet written from the code.