Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Self Sign Up

If you are a new user and want to sign up to access OpenSpecimen, go to the dashboard page and click on the 'Sign Up' button.

Expand
titleClick here to view details...

Fill up details and click on 'Sign up.'

Image Removed

Once you sign up, the admin will receive an email.

Image Removed
  • Only a Super Admin can approve your user account, and assign roles and privileges.

  • Once approved, you will receive an email with the login information and how to set up their password.

  • If your request gets rejected, you will be notified via email.

Auto approval of new users

From V9.1 onwards, an auto-approve user feature has been introduced. With this feature, the users who have signed up will either get automatically approved or the super admins will approve the account. 

System-level settings :  Below are the list of the settings which the Super admin should enable so that the users are auto-approved:

...

titleClick here to view details...

Login as Super admin → Settings

...

Fields 

...

Description

...

Permissible Values

...

Validation

...

Auto Approve Users

...

Enable automatic approval of new user signup requests.

...

  • Enabled 

  • Disabled

...

If Disabled accounts have to be approved by Super Admins

...

Default Signup Institute

...

Default institute to use for the newly signed-up users.

...

It should be an existing Institute. 

If not specified, the sign in user will get an error for 'Institute name is required'

...

Default Signup User Role

...

Default role to assign users on auto approval of their signup requests.

...

It should be one of the default roles

...

Local Account Signups

...

Enable signup requests for the 'OpenSpecimen' domain.

...

  • Enabled 

  • Disabled

...

When disabled, the domain dropdown should not contain the option 'OpenSpecimen'

For the users to receive the notification below, fields should be enabled

...

Fields 

...

Description

...

Permissible Values

...

Validation

...

User Created

...

Send an email when a new user is created.

...

  • Enabled 

  • Disabled

...

When disabled, the new user will not receive any notification

...

User Signup Request

...

Email administrator when a new user signs up.

...

  • Enabled 

  • Disabled

...

User Signup Approved

...

Send an email when a signup request is approved by administrator.

...

  • Enabled 

  • Disabled

Steps for self sign up:

Expand
titleClick here to view details...
  • Click on the sign-up tab 

Image Removed
  • Fill in the details below

Image Removed
  • Click on the sign-up tab after filling the details

  • If auto approval is enabled, the new user will see this screen

Image Removed
  • A mail notification will be received with the login details

Image Removed
  • Once the new user clicks on the sign-in link, the reset password page will be reloaded

Image Removed
  • The new user will be registered with institute and roles set at the system setting level

Image Removed
  • If the auto approval is disabled, then the new user will get the approval mail with login details once the request is approved.

...

Types of Users

...

Type

...

Description

...

Super Administrator

...

Has access to all the data and operations across all the sites and institutes in the application.

...

Regular User

...

Has limited access based on their roles within the associated site.

...

Institute Administrator

...

Has access to all the data and operations within all the sites of the institute to which the user is associated.

...

Contact User

...

Users that do not log in to the system. For example, nurses, external lab members, etc.

List of fields available on the create users page and their description:

...

Fields

...

Description

...

Type

...

Type of the user: 

  • Super Administrator

  • Institute Administrator

  • Contact

  • Regular

...

First Name

...

First Name of the user

...

Last Name

...

Last Name of the user

...

Email Address

...

Email ID of the user

...

Phone Number

...

Phone number of the user

...

Domain Name

...

It is "OpenSpecimen" by default. If you have LDAP/SAML configured, you can add that as the domain name

...

Login Name

...

The username that will be used to log in

...

Institute

...

Institute under which the user needs to be created

...

Time Zone

...

Time zone of the user

...

Manage Forms

...

If enabled, the user will be able to add/edit forms. Refer to the wiki page for more details on forms.

...

Manage Workflows

...

If enabled, the user will be able to add/edit workflows. Refer to the wiki page for more details on workflows.

...

Disable Notifications

...

If enabled, the user will not receive any emails from OpenSpecimen.

...

API User

...

Enable if the user works with APIs. Refer to the wiki page for more details.

...

Download Labels Print File

...

Allows the users to download CSV files for printing labels. Refer to the wiki page for more details.

...

Address

...

Address of the user

Data Entry Users

Administrators (Super/Institute/Site) can create authorized users and provide them with specific access privileges in OpenSpecimen. These users can be Site Managers, Biobank Managers, Laboratory Managers, Clinicians, Technicians, etc.

Expand
titleSteps to create users...
  • Select the 'Users' card from the home page or menu and click 'Create'. The types of users depend on their role and their respective responsibilities.

Image Removed
  • Selecting 'Regular' will allow you to assign different roles to the user other than super and institute admin.

Image Removed

Contact Users

