Schedule parameters
Objective
Configure the operational options that affect the schedule: the reasons shown when creating a block and the branches available to associate with appointments and blocks.
Before starting
- Have the
AGENDA_PARAMETERSaction enabled for the user. - Define the reasons or values that the team will use.
How to open the drawer
- Enter the Schedule module.
- In the schedule header, click the gear icon that appears to the right of the staff member tabs. It only shows if the user has
AGENDA_PARAMETERS. - A side drawer opens with two tabs: Blocking reasons and Branches.
Step by step - Manage blocking reasons
- In the drawer, make sure you are on the Blocking reasons tab.
- Use the Search blocking reason field to locate an existing reason by name.
- To create a new reason: click Add. An editable card appears with a color picker and a name field.
- Choose the color and type the reason name.
- Confirm with the check icon. If you want to discard, use the X icon.
- To edit an existing reason: click the pencil icon on the card, adjust color or name and confirm.
- To delete a reason: click the trash icon. The reason is removed from the list; historical blocks that used it will keep the label they had at the time of creation.
- When all changes are ready, click Save at the bottom of the drawer. The system confirms with a success toast.
- If you try to close the drawer with unsaved changes, the system asks for confirmation.
Step by step - Manage branches from the Branches tab
- Switch to the Branches tab inside the same drawer.
- Use the Search branch field to filter by name or phone.
- To add a new branch: click Add, enter name and phone, and confirm.
- To edit an existing one: click the pencil icon, adjust the data and confirm.
- To delete a branch: click the trash icon. This action requires the
AGENDA_BRANCHESaction. - Click Save to apply the changes.
Expected result
- The new reasons appear in the Blocking reason selector of the blocks dialog and are painted with their color.
- The new branches appear in the Branch field of the appointment capture modal and in the blocks dialog.
- The drawer shows the date and time of the last successful update.
Common errors
| Situation | What to do |
|---|---|
| The gear icon does not appear | The user does not have AGENDA_PARAMETERS action. Request from administration. |
| I cannot edit a reason | Verify that the user has AGENDA_PARAMETERS and BLOCKING_REASONS actions. |
| I cannot edit branches | Verify the AGENDA_BRANCHES action. |
| The Save button is disabled | There are no pending changes or a save is in progress. Verify that no card is in edit mode. |
| Closing the drawer asks for confirmation | There are unsaved changes. Confirm Yes, leave to discard them or No, stay to go back and apply Save. |
| The new reason does not appear when blocking | Refresh the schedule (change view or doctor) so the calendar takes the updated list. |
Suggested permissions
- Action
AGENDA_PARAMETERSto open the drawer. - Action
BLOCKING_REASONSto create, edit or delete blocking reasons. - Action
AGENDA_BRANCHESto manage branches inside parameters.
Relation with other modules
- Block time: the reasons configured here are the only ones available when creating a block.
- Create appointment: the branches configured here appear as options when registering an appointment.
- Branches and locations: this tab offers quick access; changes also impact the Branches and locations module.
- Notifications and automations: the availability of new reasons can be used in automatic rules.