User guide for FitBit user registration portal

REST Source Authorizer is an application in the RADAR-base platform which authorizes the subject’s external applications (e.g. FitBit) to the platform to collect data from subjects.

This document is a guide through the procedure for registering a new subject’s FitBit account to RADAR-base.

1. Prerequisites

1. Each subject should already have a FitBit account that is synchronized with his/her device.

2. The RADAR-base platform with Management Portal and REST Source Authorizer applications should be installed on your environment.

3. A project should be created in the Management Portal application on your environment for your trial and subjects should be registered in Management Portal for each participant. (See Appendix I)

2. Instructions

2.1 Authorize a Subject’s Fitbit account to RADAR-base

2.1.1 For the Researchers and the System Administrator

1. Open REST Source Authorizer Application by going to `<your-platform-url>/rest-sources/authorizer/login` in the browser.

2. Click on the Login with Management Portal button.

3. You will be redirected to a login page in the Management Portal app hosted in your environment. 

4. Enter the credentials of your account from the Management Portal to log in, then click on the Sign in button.

5. Once you have logged in, you will be requested to authorize the RADAR REST Sources  Authorizer app to add subjects to the platform. Select all the choices and click on the Approve button.

6. Once you have logged in, you will be requested to authorize the RADAR REST Sources  Authorizer app to add subjects to the platform. Select all the choices and click on the Approve button.

7. Once you have logged in and granted access successfully, you will be redirected to the home page of the app. 

8. Select a project from the Project dropdown. (If you have more than one project)

9. Select FitBit from the Source Type dropdown. (If there are more than one source type available for the selected project)

10. You see a list of subjects for the selected project and selected source type (FitBit) in the table.

11. To link a subject’s FitBit account to the RADAR-base platform click on the Link button.

A dialog will open with the subject’s details. It is possible to run the Authorization process immediately “Authorize Button” or create a participant-specific URL which can be sent to a participant so they can complete the device authorization workflow.

12. Enter the dates for start and end dates or use the range-picker to select the start and end dates to specify from which date to which date you want to collect data from this subject.

13. If you enter or select valid dates, the Authorize and Generate URL buttons will be enabled.

14. If the subject is sitting next to you, or you have his/her FitBit account credentials, press Authorize button.

14.1. You will be redirected to the FitBit login page. Log in using the FitBit account credentials of the subject.

14.2. Once successfully logged in, the FitBit user will be requested to authorize the RADAR-base platform to collect listed data from their FitBit account. Click on the Allow all check-box and then click Allow button.

14.3. After the subject is successfully authorized, you will be redirected to the REST Source Authorizer App, to where you were before with the updated fields in the dialog.

14.4. Close the dialog and see the table is updated for the subject.

15. If the subject is not available and you don’t have his/her FitBit account credentials, press Generate URL button.

15.1. A message box will appear at the bottom of the dialog. Copy the message and send it to the subject via email, a messaging application, etc.

15.2. After you copy the message, close the dialog. You will see the table is updated for the subject to Pending status with the date and time.

16. While the user is authorized, if you would like to make changes to the start and end date of the data collection for a subject, or in case if you see gaps in the data or you would like to reset the data collection, you can do so by clicking on the Reset button. In the opened dialog modify the dates, then click on Reset button

Be aware that this option will download the data from FitBit Cloud again for this subject. It is a resource-intensive operation. Please make sure that you require this operation before resetting the data collection.

If the reset is not necessary, you can exit this dialog by clicking the Cancel button.

17. If you would like to stop receiving FitBit data from a subject, you can unlink the subject from the RADAR-base platform. To do so, click on the Unlink button and confirm the process by clicking the Yes button in the dialog.

18. To log out from the application, you can click on the Logout button on the top right.

2.1.2 For Subjects

1. Open the message received from your support team.

2. Click on the link provided. You will be redirected to REST Source Authorizer App.

3. Click on the Authorize FitBit Account button. You will be redirected to the FitBit Login page. 

4. Log in using the FitBit account credentials.

5. Once successfully logged in, you will be requested to authorize the RADAR-base platform to collect listed data from your FitBit account. Click on the Allow all check-box and then click Allow button.

6. After you granted access successfully, you will be redirected to the REST Source Authorizer App with a message indicating the linking was successful.

7. Your FitBit account is linked to the RADAR-base platform. Close the page.

3. Appendix I

3.1. Create a Project in Management Portal

1. Open the Management Portal app by going to `<your-platform-url>/managementportal/` in the browser.

2. Log in to Management Portal as SYSTEM_ADMIN.

3. From the menu, go to Administration -> Projects.

4. Click Create a new Project button.

5. Enter project details (e.g. name of study, selection of wearable devices used in study) and click Save button.

3.2 Create Subjects in Management Portal

1. Open Management Portal by going to `<your-platform-url>/managementportal/`

2. Log in to Management Portal as SYSTEM_ADMIN or Project Admin (Researcher).

3. Select the project from the home page or project menu.

4. Click Create a new Subject button.

5. In the External ID field enter the subject’s local ID (the subject ID in your trial-specific database) and click on the Save button.

6. (Optional) If there is a link that can refer to that subject in another system, enter that link in the External Link field.

8. The created subject will be listed in your project view.