config.json

{
	"name": "Example Module",

	"namespace": "Vanderbilt\\ExampleExternalModule",

	"authors": [
		{
			"name": "Mark McEver",
			"email": "mark.mcever@vanderbilt.edu",
			"institution": "Vanderbilt University Medical Center"
		}
	],

	"permissions": [
		"hook_every_page_top",
		"select_data",
		"update_data",
		"delete_data",
		"update_user_permissions"
	],

	"description": "This module contains example code and configuration for all common External Module functionality to provide module developers working examples.  Please add examples here as new External Module features are added!",

	"links": {
		"control-center": [
			{
				"name": "My Control Center Menu Link",
				"icon": "user",
				"url": "system_level_homepage.php"
			}
		],
		"project": [
			{
				"name": "My Project Menu Link",
				"icon": "report",
				"url": "project_homepage.php"
			}
		]
	},

	"system-settings": [
		{
			"key": "project-menu-background-css",
			"name": "Project Menu Background CSS",
			"required": false,
			"allow-project-overrides": true,
			"type": "text",
			"default": "#e2ca9c"
		},
		{
			"key": "preferred-transportation",
			"name": "Preferred Method of Transportation",
			"required": true,
			"allow-project-overrides": false,
			"type": "radio",
			"default": "car",
			"choices": [
				{ "value": "car", "name": "Car" },
				{ "value": "bus", "name": "Bus" },
				{ "value": "bike", "name": "Bicycle" }
			]
		}
	],
	
	"project-settings": [
		{
			"key": "literate",
			"name": "I certify that I am literate",
			"required": true,
			"type": "checkbox"
		},
		{
			"key": "likes-pizza",
			"name": "Do you like pizza?",
			"required": false,
			"type": "dropdown",
			"choices": [
				{ "value": "1", "name": "Yes" },
				{ "value": "0", "name": "No" }
			]
		},
		{
			"key": "pages",
			"name": "Any Number of Pages to Look at",
			"required": false,
			"repeatable": true,
			"type": "text"
		},
		{
			"key": "forms",
			"name": "Form to act upon",
			"required": false,
			"repeatable": false,
			"type": "form-list"
		},
		{
			"key": "fields",
			"name": "Fields to inspect",
			"required": false,
			"repeatable": true,
			"type": "field-list"
		},
		{
			"key": "dags",
			"name": "Data Access Groups",
			"required": false,
			"repeatable": false,
			"type": "dag-list"
		},
		{
			"key": "user-roles",
			"name": "User Roles",
			"required": false,
			"repeatable": false,
			"type": "user-role-list"
		},
		{
			"key": "users",
			"name": "Users",
			"required": false,
			"repeatable": false,
			"type": "user-list"
		},
		{
			"key": "emails",
			"name": "Email forms",
			"required": true,
			"type": "sub-settings",
			"repeatable": true,
			"sub_settings":[
				{
					"key": "form-name",
					"name": "Form name",
					"required": true,
					"type": "form-list"
				},
				{
					"key": "email",
					"name": "Email Address",
					"required": true,
					"type": "text"
				},
				{
					"key": "email-subject",
					"name": "Email Subject",
					"required": true,
					"type": "text"
				},
				{
					"key": "email-text",
					"name": "Email Text",
					"required": true,
					"type": "textarea"
				}
			]
		}
	]
}