18. Things to do

18.1. Tasks

  • Bugfix: answer column in CISR main data table is double-escaping HTML, e.g. “I don't enjoy anything”.

  • CISR: document current version (2013?) and examine changes required for 2020 version (very minor?) – think about how best to handle this.

Priority: IAM

To be prioritized

  • Mini-ACE (mACE).

  • Free-Cog: https://pubmed.ncbi.nlm.nih.gov/33124050/

  • Test Your Memory (TYM) task (Jerry M. Brown).

  • Continuous performance task, as per RNC’s similar previous task (Linda P and team). A/w ETB.


Not a priority

  • Cardinal_ExpDet* tasks: generate noise on the fly?

  • PDSQ screener (see Clark talk 2018-09-20, MQ Data Science)

  • For computational fitting work, see https://lbfgspp.statr.me/


  • review Guo 2015 “measurement-based care”:

    • HADS/HDRS already

    • QIDS – permissible?

    • Maudsley Treatment Inventory?

    • see notes on Cleare lecture 15/11/2018

  • new task: ReQoL (https://www.reqol.org.uk/p/overview.html)

  • new task: mini-ACE (subset of the ACE-III)

  • new task: Andy Foster / eating disorders; e-mail of 24/5/16

  • new task: AQ10 autistic spectrum screening

  • discarded tasks - revitalize: ASRM

  • discarded tasks - revitalize: BARS

  • discarded tasks - revitalize: BFCRS

  • discarded tasks - revitalize: CSI

  • discarded tasks - revitalize: FAB

  • discarded tasks - revitalize: GASS

  • discarded tasks - revitalize: LSHSA

  • discarded tasks - revitalize: LSHSLAROI2005

  • discarded tasks - revitalize: LUNSERS

  • discarded tasks - revitalize: MADRS

  • discarded tasks - revitalize: SAS

18.2. Client core


  • Create 64-bit ARM build, then release to Google Play Store (deadline 1 Aug 2019). Work in progress: build_qt.py --build_android_arm_v8_64.

  • Test task upload (and date filtering) under Windows/SQL Server.

  • “Single patient” mode to go along with task scheduling.

    • e.g. activate CamCOPS at first use with a URL to a server including a security token; this should then lead to the CamCOPS client registering with the server and knowing the owner’s identity

    • in single-patient mode, automatic fetching of scheduling info (but must cope if network down)

    • in single-patient mode, automatic uploading of completed tasks (but must cope if network down)

    • facility to switch in and out of single-patient mode

    • helpful summary of “things you need to do”, so it walks the user through

    • See “server” below.

Medium priority

  • Have facility to upload and/or automatically feed patient details into the server, then have clients restrict to these predefined patients. Since we are aiming to minimize PID on the client, this could be implemented by having the client validate its patients with the server, and refusing to upload if they don’t match (done). This would be a per-group setting.

    • Client validation check implemented.

    • Just needs server-side extensions to camcops_server.cc_modules.cc_patient.is_candidate_patient_valid(), including a per-group setting for “should we validate”, and a way of getting suitable data in.

    • Note that any patient unification should be external to CamCOPS (i.e. addressing the question of “are these two patients the same person”).

    • Maybe implement as (1) a _known_patients table and (2) a _known_patient_idnums table?

    • Needs slightly more thought about what constitutes a “match” given a variable set of input and a variable set of known information. (Could have an ID policy for the known information too…)

    • Should “known” patients be across groups, or per-group?

Not a priority

  • If user registration fails, automatically offer a “try again” option (in CamcopsApp::patientRegistrationFailed())?

  • MacOS build.

  • Think about a web-based client, e.g. via VNC (but this is complex and loads servers/networks considerably). Potentially more promising is Qt for WebAssembly (in preview May 2018), which compiles to a variety of portable quasi-assembly language; the browser downloads and runs it. However, at present there is no threading or DNS lookup (http://blog.qt.io/blog/2018/05/22/qt-for-webassembly/).

  • Desktop-style menu for desktop clients. (Faster to navigate around.)

  • Current Android back button behaviour may not be optimal.

  • Maybe implement pinch zoom for some subclasses of OpenableWidget, e.g. MenuWindow and Questionaire. See http://doc.qt.io/qt-5/qtwidgets-gestures-imagegestures-example.html

  • QuAudioRecording: questionnaire element to record audio

  • QuVideoRecording: questionnaire element to record video

  • Qt have fixed bug https://bugreports.qt.io/browse/QTBUG-35545 as of Qt 5.12.0 beta 1, so may be possible to improve dialogue boxes again on Android (but possibly our workaround sorted it; can’t remember); check.

  • Via tablet_qt/tools/build_qt.py, also build iOS “fat binary” with 32- and 64-bit versions?

18.3. Server


  • What’s the optimal packaging method for the server? Is it DEB/RPM for Linux, and PyInstaller + Inno Setup (or just Inno Setup) for Windows?

  • Improve installation ease and docs.


  • Self-test: possible to avoid recreating database structure each time? Makes it very slow. (MB 2020-08-19: Certainly possible with pytest / pytest-django. I haven’t checked if there’s an equivalent for pyramid. No doubt this would require a lot of work up front and would be good not to have to maintain our own test runner.)

  • At present the client calls op_validate_patients prior to an upload. This eliminates all realistic possibilities of uploading patient details not permitted to that user. However, it doesn’t prevent the theoretical possibility of someone (a) obtaining a legitimate single-user account, (b) cracking its password, and (c) using a hacked version of the CamCOPS client to upload new “false” patient data from that user (into the group to which they are legitimately allowed to upload their own data). It’d be pretty traceable, and would not damage other data (just add potentially spurious data), but not theoretically impossible. The fix would be to have the server verify this too. (Slightly tricky as it involves validating not just the easy one-step JSON upload but also the table-by-table version, which requires tying patient records to ID numbers).

Not a priority

  • Consider: see DEBUG_TEMPLATE_SOURCE – would it improve performance to have a Mako template cache directory always set, via the config file? (There is still memory caching at present.)

  • Fix Alembic migration autogeneration – too much non-change junk.

  • Tracker improvements.

    • In camcops_server.cc_modules.cc_tracker.Tracker.get_all_plots_for_one_task_html(), consider improvements to allow tracker information to be associated with a user-specified date (see e.g. GBO), rather than the creation time (with fallback to the creation time if not specified).

    • Consider cross-task trackers, e.g. GBO-GPC and GBO-GRaS both contributing to a “goal 1 progress” tracker. Simplest way might be to collect specimen and x/y information from all tasks, keyed by tracker name, with some defaults for existing trackers?

  • Implement (from command line) “export to anonymisation staging database” = with patient info per table. (Extend cc_dump.py. See generate_anonymisation_staging_db(), and it’s also temporarily disabled in the master command-line handler.) Framework very partly done; search for db_patient_id_per_row.

    • Best to implement by fixed column names for all ID numbers, e.g. _patient_idnum1, _patient_idnum17, etc.? NULL if absent.

  • FHIR support via fhirclient.

  • More generic e-mails to administrators, via backend task. (E-mail framework now in place.)

  • There are still some of the more complex Deform widgets that aren’t properly translated on a per-request basis, such as

    • TranslatableOptionalPendulumNode

    • TranslatableDateTimeSelectorNode

    • CheckedPasswordWidget

18.4. Documentation

  • Finish manual esp. web site user guide.

18.5. Developer convenience

18.6. Wishlist and blue-sky thoughts

Server-side “all tasks in full” view, like a clinical text view but for researchers?

A “research multi-task view” would be an easy extension to the task collection classes used for trackers and CTVs, if there is demand.

Improvements to “camcops merge_db” facility

The merge facility doesn’t yet allow you to say “ID#8 in database A means something different to ID#8 in database B; don’t merge that”. Should it? (Example: “research ID” that is group-specific, versus “NHS number” that isn’t.) More generally: should some ID numbers be visible only to certain groups?

Server-side ability to edit existing (finalized) task instances?

Would be done in a generic way, i.e. offer table with {fieldname, comment, old value, new value}; constrain to min/max or permitted values where applicable; at first “submit”, show differences and ask for confirmation; audit changes. For BLOBs, allow option to upload file (or leave unchanged).

Client-side index of tasks by patient ID, to speed up lookup on the tablet?

Might be worthwhile on the client side as the number of tasks grows. (The server already has indexing by patient ID.)

MRI triggering on task side

For example: CamCOPS tasks running on a desktop and communicating via TCP/IP with a tool that talks to an MRI scanner for pulse synchronization and response.

18.7. Considered but rejected

  • Client-side task index, to speed up the client’s patient summary view. (This is not a performance problem!)

  • Tasks record the language operational on the client at the moment of their creation. (Would need the client to remove this field for older server versions at the moment of upload.) A reason not to: users can switch language mid-way, and we’re not going to track all those potential changes.

18.8. Documentation to-do list

Things to do collected from elsewhere in this documentation:


Docker/CamCOPS source: (a) is that the right method? Or should we be using docker-app? (Is that experimental?) (b) Document.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/camcops/checkouts/latest/docs/source/administrator/docker.rst, line 74.)


MB 2020-08-19: I wonder if we should follow the approach here for releasing docker images when we create a new release on GitHub – https://docs.github.com/en/actions/language-and-framework-guides/publishing-docker-images – and publish the image on Docker Hub.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/camcops/checkouts/latest/docs/source/administrator/docker.rst, line 78.)

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/camcops/checkouts/latest/docs/source/administrator/docker.rst, line 611.)


