config.json

{
    "name": "Pediatric Acute Care Data Mirror",
    "namespace": "Stanford\\PACE",
    "description": "This module mirrors Rhapsode data in REDCap",
    "documentation": "README.md",
    "authors": [
        {
            "name": "Jordan Schultz",
            "email": "jmschult@stanford.edu",
            "institution": "Stanford University"
        }
    ],
    "framework-version": 13,

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

    "enable-no-auth-logging": true,

    "no-auth-pages": [
        "cron/mirrorRhapsode"
    ],

    "links": {
        "project": [
            {
                "name": "Refresh Rhapsode Data",
                "icon": "gear",
                "url": "cron/mirrorRhapsode.php",
                "show-header-and-footer": true
            }
        ]
    },


    "system-settings": [
        {
            "key": "rhapsode-username",
            "name": "<b>Rhapsode Username</b><br>Login username used to authenticate REST calls",
            "required": true,
            "type": "text"
        },
        {
            "key": "rhapsode-password",
            "name": "<b>Rhapsode Password</b><br>Login password used to authenticate REST calls",
            "required": true,
            "type": "text"
        },
        {
            "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": "rhapsode-url",
            "name": "<b>Rhapsode API Url Entry</b><br>The API endpoint(s) called on the Rhapsode Client",
            "required": true,
            "repeatable":true,
            "type": "sub_settings",
            "sub_settings":[
                {
                    "key": "preset-url",
                    "name": "<b>API url</b><br>The actual API url to call in each request",
                    "type": "text",
                    "required": true
                },
                {
                    "key": "preset-type",
                    "name": "<b>Learning progress preset</b><br>Set true if the API url for this entry contains the Knowledge & Learning progress fields on Rhapsode",
                    "type": "dropdown",
                    "choices": [
                        {
                            "name": "False",
                            "value": 0
                        },
                        {
                            "name": "True",
                            "value": 1
                        }

                    ],
                    "required": true
                }

            ]
        },
        {
            "key": "mapping-fields-description",
            "type": "descriptive",
            "name": "<h5><strong>Learner field mapping designations</strong></h5><i>Each Rhapsode field below should be mapped to a REDCap field to store its corresponding data</i>"
        },
        {
            "key": "rhapsode_activity_last_week",
            "name": "<b>Activity Last week</b><br>REDCap Field that 'activity last week' <i>(Rhapsode variable)</i> will be mirrored to",
            "required": true,
            "type": "field-list"
        },
        {
            "key": "rhapsode_learning_progress",
            "name": "<b>Learning Progress Field</b><br>REDCap Field that 'learning progress' % <i>(Rhapsode variable)</i> will be mirrored to",
            "required": true,
            "type": "field-list"
        },
        {
            "key": "rhapsode_auto_refresh",
            "name": "<b>Automatically Refresh</b><br>REDCap Field that 'automatically refresh' <i>(Rhapsode variable)</i> will be mirrored to",
            "required": true,
            "type": "field-list"
        },
        {
            "key": "rhapsode_refresh_knowledge",
            "name": "<b>Refresh Knowledge</b><br>REDCap Field that 'refresh knowledge' <i>(Rhapsode variable)</i> will be mirrored to",
            "required": true,
            "type": "field-list"
        },
        {
            "key": "rhapsode_refresher_progress",
            "name": "<b>Refresher Progress Field</b><br>REDCap Field that 'overall refresher progress' % <i>(Rhapsode variable)</i> will be mirrored to",
            "required": true,
            "type": "field-list"
        },
        {
            "key": "mapping-fields-description-2",
            "type": "descriptive",
            "name": "<h5><strong> 6 Class field mapping designations</strong></h5><i>Each Rhapsode field below should be mapped to a REDCap field to store its corresponding data</i>"
        },
        {
            "key": "rhapsode_difficulty_breathing",
            "name": "<b>Difficulty Breathing Field</b><br>REDCap Field that 'Difficulty breathing' % <i>(Rhapsode variable)</i> will be mirrored to",
            "required": true,
            "type": "field-list"
        },
        {
            "key": "rhapsode_term_birth_b",
            "name": "<b>Term Birth B Field</b><br>REDCap Field that 'Term Birth B' % <i>(Rhapsode variable)</i> will be mirrored to",
            "required": true,
            "type": "field-list"
        },
        {
            "key": "rhapsode_body_swelling",
            "name": "<b>Body Swelling Field</b><br>REDCap Field that 'Body Swelling' % <i>(Rhapsode variable)</i> will be mirrored to",
            "required": true,
            "type": "field-list"
        },
        {
            "key": "rhapsode_fever",
            "name": "<b>Fever Field</b><br>REDCap Field that 'Fever' % <i>(Rhapsode variable)</i> will be mirrored to",
            "required": true,
            "type": "field-list"
        },
        {
            "key": "rhapsode_term_birth_a",
            "name": "<b>Term Birth A Field</b><br>REDCap Field that 'Term Birth A' % <i>(Rhapsode variable)</i> will be mirrored to",
            "required": true,
            "type": "field-list"
        },
        {
            "key": "rhapsode_diarrhea",
            "name": "<b>Diarrhea Field</b><br>REDCap Field that 'Diarrhea' % <i>(Rhapsode variable)</i> will be mirrored to",
            "required": true,
            "type": "field-list"
        },
        {
            "key": "mapping-fields-description-3",
            "type": "descriptive",
            "name": "<h5><strong>Misc Fields</strong></h5>"
        },
        {
            "key": "rhapsode_last_updated",
            "name": "<b>Last Updated</b><br>REDCap Field that records the timestamp of last CRON run",
            "required": false,
            "type": "field-list"
        },
        {
            "key": "rhapsode_last_offset",
            "name": "<b>Last Offset value</b><br>Offset value used by API to determine which week to stop pulling participant data (After specified week, pulling will stop)",
            "required": true,
            "type": "text"
        }

    ],
    "crons": [
        {
            "cron_name": "mirror_rhapsode_data",
            "cron_description": "This cron will run weekly, hitting the Rhapsode API and massaging data in a format REDCap can consume.",
            "method": "callCron",
            "cron_frequency": "86400",
            "cron_max_run_time": "3600"
        }
    ],

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