Configuration

MetricWire Configuration Guide

The configuration instructions below will guide you on how to set up m2c2kit assessments within MetricWire. This configuration stores research participant data on our m2c2 server.

1. Login to MetricWire Catalyst at https://catalyst.metricwire.com/

2. Create or edit an Assessment

3. Add a Field of type "WebView" within the assessment

4. In the Webview settings, Enable 'catalyst_next_button' event to go next

5. Enter the cognitive assessment URLs, taking into consideration the following:

   • Modify URL to include special parameters that inject identifiers from MetricWire. These store participant and session information alongside the data. Add the following text, exactly as shown, to the end of the URL: &participant_id=|*participantUserId*|&session_id=|*submissionSessionId*|&admin_type=metricwire

   • Update the activity_name to the cognitive assessment you want to use. activity_name possible values are: symbol-search, grid-memory, color-shapes, color-dots

   • You will likely want to change the number_of_trials for each cognitive assessment. For testing purposes, you may want to keep this as is (number_of_trials=2::int) and update this later.

   • Add the study_id. The default is demo. This will need to change to your study name before you get started. This will be requested by following the steps of the Authorization guide, below.

   • Add the api_key. The default is demo. This must be a valid API key if you are collecting participant data. If you are ready for your API key, please follow the Authorization Guide, below.

   • It is optional to add group as a string group indicator.

   • It is optional to add wave as a string wave indicator.

   • These are example URLs:

     • https://prod.m2c2kit.com/m2c2kit/nt/index.html?activity_name=symbol-search&study_id=demo&width=400&height=1000&api_key=demo&number_of_trials=2::int&show_quit_button=false::boolean&participant_id=|*participantUserId*|&session_id=|*submissionSessionId*|&admin_type=metricwire
     • https://prod.m2c2kit.com/m2c2kit/nt/index.html?activity_name=color-shapes&study_id=demo&width=400&height=1000&api_key=demo&number_of_trials=2::int&show_quit_button=false::boolean&participant_id=|*participantUserId*|&session_id=|*submissionSessionId*|&admin_type=metricwire
     • https://prod.m2c2kit.com/m2c2kit/nt/index.html?activity_name=color-dots&study_id=demo&width=400&height=1000&api_key=demo&number_of_trials=2::int&show_quit_button=false::boolean&participant_id=|*participantUserId*|&session_id=|*submissionSessionId*|&admin_type=metricwire
     • https://prod.m2c2kit.com/m2c2kit/nt/index.html?activity_name=grid-memory&study_id=demo&width=400&height=1000&api_key=demo&number_of_trials=2::int&show_quit_button=false::boolean&participant_id=|*participantUserId*|&session_id=|*submissionSessionId*|&admin_type=metricwire

6. Save changes and sync the Assessment with your study.

7. Publish and preview/test your study to ensure the cognitive assessments appear.

tip

To preview/test your study, create a test account by going to the 'Contact Manager' of your workspace and select 'Create Test Accounts'. Then, add yourself as a participant with that test participant email and send yourself a survey: video demonstration

8. Preview/test your study to ensure the cognitive assessments appear.

Custom assessment parameters

The assessments have many parameters that can be customized. See the reference for the GameParameters:

• Symbol Search Game Parameters

• Grid Memory Game Parameters

• Color Shapes Game Parameters

• Color Dots Game Parameters

However although parameters are passed via URL, we still need to preserve type information to pass to m2c2kit. That happens by spelling the parameters exactly as noted in the links above, and the types need to be passed with a double color (::) separator. For example, if I wanted 1 trial I would specify the URL param as: number_of_trials=1::int

Available data types are:

• int
• float
• boolean
• base64
• json
• uri

The link below is an example of a task demo for Symbol Search, with 3 trials:

https://prod.m2c2kit.com/m2c2kit/nt/index.html?activity_name=symbol-search&study_id=demo&api_key=demo&number_of_trials=3::int&show_quit_button=false::boolean&participant_id=None&session_id=XXX&admin_type=missing

Data Access

1. Once you are ready to start your study, register your study data users and study ID on our portal following the Authorization Guide.

2. Once you receive your study ID and API key, use the url generator to put produce links and insert into MetricWire: Link Generator.

IMPORTANT: Make sure you have done this for all your existing URLs for each survey you have set up. Otherwise, you will not collect the data.

3. Save changes and sync your study.

4. Publish and produce some test data.

5. Use the Jupyter Notebook for data extraction and confirm that you are receiving data.

   • If you are at this stage, you should have followed the Authorization Guide mentioned above and requested your study ID and study data users by filling out the forms referenced in the Authorization Guide.

6. After testing your study thoroughly, collect data!

   • It is essential to make sure you are receiving data before going live. You should also check that you can cross-link your survey data with your cognitive assessment data using the session_id.

Using this documentation would allow you to get started to collect data from m2c2kit assessments via Metricwire.