change docs once webview updated for new export system

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/camcops/checkouts/latest/docs/source/administrator/server_front_end_admin.rst, line 223.)


https://pypi.io/project/XXX/ (for pip install XXX)

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/camcops/checkouts/latest/docs/source/administrator/server_installation.rst, line 49.)


sort out MySQL dependencies and/or provide database driver advice

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/camcops/checkouts/latest/docs/source/administrator/server_installation.rst, line 124.)


implement Windows service

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/camcops/checkouts/latest/docs/source/administrator/server_installation.rst, line 126.)


write Ubuntu specimen installation

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/camcops/checkouts/latest/docs/source/administrator/server_installation.rst, line 151.)


Current Windows problems: SQL DELETE taking forever during upgrade_db. See DELETE takes forever. Probably to do with constraints/triggers. Temporary workaround: use create_db instead. (However, the reindex command works fine.)

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/camcops/checkouts/latest/docs/source/administrator/server_installation.rst, line 242.)


TranslatableDateTimeSelectorNode not fully implemented

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/camcops/envs/latest/lib/python3.6/site-packages/camcops_server/cc_modules/cc_forms.py:docstring of camcops_server.cc_modules.cc_forms.TranslatableDateTimeSelectorNode, line 4.)


TranslatableOptionalPendulumNode not fully implemented

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/camcops/envs/latest/lib/python3.6/site-packages/camcops_server/cc_modules/cc_forms.py:docstring of camcops_server.cc_modules.cc_forms.TranslatableOptionalPendulumNode, line 4.)


