UserOfficeProject · alexyvanot · Mar 17, 2025 · Mar 17, 2025 · Mar 26, 2025 · Mar 26, 2025
@@ -0,0 +1,115 @@
+# Scheduler :material-calendar-month:
+
+_________________________________________________________________________________________________________
+
+## What is the Scheduler?
+
+The Scheduler section of the User Office Application allows instrument scientists to plan and manage time slots for the use of equipment and instruments. This feature is accessible via the calendar interface, where users can view, organize, and modify beam time slots. The module also allows filtering of time slots based on various criteria for efficient scheduling.  
+
+_________________________________________________________________________________________________________
+
+## Accessing the Scheduler Interface
+
+The scheduling module is not accessible by default within the core part of the User Office Application. Instead, scheduling is managed through a separate interface. Since it is a dedicated Application, the User Office Scheduler comes with its own URL, which is usually different from that of User Office Core. However, It depends on how the Infrastructure is built.
+
+_________________________________________________________________________________________________________
+
+## Prerequisites
+
+### System Requirements
+- A supported web browser (Chrome, Firefox, Safari, etc.).
+
+### Essential Configuration
+- The scheduling module must be deployed and activated to allow access.
+- Users must have appropriate permissions as Instrument Scientists or administrators (User Officer) to access and modify scheduling data.
+
+### Linking Proposals
+- This part should be done by the User Officer in the User Office Core application.
+- Scheduling is tied to Calls for each Proposal which must be correctly associated with planned time slots.
+- Proposals in **SCHEDULING** status will appear in the calendar, and administrators can assign time slots accordingly. Note there are 2 ways to set a proposal to **SCHEDULING** status:
+  1. **Through Workflow**: Configure the workflow to automatically transition proposals to **SCHEDULING** status based on predefined criteria. For more details on configuring the **SCHEDULING** status, refer to the [Creating Workflow guide](../user-guide/user-officer/creating_workflow.md).
+  2. **Manual Status Change**: The User Officer can manually change the status of a proposal to **SCHEDULING** within the User Office Core application.
+- Proposals need to be **Accepted** by the User Officer in order to be scheduled.
+- It is necessary to check the **RabbitMQ** box in the **SCHEDULING** status of the Call Workflow to allow the proposal to be processed in the scheduler. To enable this:
+  1. Click on the **SCHEDULING** status in your workflow tree.
+
+    ![scheduler_wf](../assets/images/scheduler_wf.png)
+
+  2. Click on **Status Actions**.
+
+    ![scheduler_wf_status](../assets/images/scheduler_wf_status.png)
+
+  3. Check the **RabbitMQ** box.
+
+    ![scheduler_wf_rabbit](../assets/images/scheduler_wf_rabbit.png)
+
+You can now put your proposal in **SCHEDULING** status and allocate time slots, so it will appear in the scheduler.
+
+![scheduler_pre_status](../assets/images/scheduler_pre_status.png)
+
+![scheduler_pre_allocate](../assets/images/scheduler_pre_allocate.png)
+
+
+
+_________________________________________________________________________________________________________
+
+## Interface
+
+### Left Panel
+The left panel displays the different menus available in the User Office Application. The default page is **Calendar**, where all planned time slots are visualized. Additional menus, such as **Equipment List** and **Equipment Request**, will be added to manage equipment and related requests.
+
+![scheduler_menu](../assets/images/scheduler_menu.png)
+
+### Calendar Page
+The calendar interface is dedicated to **Instrument Scientists** and allows them to view planned time slots on a calendar.
+**NOTE:** Instrument Scientist will be able to do the Scheduling operation only for the Instruments they are assigned to.
+
+![scheduler_calendar](../assets/images/scheduler_calendar.png)
+
+#### Calendar Features:
+- **Default Display**: The calendar is displayed by default in **Calendar mode**, providing a classic view of the schedule over a given period.
+
+#### Available Filters:
+- **By instrument**: Filters time slots by specific instruments, such as beamlines like **ROCK**.
+- **By equipment**: Filters by the equipment being used (details available in the Equipment List menu).
+- **By local contact**: Displays time slots by associated Instrument Scientists.
+
+![scheduler_filters](../assets/images/scheduler_filters.png)
+
+#### Display Types:
+The right panel allows changing the calendar display type with three options:
+1. **Calendar**: Classic view (default).
+
+![scheduler_view_calendar](../assets/images/scheduler_view_calendar.png)
+
+2. **Table**: Structured tabular view of time slots.
+
+![scheduler_view_table](../assets/images/scheduler_view_table.png)
+
+3. **Timeline**: Chronological view similar to Outlook, providing a linear and intuitive representation of time slots.
+
+![scheduler_view_timeline](../assets/images/scheduler_view_timeline.png)
+
+_________________________________________________________________________________________________________
+
+## Event Management
+
+A **NEW EVENT** button is available to create new events, such as:
+- **Maintenance**: Scheduling a time period for instrument or equipment maintenance.
+- **Shutdown**: Scheduling machine downtime.
+
+![scheduler_new_event](../assets/images/scheduler_new_event.png)
+
+![scheduler_plan_down](../assets/images/scheduler_plan_down.png)
+
+### Time Slots to Plan
+Time slots are associated with proposals. For example, a proposal in **SCHEDULING** status may appear in the calendar, as shown with proposal **2025000**. This proposal is currently being scheduled for a duration of **2 days and 17 hours**. This process is essential for managing periods of instrument and equipment usage.
+
+![scheduler_plan_drag](../assets/images/scheduler_plan_drag.png)
+
+![scheduler_plan](../assets/images/scheduler_plan.png)
+
+![scheduler_planned](../assets/images/scheduler_planned.png)
+
+_________________________________________________________________________________________________________
+
@@ -63,6 +63,7 @@ nav:
           - Settings:
               - Proposal workflows: user-guide/user-officer/settings/proposal_workflow.md
               - Features: user-guide/user-officer/settings/features.md
+      - Scheduler: user-guide/scheduler.md
   - Developer Guide:
       - Contributing: developer-guide/CONTRIBUTING.md
       - Architecture: developer-guide/architecture.md