Documentation about Study Configurator

content/docs/study-configurator/configurator-overview.mdx

@@ -0,0 +1,50 @@
+---
+title: Study Configurator Overview
+description: Overview of the study configurator interface
+---
+
+## Study Configurator Dashboard
+
+The Study Configurator lets you manage study-wide configuration: surveys, rules, variables, and settings. The dashboard provides a quick summary and entry points to all relevant actions.
+
+![Study configurator dashboard overview](./images/study-conf-overview.png)
+
+### Top Navigation Bar
+- **[Dashboard]**: Returns to the main overview of the study.
+- **[Surveys](/docs/study-configurator/surveys)**: Manage surveys for the current study.
+- **[Rules](/docs/study-configurator/rules)**: View published rules versions and upload a new version.
+- **[Variables](/docs/study-configurator/study-variables)**: Define and manage key–value pairs used across rules and surveys.
+- **[Settings](/docs/study-configurator/settings)**: Configure settings like status, code lists, notifications, and access.
+
+![Top navigation bar](./images/top-navigation-bar.png)
+
+### Study Header
+- **Study Key**: Displays the unique study key (e.g., `tekenradar`). 
+- **Status Toggle**: Shows current status (e.g., `active`). Use the dropdown to update the study status when needed.
+
+![Study header](./images/study-header.png)
+
+### Overview Cards
+- **Participants**: Shows the number of registered participants. Use “View Participants” to open participant management.
+- **Temporary Participants**: Shows the number of temporary participants (e.g., pre-registration).
+- **Total Responses**: Shows the total number of submitted survey responses. Use “View Responses” to open the responses explorer.
+
+![Overview cards](./images/overview-cards.png)
+
+### Surveys
+- Displays all surveys in the study, including last updated date and number of versions.
+- Click a survey card to open survey management for that survey.
+- The link **Open survey management** takes you directly to the central surveys management page.
+
+![Surveys overview](./images/surveys-overview.png)
+
+### Study Card Preview
+- Shows how the study card is presented in management views.
+- Includes the name, description and tags of the study and a link to go to study settings.
+
+![Study cards preview](./images/study-card-preview.png)
+
+### Language Toggle
+- Switch interface labels between supported languages (e.g., `nl`, `en`). 
+
+![Language toggle](./images/language-toggle.png)

content/docs/study-configurator/meta.json

@@ -2,5 +2,13 @@
     "title": "Study Configurator",
     "description": "Create and configure study settings",
     "root": true,
-    "icon": "FolderCog"
+    "icon": "FolderCog",
+    "pages": [
+        "starting-page",
+        "configurator-overview",
+        "surveys",
+        "rules",
+        "study-variables",
+        "settings"
+    ]
 }

content/docs/study-configurator/rules.mdx

@@ -0,0 +1,41 @@
+---
+title: Study Rules Workspace
+description: Manage study rules - view published versions and upload new versions for your study.
+---
+
+[← Back to Study Configurator Overview](/docs/study-configurator/configurator-overview)
+
+## Overview
+
+The Rules workspace provides an interface for managing study rules that govern the flows and behaviors in your study. Study rules define scheduling, triggers, and event handlers that control when and how participants interact with surveys and other study elements.
+
+To create and edit study rules, use the [Study Rules Editor](/docs/study-rules-editor/basics/editor-overview).
+
+![Rules Workspace](./images/rules-workspace.png)
+
+## Key Features
+
+### Upload Study Rules
+
+Use the **"Upload a new version"** button to import a study rules definition file (JSON format). This allows you to:
+- Deploy new rule configurations to your study
+- Update existing rules with modified logic
+- Import rules created with the [Study Rules Editor](/docs/study-rules-editor/basics/editor-overview)
+
+### Version Management
+
+The Versions section displays a chronological history of all published rule versions, with each entry showing:
+
+- **Publication Status**: The currently active version appears with a star icon
+- **Timestamp**: The exact date and time when the rules were published (e.g., 7/3/2023, 11:20:50 AM)
+
+#### Version Actions
+
+Each version has an options menu (three-dot icon) with the following actions:
+
+- **Download JSON**: Export the rules version as a JSON file for backup, review, or editing
+- **Delete version**: Permanently remove this version from the history (cannot be undone)
+
+<Callout type="info">
+Only one rules version can be active at a time. Uploading a new version automatically makes it the active version and unpublishes the previous one.
+</Callout>

content/docs/study-configurator/settings.mdx