is_candidate_patient_valid: check against predefined patients, if the group wants

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/camcops/envs/latest/lib/python3.6/site-packages/camcops_server/cc_modules/cc_patient.py:docstring of camcops_server.cc_modules.cc_patient.is_candidate_patient_valid_for_group, line 7.)


address this by having the server require patient validation for all uploads?

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/camcops/envs/latest/lib/python3.6/site-packages/camcops_server/cc_modules/client_api.py:docstring of camcops_server.cc_modules.client_api.op_validate_patients, line 17.)


Does this mean that a QML onClicked event behaves differently with respect to touch events depending on whether it’s compiled on a touch-aware or a touch-unaware computer? That might represent a Qt bug; investigate and report if so. In the meantime, compile for Windows on a Surface Book 2 or similar.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/camcops/checkouts/latest/docs/source/changelog.rst, line 1999.)


check this fixes the SQL Server “DELETE” bug +++

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/camcops/checkouts/latest/docs/source/changelog.rst, line 2164.)


Maybe “Include prebuilt OpenSSL libraries” will simplify things?

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/camcops/checkouts/latest/docs/source/developer/building_client.rst, line 145.)


IN PROGRESS ARM64 sudo apt-get install gcc-4.9-aarch64-linux-gnu

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/camcops/checkouts/latest/docs/source/developer/building_client.rst, line 399.)


Have the default ID number type configurable per group?

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/camcops/checkouts/latest/docs/source/introduction/patient_identification.rst, line 104.)


Width of dropdown boxes for dates/spinboxes is too small under Win10 in tablet mode.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/camcops/checkouts/latest/docs/source/introduction/requirements.rst, line 80.)


Check: ID/ED-3D “incorrect” sound not playing under Win10, even though “correct” sound works fine (and listed correctly in resource file, and working on other platorms). Investigate.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/camcops/checkouts/latest/docs/source/introduction/requirements.rst, line 85.)


This tour is a little outdated; apologies! The screenshots are of the older Javascript/Titanium application, not the newer C++/Qt application, and the server front end has also improved. We’ll update this when we can.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/camcops/checkouts/latest/docs/source/introduction/tour.rst, line 25.)


Exact text check.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/camcops/checkouts/latest/docs/source/tasks/ctqsf.rst, line 32.)


Standardized encoding?

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/camcops/checkouts/latest/docs/source/tasks/ctqsf.rst, line 33.)


Scoring system?

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/camcops/checkouts/latest/docs/source/tasks/ctqsf.rst, line 34.)


Reference RNC new method when published.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/camcops/checkouts/latest/docs/source/tasks/kirby_mcq.rst, line 117.)


IN PROGRESS +++ a/w funding before proceeding

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/camcops/checkouts/latest/docs/source/to_do.rst, line 41.)


Package CamCOPS client for easier Linux distribution.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/camcops/checkouts/latest/docs/source/user/client_installation.rst, line 115.)


Implement a simpler way to do this, without the need to re-register (which requires elevated privilege),

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/camcops/checkouts/latest/docs/source/user/client_uninstall_upgrade.rst, line 52.)