[redcap] REDCap UI

Makefile

@@ -262,3 +262,6 @@ electrophysiology_browser: $(filter modules/electrophysiology_browser/%,$(MOFILE
 
 dicom_archive: $(filter modules/dicom_archive/%,$(MOFILES)) $(filter modules/dicom_archive/%,$(I18NJSONFILES))
     target=dicom_archive npm run compile
+
+redcap: $(filter modules/redcap/%,$(MOFILES)) $(filter modules/redcap/%,$(I18NJSONFILES))
+    target=redcap npm run compile

SQL/0000-00-00-schema.sql

@@ -2708,3 +2708,26 @@ CREATE TABLE `redcap_notification` (
   PRIMARY KEY (`id`),
   KEY `i_redcap_notif_received_dt` (`received_dt`)
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+
+CREATE TABLE `redcap_dictionary` (
+    ID int(10) unsigned NOT NULL auto_increment,
+    InstrumentName varchar(255),
+    FieldName varchar(255) NOT NULL,
+    FieldRequired boolean NOT NULL,
+    FieldType varchar(20) NOT NULL,
+    FieldLabel text NOT NULL,
+    SectionHeader text,
+    Choices text,
+    FieldNote text,
+    TextValidationType varchar(50),
+    TextValidationMin varchar(50),
+    TextValidationMax varchar(50),
+    Identifier text,
+    BranchingLogic text,
+    CustomAlignment varchar(10),
+    QuestionNumber text,
+    MatrixGroupName varchar(100),
+    MatrixRanking varchar(50),
+    FieldAnnotation text,
+    PRIMARY KEY (`ID`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='All REDCap instrument fields and variables';

SQL/0000-00-02-Permission.sql

@@ -166,6 +166,7 @@ INSERT INTO `permissions` (code, description, moduleID, categoryID) VALUES
     ('dicom_archive_nosessionid', 'DICOMs with no session ID', (SELECT ID FROM modules WHERE Name='dicom_archive'),2),
     ('dicom_archive_view_ownsites', 'DICOMs - Own Sites', (SELECT ID FROM modules WHERE Name='dicom_archive'),2),
     ('view_instrument_data', 'Data', (SELECT ID FROM modules WHERE Name = 'instruments'),2),
+    ('redcap_ui_view','REDCap GUI - View',(SELECT ID FROM modules WHERE Name ='redcap'),2),
     ('biobank_specimen_view','View Specimen Data',(SELECT ID FROM modules WHERE Name='biobank'), '2'),
     ('biobank_specimen_create','Create Specimens',(SELECT ID FROM modules WHERE Name='biobank'), '2'),
     ('biobank_specimen_update','Process Specimens',(SELECT ID FROM modules WHERE Name='biobank'), '2'),
@@ -289,7 +290,8 @@ INSERT INTO `perm_perm_action_rel` (permID, actionID) VALUES
   ((SELECT permID FROM permissions WHERE code = 'biobank_fullprojectaccess'),1),
   ((SELECT permID FROM permissions WHERE code = 'view_instrument_data'),1),
   ((SELECT permID FROM permissions WHERE code = 'dqt_view'),1),
-  ((SELECT permID FROM permissions WHERE code = 'dqt_view'),8);
+  ((SELECT permID FROM permissions WHERE code = 'dqt_view'),8),
+  ((SELECT permID FROM permissions WHERE code = 'redcap_ui_view'),1);
 
 
 -- permissions for each notification module

SQL/9999-99-99-drop_tables.sql

@@ -103,6 +103,7 @@ DROP TABLE IF EXISTS `modules`;
 
 -- 0000-00-00-schema.sql
 DROP TABLE IF EXISTS `redcap_notification`;
+DROP TABLE IF EXISTS `redcap_dictionary`;
 
 DROP TABLE IF EXISTS `candidate_consent_rel`;
 DROP TABLE IF EXISTS `consent`;

SQL/New_patches/2025-07-10_REDCap_front_end_permission.sql

@@ -0,0 +1,38 @@
+-- adds the redcap_ui_view permission
+INSERT INTO permissions (code, description, moduleID, categoryID)
+    VALUES (
+        'redcap_ui_view',
+        'REDCap GUI - View',
+        (SELECT ID FROM modules WHERE Name ='redcap'),
+        (SELECT ID FROM permissions_category WHERE Description = 'Permission')
+    );
+
+INSERT INTO perm_perm_action_rel (permID, actionID)
+    VALUES (
+        (SELECT permID FROM permissions WHERE code = 'redcap_ui_view'),
+        (SELECT ID FROM permisssions_action WHERE name = 'View')
+    );
+
+-- adds the redcap dictionary table
+CREATE TABLE `redcap_dictionary` (
+    ID int(10) unsigned NOT NULL auto_increment,
+    InstrumentName varchar(255),
+    FieldName varchar(255) NOT NULL,
+    FieldRequired boolean NOT NULL,
+    FieldType varchar(20) NOT NULL,
+    FieldLabel text NOT NULL,
+    SectionHeader text,
+    Choices text,
+    FieldNote text,
+    TextValidationType varchar(50),
+    TextValidationMin varchar(50),
+    TextValidationMax varchar(50),
+    Identifier text,
+    BranchingLogic text,
+    CustomAlignment varchar(10),
+    QuestionNumber text,
+    MatrixGroupName varchar(100),
+    MatrixRanking varchar(50),
+    FieldAnnotation text,
+    PRIMARY KEY (`ID`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='All REDCap instrument fields and variables';

modules/redcap/jsx/redcapIndex.js

@@ -0,0 +1,66 @@
+import PropTypes from 'prop-types';
+import {TabPane, Tabs} from 'jsx/Tabs';
+import NotificationViewer from './tabs/notificationViewer';
+import DictionaryViewer from './tabs/dictionaryViewer';
+import IssuesViewer from './tabs/issuesViewer';
+import {createRoot} from 'react-dom/client';
+
+
+/**
+ * REDCap index view
+ *
+ * @param {array} props
+ * @return {JSX}
+ */
+export default function RedcapIndex(props) {
+  // list of tabs
+  const tabList = [
+    {id: 'notificationTable', label: 'Notifications'},
+    {id: 'dictionaryTable', label: 'Data Dictionary'},
+    {id: 'issuesTable', label: 'Issues'},
+  ];
+
+  return (
+    <>
+      <Tabs tabs={tabList} defaultTab='notificationTable' updateURL={true}>
+
+        {/* notifications */}
+        <TabPane TabId={tabList[0].id}>
+          <NotificationViewer baseURL={props.moduleURL} />
+        </TabPane>
+
+        {/* dictionary */}
+        <TabPane TabId={tabList[1].id}>
+          <DictionaryViewer baseURL={props.moduleURL} />
+        </TabPane>
+
+        {/* issues */}
+        <TabPane TabId={tabList[2].id}>
+          <IssuesViewer baseURL={props.baseURL} moduleURL={props.moduleURL} />
+        </TabPane>
+
+      </Tabs>
+    </>
+  );
+}
+
+RedcapIndex.propTypes = {
+  baseURL: PropTypes.string.isRequired,
+  moduleURL: PropTypes.string.isRequired,
+  hasPermission: PropTypes.func.isRequired,
+};
+
+/**
+ * Render REDCap main page on page load
+ */
+document.addEventListener('DOMContentLoaded', function() {
+  createRoot(
+    document.getElementById('lorisworkspace')
+  ).render(
+    <RedcapIndex
+      baseURL={loris.BaseURL}
+      moduleURL={loris.BaseURL + '/redcap'}
+      hasPermission={loris.userHasPermission}
+    />
+  );
+});