config.json

{
	"name": "PubMed Search",

	"namespace": "Vanderbilt\\PubmedSearchExternalModule",

	"description": "This module takes last_name and first_name fields and downloads all PubMed entries for that name. It puts the PubMed entries into another REDCap field. It also requires one helper text field. It checks PubMed once a day for new entries. Because of inaccuracies of the process, it is recommended that human eyes manually oversee the download process.",

	"authors": [
		{
			"name": "Scott J. Pearson",
			"email": "datacore@vumc.org",
			"institution": "Vanderbilt University Medical Center"
		},
		{
			"name": "Andy Martin",
			"email": "andy123@stanford.edu",
			"institution": "Stanford University"
		},
		{
			"name": "Jae Lee",
			"email": "jael@stanford.edu",
			"institution": "Stanford University"
		},
		{
			"name": "Devin Cowan",
			"email": "devin.r.cowan@dartmouth.edu",
			"institution": "Dartmouth College"
		}
	],
	"framework-version": 5,

	"permissions": [
		"redcap_data_entry_form_top",
		"hook_survey_page_top"
	],

	"no-auth-pages":["ajax"],

	"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"
		}
	],

	"project-settings": [
		{
			"key": "record_id",
			"name": "Record ID Field (first field)",
			"required": true,
			"type": "field-list"
		},
		{
			"key": "first_name",
			"name": "First name/initial field",
			"required": true,
			"type": "field-list"
		},
		{
			"key": "last_name",
			"name": "Last name/initial field",
			"required": true,
			"type": "field-list"
		},
		{
			"key": "citations",
			"name": "Citations field (Must be on non-repeatable form/event)",
			"required": true,
			"type": "field-list"
		},
		{
			"key": "count",
			"name": "Citations count field (Must be on non-repeatable form/event)",
			"required": true,
			"type": "field-list"
		},
		{
			"key": "helper",
			"name": "Helper text field (can be @HIDDEN) that stores which PubMed Ids are downloaded. (Must be on non-repeatable form/event.)",
			"required": true,
			"type": "field-list"
		},
		{
			"key": "institution",
			"name": "Institution to search everyone for (use short name like Vanderbilt, not a long name; do not use initials)",
			"required": true,
			"type": "text"
		},
		{
			"key": "institution_fields",
			"name": "Fields which possibly contain institution information for each record",
			"required": true,
			"repeatable": true,
			"type": "field-list"
		},
		{
			"key": "edit-citations",
			"name": "<b>Make citations fields editable</b><br>By default, the fields marked as read-only to reduce confusion",
			"required": false,
			"type": "checkbox"
		},
		{
			"key": "enable-cron",
			"name": "<b>Enable CRON</b><br>By default, cron jobs are not enabled. If you enable, pubmed citations will be fetched on the backend at a regular interval and users will not be able to modify them.",
			"required": false,
			"type": "checkbox"
		},
		{
			"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"
		},
		{
			"key": "enable-js-debug",
			"name": "<b>Enable javascript debugging</b>",
			"required": false,
			"type": "checkbox"
		}
	],
	"crons": [
		{
			"cron_name": "pubmed_cron",
			"cron_description": "PubMed Cron",
			"method": "pubmed",
			"cron_frequency": "604800",
			"cron_max_run_time": "14400"

		}
	]
}