Skip to content

Bika Lab Systems

Sections
Personal tools
You are here: Home Help Centre Manuals Bika LIMS 2 'Inkosi' Bika LIMS 2 System Setup
Document Actions

Bika LIMS 2 System Setup

Note: This is the print view with all the Reference Manual pages on one page. The paginated version is available here, if you prefer that.

Work In Progress - 10/02/2008

10. Bika LIMS 2 System Setup

Setting up Bika LIMS 2. Lab managers and administrators only

10.1. Introduction

The Bika LIMS Configuration Panel. Lab managers only

Bika LIMS is configured in the Bika configuration panel, reached by clicking on the site setup link top right or preferences on the top menu bar

The Bika Configuration portlet appears in the left hand navigational column from where all set-up items can be reached

This function is only available to the lab manager

Bika LIMS Configuration portlet

Bika configuration portlet

All the menu functions are presented, and remain in the left navigation area while on the set-up pages


10.2. Analysis Profiles

Collection of analyses frequently requested, can be stored as analysis profile and repeatedly used as request 'template'

All your laboratory analysis profiles, are listed in the table below and are editable by lab managers


Lab's Analysis Profile list

Click on [add new lab analysis profile] to add a new profile, or click on the title of an existing profile to edit it. If you want to delete one, check the box opposite its title and press [delete] at the bottom of the page

Lab Analysis Profile

















The lab analysis profile Title will be shown in the drop down while creating new analysis requests, and is a mandatory field

Sample Type, each lab analysis profile is linked to a sample type, to select one use the drop down menu.

Analyses, to select which analyses need to applied to this lab analysis profile, tick the box next to the required analysis.

Once you're done with editing an existing profile or creating a new new one, click on Save to save your changes.

Client specific Analysis profiles can be created on AR creation forms by saving the parameters selected for creating the AR as a template. Clients may use this facility to create and maintain their own profiles. These are available for edits in their own set-up area too

10.3. Analysis Services

Setting up analysis services, their descriptions and parameters

All the analytical services offered by your lab are added and listed here and editable to lab managers


Analysis services


Click on [add new analysis service] to add a new service, or click on the title of an existing service to edit it. If you want to delete one, check the box opposite its title and press [delete] at the bottom of the page


setup analysis services a


The analysis service Description may be used to capture information visible to clients. Typically this is a description of the analysis method and its results interpretation, assisting clients in deciding which analyses to request. Analysis services throughout the system are hyperlinked to pop-ups for clients to look up this information

Instructions are similarly available to lab staff and should contain technical information to guide them through the analysis

bika 2 setup analysis unit

Unit must be completed with the unit of measurement for the analysis as it will be reported

In earlier Bika versions, minimum and maximum value fields were populated here to determine whether a test result is out of range, and then highlighted in the analysis request and worksheet results. Since Bika 2, these are maintained per sample type in a separate set-up item, Analysis specifications


bika 2 setup analysis services b price


Two prices can be kept on record for the analysis service, typically  a cheaper price for bulk buyers, called 'corporate' in the example above. Prices may be overwritten by lab managers on individual ARs, or a 'membership' discount applied per individual clients

The VAT % defaults to the system default but may be edited

bika 2 setup analysis services c instrument

The Instrument Import Keyword is the name of the analysis in the .csv file of results imported from lab instruments and is used to match results with analyses. This name must be spelled exactly the same here and as column header in the .csv

Instrument and Method are no more than place holders at this stage. In future versions they will be used in instrument maintenance modules


bika 2 setup analysis services d TAT


Maximum Hours Allowed is the time limit specified for this test to be concluded. When an analysis request exceeds this time limit, it is displayed in the late analyses pop-up


bika 2 setup analsysis service calculation selection

The Calculation Type drop down menu is used to select the calculation type associated with the analysis. These are defined in the Calculation Types section of the system set-up and typically includes a range of weight and titration calculations


bika 2 setup analysis services e titration

