Commit 55a815fb authored by Hayat's avatar Hayat
Browse files

document external scheduler

parent fe47c965
......@@ -54,13 +54,15 @@ rooms or machines that can not be used in more than one appointment at a time.
Relevant guides:
- :ref:`set-up-external-scheduler`
- :ref:`make-appointments-with-external-scheduler`
.. TODO::
- manage study sessions
- make appointments
- manage resources
- access calendar feeds
- use external scheduler
Misc
----
......
.. _make-appointments-with-external-scheduler:
Make appontments with the external scheduler
============================================
Castellum allows the use of an external scheduler. That way subjects can select
the dates for appointments for study sessions themselves.
.. note::
Note that this is an optional feature which may not be activated in your setup.
If the links referenced in this guide are missing from the user interface, the
feature is either not installed or not used for this session. If you would like
to use it, ask the study coordinator for this study to enable it.
1. Navigate to the scheduler link
- in the subject details (step for of this guide: :ref:`recruitment`),
in recruitment, click **Appointments**.
- Click **Select timeslot for this subject** to go to the scheduler.
Clicking the "Copy" symbol will copy the scheduler linkto your clipboard
so you can send it to the subject via email.
2. In the scheduler, select an appointment and click **Save**. This step can
also be done by the subject themself (if you've sent them the link).
.. _set-up-external-scheduler:
Set up an external scheduler for appointments
=============================================
Castellum allows the use of an external scheduler. That way subjects can select
the dates for appointments for study sessions themselves.
.. note::
Note that this is an optional feature which may not be activated in your setup.
If the links referenced in this guide are missing from the user interface, the
feature is not installed. If you would like to use it, please talk to the
administrator of your castellum instance.
1. Find the scheduler link in castellum
- On the startpage, click **Studies**.
- In the studies list, select a study by clicking **Details**.
- Go to the **Sessions** tab.
- If there are no sessions yet, create some:
:ref:`study-recruitment-settings`
- Next to a session, click **Update**.
- Click **New schedule**.
2. Create a new schedule in the scheduler
- On the startpage, click **Create new**.
- Add a meaningful title such as the name of the session this schedule
refers to.
- Under "Timeslots", add all dates on which appointments are available
and each time confirm with **Add date**. The format depends on your browser
settings. Each date will add a new row to the table below.
- On the next line, add all times on which appointments are available and
each time confirm with **Add time**. The format depends on your browser
settings. Each date will add a new column to the table below.
- Clicking on the checkboxes allows to deactivate individual slots for
refinement.
- Clicking on the bin symbol removes the entire row or column.
- Confirm your selection by clicking **Save**.
- Note the ID of this schedule. It's the last number of the URL (e.g.
"yourscheduler/3/"). You will need it in the next step.
3. Enter the schedule id in castellum
- Under **External schedule ID**, enter the scheduler ID.
- Confirm with **Save**.
- The scheduler can now be used in recruitment.
......@@ -108,13 +108,16 @@ In order to limit the search for subjects in Castellum,
- Define **Session instructions**,
- **Start of test sessions**,
- **End of test sessions** and
- click on **Add session**
- Click on **Add session**
- When adding a test session, always give the session a **Name** and specify
the **Duration of a session in minutes**
- Select the **Type** of the session and press **Add session**
- By clicking on the red button **Delete**, you can erase any test session you
created
- Click on **Update** to go to Session details. If your institute uses the
external scheduler to schedule appointments, you can enable it here
(see this guide: :ref:`set-up-external-scheduler`)
8. If recruitment is to take place by e-mail or if information is to be sent by
......
......@@ -25,3 +25,5 @@ Welcome to Castellum's documentation!
guides/consent-management
guides/recruitment
guides/set-up-external-scheduler
guides/appointments-external-scheduler
......@@ -45,6 +45,7 @@ Relevant guides:
- :ref:`study-recruitment-settings`
- :ref:`study-finish`
- :ref:`study-delete`
- :ref:`set-up-external-scheduler`
Study Approver
~~~~~~~~~~~~~~
......@@ -144,6 +145,8 @@ Relevant guides:
- :ref:`subject-search`
- :ref:`recruitment`
- :ref:`recruitment-mail`
- :ref:`make-appointments-with-external-scheduler`
.. TODO::
......@@ -164,6 +167,8 @@ Relevant guides:
- :ref:`subject-search`
- :ref:`subject-get-pseudonym`
- :ref:`make-appointments-with-external-scheduler`
.. TODO::
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment