New Data Dictionary framework and module

SQL/0000-00-01-Modules.sql

@@ -23,6 +23,7 @@ INSERT INTO modules (Name, Active) VALUES ('data_release', 'Y');
 INSERT INTO modules (Name, Active) VALUES ('datadict', 'Y');
 INSERT INTO modules (Name, Active) VALUES ('dataquery', 'Y');
 INSERT INTO modules (Name, Active) VALUES ('dicom_archive', 'Y');
+INSERT INTO modules (Name, Active) VALUES ('dictionary', 'Y');
 INSERT INTO modules (Name, Active) VALUES ('document_repository', 'Y');
 INSERT INTO modules (Name, Active) VALUES ('examiner', 'Y');
 INSERT INTO modules (Name, Active) VALUES ('genomic_browser', 'Y');

SQL/New_patches/2021-03-31-NewDictionaryModule.sql

@@ -0,0 +1 @@
+INSERT INTO modules (Name, Active) VALUES ('dictionary', 'Y');

modules/dictionary/.gitignore

@@ -0,0 +1 @@
+js/*

modules/dictionary/README.md

@@ -0,0 +1,53 @@
+# Data Dictionary
+
+## Purpose
+
+The dictionary module is used for viewing and modifying the
+LORIS data dictionary for installed and active modules.
+
+## Scope
+
+The module displays and manages the data dictionary for modules
+which provide a dictionary, and allows users to override the
+descriptions provided.
+
+It does not provide a way to enter new fields into the data dictionary,
+doing so requires updating or creating a new module which provides
+a dictionary.
+
+## Permission
+
+The `data_dict_view` permission allows the user to view the LORIS
+data dictionary.
+
+The `data_dict_edit` permission allows the user to both view, and
+modify the description of, rows in the data dictionary.
+
+## Configuration
+
+None
+
+## Notes
+
+The field names should be unique (see interactions below).
+
+Instruments must implement the getDataDictionary method. The
+`LorisFormDictionaryImpl` trait can be used to implement the
+dictionary in the same way that the `data_dictionary_builder`
+script populates the `parameter_type` table for the `data_dict`
+module. However, this is done on a heuristic best-effort basis.
+Data can be described more accurately described by implementing
+the function manually.
+
+## Interactions with LORIS
+
+The `dictionary` module uses the same override descriptions as
+the `data_dict` module so that users do not need to modify the
+description twice as the dictionary is migrated to being managed
+by modules. This means that the name of fields should be unique
+across LORIS until the `data_dict` module is retired.
+
+Modules such as the data query module may use this module as
+an API to get a list of fields to be displayed and determine
+their scope, cardinality, and (possibly overriddens) description for
+context sensitive display purposes.

modules/dictionary/help/dictionary.md

@@ -0,0 +1,17 @@
+# Data Dictionary
+
+This module houses definitions or descriptions for the data fields in LORIS.
+
+Use the *Selection Filter* section to search for specific fields. Your results will be displayed in the data table below. 
+
+Click on the pencil icon to override the *Description* of a field - this should be done with caution. When a field description is modified, the new description is used in the Data Query Tool (after it is refreshed), by users who are selecting data fields to analyze or download. The modified field description will not be visible in the instrument form into which a user or survey participant enters data.
+
+The *Data Scope* column represents the scope that the dictionary item corresponds to and can be
+either "candidate" or "session".
+
+The *Data Cardinality* describes how many items of the dictionary type may exist per scope.
+It may be one of:
+- **Unique** -- there is a single value across all entities of the scope (ie. an unique candidate identifier for a candidate or a visit label for a session)
+- **Single** -- There is exactly one value per entity of the scope
+- **Optional**  -- There may be one or zero values per entity of the scope
+- **Many** -- There may be zero or more values associated with entities of the scope