For analyses requiring titration, the Titration Volume Unit, typically ml, needs to be provided as it appears on the analysis request once the titration volume has been captured

bika 2 setup analysis duplicate variation

Duplicate Variation is a quality control measure indicating the maximum percentage difference allowed between results for this particular analysis of duplicate samples on the same worksheet. If the difference is bigger than the percentage specified here, the results will be highlighted on the worksheet and the worksheet rejection workflow entered


bika 2 setup analysis department

Department managers responsible for results are included on results publications including their contact details - to provide a short cut for clients having queries. Therefore every analysis service needs to be assigned to a department. The departments are entered in the Lab departments section of the set-up and presented as selection options on a drop down menu here

As indicated by the red square next to it, Department is a compulsory field


bika 2 setup analysis services accreditation

Accredited marks the analysis service as having been accredited as described under the accreditation section. Accredited analyses are indicated as such throughout the system

bika 2 setup analysis services uncertainties


The intercept table of Uncertainties is used to determine the measure of uncertainty for the analysis. These uncertainty values are shown throughout the system as +/- value, after the result

Using the example above, a result of 15 units will be reported as 15 +/- 2 units


bika 2 save cancel button

Press [save] to submit your edits, [cancel] if you don't want to


10.4. Analysis specifications

Setting up valid ranges for results from the laboratories' perspective

All the analytical services offered by your lab are added and listed here and editable to lab managers. The same functionality is available to clients in their own set-up areas where they may maintain their own specifications

Users may then apply either their own specifications or that of the laboratory on several Analysis request or Worksheet views where results are displayed. Results outside of the chosen range are then highlighted

In the lab, staff may then take measures such as entering rejection or re-testing workflows

Bika 2 - Lab Analysis Specs - List

Click on [add new lab analysis specification] to add a new specification, or click on the title of an existing service to edit it. If you want to delete one, check the box opposite its title and press [delete] at the bottom of the page


Adding a New Lab Analysis Specification

Bika 2 - Add Analysis Specs











Click on the tick box next to sample type to select the sample type you want to set specifications for. More than one sample type may be selected but all selected sample types will then get the same specifications

Then enter the minimum, maximum and percentage error for that sample type

Note: You'll notice that some sample types, have 'specified' behind it. This means that an analysis specification for that sample has already been set-up and if it is selected again, the previous specification will be overwritten

Click on [Save] to apply your set-up


How are the minimum and maximum values, and percentage error applied?

When a results is submitted it is compared to the minimum and maximum values for its sample type specification, also depending whether the lab or client specifications are selected. If the limits are not exceeded it is reported normally as 'in range'

If the result exceeds the limits, the error percentage is applied to it and it is again measured against the valid range limits. If it then falls in range, it is reported as 'in error range'. If it is still over the limits, it is reported as 'out of range'


Editing an existing Lab Analysis Specification


Click on an existing specification's sample type on the list of specifications

Bika 2 - Lab Analysis Specs - List


The specification's screen opens and it can now be edited:

Bika 2 - Edit Lab Analysis Specs

Modify the values in the min, max and % error fields as required


NB The Sample Type drop down menu

The Sample Type drop down menu at the top of this screen is used to apply the specification to the selected Sample type. It offers the sample type initially selected, and all others for which no specifications exist

If a new sample type is selected here and the specification saved, the specification for the sample type for which the screen was initially opened is removed and 'switched' to the newly selected sample type

In future editions this should be changed into a copy instead of deletion, and if technically impossible, the drop down replaced with plain text of the sample type for which the specification may be edited


Click on [Save] to apply your set-up

10.5. Bika Calendar

Bika Calendar set-up

The Bika Calendar functionality and set-up is available in a separate manual in the manual section of the Bikalabs.com HelpCenter, which you can find by clicking here

The complete URL:

http://www.bikalabs.com/helpcentre/manual/bika-calendar-manual

10.6. Bika Settings

Security, discount set-up, VAT set-up and prefixes

Bika settings define default values for the Bika LIMS installation. System wide preferences are set here by the lab manager or system administrator



