Settings Reference
This page lists every setting in Dantian Clinical Training Logbook, with its label as it appears on screen, what it does, its default, and the values it accepts. The settings sit on two screens under the Clinical Training Logbook admin menu. Both need the manage_options capability, which administrators have by default.
- Plugin Settings: site-wide options on the Site Setup, Evidence Defaults and Reflection Settings tabs. While Pro isn’t active there’s also an Upgrade to Pro tab.
- Logbook Configuration: your program structure on the Levels, Clinic Types, Interventions, Requirements and Clinic Minimums & Evidence tabs.
🔒 Pro feature — requires the Pro plugin.
Pro adds the Cloud Storage, Notifications & Review and Licensing tabs to Plugin Settings, and a Cohorts tab to Logbook Configuration. It also shows extra rows on Site Setup, Evidence Defaults and Reflection Settings, which are marked below.
How saving works. Each tab, and each separate form within a tab, has its own save button, and that button only saves its own form. Changes you make on one tab are lost if you move to another without saving. Text fields whose default is “built-in text” show that text as a placeholder. Leave them blank to keep the built-in wording, which is translated for each viewer’s language.
Site Setup tab
Screen: Plugin Settings → Site Setup · Save button: Save Site Setup
Pages
| Setting | What it does | Default | Allowed values |
|---|---|---|---|
| Entry form page | The page holding [dclb_entry]. Edit links and Log a Treatment buttons point here. |
The Log a Treatment page created on activation | Any page, or — Select page — for none |
| Overview page | The page holding [dclb_overview]. The My Logbook link and the student login destination point here. |
The My Logbook page created on activation | Any page, or none |
If the entry form page and the overview page are the same page, the screen shows a warning. Choose different pages for each.
🔒 Pro feature — requires the Pro plugin.
| Setting | What it does | Default | Allowed values |
|---|---|---|---|
| My Usage button label | Text on the navigation button that links students to their usage report | Blank (shows My Usage) | Any text |
| Reflective Journal page | The page holding [dclb_journal] |
The Reflective Journal page created when Pro is activated | Any page, or none |
| Usage page | The page holding [dclb_usage] |
The My Usage page created when Pro is activated | Any page, or none |
| Trainer Workspace page | The page holding [dclb_trainer_workspace]. Trainers are sent here after logging in. |
The Trainer Workspace page created when Pro is activated | Any page, or none |
When Pro is deactivated, these rows are hidden but their saved values are kept.
See Front-end pages and the Shortcode reference.
Appearance
| Setting | What it does | Default | Allowed values |
|---|---|---|---|
| Primary accent color | Colour for buttons, pills and progress bars | Blank (uses your active theme’s colour) | A hex colour such as #0f5c75. An invalid value is saved as blank. |
| Secondary accent color | Colour for gradients and supporting highlights | Blank (uses the plugin’s mint accent) | A hex colour such as #5de0e6 |
| Disable plugin dark mode adaptation | Keeps the logbook in light-mode colours even when the visitor’s device prefers dark mode | Off | On / off |
Demographics
| Setting | What it does | Default | Allowed values |
|---|---|---|---|
| Sex field label | Label for the sex field on the entry form | Blank (shows Sex assigned at birth) | Any text |
| Sex field helper text | Text shown under the sex selector | Blank (shows the built-in explanation of why sex assigned at birth is recorded) | Text with limited HTML, such as links |
| Age ranges for progress | Age bands used in the overview’s demographics summary. Each band has a Label, Min age and Max age. Ranges include both ends, and you leave Max age blank for an open-ended band such as 65+. Use Add age range to add a row. | None. No bands exist until you add them. | Any number of bands. A row with no label is dropped, and a max below the min is raised to the min. |
The sex options on the entry form are fixed: Male, Female and Intersex.
Roles
| Setting | What it does | Default | Allowed values |
|---|---|---|---|
| Eligible student roles | Decides who counts as a student: who appears in admin student lists and pickers, and who the login redirect and (Pro) allocation and reminder lists include. It does not stop other logged-in users opening the entry form. See User roles and permissions. | Subscriber, plus Administrator | Any combination of the site’s roles. Administrator is always included and can’t be unticked. If you untick everything, the setting falls back to Subscriber. |
| Student login destination | After login, sends users with an eligible student role to the Overview page instead of the WordPress dashboard. Administrators are never redirected, and a login that asked for a specific destination (for example a password-reset or deep link) keeps it. | Off | On / off. It does nothing until an Overview page is assigned, and the screen tells you so. |
🔒 Pro feature — requires the Pro plugin.
| Setting | What it does | Default | Allowed values |
|---|---|---|---|
| Additional trainer role | Gives trainer access to one more role. It is only one of four ways someone becomes a trainer. The others are being an administrator, holding the Clinical Trainer role, and being named as a trainer on a cohort. Changing it never removes access granted those other ways. | Administrator | Any one role on the site |
Offline draft autosave
| Setting | What it does | Default | Allowed values |
|---|---|---|---|
| Enable offline draft autosave | Saves an in-progress entry in the student’s own browser, so a crash, an accidental navigation away or a dropped connection doesn’t lose it. Drafts belong to the logged-in user, expire after 24 hours, and are deleted on submit and on logout. | Off | On / off |
| Also save client demographics (name, age, sex) in drafts | Also keeps the client’s name, age and sex in the browser draft. It only appears once autosave is on. The reflection text is saved either way. | Off | On / off |
Browser storage isn’t encrypted, so anyone with access to that browser profile can read it. Leave autosave off if your students share computers. See Logging treatments.
Data management
These two options only take effect when the plugin is deleted from the Plugins screen. Deactivating it changes nothing.
| Setting | What it does | Default | Allowed values |
|---|---|---|---|
| Delete this plugin’s data — its database tables and settings — when it is uninstalled | Removes the logbook’s database tables and settings on uninstall | Off (keep everything) | On / off |
| Also delete all uploaded evidence files when the plugin is uninstalled | Removes the evidence files kept in the plugin’s private storage on uninstall. This works on its own: it deletes files even if the data option above is off. | Off | On / off |
Saved Bunny and Google Drive credentials and the encryption key are always removed on uninstall, whatever these options say.
🔒 Pro feature — requires the Pro plugin.
Pro has its own Delete data on uninstall option on the Licensing tab. Note how the two interact. When you uninstall Pro while the free plugin is still installed, Pro deletes its own data if either its own option or the free plugin’s Delete this plugin’s data option is on. See What happens on uninstall.
Evidence Defaults tab
Screen: Plugin Settings → Evidence Defaults · Save button: Save Evidence Defaults
These defaults apply across the whole site. Whether notes or a reflection are required is set per clinic type on the Clinic Minimums & Evidence tab.
| Setting | What it does | Default | Allowed values |
|---|---|---|---|
| Accepted types | File types students can upload as treatment notes. The upload dialog and the server check both use this list. | All six ticked | PDF (.pdf), Word (.docx), Word (.doc), Rich Text (.rtf), Plain Text (.txt), Image files (.jpg, .png, .gif, .webp). Ticking nothing restores the full default list. |
| Notes upload helper text | Text shown under the treatment-notes upload field | Blank (shows “Upload scans or documents that summarise diagnostics and treatment outcomes.”) | Text with limited HTML |
| Delete replaced evidence files | When a student replaces the notes on an existing entry, deletes the old file if nothing else uses it. Only files the plugin manages are deleted. | Off | On / off |
| Cleanup providers: WordPress media (plugin-marked files only) | Includes the plugin’s on-server evidence store when looking for unlinked files | On | On / off |
The image option accepts .jpg, .jpeg, .png, .gif, .webp and .heic files.
Upload size (free plugin). There’s no size setting in the free plugin. An evidence file can be up to 25 MB, or your server’s PHP upload limit if that is lower.
🔒 Pro feature — requires the Pro plugin.
| Setting | What it does | Default | Allowed values |
|---|---|---|---|
| Cleanup providers: Bunny tracked objects | Includes Bunny CDN files in unlinked-file checks | On | On / off |
| Cleanup providers: Google Drive indexed objects | Includes Google Drive files in unlinked-file checks | Off | On / off |
The Unlinked Files Cleanup section on the Cloud Storage tab has its own copies of these three provider checkboxes. Ticking one there adds that provider to a single preview. Unticking one there doesn’t remove a provider that’s ticked here: a provider switched on on Evidence Defaults is always included in the preview.
Reflection Settings tab
Screen: Plugin Settings → Reflection Settings · Save button: Save Reflection Settings
| Setting | What it does | Default | Allowed values |
|---|---|---|---|
| Reflection helper text | Text shown under the reflection box on the entry form, unless the clinic type has its own reflection prompt | Blank (shows “Capture insights, surprises, or follow-up plans—collected once per entry.”) | Text with limited HTML |
Minimum word counts and whether a reflection is required are set per clinic type on Clinic Minimums & Evidence.
🔒 Pro feature — requires the Pro plugin.
| Setting | What it does | Default | Allowed values |
|---|---|---|---|
| Reflections button label | Text on the navigation button that links to the student’s reflective journal. The journal page itself is assigned on Site Setup. | Blank (shows Review Reflections) | Any text |
| Enable reflection feedback | Lets trainers (in the Trainer Workspace) and administrators (on Reflections Overview) leave feedback on student reflections | Off | On / off |
| Feedback email notification | Emails the student when feedback is left on their reflection | Off | On / off |
See Reflections, journal and feedback.
Upgrade to Pro tab
Screen: Plugin Settings → Upgrade to Pro (free plugin only)
This tab has no settings. It lists what Pro adds and has a Learn more about Pro link. It disappears when Pro is active.
Cloud Storage tab
🔒 Pro feature — requires the Pro plugin.
Screen: Plugin Settings → Cloud Storage. Each section saves separately. For setup steps, see Cloud storage.
General Storage (Save Storage Preference)
| Setting | What it does | Default | Allowed values |
|---|---|---|---|
| Active storage | Where new evidence uploads go. Files already uploaded stay where they are. | Auto — use highest-priority configured provider | Auto (Bunny CDN if configured, otherwise Google Drive, otherwise on-server storage), Bunny CDN, Google Drive, WordPress media library. A provider that isn’t configured shows “(not configured)” and can’t be chosen. |
The WordPress media library option is the plugin’s private on-server evidence store. Despite the name, it doesn’t use the public Media Library.
Bunny Storage (Save Bunny Settings)
| Setting | What it does | Default | Allowed values |
|---|---|---|---|
| Storage zone name | Your Bunny.net storage zone | Blank | Text |
| Storage region | The region your storage zone is in | — Select region — | Falkenstein (de), New York (ny), Los Angeles (la), Singapore (sg), Sydney (syd), London (uk) |
| Storage API key | The storage zone password | Blank | Text. It’s never shown again after saving. Leave it blank to keep the saved key. |
| Pull zone hostname | Your pull-zone hostname, without https:// |
Blank | For example yourzone.b-cdn.net |
| Pull zone token key | Token authentication key for the pull zone | Blank | Text. It’s never shown again. Leave it blank to keep the saved key. |
| Max upload size (MB) | Largest evidence file accepted for Bunny uploads | 50 | 1 to 500. The real limit is whichever is lower, this value or your server’s PHP upload limit. The screen warns you if this value is higher. |
wp-config.php alternative. You can define any of DCLB_BUNNY_STORAGE_ZONE, DCLB_BUNNY_REGION, DCLB_BUNNY_API_KEY, DCLB_BUNNY_PULL_ZONE, DCLB_BUNNY_PULL_TOKEN and DCLB_BUNNY_MAX_SIZE in wp-config.php. A defined constant always beats the saved value. When the credentials are defined there, the credential fields are hidden. A Clear stored Bunny credentials from the database checkbox then lets you remove the copies saved in the database.
Google Drive Storage (Save Google Drive Settings, Test Connection)
| Setting | What it does | Default | Allowed values |
|---|---|---|---|
| Drive folder ID | The Shared Drive folder that evidence goes into. Service accounts can’t upload to a personal “My Drive” folder. | Blank | The ID from the folder’s URL |
| Service account JSON | The service account key downloaded from Google Cloud Console. It’s stored encrypted and never shown again. | Blank | The full JSON key. It is only saved if it contains private_key and client_email. Leave the box blank to keep the saved key. |
wp-config.php alternative. Define DCLB_GDRIVE_SERVICE_ACCOUNT_JSON and the text box is disabled. A Remove stored key from the database checkbox then appears. If you define DCLB_SECRET_KEY, the key that encrypts saved credentials stays out of the database. Then a database dump alone can’t decrypt them.
Storage Migration
These are actions rather than settings. Choose Bunny → Google Drive or Google Drive → Bunny, then Check pending files and Run migration. Both providers must be configured first.
Unlinked Files Cleanup
Choose which providers to include, select Preview unlinked files, review the list, tick I understand selected files will be permanently deleted and cannot be recovered., then select Delete selected files. Nothing here is saved as a setting. Providers switched on under Evidence Defaults → Cleanup providers are always included, even if you untick them here.
Evidence Delete Failures (Admin)
This is a log of evidence files that couldn’t be deleted, with a Clear failure log button. It has no settings.
Notifications & Review tab
🔒 Pro feature — requires the Pro plugin.
Screen: Plugin Settings → Notifications & Review. The tab has three sections. Each saves separately, and if you try to save one while another has unsaved changes, the screen asks you to confirm.
Email Notifications (Save Notification Settings)
| Setting | What it does | Default | Allowed values |
|---|---|---|---|
| Enable reminders | Sends a weekly digest to students who have saved entries with missing evidence | Off | On / off |
| Send on | Day of the week the digest goes out | Monday | Monday to Sunday |
| Send at | Time of day, in the site’s timezone | 09:00 | Any time (24-hour) |
| Email subject | Subject line of the digest | Blank (shows “Reminder: incomplete logbook entries — {your site name}”) | Text |
| Email body | Body of the digest | Blank (uses the built-in template) | HTML. Placeholders: {first_name}, {last_name}, {incomplete_count}, {treatment_list}, {site_name}, {site_url}, {unsubscribe_url} |
If you remove {unsubscribe_url} from a custom body, students can no longer unsubscribe themselves. Digests only go to students with a current active allocation. See Reminder emails.
Per-Student Reminder Opt-Out
This section lists every user with an eligible student role, 20 per page, and shows whether each one is Subscribed or Unsubscribed to the weekly digest. Use Opt out or Re-enable to change one student. Everyone starts subscribed.
Privacy & Notes Review (Save Review Settings)
| Setting | What it does | Default | Allowed values |
|---|---|---|---|
| Enable privacy review | Lets trainers review entries for patient-identifiable information | Off | On / off |
| Enable notes completeness review | Lets trainers flag entries whose treatment notes are insufficient | Off | On / off |
| Progress counting: Exclude flagged entries from requirement progress counts | Flagged entries don’t count towards progress until they’re resolved | On | On / off |
| Privacy flag reasons | Quick-select reasons offered when flagging a privacy issue, one per line. Trainers can also type their own. | Blank (offers the four built-in reasons) | Text, one reason per line |
| Notes incomplete reasons | Quick-select reasons for flagging notes as incomplete, one per line | Blank (offers the four built-in reasons) | Text, one reason per line |
| Privacy Flag → Enable email | Emails the student when an entry is flagged for privacy | On | On / off |
| Privacy Flag → Email subject | Subject of that email | Blank (shows “Action required: Privacy issue with your treatment notes”) | Text |
| Privacy Flag → Email body | Body of that email | Blank (uses the built-in template) | HTML. Placeholders: {first_name}, {last_name}, {treatment_date}, {treatment_number}, {flag_reason}, {entry_url}, {site_name} |
| Privacy Flag → Student banner | Banner shown on the student’s entry form while the entry is flagged | Blank (uses the built-in banner) | HTML. Placeholder: {flag_reason} |
| Treatment Notes Incomplete → Enable email | Emails the student when an entry is flagged as incomplete | On | On / off |
| Treatment Notes Incomplete → Email subject | Subject of that email | Blank (shows “Action required: Your treatment notes are incomplete”) | Text |
| Treatment Notes Incomplete → Email body | Body of that email | Blank (uses the built-in template) | HTML. Same placeholders as the privacy email. |
| Treatment Notes Incomplete → Student banner | Banner shown while the entry is flagged as incomplete | Blank (uses the built-in banner) | HTML. Placeholder: {flag_reason} |
The flag emails only send while their review track is turned on. See Evidence review.
Licensing tab
🔒 Pro feature — requires the Pro plugin.
Screen: Plugin Settings → Licensing
| Setting | What it does | Default | Allowed values |
|---|---|---|---|
| License Key | Activates your Pro licence on this site so the site receives Pro updates. Buttons: Activate License, Deactivate, Activate a Different Key. | Blank (status Inactive) | Your licence key. Once saved it’s shown masked. |
| Delete data on uninstall | When Pro is uninstalled, permanently deletes Pro’s tables and settings: cohorts, allocations, audit logs, evidence objects and Pro configuration. Cloud-stored evidence files are also removed, on a best-effort basis. Saved with Save Data Retention Setting. | Off | On / off |
Licensing never turns features off. Without an active licence, Pro keeps working and only automatic updates stop. Licence credentials are always removed on uninstall. See Licensing and updates.
Settings on other Pro screens
🔒 Pro feature — requires the Pro plugin.
| Setting | Where | What it does | Default |
|---|---|---|---|
| Lock a student’s allocation automatically when its level is complete | Student Allocations → Automatic locking | Locks an allocation once every required requirement for its level is met. You can still unlock it by hand. | Off |
| Count treatments logged before cohort assignment | Cohort Progress toolbar | Includes entries logged before the student joined the cohort in the cohort’s totals | On |
Logbook Configuration tabs
Screen: Clinical Training Logbook → Logbook Configuration. These tabs hold your program catalogue. Each item is a record you add, edit and delete, not a single on/off setting. The full guide is Program catalogue. Here are the fields and their starting values:
| Tab | Fields (as labelled) | Notes |
|---|---|---|
| Levels | Name, Slug, Description, Sort Order | Students log entries against a level. |
| Clinic Types | Name, Slug, Applies To Levels, Sort Order | Each clinic type must apply to at least one level. |
| Interventions | Label, Slug, Category, Description, Applies To Levels, Clinic Types (optional) | Leave levels empty to apply to all levels, and clinic types empty to show for every clinic. |
| Requirements | How many times an intervention must be logged for a level | See Requirements. |
Clinic Minimums & Evidence tab
You set these per level and clinic type with Set Clinic Minimum.
| Setting | What it does | Default | Allowed values |
|---|---|---|---|
| Minimum Count | Treatments a student must complete at this clinic type | 0 | 0 or more |
| Require treatment notes to be uploaded | Makes a notes upload part of a complete entry | Off | On / off |
| Require written reflection | Makes a reflection part of a complete entry | Off | On / off |
| Enforcement (notes and reflection) | What happens when required evidence is missing at save. The free plugin only has Hard, so no selector is shown. | Hard — block save until provided | Free: Hard. Pro adds Soft — allow save, show warning and Reminder chain — allow save, escalating email reminders. |
| Reflection minimum words | Minimum length a required reflection must reach | 0 (no minimum) | 0 or more |
| Reflection prompt | Replaces the site-wide reflection helper text for this clinic type | Blank | Text with limited HTML |
| Clinic notes for students | Notes shown in the student’s overview under program progress | Blank | Text with links and lists |
Cohorts tab
🔒 Pro feature — requires the Pro plugin.
Create Cohort fields: Cohort Name, Level, Program Stream, Intake Year, Trainers, Dates (start and end, for information only), Bridge Options, Notes, and Capture requirement snapshot immediately after saving. The Trainers list shows administrators, users with the Additional trainer role, and users with the Clinical Trainer role (or any role with the same trainer capability). See Cohorts and cohort progress.
wp-config.php constants
| Constant | Effect | Plugin |
|---|---|---|
DCLB_EVIDENCE_PRIVATE_DIR |
Puts the private evidence store in a folder you choose. Use a path that isn’t publicly reachable. | Free |
DCLB_SECRET_KEY |
Keeps the key that encrypts saved credentials out of the database | Free (used by Pro’s cloud credentials) |
DCLB_BUNNY_STORAGE_ZONE, DCLB_BUNNY_REGION, DCLB_BUNNY_API_KEY, DCLB_BUNNY_PULL_ZONE, DCLB_BUNNY_PULL_TOKEN, DCLB_BUNNY_MAX_SIZE |
Bunny settings. A defined constant overrides the matching saved setting. | Pro |
DCLB_GDRIVE_SERVICE_ACCOUNT_JSON |
Google Drive service-account key | Pro |
Store credential values only in wp-config.php or your host’s secrets manager. Never put them in documentation or shared files.
Was this helpful?
Thank you for your feedback!