Manage the permissions of the System Administrator, Facility Administrator, Researcher, and Collaborator user roles to restrict or allow the following actions:
View and interact with certain features of the interface.
Perform certain actions in the interface.
View and restrict any actions in the interface. [Clarity LIMS v6.1 and above]
Command-line Permissions Tool
Role-based permissions are controlled through the permissions-tool.jar tool, at /opt/gls/clarity/tools/permissions/.
For assistance with running the command-line permissions tool, contact the Illumina Support team.
Functionality includes the following commands:
—List all roles in the system.
—List names and descriptions of all permissions in the system.
NOTE: The permissions-tool.jar tool function names and property names are case-sensitive. If you type the incorrect case, your command or property cannot be understood.
There can be a delay (up to 20 minutes) before changes to some API-related permissions take effect.
Supported Commands
List all user roles in the system:
Show permissions for a specific role:
Create a role:
Show assigned permissions for all roles:
listPermissions
List names and descriptions of all permissions:
assignPermission
Assign a permission to a role (the example assigns permission to create controls):
[Clarity LIMS v6.1 and above] Assign a permission to a role (the example assigns read-only permission to a role):
Refer to .
removePermission
Remove a permission from a role (the example removes permission to create controls):
Refer to .
Supported Permissions
The sections below list LIMS permissions and actions, and the user roles to which each permission/action is assigned by default.
By default, System Administrators and Facility Administrators have all permissions listed.
Permission: AdministerLabLink
The default role with AdministerLabLink permission is Administrator. This permission is added to the existing System Administrator & Facility Administrator roles.
The Collaborator role is based on the existing Collaborator role in LabLink v1.0.
Note: The existing Researcher role does not have the new permission and behaves similarly to the LabLink Collaborator role.
Permission: ClarityLogin
Default roles with this permission: Administrator, Researcher
Allows:
Result of denied permission
Permission: APILogin
Allows:
Result of denied permission
Permission: Project
Action:
Allows:
Result of denied permission
Permission: Sample
Action:
Allows:
Result of denied permission
Permission: Controls
Default roles with these permissions: Administrator
Action:
Allows:
Result of denied permission
Permission: ReagentKit
Default roles with these permissions: Administrator
Action:
Allows:
Result of denied permission
Permission: Role
Default roles with these permissions: Administrator
Action:
Allows:
Result of denied permission
Permission: Read-Only [Clarity LIMS v6.1 and above]
Default roles with this permission: Not applicable. You can assign this permission to any role.
Permission: User
Default roles with these permissions: Administrator
Action:
Allows:
Result of denied permission
In the LIMS user interface, the term 'contact' has been replaced with 'client.' However, the API still uses the permission Contact.
All users with ClarityLogin permission can view and edit their own user details (except for assigning/removing roles).
Permission: Contact
Default roles with these permissions: Administrator
Action:
Allows:
Result of denied permission
In the LIMS user interface, the term 'contact' has been replaced with 'client.' However, the API still uses the permission Contact.
Users with ClarityLogin permission can view and edit their own client and user details.
Clients can edit their own details (except for assigning/removing roles) without having update permission.
Permission: Process
Default roles with these permissions: Administrator
Action:
Allows:
Result of denied permission
In the LIMS user interface, the term 'process' has been replaced with 'master step.' However, the API still uses the permission Process.
Permission: OverviewDashboard
Default roles with this permission: Administrator
Action:
Allows:
Result of denied permission
Permission: Configuration
Default roles with this permission: Administrator
Action:
Allows:
Result of denied permission
Permission: ReQueueSample
Default roles with this permission: Administrator, Researcher, Collaborator
Allows:
Result of denied permission
Permission: SampleWorkflowAssignment
Default roles with this permission: Administrator, Researcher, Collaborator
Allows:
Result of denied permission
Permission: RemoveSampleFromWorkflow
Default roles with this permission: Administrator
Allows:
Result of denied permission
Permission: MoveToNextStep
Default roles with this permission: Administrator
Allows:
Result of denied permission
Permission: SampleRework
Default roles with this permission: Administrator
Allows:
Result - permission granted
Permission: ReviewEscalatedSamples
Default roles with this permission: Administrator
Allows:
Result - permission granted
Permission: ESignatureSigning
Default roles with this permission: Administrator
Allows:
Result of denied permission
Permission: CanEditCompletedSteps (LIMS v5.1 and Later)
Default roles with this permission: None
Allows:
Result - permission granted
Modifications are limited to what is available on the Record Details screen for the step.
Details such as sample placement or routing cannot be modified.
Only steps completed after upgrading to LIMS v5.1 can be edited. Steps completed in v5.0 or earlier cannot be edited.
Steps that were executed using the Process API cannot be edited.
For details, see .