Working with Scope and Codes

Overview

Some laboratories, although they belong to a corporate organisation, are allowed to adjust their operations and hence the way their LIMS functions, based on local requirements, and permits the laboratory to be very reactive to local conditions, clients and commercial aspects.

Other laboratories are centrally controlled, with only limited local 'flexibility' to adapt to their local requirements.

CCLAS allows, for most of the static entity types, the ability to create an entity at:

  • The organisational level, with organisational-scope (org-scope), and thereby visible and usable by all laboratories within the organisation.
  • The laboratory level, with laboratory-scope (lab-scope), and thereby visible and usable only by the laboratory that created it.

Scope

Scope refers to the entities visible to a user.

Entity Creation Affected by Scope

An entity can be created with laboratory scope, often referred to as 'lab-scope', such that it is visible only to users logged into that laboratory, or with organisation scope, often referred to as 'org-scope', such that, it is visible only to users logged into any laboratory beneath the organisation.

When you create any entity in CCLAS, its usage scope must be selected, after which, the usage scope cannot be changed. Depending upon the type of entity, it could have a scope of either:

  • Outside of the organisation and laboratory, at instance level—These entities are visible to all users regardless of the Laboratory that the user logged into for the session.
  • Organisation-scope—These entities are only visible to a user who is logged into any laboratory within the organisation.
  • Laboratory-scope—These entities are only visible to a user who is logged into the laboratory.

Note: User security rights are set to allow users to create entities with org-scope and lab-scope, org-scope only, lab-scope only, or neither.

Entity Search Affected by Scope

When searching for entities at either organisation or laboratory level, entities can be filtered by Scope:

  • All—Where no organisations are selected, then the search filters entities by the current organisation and laboratory. Where one or more organisations are selected, then the search filters entities by the selected organisations and the current laboratory.

  • Laboratory only—The search filters entities by the current laboratory,

  • Organisation only—Where no organisations are selected, then the search filters by the current organisation. Where one or more organisations are selected, then the search filters by the selected organisations.

The selection in the Scope field can determine the visibility for other fields in the form, and the content of various drop-down selection lists. For example, where the Scope is selected as Organisation only, then the drop-down lists associated with other search criteria only contains org-scope entities, or where the Scope is selected as Laboratory only, then drop-down lists associated with other search criteria only contains lab-scope entities.

Linking of Entities Affected by Scope

When updating an entity, the entity's Scope affects the content of drop-down lists.

Entities that have organisation scope can link to org-scope entities only, however, entities that have laboratory scope can link to org-scope or lab-scope entities. A laboratory enabled org-scope scheme is deemed to have laboratory scope (sometimes referred to as enabled-scope).

Create an entity with organisation or laboratory scope and link to it from another entity

Codes

Each organisation on the instance needs to have a unique code. Each laboratory on the instance needs to have a unique code. Two laboratories within two different organisations cannot have the same laboratory code.

Codes of entities that have a scope property, that is, they are associated with a laboratory or with an organisation, need to have a code that is unique within the organisation and laboratory. That is, two entities of the same type cannot have the same code if they are in the same organisation or laboratory.

An entity can link to another entity as long as the scope of the two entities are compatible. The general rules are:

  • A lab-scope entity can link to a lab-scope entity as long as they each exist in the same laboratory.
  • A lab-scope entity can link to an org-scope entity as long as they each exist in the same organisation.
  • An org-scope entity can link to an org-scope entity as long as they each exist in the same organisation.
  • An org-scope entity cannot link to a lab-scope entity.

Example: A lab-scope tax cannot be added to an org-scope client.

An entity that is of a 'group' entity type can contain entities from either scope, as long as the type of group permits it. The general rules are:

  • A lab-scope group entity can contain a lab-scope member entity as long as it exists in the same laboratory as the group entity, and can contain an org-scope member entity as long as it exists in the same organisation as the laboratory associated with group entity.
  • An org-scope group entity can contain a lab-scope member entity as long as it exists in the same laboratory as the group entity and as long as the entity type permits it, and can contain an org-scope member entity as long as it exists in the same organisation as the laboratory associated with group entity.

Examples:

  • An org-scope client group can only contain org-scope clients; a lab-scope client group can contain either org-scope or lab-scope clients.
  • An org-scope instrument group can contain lab-scope instruments (but note that instruments can only be created with lab-scope).
  • An org-scope price catalogue group can contain both org-scope and lab-scope price catalogues; a lab-scope price catalogue group can contain both org-scope and lab-scope price catalogues.

Irrespective of the access level of the user, a code field cannot be changed during update. It can be set only on create.