config.json

{
  "name": "Shazam",

  "namespace":"Stanford\\Shazam",

  "description": "A module for applying REDCap inputs into tabular or other custom layouts for surveys and data entry forms",

  "versions": [
    {
      "0.1": "Initial Development Version on EMs",
      "1.0.2": "Bug fixes around survey shazam with labels",
      "1.1.0": "Added support for widgets and multiple bug fixes",
      "1.1.1": "Fixed bug reported by Mark on label option",
      "1.1.2": "Fixed js saving bug and isDev bug",
      "1.1.3": "Hide Shazam Setup for only design users",
      "1.1.4": "Extensive bug fixing to make it more robust across questions types and survey/data entry",
      "1.1.5": "Fixed issue with js passthru and ExternalModules prior to 8.4.3",
      "1.1.6": "Fixed label issue with descriptive fields",
      "1.1.9": "Last version for boostrap 3",
      "1.2.0": "Boostrap 4 version",
      "1.2.1": "Fix release issue that made 1.2.0 really the same as 1.1.9",
      "1.2.2": "Bug fix around matrix fields",
      "1.3.0": "Fixed issue with matrix groups, changed logging, added backup versions",
      "1.3.1": "Bug fix for permissions of survey users to save updated shazam",
      "1.3.2": "Another attempt at fixing matrix group formatting",
      "1.3.3": "Added option to skip API url passthru",
      "1.3.4": "Added option to have Shazam call a function before it renders the page so other modules can do stuff",
      "1.3.5": "fixed issue around bug in em framework and emlogger integration",
      "1.3.6": "another logging fix",
      "1.3.7": "escape descriptive field info",
      "1.3.8": "Adding option to allow select regular users to edit javascript",
      "1.3.9": "Fix for PHP8 around count",
      "1.3.10": "Fix for PHP8 around SUPER_USER constant",
      "1.3.11": "Another fix for php8 around javascript allow_users array",
      "1.3.12": "Another release to address psalm detection issues",
      "1.3.13": "Address odd crashing issue with php syntax for methods changing with php 8.x - oddly, it works for me but not on some other servers.  Also updated framework to v9"
    }
  ],

  "authors": [
    {
      "name": "Andy Martin",
      "email": "andy123@stanford.edu",
      "institution": "Stanford University"
    },
    {
      "name": "YongJae Lee",
      "email": "jael@stanford.edu",
      "institution": "Stanford University"
    },
    {
      "name": "Jordan Schultz",
      "email": "jmschult@stanford.edu",
      "institution": "Stanford University"
    }
  ],

  "framework-version": 9,

  "permissions": [
    "redcap_survey_page_top",
    "redcap_data_entry_form_top",
    "redcap_every_page_top"
  ],

  "links": {
    "control-center": [
    ],
    "project": [
      {
        "name": "Shazam Setup",
        "icon": "gear",
        "url": "config.php"
      }
    ]
  },

  "system-settings": [
    {
      "key": "enable-system-debug-logging",
      "name": "<b>Enable Debug Logging</b><br>If you have the Stanford emLogger external module installed and configured, you can enable additional debug-level logging through this checkbox.  Note that this will enable debugs for ALL Shazam projects.  You can alternatively enable it on a per-project basis by going that that project's Shazam EM configuration page",
      "required": false,
      "type": "checkbox"
    },
    {
      "key": "do-not-use-api-endpoint",
      "name": "<b>Do NOT use API Endpoint for Public URLs</b><br>This should be left unchecked unless you are having issues loading js files on public surveys or if your site blocks public access to the api endpoint",
      "type": "checkbox"
    },
    {
      "key": "shazam-inline-js",
      "name": "<b>Deliver JavaScript inline</b><br>This work-around will deliver javascript inline instead of making a script tag back to the server.  Only use if your API-endpoint is not open to the Internet",
      "type": "checkbox"
    },
    {
      "key": "enable-add-user-javascript-permissions",
      "name": "<b>Enable user whitelist for javascript editing</b><br>If checked, superusers can grant regular users the ability to edit Shazam javascript on a per project basis",
      "type": "checkbox"
    },
    {
      "key": "notification-email-from-address",
      "name": "<b>Email From Address</b><br>When you grant javascript editing rights an email is sent from this address  (e.g. no-reply@myredcap.com or help@myredcap.com)<br>If left unset, the default will be the superuser ",
      "required": false,
      "type": "email"
    },
    {
      "key": "notification-email-header",
      "name": "<b>Notification Email Header</b><br>This is the body of the email sent to notify users of javascript edit rights",
      "required": false,
      "type": "rich-text"
    }
  ],

  "project-settings": [
    {
      "key": "shazam-descriptive",
      "name": "<b>This module is configured by a link on the sidebar called 'Shazam Setup'.</b><br><i>The actual config is stored in a hidden shazam-config external module variable</i>",
      "type": "descriptive"
    },
    {
      "key": "shazam-display-icons",
      "name": "<b>Display Data History & Field Comment Log/Data Resolution Workflow Icons</b><br>You can also enable these icons for just a particular input by adding the class <code>shazam-icons</code> to a particular input field",
      "type": "checkbox"
    },
    {
      "key": "enable-project-debug-logging",
      "name": "<b>Enable Stanford emLogger Logging</b><br>If you have the Stanford emLogger external module installed and configured, you can enable additional debug-level logging for this project",
      "required": false,
      "type": "checkbox"
    },
    {
      "key": "enable-project-console-logging",
      "name": "<b>Enable Console Debug Logging</b><br>You can enable debug-level logging to the browser console for this project",
      "type": "checkbox"
    }
  ],

  "compatibility": {
    "php-version-min": "5.6.0",
    "redcap-version-min": "9.1.1"
  }


}