Project setup

Once REDCap has been installed, a myARCH REDCap project can be created. The following describes the steps on how to setup such a project:

1. (If authentication is enabled) Point a web browser to the home page of the REDCap installation (e.g. http://hostname.institution.org/redcap)
2. Click the 'Create New Project' tab
   1. Select a project title (e.g. 'myARCH')
   2. Select a purpose
   3. Click 'Create an empty project' to start with a blank project
   4. Click 'Create Project'
3. Configure the project for myARCH (from the REDCap home page, click on the project that was just created, then click 'Project Setup')
   1. Under 'Main project settings', click 'Enable' next to the option 'Use surveys in this project?'
   2. Upload the survey forms from the myARCH Data Dictionary
      • In the 'Data Collection Instruments' section, click 'Data Dictionary'
      • Upload the provided myARCH data dictionary file (needs to be accessible from the browser)
      • Click 'Commit changes' to incorporate into the project
   3. Perform additional customizations
      • Find the 'Enable optional modules and customizations' section
      • Click 'Enable' next to 'Designate an email field to use for invitations to survey participants'
        • In the dialog that pops up, select the field 'myscilhs_contact_email' and click OK
      • Click 'Additional Customizations'
        • Check the box next to 'Data Entry Trigger'
          • In the URL section, enter the location of the myARCH Survey Manager trigger service (e.g. https://surveymanager.institution.org/surveymanager/trigger/pull)
          • If the mySCILHS Survey Manager has been installed and configured, click 'Test' to verify that REDCap has access to it
        • Click 'Save'

Once configured, the REDCap Data Entry Trigger will call the myARCH Survey Manager service endpoint whenever a REDCap record entry is saved or updated (either from the GUI or via a completed survey submission). That service endpoint will take the information from the newly created/updated record and push it to the myARCH Survey Result queue for further processing.
It's important to note that the downstream processing will be transparent to the REDCap interface, so its status may only be ascertained from the application server logs located on the myARCH Survey Manager machine.