Some users (e.g., PI of the study, external lab members, nurses, etc.) do not log into OpenSpecimen. For such types of users, you can create a 'Contact' user type. 

Expand

The contact users can be used in the below fields:

  • CP PI or coordinator

  • Specimen events

  • DP PI or coordinator

  • Order requestor

  • Custom form

  • Project PI 

Info

Email Notification

By default, contacts will not receive login credentials and email notifications. You can enable/disable the OpenSpecimen email notifications for an individual user from v7.1, as shown below:

Image Removed

Assign Roles

Once you create a regular user, you will need to assign roles like technicians, tissue bankers, etc., by clicking on the 'Roles' tab from a specific user overview page.

Info

The roles tab will only appear if 'Regular' is selected under the 'Type' field on the 'Create users' page. It will not appear if the user is a super administrator, institute administrator, or contact.

Expand
titleSteps to assign roles...
  • Click the 'Roles' tab on the user overview page.

Image Removed
  • Click 'Add role' and start entering data. Users can either assign privileges to all (current & future) CPs or specific CPs of a site.

Image Removed
Info

For multi-site protocols, you can assign multiple roles to a user under multiple sites on the same protocol.

Note

Note:

  • The 'All Current and Future' option in the site's drop-down will appear only if no roles are already assigned to a specific site.

  • When you assign the "Administrator" role to the user for a site, they get access to all CPs of that site by default.

  • You can only see those sites under the "Sites" dropdown that are registered under the institute that the user is affiliated with.

Image Removed

For more information on default roles and privileges, refer to the wiki page.

Set Default Printer for User

You can set a 'Printer' value for each user from the dropdown. This dropdown is configurable through 'Extras → Dropdown Manager → Label Printer'. This value takes precedence over 'Print Rule' settings. This value is added in the generated label CSV. This way, you can set the Printer based on the logged-in user. It is typically helpful when multiple printers are available. 

Edit

You might want to edit user details like the user's Institute, primary site, contact details, role, form management, etc. The super Admin can update all the profile attributes of the users. 

Expand
titleClick here to view details...

Log in as a super admin and click on 'Edit' from the user overview page to edit the user.

Image Removed

From v7.2, you can edit some basic details of their profile, such as phone number, time zone, address, and notification settings. This will help regular users to do minor profile edits without bothering admin users. Rest fields will be non-editable to regular users.

Image Removed

Steps to edit your own profile details :

  • Log in to OpenSpecimen → Click on the 'User Profile' icon at the right-hand side top corner, as shown below.

Image Removed
  • Click on the username as shown below.                                                 

Image Removed
  • Edit phone number, time zone, address, and notification settings → Update. Verify if the details are updated.

Image Removed
Info

Note: Institute and site admins can edit all users' profile attributes created under their institute and site.  

Lock / Unlock

Expand
titleClick here to view details...

The user account will get locked in 3 cases:

  1. The user has tried maximum failed login attempts.

  2. The user is inactive for the 'N' number of days.

  3. Super admin forcefully locked the user account.

The system throws an error on UI about the account locked at the time of login. Locked users have to contact their admins to get their accounts unlocked.

To unlock a user account, search for the user's account → From the user overview page, click 'Unlock'. Following these steps, a user will get an email notification that the account is unlocked.  Super admin, institute admin, and site admin users can lock/unlock user accounts.

Image Removed
Note

Note: If the super admin account gets locked, other super admins can unlock it, or the user has to email the OpenSpecimen help desk.

...

Expand
titleClick here to view details...

Using the 'Delete' tab, you can delete the users created by mistake or who are no longer needed.

Before deleting a user, make sure that the user is not linked to any data in the system. e.g., as a PI, coordinator, or technician of a CP, since you won't be able to access data linked to the deleted user. To delete the user, go to the user's list page, search for the user's name and click on 'Delete'.

Sometimes you might want to close a user account but retain data linked to the user. In such cases, you can archive the user account. The archived user would not appear in any dropdown list. However, you can access the older data linked with the user.

Image Removed

If you wish to reactivate the archived user - Go to the user's list page→ Set the activity status to 'Archived' in search filters. The archived users' list will appear. Click the user to be reactivated and click 'Reactivate'.  

Image Removed

Impersonate

Super Admin can use the ‘Impersonate’ to log in as another user. This is useful for the support team to debug access issues or user-specific issues. 

Post impersonation, the super admin’s UI will refresh the same as that of the user’s UI.

...

titleClick here to view details...

...

A message at the top of the page highlights the user impersonated and the option to return to the super admin’s account.

Email Notification (v8.1)

When you impersonate as a user, you will get a popup message asking if you still want to proceed.

...

An email is sent to both the impersonated user and who are impersonating.

...

Child pages (Children Display)
allChildrentrue