Click on bika settings for the settings screen to open:


System defaults

Bika settings


Password lifetime defines the number of days before users’ passwords expire, requiring them to renew their passwords. A zero value implies passwords do not expire

Automatic log-off defines the number of minutes of inactivity before the system automatically logs the user off. A zero value implies automatic log-off is disabled

Member discount defines the discount percentage that is applied to members. In the client set-up, lab managers may set clients up as a member of the discount group

VAT % is the Value Added Tax percentage to be applied to services and products. The VAT may be changed per individual service, but this value sets the system default

Bika LIMS generates sequential serial numbers as new objects are created, e.g. analysis requests, worksheets and orders. The prefixes and formats for these serial numbers are defined in the Prefixes list

The prefix may include special characters, typically ‘XX-‘, and a certain length of the string to be used, A typical AR number, as shown in the screen shot above, would be AR-00001

NB It is important not to include any dashes 
in the actual prefix as these are programmatically used
to separate Sample IDs from AR IDs.



AR08- is valid but AR-08- is not

Click on [Save] to save your changes.


10.7. Calculation Types

Calculation Types available in the system to be applied to analyses are listed and maintained here

The calculations are used in the actual programming and cannot be modified without the intervention of programmers. The calculation descriptions are displayed with the instructions for analyses to analysts, and are the only information that should be edited here by lab staff

Bika 2 - Calculation Types


Click on the title of an existing Calculation to edit it


NB Do not delete one or add calculations unless under instructions from Bika programmers


Bika 2 - Edit Calculation Types

Title describes the title of the calculation, this will be populated in the Calculation Type drop down from your Analysis Services set-up, which is explained here

Description describes the formula to be used for the calculation and is for information purposes only

code describes that is used in the programs for the calculation


Click on [Save] to apply your changes

10.8. Instruments

Setting up Laboratory Instruments, and all their details, including calibration certificates and calibration expiry dates

All the lab instruments used by your lab are added and listed here and editable to lab managers. Analysis services can be assigned to instruments in their set-ups

The instrument data are currently not used for anything else and this repository mainly serves to keep instrument data in one central place. In future developments this will be expanded to a fully fledged instrument maintenance module


Bika 2 - Lab Instruments

Click on [add new instruments] to add a new instrument, or click on the title of an existing instrument to edit it. If you want to delete one, check the box opposite its title and press [delete] at the bottom of the page

Bika 2 - Edit Lab Instrument


Self explanatory: Title is for what the instrument is called in the lab, its Description and Type, Brand and Model, Serial No. Calibration Certificate is used to store the name of the calibration certificate that applies to the instrument and its Calibration Expiry Date


Click [Save] to apply your changes

10.9. Lab Contacts

Setting up Lab Contacts and their signatures

All the lab contacts available to your lab are added and listed here and editable to lab managers. Each department in the lab (set-up here), has a manager assigned to it, which can be selected from the list of Lab Contacts

In the Analysis Services set-up (covered here), each analysis is linked to a department. When an analysis request is published, the system looks up the responsible manager's contact details and publish it with the results to assist clients with queries

 The signature of the manager is used in printed results certificates


Bika 2 - Lab Contacts

Click on [add new labcontact] to add a new laboratory contact, or click on the title of an existing service to edit it. If you want to delete one, check the box opposite its title and press [delete] at the bottom of the page


Bika 2 - Edit Lab Contacts - 1

Self explanantory: Title e.g. Mr, Mrs, Dr, Miss, etc, Firstname, Surname, Email address, Phone (business),  Fax (business), Phone (home),  and Phone (mobile) for the mobile phone number where the lab contact can be reached

Bika 2 - Edit Lab Contacts - 2

Job title describes the job title of the lab contact
Signature allows a signature in image format (png, gif, jpeg) to be uploaded for use in published report. To select an image, click [Browse] and you can upload an image from your desktop.

Click [Save] to apply your changes






10.10. Lab Departments

Setting Lab Departments and their managers

