User Guide for Management Portal
- Nivethika Mahasivam
This document describes the most important features of Management Portal for related user roles.
User Guide for System Admin
Create a project
First step to manage a study in RADAR-base is to create a project in Management Portal. Creating a new project can be done by a user with the SYSTEM_ADMIN role.
Create a ‘Project’ to manage your study in ManagementPortal at `<your-platform-url>/managementportal/`. (For System admin only)
Login as SYSTEM_ADMIN,
Then Administration -> Projects -> Create a new Project
Enter project details (e.g. name of study, selection of data source types used in study) and click Save.
Properties | Description |
|---|---|
Project Id | A unique identifier of a project, study, or trial. This field is case-sensitive and is used across the platform to identify Management Portal users, participants and data submitted collected in the platform. |
Human readable project name | An optional project name that can be easily understandable to the users. |
Description | A brief description of the study. |
Location | The location where the study is conducted. |
Start date | Start date of the study. This information is collected only as meta-data. It is not used for any other validation in the system |
End date | End date of the study. This information is collected only as meta-data. It is not used for any other validation in the system |
Source Type | A list of source-types that can be used in the project. E.g., ANDROID_PHONE_1.0.0. |
Attributes | Additional meta-data of the study. This information is stored as a key-value pair. The Management Portal supports some predefined attributes that are available in the drop-down. Values should be entered manually by the user who is creating or managing the project. E.g., External-project-id: Enter project-id from Redcap. Supported attributes: Privacy-policy-url: Override default privacy-policy used on the pRMT app with a custom one for this project. Work-package: identifier to group a number of projects as belonging to the same team. Phase: if multiple Management Portal projects are created for the same study in different phases, specify the phase here. External-project-url: URL of the external project ID. |
Managing users
List of roles in Management Portal
Role | Project specific/Global | Description |
SYSTEM_ADMIN | Global | A user with SYSTEM_ADMIN role can create projects and users. Can access and manage all projects and resources attached to the project. Can access and manage OAuth Clients. Can access audit logs and health metrics. |
PROJECT_ADMIN | Project specific | A user with PROJECT_ADMIN role can access projects that are related to their role. Can create participants in a project. Can edit properties of a project. Can assign or remove data sources to participants in a project. E.g., apps and devices. |
PARTICIPANT | Project specific | Can send data from assigned (data)sources. All active Subjects created in Management Portal have PARTICIPANT role. User with PARTICIPANT role cannot login to Management Portal. |
INACTIVE_PARTICIPANT | Project specific | This role will be assigned to deactivated Subjects in a project. Their ability to send data will be deactivated once the latest access token expires. |
The Management Portal user interface supports only SYSTEM_ADMIN and PROJECT_ADMIN roles. The PARTICIPANT and INACTIVE_PARTICIPANT roles are supported by Management Portal, but these user types do not interact directly with the portal application. The PROJECT_OWNER, PROJECT_AFFILIATE and PROJECT_ANALYST roles are not fully developed and should not be used.
Creating users
A user with SYSTEM_ADMIN role can create new users with SYSTEM_ADMIN role and users with project specific roles. Users with SYSTEM_ADMIN role have access to all resources in Management Portal and access information from all studies. Users with project specific roles, in contrast have access to only the projects their roles are mapped to. A user can have multiple roles in one or more projects. For a consistent experience, only the PROJECT_ADMIN project-specific role should be used to assign users to a project. Users with that role on a project can view or edit that project and its participants. They are also able to view and modify that project and its participants in other RADAR-base applications.
Creating a user with SYSTEM_ADMIN role
Login as SYSTEM_ADMIN,
Then Administration -> User Management -> Create an admin user.
Enter user details and click on the Save button.
Properties | Description |
Login | The username of the user. |
First name | First name of the user. |
Last name | Last name of the user. |
Email address of the user where the activation link will be sent. | |
Role | Role “ROLE_SYS_ADMIN” will be already defined for this user. |
2. Creating a user with PROJECT_ADMIN role
Login as SYSTEM_ADMIN,
Then Administration -> User Management -> Create a new user.
Enter user details and add project specific roles, click on the Save button. (Please note only PROJECT-ADMIN and SYSTEM-ADMIN users are fully supported by Management Portal web interface at the moment.)
Properties | Description |
Login | The username of the user. |
First name | First name of the user. |
Last name | Last name of the user. |
Email address of the user where the activation link will be sent. | |
Role | Select a combination of an Authority (here “ROLE_PROJECT_ADMIN”) and a project. From the drop-downs and press on the “Add” button to add it to the Role list. When not pressing “Add”, the role assignment will not be saved. |
3. Resend activation link
Once a user is created, the user will receive a reset link via email to reset the password and to activate their account (to the email address specified in Management portal). It has an expiry time. If the user was unable to reset the password before the expiration, it is possible to resend a reset link to the user. It can be done by clicking on the Send activation link button.
4. Delete a user from Management Portal
To remove a user from the system, please click on the Delete button.
User Guide for Project Admin and System Admin
Managing a study
Once a project is created, new users can be added to the project.
All project specific details can be managed from Project view. To go to the project view of a project, go to Projects -> Name of the project. Then you will see the project view.
Assigning source-types
A user can modify the project properties by clicking on the Edit button. The project admin or system admin can choose which of the data source types should be in a project. This can be done by assigning the Source types for a project. To do so, please click on the Edit button, then select the source-types, then click on the Save button.
Enrolling participants
To enroll a new participant to a project, please create a new Subject on corresponding project. To do so, please click on the Create a new Subject button. You can optionally enter additional information such as External link (e.g. link to redcap), external-id (e.g. record id of a subject on redcap), then click on Save button.
This step is automated using some integration system for specific study set-up. E.g. for RADAR-CNS and RADAR-AD studies, there is an integration system available to automatically create participants for subjects recorded in RedCap system.
On-boarding participants to use RADAR-base apps
To enable a participant with using RADAR-base supported apps such pRMT app, aRMT app or other, please follow the steps below.
Install the app on your phone and open the app. You will see a Scan QR code button on you app.
Click on Pair App on the subject you created.
You will see a pop-up. From the Client app drop-down, choose the app you want to enable (e.g. aRMT). Click on generate QR Code button.
Then you will see a QR code generated for you.
Scan the QR code from your app, allow permissions when requested.
Useful links
Step by step guide to use pRMT app from RADAR-base is available here.
Step by step guide to use aRMT app from RADAR-base is available here.