config.json

{
  "name": "Research IT Dashboard",
  "namespace": "Stanford\\ProjectPortal",
  "description": "A module that links redcap projects to Stanford Research Project Portal",
  "framework-version": 7,
  "versions": [
    {
      "0.1": "Initial Development Version"
    }
  ],
  "authors": [
    {
      "name": "Andy Martin",
      "email": "andy123@stanford.edu",
      "institution": "Stanford University"
    },
    {
      "name": "Ihab Zeedia",
      "email": "ihabz@stanford.edu",
      "institution": "Stanford University"
    }
  ],
  "permissions": [
    "redcap_every_page_top"
  ],
  "no-auth-pages": [
    "services",
    "cron/entity/check_overdue_payments",
    "cron/portal/process_ems",
    "ajax/notifications/get_projects"
  ],
  "links": {
    "project": [
      {
        "name": "REDCap R2P2 Dashboard",
        "icon": "fas fa-columns",
        "url": "views/index.php",
        "show-header-and-footer": true
      }
    ],
    "control-center": [
    ]
  },
  "system-settings": [
    {
      "key": "redcap-support-project",
      "name": "<b>Select the Support Project that will integrate REDCap intake form with RIT Portal.</b>",
      "type": "project-id"
    },
    {
      "key": "project-portal-api-token",
      "name": "<b>Token to be used to get user projects or update REDCap projects with Project Portal`s link.</b>",
      "type": "text"
    },
    {
      "key": "portal-username",
      "name": "<b>Enter the portal username that will be used to authenticate the integration between portal and redcap.</b>",
      "type": "text"
    },
    {
      "key": "portal-password",
      "name": "<b>Enter the portal username password that will be used to authenticate the integration between portal and redcap.</b>",
      "type": "text"
    },
    {
      "key": "portal-base-url",
      "name": "<b>Enter the portal base url to make the integration.</b>",
      "type": "text"
    },
    {
      "key": "external-modules-manager-redcap-project",
      "name": "<b>Set External Modules Manager REDCap project to allow dashboard to communicate with it.</b>",
      "type": "project-id",
      "default": "16000"
    },
    {
      "key": "external-modules-manager-em",
      "name": "<b>Set External Modules Manager EM to allow dashboard to communicate with it.</b>",
      "type": "text"
    },
    {
      "key": "access-token",
      "name": "<b>Current Access JWT token to R2P2</b>",
      "type": "text"
    },
    {
      "key": "refresh-token",
      "name": "<b>Current Refresh JWT token to R2P2</b>",
      "type": "text"
    },
    {
      "key": "expiry-timestamp",
      "name": "<b>Expiration Unix timestamp for current access token</b>",
      "type": "text"
    },
    {
      "key": "refresh-expiry-timestamp",
      "name": "<b>Expiration Unix timestamp for current Refresh token</b>",
      "type": "text"
    },
    {
      "key": "ip_whitelist",
      "name": "IP Whitelist",
      "type": "sub_settings",
      "repeatable": true,
      "sub_settings": [
        {
          "key": "ip",
          "name": "IP address or CIDR notation (e.g. 192.168.123.1/24). Create a new subsetting for each IP address.",
          "required": false,
          "type": "text"
        }
      ]
    },
    {
      "key": "linked-portal-projects",
      "name": "<b>JSON for all linked projects</b>",
      "required": false,
      "type": "textarea"
    },
    {
      "key": "rit-dashboard-main-header",
      "name": "RIT Project Dashboard Main Header",
      "required": false,
      "type": "rich-text"
    },
    {
      "key": "rit-dashboard-ticket-tab-header",
      "name": "Ticket Tab Header",
      "required": false,
      "type": "rich-text"
    },
    {
      "key": "rit-dashboard-portal-linkage-tab-header",
      "name": "Portal Linkage Tab Header",
      "required": false,
      "type": "rich-text"
    },
    {
      "key": "rit-dashboard-external-modules-tab-header",
      "name": "External Modules Tab Header",
      "required": false,
      "type": "rich-text"
    },
    {
      "key": "rit-dashboard-line-items-tab-header",
      "name": "External Modules Tab Header",
      "required": false,
      "type": "rich-text"
    },
    {
      "key": "enable-system-debug-logging",
      "name": "<b>Enable Debug Logging (system-wide)</b>",
      "required": false,
      "type": "checkbox"
    },
    {
      "key": "emails_templates",
      "name": "Email template",
      "required": true,
      "type": "sub_settings",
      "repeatable": true,
      "sub_settings": [
        {
          "key": "template_name",
          "name": "Email Template Name",
          "required": true,
          "type": "text"
        },
        {
          "key": "template_subject",
          "name": "Email Template Subject",
          "required": true,
          "type": "text"
        },
        {
          "key": "template_body",
          "name": "Email Template Body",
          "required": true,
          "type": "rich-text"
        }
      ]
    }
  ],
  "project-settings": [
  ],
  "crons": [
    {
      "cron_name": "project_rma_check",
      "cron_description": "Check projects in Prod status if RMA in place or not. ",
      "method": "checkProjectsRMACron",
      "cron_frequency": "86400",
      "cron_max_run_time": "3600"
    },
    {
      "cron_name": "process_em_charges",
      "cron_description": "This Cron will replicate EM charges to a table in R2P2. Also, it will process custom charges and replicate them into R2P2.",
      "method": "processCustomCharges",
      "cron_frequency": "86400",
      "cron_max_run_time": "3600"
    }
  ]
}