Universal Connections: Add any External Study to FCX 🎬 Follow
Table of Contents
Add External Study
Edit External Study
Connect External Study to Activity
Link any external provider studies to activity landing pages, tracking UserID and study completion to assign reward points.
Members click on the activity link; they are routed outside of Fuel Cycle to the external study and returned to the community upon completion.Â
Add External Study
- Click on the âž• button at the top of the FCX Studies tab (Community > Surveys > FCX Studies) to begin.
- Add a Study Title for moderation purposes (maximum of 500 characters).
- Copy your study's shareable URL from your study source.
- Paste the shareable URL into the Study URL field.
- Choose whether members will be able to click on the study to retake multiple times by choosing Yes or No for Re-take Enabled.
Edit External Study
Edit links are available on the FCX Studies tab (Community > Surveys > FCX Studies). Use the filtering function to find only External Studies. Click the Edit link on the same row as the study you wish to edit.
Connect External Study to Activity
Click Add FCX Block to Activity Landing Page to learn how to add an external study to an activity's landing page block.
When members access the external study link in an activity, they are routed outside of the Fuel Cycle platform to the external study and back upon completion. The completion statuses to determine point association are determined from the redirect URL and are as follows:
- Termination: status=TERMINATED
- Over Quota: status=FAILED_OVER_QUOTA
- Low Quality: status=FAILED_DATA_QUALITY
- Completion: status=COMPLETED
If the redirect URL does not contain any status, it is considered invalid. In such cases, even if the FCX retake setting is disabled, members can retake the study. However, after retaking the study, if a member receives partial or completed status, they won't be able to retake it.
Link Creation
The Fuel Cycle platform will auto-generate a link for each member with their UserID, a unique tracking ID for the study, and the redirect URL for the external tool to use to send them back to Fuel Cycle. It will follow this structure:
www.[EXTERNAL STUDY URL]?fcUserId=[USER ID]&fcTrackId=[PARAMETER]&redirectUrl=[REDIRECT URL]
Redirects
If the external tool can parse the link from Fuel Cycle and use the parameters automatically, the only parameter the external tool needs to handle is adding in the status for the respondent to the end of the redirect URL that was passed in. This would allow the redirect link to follow this structure:
[REDIRECT URL]&status=[STATUS]
Status Options:
- TERMINATED
- FAILED_OVER_QUOTA
- FAILED_DATA_QUALITY
- COMPLETED
If the external tool requires manual inputs of the exact redirects, please use the following structure to create them:
Termination
[COMMUNITY DOMAIN]/externalStudyRedirect?fcTrackId=[INSERT PARAMETER]&status=TERMINATED
Over Quota
[COMMUNITY DOMAIN]/externalStudyRedirect?fcTrackId=[INSERT PARAMETER]&status=FAILED_OVER_QUOTA
Failed Data Quality
[COMMUNITY DOMAIN]/externalStudyRedirect?fcTrackId=[INSERT PARAMETER]&status=FAILED_DATA_QUALITY
Complete
[COMMUNITY DOMAIN]/externalStudyRedirect?fcTrackId=[INSERT PARAMETER]&status=COMPLETED
Comments
0 comments
Please sign in to leave a comment.