config.json

{
	"name": "Duster",

	"namespace": "Stanford\\Duster",

	"description": "A self-service tool for researchers to automatically import clinical data into REDCap projects",

	"framework-version": 9,

	"documentation": "README.md",

	"authors": [
		{
			"name": "Jonasel Roque",
			"email": "jonaselr@stanford.edu",
			"institution": "Stanford University & Stanford Health Care"
		}
	],

	"permissions": [
		"redcap_every_page_top"
	],

	"enable-every-page-hooks-on-system-pages": true,

	"links": {
		"project": [
			{
				"name": "DUSTER: Get Data",
				"key": "dusterdata",
				"icon": "fas fa-receipt",
				"url": "pages/populateData.php",
				"show-header-and-footer": true
			},
			{
				"name": "DUSTER: Edit Project",
				"key": "dustereditproject",
				"icon": "fas fa-pen-to-square",
				"url": "pages/editProject.php",
				"show-header-and-footer": true
			}
		],
		"control-center": [
			{
				"name": "DUSTER: Refresh Server side metadata",
				"key": "metadata-refresh",
				"icon": "fas fa-receipt",
				"url": "services/refreshMetadata.php",
				"show-header-and-footer": true
			}
		]
	},

	"no-auth-pages": [
		"services/getData",
		"services/refreshMetadata"
	],

	"project-settings": [
		{
			"key": "enable-project-debug-logging",
			"name": "<b>Enable Debug Logging</b><br><i>(optional)</i> Requires installation and configuration of emLogger",
			"required": false,
			"type": "checkbox"
		}
	],

	"system-settings": [
		{
			"key": "enable-system-debug-logging",
			"name": "<b>Enable Debug Logging (system-wide)</b><i>(optional)</i> Requires installation and configuration of emLogger",
			"required": false,
			"type": "checkbox"
		},
		{
			"key": "starrapi-metadata-url",
			"name": "STARR-API Metadata Webservice URL",
			"required": true,
			"type": "text"
		},
		{
			"key": "starrapi-config-url",
			"name": "STARR-API Config Webservice URL",
			"required": true,
			"type": "text"
		},
    	{
      		"key": "starrapi-dataset-design-url",
      		"name": "STARR-API Dataset Design URL",
      		"required": true,
      		"type": "text"
    	},
		{
			"key": "starrapi-data-url",
			"name": "STARR-API Data Webservice URL",
			"required": true,
			"type": "text"
		},
		{
			"key": "duster-email",
			"name": "<b>Error notification email</b>",
			"required": false,
			"type": "text"
		},
		{
			"key": "get-data-limit",
			"name": "<b>Maximum number of records for Get Data (default is 600)</b>",
			"required": false,
			"type": "text",
			"validation" : "number"
		},
		{
			"key": "server-type",
			"name": "<b>Server Type</b><br>server environment flag for REDCap URL",
			"required": true,
			"type": "dropdown",
			"choices": [
				{
					"value": "local",
					"name": "Local"
				},
				{
					"value": "development",
					"name": "Development"
				},
				{
					"value": "production",
					"name": "Production"
				}
			]
		},
		{
			"key": "enable-allowlist",
			"name": "<b>Enable Allow List</b>",
			"required": false,
			"type": "checkbox"
		},
		{
			"key": "allowlist",
			"name": "SUNet Allowlist",
			"required": false,
			"type": "sub_settings",
			"branchingLogic" : {
				"field": "enable-allowlist",
				"op": "=",
				"value" : true
			},
			"sub_settings": [
				{
					"key": "sunet",
					"name": "SUNet",
					"required": false,
					"type": "text",
					"repeatable": true

				}
			]
		}

	],

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