keyingress Integration

Estimated reading: 5 minutes

In this step-by-step guide you will learn how to use the link between ReDem® and the survey software keyingress to perform real-time quality checks.

Specify data structure and quality checks

1. Create your survey with the questionnaire in keyingress.

- When designing the questionnaire, make sure to include enough elements for quality checking (open-ended and matrix questions).

2. Now log into your ReDem® account and click on the »Live Import« tab.

- Enter a name for the survey and select »keyingress« as your survey software from the drop-down menu.
- Click the »Next Step« button.

3. Determine whether you want to use the total survey duration as a quality criterion.

- After selecting the first quality criterion, you will get a preview of the credits needed per interview.

4. Go through your questionnaire from top to bottom and select your items that you want to use for the quality checks.

As a practical tip, we recommend the use of two screens. Open the questionnaire in keyingress on one screen and use the other screen for ReDem®.

- When you have selected the first item in the questionnaire, click the »Add new page« button.
- Enter an individual name.
  - To simplify the mapping, it is recommended to use the same name in both keyingress and ReDem® (e.g. Question Q4).
- If the determination of the first page concerns the very first question in the questionnaire, you must set the corresponding checkmark for it.
- Specify which quality checks you want to perform. Currently, you can use the following items as quality checks.
  - You can also always combine the checking of open questions and matrix questions with the duration.
- Please note that only one question per page is allowed for items used for quality checking.
- »Save« your specifications and repeat this step until you have specified all the quality checks you want.
- Then click the »Done« button

Set cleaning preferences

5. Decide if you want the interviews to be cleaned live or if you want to leave the cleaning feature disabled.

- When activating the cleaning feature, it is recommended to keep the default values. These values are based on our experience and ensure high data quality for the remaining interviews (Completes).
- Interviews that are below the specified thresholds are removed (Screenout).
- You can always adjust the cleaning settings later.

Insert ReDem® macros into keyingress

6. Open the integration guide.

7. Please follow the integration guide and copy all macros into your questionnaire in keyingress.

- Make sure that all macros and the script for data transfer are correctly located in the questionnaire.
- In each question/item, check if the following macro pattern is present in this format: redem_quality_check:<SCORE TYPE>,<POSITION>,<QUESTION KEY>,<ID>;
- When all the placeholders are filled in, the macro looks something like this: redem_quality_check:OES,null,Q5,63dd35d184d5d1383418e5d9ce66fe;

8. Insert the script to send the data from keyingress to ReDem®. The script is inserted as a separate page (End Page).

- While respondents are on this page, the data is first transferred to ReDem® for quality control. Once the quality check is complete, the result is sent back to keyingress. There are two possible termination codes:
  - STC_ID = 5 (Complete – Good Quality)
  - STC_ID = 48 (Screenout – Bad Quality – do not affect your quotas)
  - The ReDem®-Score can also be viewed in keyingress and is stored as a history entry for each interview.
- If you insert this script at an earlier point in the questionnaire, this process will be performed sooner.
- We recommend inserting this script after the last question.

Verification and test of the integration

9. Create test interviews to ensure all data is transferred correctly to ReDem®.

- It is recommended to create both good quality and bad quality test interviews to be able to check if the correct STC_ID is assigned in keyingress afterwards.
- Important: Any error in the integration will not affect the data collection in keyingress. In the worst case, the data is simply not submitted to ReDem®.

10. Check if the test interviews are recorded in ReDem®.

- After importing the first interview, you can follow the quality check live on your ReDem® Dashboard.

11. Then check whether the data has received the correct STC_ID in keyingress.

- The ID value in the ReDem® data table is equal to the value of »tan« in keyingress.

12. Remove the test interviews from ReDem®.

- To do this, open the data table and select all data records to be deleted.
- Then click the »Delete data records« button.

13. You can start the data collection now.

During data collection - Live Report

- - After the data collection has been started, you have the possibility to view the quality check live. All charts are updated in real time.
  - If required, you can also adjust the cleaning settings during data collection.
    - Please note that the new cleaning settings will only affect future interviews.

Finish data collection

- After the data collection is completed, you can change the status of the data import from »LIVE« to »FINISHED«.
- If you have not enabled live cleaning, the data can now be cleaned.
- Please note that once the data import is finished, no further interviews can be submitted.
- However, you have the option to change the status back to »LIVE« at any time.

If you have any further questions about the integration of ReDem® in keyingress, please contact us at support@redem.io