All lab departments existing in your lab are added and listed here and editable to lab managers. The Lab departments are used to identify the lab managers responsible for published analysis results as all analysis services are assigned to departments

The responsible lab managers' names and contact details are then provided on results to provide a short cut to clients having queries


Bika 2 - Lab Departments

Click on [add new department] to add a new department, or click on the title of an existing department to edit it. If you want to delete one, check the box opposite its title and press [delete] at the bottom of the page


Bika 2 - Edit Lab Departments


Title describes the title of the laboratory department

Description describes the description of the lab department

Manager is a selection of Lab Contact (which is discussed here)

Click [Save] to apply your changes

10.11. Laboratory Information

The name of the laboratory as it will appear in browser frames, contact numbers, physical and postal address, email address and accreditation information

Click on the laboratory information link

A series of tabs will be presented with the |default| tab open where the laboratory name and contact details can be maintained. Using the [next] button, the lab addresses, bank account details and accreditation information  can be maintained on the subsequent |Address|, |Bank Account| and |Accreditation| tabs

Laboratory Name

bika 2 setup laboratory name

Laboratory details

Name describes the name of the laboratory
Registration number describes the laboratory registration number
Tax number describes the VAT/Tax number associated with your laboratory
Number of employees describes the number of employees working at your laboratory
Phone describes the phone number of your laboratory
Fax describes the fax number of your laboratory
Laboratory Confidence Level % describes the accuracy level of results across the laboratory. More details confidence lvels can be set-up in the Analysis Services section (see here)

Click on the [next] button to navigate to the address form

Laboratory Address

bika 2 setup laboratory address

Laboratory address details

You'll notice that there are three address sections; Physical Address, Postal Address and Billing Address, as the fields are all the same they will only be explained once, below.

Email address describes the laboratories email address
Address describes the address of the laboratory
City describes the city the laboratory resides in
State describes the province or state the laboratory is in
Postal Code describes the postal code  the laboratory is in
Country describes the country the laboratory resides in, you can select it, by using the drop down menu

Click on the [next] button to navigate to the bank account details form

Bank Account

bika 2 setup laboratory bank details

Laboratory bank details

Type of account describes the type of bank account that is used by the laboratory
Account name describes the bank account name used
Account number describes the bank account number used
Brancg code describes the branch number of the bank the laboratory uses
Bank name describes the name of the Bank

Click on the [next] button to navigate to the bank account details form

Accreditation


Bika 2 - Edit laboratory - accreditation

Check the Accredited checkbox if the laboratory has been accredited. This will cause the accreditation body logo to appear with its link to accreditation details, and indicate which analyses have been accredited. Accreditation body and certification texts can be edited in the i18n Translation files

To further enable accreditation, analysis services need to be identified as being accredited, this can be done here 

Accreditation Body Abbreviation describes the short name or abbreviation of the accreditation body and Accreditation Body its full name, Accreditation Body URL its  web address

Accreditation is the accreditation type for your lab, typically ISO 17025

Accreditation Reference holds the number or unique identifier that the accreditation body issued to your laboratory

10.12. Mail Templates

The lab manager or systems administrator maintains lay-out templates for results publication to clients as emails and faxes. Graphics, e.g. logos, may be included in the templates

Email templates

Click on the links to view and edit the email templates

Excerpt of email template

Click on the |edit| tab to edit the template

Email template edit

Click on [save] to commit the changes


10.13. Methods

Setting up lab methods and their descriptions

All the methods offered by your lab are added and listed here and editable to lab managers. The methods can then be assigned to analysis services in their set-up

Currently methods are not used anywhere else in the system (yet) but serves mainly as a repository for information regarding the lab methods. In future customisations this information could be surfaced where most needed by analysts, in work sheets say


Bika 2 - Lab Methods

Click on [add new method] to add a new method, or click on the title of an existing method to edit it. If you want to delete one, check the box opposite its title and press [delete] at the bottom of the page


Bika 2 - Edit Lab Methods

