config.json

{
	"name": "Data Model Browser",

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

	"permissions": [],

	"links": {
		"project": [
			{
				"name": "Data Model Browser",
				"icon": "fas fa-database",
				"url": "browser.php?NOAUTH",
				"target": "_blank"
			}
		]
	},

	"no-auth-pages":["browser","downloadFile","startDDProjects","functions", "main","options/downloadPDF_AJAX"],

	"description": "This module’s main use is to create an auto-generated, web-browsable version of a Data Exchange Standard, a common data model for sharing.",

	"project-settings": [
		{
			"key": "des-disable-crons",
			"name": "<div>Disable Crons</div><font style='color:red;font-style:italic'>*This will stop all crons from running and will not generate JSON files overnight</font>",
			"type": "checkbox"
		},
		{
			"key": "des-projectname",
			"name": "Enter the Project name",
			"required": true,
			"type": "text"
		},
		{
			"key": "des-privacy-description",
			"name": "<div>Select a privacy type for the Data Model Browser:</div><br><div class='alert alert-info' style='border-color:#bce8f1 !important'><ul><li><strong>Public</strong> (no login required; anyone with the link can view the Browser page)</li><li><strong>This Project's users only</strong> (REDCap login required; only this project's users can view the Browser page)</li><li><strong>Another Project's users </strong> (REDCap login required; only users from another project can view the Browser page. You can only select other projects where you have Project Setup rights.)</li></ul></div>",
			"type": "descriptive"
		},
		{
			"key": "des-privacy",
			"name": "Privacy type",
			"required": true,
			"choices": [
				{
					"name": "Public",
					"value": "public"
				},
				{
					"name": "This Project's users only",
					"value": "main"
				},
				{
					"name": "Another Project's users",
					"value": "other"
				}
			],
			"type":"radio"
		},
		{
			"key": "projects",
			"name": "Select the project/s whose people can access the FAQ",
			"type": "sub_settings",
			"repeatable":true,
			"branchingLogic": {
				"field": "des-privacy",
				"op":"=",
				"value": "other"
			},
			"sub_settings":[
				{
					"key": "des-project",
					"name": "Project",
					"type": "project-id"
				}
			]
		}
		,{
			"key": "users",
			"name": "User Permissions",
			"type": "sub_settings",
			"repeatable": true,
			"sub_settings": [
				{
					"key": "user-permission",
					"name": "<div>Select a REDCap user to add to all Hub projects. </div><div>This will automatically add the user to the 5+ REDCap projects that power the Hub. The user will have \"Project Design and Setup\" rights on those projects. After initial setup, users will need to be added manually to all Hub projects.</div><br><div><font style='color:red;font-style:italic'>*This list shows all users on this REDCap project. Add users to this project before installing if you want to be able to select their usernames in this list.</font></div>",
					"type": "user-list"
				}
			]
		}
	],
	"crons": [
		{
			"cron_name": "createpdf",
			"cron_description": "Cron that runs once a day to check if there are changes and create a JSON/PDF",
			"method": "createpdf",
			"cron_frequency": "21600",
			"cron_max_run_time": "3600"
		},
		{
			"cron_name": "regeneratepdf",
			"cron_description": "Cron that regenerates the PDF if the checkbox has been selected",
			"method": "regeneratepdf",
			"cron_frequency": "60",
			"cron_max_run_time": "60"
		}
	],
	"compatibility": {
		"php-version-min": "8.2.25",
		"php-version-max": "",
		"redcap-version-min": "12.2.7",
		"redcap-version-max": ""
	}
}