@@ -0,0 +1,230 @@
+---
+title: Settings
+description: Configure study-wide settings such as status, visibility, labels, and access controls.
+---
+
+import { ImageZoom } from 'fumadocs-ui/components/image-zoom';
+import { Step, Steps } from 'fumadocs-ui/components/steps';
+import codeListsAddEntriesImg from './images/code-lists2.png';
+import notificationsNewTopicImg from './images/notifications2.png';
+
+
+[← Back to Study Configurator Overview](/docs/study-configurator/configurator-overview)
+
+## Overview
+
+The Settings workspace provides access to various configuration options for your study. Settings are organized into different categories accessible through the left sidebar.
+
+## General
+
+The General tab contains the core configuration settings for your study.
+
+![Settings General](./images/settings-general.png)
+
+### Study Status
+
+Study status defines whether the study is visible to participants and whether data collection is active.
+
+- **Current status**: Select from the dropdown to set the study status:
+  - `active`: Study is visible and collecting data
+  - `inactive`: Study is not visible to participants
+
+![Settings General](./images/study-status.png)
+
+### Default Study
+
+Configure whether this study should be the default study for your instance.
+
+- **Default Study**: When enabled, all participants will be automatically assigned to this study by default once they log in. If the study is not the default study, participants need to join the study manually.
+
+### Display Texts
+
+If the instance supports study selection, the display texts define how the study appears to participants when they choose which study to join.
+
+Click **"Edit Display Texts"** to open the editor where you can configure:
+
+![Display Texts Editor](./images/display-texts.png)
+
+- **Study Name**: A short title for the study card (e.g., "Infectieradar")
+- **Study Description**: A brief description of the study shown on the study card
+- **Tags**: Optional tags to categorize the study (e.g., "tekenradar")
+- **Language Support**: Edit texts for each supported language using the language selector in the top right
+
+Changes are applied by clicking the **"Apply"** button.
+
+### File Upload
+
+Toggle this option to configure whether participants are allowed to upload files as part of their study participation.
+
+## Code Lists
+
+The Code lists tab allows you to manage available codes for the study. These can be used to validate participant data, for example when participants need to enter specific codes to join the study or access certain features.
+
+![Code Lists](./images/code-lists1.png)
+
+### Managing Code Lists
+
+Each code list displays:
+- **List name**: The identifier for the code list (e.g., "list1")
+- **Code entries**: Shows the codes with their creation date (e.g., "9.1.2026")
+- **Entry count**: Indicates how many codes are shown (e.g., "Showing 2 of 2")
+- **Delete option**: Each code has an X button to remove it from the list
+
+### Adding Codes
+
+Click the **+** button in the top right to add new codes to a list.
+
+
+In the "Add Code List Entries" dialog:
+
+<Steps>
+<Step>
+**Select code list**: Choose an existing list from the dropdown or create a new one by entering a new name.
+
+<ImageZoom
+className='p-2 bg-neutral-200 rounded-xl'
+src={codeListsAddEntriesImg}
+width={400}
+height={200}
+alt="Add Code List Entries" 
+/>
+
+</Step><Step>
+**Enter codes**: Add codes in the text area, one per line
+</Step><Step>
+**Upload**: Click "Upload codes" to add the codes to the selected list
+</Step>
+</Steps>
+
+## Notifications
+
+The Notifications tab allows you to configure email notification subscriptions for study events. This controls which email addresses will receive notifications when specific study events occur.
+
+![Notifications](./images/notifications.png)
+
+<Callout type="info">
+To trigger a message topic, you need to use the ["Notify researchers (Email)"](/docs/study-rules-editor/basics/study-rules#notify-researchers) action in the Study Rules Editor when defining event handlers.
+</Callout>
+
+### Managing Notification Subscriptions
+
+Each notification topic shows:
+- **Topic name**: The identifier for the notification topic (e.g., "topic1"). This is identical to the **message type** attribute used in email templates.
+- **Subscribed emails**: Email addresses that will receive notifications for this topic, displayed as icons
+- **Delete option**: Remove email addresses from the subscription
+
+### Adding a New Topic Subscription
+
+Click **"+ New topic subscription"** to create a new notification subscription.
+
+<ImageZoom
+className='p-2 bg-neutral-200 rounded-xl'
+src={notificationsNewTopicImg}
+width={400}
+height={200}
+alt="New Topic Subscription" 
+/>
+
+In the "New topic subscription" dialog:
+
+1. **Message type**: Enter the type of notification (e.g., "reminder"). Use `*` to subscribe to all message types.
+2. **Email**: Enter the email address that should receive notifications for this topic
+3. **Add**: Click the "Add" button to create the subscription
+
+The email address will then receive notifications whenever this topic is triggered through the study rules.
+
+<Callout type="info">
+To subscribe multiple email addresses to the same topic, repeat this process for each email address individually.
+</Callout>
+
+## Access Control
+
+The Access Control tab allows you to manage user permissions for this study. Here you can grant specific users explicit permissions to perform certain actions on the study.
+
+![Access Control](./images/access.png)
+
+<Callout type="info">
+Admins or users with access to all studies are not listed here, as they already have full access.
+</Callout>
+
+### Managing Permissions
+
+The permissions list shows all users who have been granted explicit permissions to this study. If no permissions have been configured, you'll see "No permissions found".
+
+### Adding a New Permission
+
+Click **"+ Add a new permission"** to grant a user access to the study.
+
+In the "Add a new permission" form:
+
+1. **User**: Select the user from the dropdown to whom the permission will be granted
+2. **Action**: Select the action that this user is allowed to perform on the study. Use `*` to grant all available actions.
+3. **Add permission**: Click the button to grant the permission
+
+Once added, the user will be able to perform the specified action on this study.
+
+## Import / Export
+
+The Import/Export tab allows you to export your study configuration for backup or sharing, and to import configurations from other studies or systems.
+
+![Import Export](./images/import-export.png)
+
+### Export Study Configuration
+
+Prepare your study configuration for export by selecting which components to include:
+
+- **Include study configuration**: Export general study settings
+- **Include surveys**: Export all survey definitions and versions
+- **Include rules**: Export study rules and logic
+
+Click **"Prepare and download study configuration"** to generate and download a JSON file containing the selected components.
+
+### Import Study Configuration
+
+Click **"Open Importer"** to import a study configuration from a JSON file.
+
+![Study Config Importer](./images/importer-study-config2.png)
+
+The importer guides you through three steps:
+
+<Steps>
+<Step>
+**Select study configuration file**: Upload a JSON configuration file by clicking to browse or dragging and dropping the file
+</Step>
+<Step>
+**What to import**: Select which parts of the configuration to import (available after file selection):
+  - **Override study configuration**: Replace current study settings with those from the imported file
+  - **Override surveys**: Replace all current surveys with those from the imported file
+  - **Override rules**: Replace current study rules with those from the imported file
+</Step>
+<Step>
+**Confirm import**: Review your selections and click "Import" to override the current study configuration with the selected parts
+</Step>
+</Steps>
+
+<Callout type="warning">
+Importing a configuration will override the current study configuration with the selected parts of the imported file. Make sure to export your current configuration first if you want to keep a backup.
+</Callout>
+
+## Advanced
+
+The Advanced tab contains critical actions that can permanently affect your study data. These operations should be performed with caution.
+
+![Advanced Settings](./images/advanced.png)
+
+### Danger Zone
+
+<Callout type="warning">
+Actions in this section can permanently result in data loss.
+</Callout>
+
+#### Delete Study
+
+If the study is not needed anymore, you can permanently delete it.
+
+<Callout type="danger">
+This is an irreversible action. You won't be able to access the study anymore. All study data, surveys, rules, and participant information will be permanently deleted.
+</Callout>
+
+Click the red **"Delete study"** button to permanently remove the study from the system.
+

content/docs/study-configurator/starting-page.mdx

@@ -0,0 +1,32 @@
+---
+title: Getting Started
+description: Select or create a study to open the Study Configurator
+---
+
+## Overview
+
+The Study Configurator starting page provides access to all studies in the system. From here, you can select an existing study to configure or create a new study.
+
+![Study Configurator starting page](./images/starting-page.png)
+
+## Selecting a Study
+
+The main view displays a list of all available studies. Each study is shown with:
+- **Study Key**: The unique identifier for the study
+- **Participants**: The number of registered participants in the study
+- **Responses**: The total number of submitted survey responses
+- **Status**: The current status (e.g., active, inactive)
+
+To open the Study Configurator for a specific study, click on the study card or the arrow button on the right. This will take you to the [Study Configurator Dashboard](/docs/study-configurator/configurator-overview) for that study.
+
+## Creating a New Study
+
+To create a new study, click the **"Create New Study"** button. This will open a form where you can configure the basic settings for the new study:
+
+![Create new study form](./images/create-study.png)
+
+- **Study Key**: Enter a unique identifier for the study. This key is used to identify the study in the system and must be unique. It can only contain letters, numbers, hyphens, and underscores, and cannot be changed later.
+- **Secret Key**: Enter a secret key for the study. The study secret is used to calculate the participant IDs in combination with a global secret configured in the study system.
+- **System default study (inactive)**: Optionally, enable this toggle to set the study as the default study for the system. This means that all participants will be assigned to this study by default.
+
+After entering the required information, click **"Create Study"** to create the study. You will be automatically taken to the [Study Configurator Dashboard](/docs/study-configurator/configurator-overview) for the newly created study, where you can start configuring surveys, rules, variables, and settings.