config.json

{
  "name": "EPV At-A-Glance Dashboard",

  "namespace": "Vanderbilt\\DashboardAnalysisPlatformExternalModule",
  "framework-version": 5,
  "authors": [
    {
      "name": "Eva Bascompte Moragas",
      "email": "datacore@vumc.org",
      "institution": "Vanderbilt University Medical Center"
    }
  ],

  "permissions": ["redcap_module_link_check_display"],

  "links": {
    "project": [
      {
        "name": "Dashboard Analysis Platform",
        "icon": "fas fa-chart-area",
        "url": "index.php",
        "target": "_blank"
      }
    ]
  },

  "no-auth-pages":["index","login","login_link","loadTable","stats_and_charts","plot_chart","dashboard_private","dashboard_public"],

  "description": "A dashboard to visualize participant perception scores from the Research Participant Perception Survey (RPPS). This module works with any of the RPPS instruments in the REDCap Instrument Library.",

  "project-settings": [
    {
      "key": "privacy-description",
      "name": "<div>Select a privacy type for the Dashboard:</div><br><div class='alert alert-info' style='border-color:#bce8f1 !important'><ul><li><strong>Local</strong> Only users logged into this REDCap instance and having project design rights on this project can access the dashboard.</li><li><strong>Consortium</strong> Allows for access to dashboard with tokens emailed to external users. Requires a project registration REDCap project.</li><li><strong>Public</strong> No authentication. Allows access to dashboard for anyone with the link.</li></ul></div>",
      "type": "descriptive"
    },
    {
      "key": "privacy",
      "name": "Privacy type",
      "required": true,
      "choices": [
        {
          "name": "Local",
          "value": "local"
        },
        {
          "name": "Consortium",
          "value": "private"
        },
        {
          "name": "Public",
          "value": "public"
        }
      ],
      "type":"radio"
    },
    {
      "key": "stop-cron",
      "name": "Stop Nightly Dashboard Update",
      "type": "checkbox"
    },
    {
      "key": "display-graph-by-site",
      "name": "Display graphs for sites.<br><em>Sites are designed by any values before a hyphen \"-\" in the record_id</em>",
      "type": "checkbox"
    },
    {
      "key": "banner",
      "name": "Add text that will diplay at the top of the page as a banner.",
      "type": "textarea"
    },
    {
      "key": "path",
      "name": "Specify a S3 path to save the cache file",
      "type": "text"
    },
    {
      "key": "registration",
      "name": "Specify the Project ID from the Project Registration.",
      "type": "text",
      "required": true,
      "branchingLogic": {
        "field": "privacy",
        "value": "private"
      }
    },
    {
      "key": "registration_from",
      "name": "Specify the FROM email address for the access link emails.",
      "type": "text",
      "required": true,
      "branchingLogic": {
        "field": "privacy",
        "value": "private"
      }
    },
    {
      "key": "warning",
      "name": "<div class='alert alert-info' style='border-color:#bce8f1 !important'><strong>NOTE</strong>: Specify up to 10 custom filters</a>",
      "type": "descriptive"
    },
    {
      "key": "custom",
      "name": "Custom Site Filters",
      "type": "sub_settings",
      "repeatable": true,
      "sub_settings": [
        {
          "key": "custom-filter",
          "name": "Select the field to add as a new filter.",
          "type": "field-list"
        }
      ]
    },
    {
      "key": "report",
      "name": "Custom Report",
      "type": "sub_settings",
      "repeatable": true,
      "sub_settings": [
        {
          "key": "custom-report-id",
          "name": "Unique Report ID",
          "type": "text"
        },
        {
          "key": "custom-report-label",
          "name": "Report Label",
          "type": "text"
        }
      ]
    }
  ],

  "crons": [
    {
      "cron_name": "dashboard_cache_file",
      "cron_description": "Cron that runs once a day to save all dashboard data",
      "method": "dashboardCacheCron",
      "cron_frequency": "21600",
      "cron_max_run_time": "86400"
    },
    {
      "cron_name": "dashboard_cache_file_report",
      "cron_description": "Cron that runs once a day to save all dashboard Report data",
      "method": "dashboardCacheCron",
      "cron_frequency": "21600",
      "cron_max_run_time": "86400"
    },
    {
      "cron_name": "dashboard_cache_file_graph",
      "cron_description": "Cron that runs once a day to save all dashboard Graph data",
      "method": "dashboardCacheCron",
      "cron_frequency": "21600",
      "cron_max_run_time": "86400"
    },
    {
      "cron_name": "dashboard_cache_file_graph_report",
      "cron_description": "Cron that runs once a day to save all dashboard Graph data on Report data",
      "method": "dashboardCacheCron",
      "cron_frequency": "21600",
      "cron_max_run_time": "86400"
    }
  ],

  "compatibility": {
    "php-version-min": "7.3",
    "php-version-max": "",
    "redcap-version-min": "10.0.0",
    "redcap-version-max": ""
  }
}