Title describes the title of the method
Method Description described the description of the method to be used for that analysis. This method is selected from the analysis service set-up, further explained here

10.14. Products

Products maintenance. Descriptions and prices. Not a common laboratory requirement but some co-operative laboratories supply chemicals, glassware and instruments to their members' smaller satellite laboratories. Other laboratories may use this facility to sell consultancy hours or simple lab products like distilled water

The products available for sale are defined here

Laboratory products

Click on a product title to edit or [add new product] for product details

Edit product details

The VAT % defaults to the system defined value, but may be overridden here for this product


10.15. Sample Points

The places from where samples are taken and their descriptions, normally a check point on a production plant, a specific fields in agriculture, a tank in wine, lat/long coordinates in geology etc

These are available on drop down menus on analysis request screens


Sample points


Click on [add new sample point] to add a new service, or click on the title of an existing service to edit it. If you want to delete one, check the box opposite its title and press [delete] at the bottom of the page


Sample point details

Edit or enter the Sample point Title and Description. Press [save] to submit your edits, [cancel] if you don't want to

10.16. Sample Types

Setting up and maintaining Sample Types

The type of samples which may be submitted. This list appears for selection when the Sample Type is entered into an analysis request


Sample types


Click on an existing sample type to edit it or the [add new sample type] button to create a new sample type. If you want to delete one, check the box opposite its title and press [delete] at the bottom of the page


On the Sample type details page:


Sample type details


Edit or enter the Sample type Title and Description

The sample type can be checked as Hazardous if necessary. Samples of this type will then be labelled as such and the sample will be displayed with hazardous icon in the system

Press [save] to submit your edits, [cancel] if you don't want to

10.17. Standard Stocks

QC Standard Stocks, Types and batches are maintained here

QC standards are described here in generic terms, as it would apply to bulk standard stocks or a batch of standard samples, or simply QC standard 'types' or 'templates'

When actual QC standard samples are added to the system, they are added for Standard suppliers and if the QC sample adhere to one of these Standard Stocks' definition, the record can be created from the stock, inheriting its properties

In some cases, the lab would literally make up its own Standard stock and then dilute parts of it at a regular basis to be used as QC control samples - from there then 'Standard Stocks'

bika 2 standard stocks list

To delete an existing stock, check the box next to it and click [delete]

Click on [add new standard] to add a new stock, or click on an existing one to edit it, the Standard stock details screen will open:

bika 2 standard stock details 1


Complete the compulsory Title field and supply a Description if you want to

If the stock has a limited shelf life, provide and Expiry date. Expired stocks will not be available when entering QC samples into the system. Date created can be used to record the date the stock was made up or manufactured

If the stock is of a Hazardous sample type, check the Hazardous check box


bika 2 standard stock details 2


Select which analyses the stock can be used a standard for by checking the corresponding boxes. Enter the expected results for the stock and the % error to be tolerated before 'out of range' alerts will be raised to analysts. Corresponding minimum and maximum values will be calculated by the system

Click [Save] to save the information

10.18. Users and Groups Administration

For system administrators only. Managing users, groups and their roles

Users

From the site setup page, select Users and Groups Administration to register personnel and assign their roles. Note that client contacts are not registered here – they are accessed via the Clients option on the main menu

Create a new user by clicking [add new user] on the user overview page, or serach for an existing user

find user

Find or add a user

[show all] Lists all users in the system


user list

Users

From this page, user email addresses may be modified in the email field, or passwords reset or the user removed by checking the corresponding checkboxes at far right, and clicking [apply changes] at the bottom of the page

Create a new user

Click on the [add new user] button to add a user

user registration form

Enter the details in the fields, return to User/Group management and assign the required roles for that user. Once the user details have been registered an email is sent by the server to the user, so that the user can set his/her own password.

Note: This email must be answered within 24 hours.

Editing a user

Click on the user name on the list to view or modify user details

User properties edit

Enter the user details, and optionally load a portrait of the user

Groups and Roles

