Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleSteps to import users...
  • Log in as an admin user and go to the users' list page.

  • Click on the 'Import' button and select the option 'Users'.

  • Click on 'Download Template File' to download the template file from the 'Import Users' page.

  • Enter all valid data in the template file as mentioned in the below table.

  • Upload the filled template file in the 'Input Records File' field, select 'Import Type' as 'Create' to create users or 'Update' to update users.

  • Click on the 'Validate and Import' button.

  • Refer to 'Import status' to check the status of the import job.

Sample CSV

Download

Data dictionary

Column

Datatype

Mandatory?

(Create)

Mandatory?

(Update)

Description

Permissible Values

Validations

Identifier

Number

No

Yes

System auto-generated unique number for every user.


It should be left blank during add, and this will be used only for updating the user details like email/login name.

Last Name

String

Yes

No




First Name

String

Yes

No




Domain Name


Yes

No

LDAP or Identity provider


"openspecimen" - if using inbuilt LDAP

Default value: 'openspecimen'

Login Name

String

Yes

No



Should be unique within the chosen domain

Email Address

String

Yes

Yes



Should be unique within the system

Institute

String

Yes

No




Primary Site

String

No

No

This field is only for information and not used for privileges checking.



Type

String

No

No

Type of the user.

The user can be a super admin or institute admin or Regular or NONE. 

  • SUPER

  • INSTITUTE

  • CONTACT

  • REGULAR / NONE

The value CONTACT is added since v6.1 to designate users that are contacts who will not be using OpenSpecimen app.

Admins can assign different roles to the users with the 'REGULAR' type.

If you leave this column blank, it will create the user as a regular user.

Activity Status

(v7.0)

String

No

No

Activity status for the user

Active / Disabled

Use 'Disabled' to delete the users.

Address

String

No

No




Phone Number

String

No

No




Disable Email Notifications

String

No

No

A disabled individual email notification

Yes / No


...

Expand
titleClick here to expand..
  • Log in as an admin user and go to the users' list page.

  • Click on 'Import' button and select option 'User Roles'.

  • Click on 'Download Template File' to download the template file.

  • Enter all valid data in the template file as mentioned in the below 'Data Dictionary' table.

  • Upload the filled template file in the 'Input Records File' field, select 'Import Type' as 'Create' to add or 'Update' to update user roles.

  • Click on the 'Validate and Import' button.

  • Refer to 'Import status' to check the status of the import job.

Sample CSV

Download

Data Dictionary

Column Name

Datatype

Mandatory?

Description

Permissible Values

Identifier

Number

Depends

System auto-generated unique number for every user.


Email Address

String

Yes

Email address of the user to which role has to be added.


Role#1#Name

String

Yes

A role that is to be assigned to the user.

  • Administrator

  • Coordinator

  • Principal Investigator

  • Researcher

  • Technician

  • Tissue Banker

Role#1#Site Name

String

Yes

The site to which the role is applicable.

Enter a valid site name or leave blank to set for "All Current and Future".

Add an extra column for the user role on multiple sites.

E.g. Role#2#Site Name, Role#3#Site Name, etc.

To update with all sites, you can add "All Current and Future".

Role#1#CP Short Title

String

Yes

Collection protocol to which the role is applicable.

Enter a valid collection protocol name or leave blank to set for "All Current and Future"

Add an extra column for the user role on multiple CPs.

E.g. Role#2#CP Short Title, Role#3#CP Short Title, etc.

To update with all CPs, you can add "All Current and Future".

...