Click on the |group membership| tab to assign this user to a group
Roles determine the authorisation and functionality the user has within the system
The following roles are defined:

  • member – all members of the portal are in the member group. Client contacts are typically only members of this group, and may view only their own company’s data
  • labmanager – Bika setup functionality and all other functionality except system setup functions reserved to the system administrator
  • labtechnician – analysts able to manage test results and worksheets
  • labclerk – able to receive samples, submit analysis requests and manage product orders
  • verifier –  permitted to verify and retract analysis requests and worksheets. This role must be combined with another role (e.g. labtechnician) to provide functional access to the system
  • publisher –  permitted to publish and retract analysis requests. This role must be combined with another role (e.g. labtechnician) to provide functional access to the system
  • manager
  • owner

Groups are logical collections of users, such as departments and business units. Groups are then given roles, and users are assigned to groups. The users within the group inherit the functionality of the roles assigned to the group

Click on the |groups| tab from the main Users and Groups Administration  area to manage groups

group overview

Groups overview


To assign roles to groups, select the appropriate checkboxes and click the [apply changes] button

Click on the [add new group] button to add a group, or click on the group name to view or modify group properties

Group properties

Adding Users to Groups

Users may be added to groups in two ways: Edit the user, and select multiple groups they should join, or edit the group and add multiple users

Click on the |group membership| tab of the user properties form:

 user group select

Group membership for user

The available groups are shown above, while the current groups to which this user belongs are shown below. Select the appropriate checkboxes and click on [add user to selected groups] to add the user. To cancel the user’s membership to the group select the appropriate checkbox from the Current Group Memberships list, and click on [remove selected groups]

To add multiple users to a group, click on the |group members| tab of the group properties form

group members select

Group membership

The available users are shown above, while the current group members are shown below. Select the appropriate checkboxes and click on [add selected users to this group] to add the user. To cancel the user’s membership to the group select the appropriate checkbox from the Current Group Members list, and click on [delete selected users]. Deleting a user does not remove the user from the system, it is only removed from this group


10.19. Worksheet Templates

The Bika 'Worksheet Template Engine' is used to create templates from which similar worksheets can be created repeatedly without having to go through lengthy manual processes every time such a worksheet is required for a certain instrument or workstation. The templates include functionality to specify QC controls for the work sheets derived from it

bika 2 worksheet template list


To delete an Worksheet Template, check the box next to it and click [delete]

Click on [add new worksheet template] to add a new stock, or click on an existing one to edit it, the Standard stock details screen will open:


bika 2 worksheet template details 1

Complete the compulsory Title field and supply a Description if you want to


bika 2 worksheet template details 2

If you are designing a worksheet template for a lab instrument with fixed number of sample positions, you may specify it in the Number of positions field. Press [reset] after entering a new number to adjust the number of positions in the table following immediately after:


bika 2 worksheet template details 3

You may specify normal analyses, of the types selected at the bottom of the screen, or any of Blank, Control or Duplicate QC analyses in any of the positions on the worksheet from the drop down menu as shown above

Calibration samples will be added to these in the near future - these will be used to apply correction factors to the results in the worksheet

Once a Blank or Control sample has been selected for a position, which standard to be used can be selected from drop down menus in the 3rd column as shown below:


bika 2 worksheet template details 4


The expected values for the Controls and Blanks will be used in the validation of results in the worksheets created with the template


bika 2 worksheet template details 5

Where a Duplicate sample has been specified, a drop down is activated in the last column to specify which position's sample must be used. In the worksheet results for these 2 positions will be compared as further QC measure



bika 2 worksheet template details 6


Finally which analyses to be performed on the samples in the positions marked Analysis, can be selected from the list of analyses at the bottom of the screen. More than one analysis may be selected for instruments which are capable of doing multiple analyses on the same sample

Click [Save] to save the worksheet template

 

www.bikalabs.com - Home of Bika Lab Systems, implementers of web based open source LIMS, Plone hosting and content management systems   Powered by Plone, the open source content management system. Customised and maintained by Bika Lab Systems