Skip to content

Bika Lab Systems

Sections
Personal tools
You are here: Home Help Centre Manuals Bika Calendar Manual
Document Actions

Bika Calendar Manual

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.

This is a user manual for Bika Calendar. It can be used with Bika LIMS 2 for the calculation of late analyses and efficiency reports but is available as stand-alone product for integration in other Plone applications

1. Bika Calendar overview

Bika Calendar functionality

1.1. Introduction to Bika Calendar

This section aims to describe the general functionality of the Bika Calendar

True working hours calendar

For the calculation of late analyses, earlier Bika design uses total elapsed time between sample reception and results publication. Not actual elapsed working hours. This resulted in analyses being flagged late incorrectly after weekends and public holidays

The Bika Calendar functionality uses only true lab working hours for these alerts and turn around reports. The maximum time allowed for analyses is configured in the analysis services' set-up

Calendar management - default days, exceptions and holidays

The lab manager configures the lab's working days and hours for any future period by defining

default working hours, typically 'nine to five' and excluding weekends

holidays,  either public or organisation specific,

exceptions - days with longer or shorter working shifts that the defaults defined earlier

Calendar Portlet

Bika Calendar - portlet

When installed, Bika Calendar is available from the 'Working hours' link in the Plone Calendar portlet, and can be viewed from there. In the long term, the working hours functionality should be integrated with the Plone Calendar


Calendar details



Bika Calendar - view detail


Upon clicking the 'Working hours' link, the screen shown above appears. The screen shot above shows information about the 'Exception Day' which is triggered by clicking the mouse on the Exception Day. Similarly details will be displayed when hovering over other days.

Navigating to other months

You can navigate and see other months' details by clicking on the 'previous' or 'next' month link. In the example above, this would mean clicking on the 'october 2007' or 'december 2007' links.

Day's Details

By clicking on any day of the calendar information will be displayed on the right of the calendar with details about that day. In the example above, the 26th of November exception Day, 'Backlog clearing' was clicked, and the day's shifts and total working hours displayed:

26 November 2007
Backlog clearing
07:00 - 12:00
13:00 - 18:00
19:00 - 23:00

Total: 14h 0m

Legend

Bika Calendar - Default Day Regular working days, your standard 'nine to five'. See Section 2, Setting up Default day, on how to set it up

Bika Calendar - Exception Day Working days which have non regular working hours, say half days or days with extra working hours to deal with backlogs. To set it up, see Section 3, Setting up Exception Day

Bika Calendar - Holiday Non-working days, either public holidays or periods for which the lab is closed, e.g. Summer breaks. For more details and how to set it up see Section 4, Setting up Holidays

Bika Calendar - Non Work Day Standard non-working days, such as Saturdays and Sundays. These are days with no working hours and left untouched by setting up any of the above













2. Setting up Bika Calendar

Setting up standard working hours, exception days, holidays, and non work days with Bika Calendar

2.1. The Bika Calendar set-up

Setting up the Bika Calendar

The Bika Calendar is set-up by users with 'Lab Manager' rights from the Bika Set-up area - for Plone users, the same as Plone setup


Bika Calendar - Preference & setup


Access the bika set-up in two ways. Click on 'site setup' from the top right hand or on 'preferences' next to your user name. This will lead you to the set-up area


Bika Calendar - Bika setup


Click the Bika Calendar to enter Bika Calendar's set-up


Bika Calendar - Setup detail

2.2. Setting up Default Days

Setting up default working days in the Bika Calendar

Clicking on the |default days| tab of the Bika Calendar set-up brings up the following screen if you have default days set-up already for a given period, in this case for the 2007 calendar year

If its your first visit this page will be empty and you would head for the [add default days] button straight away


Bika Calendar Setup - Default Day View


This screen shows the default working hours per day of the week for a given period  and the amount of working time per day. Days for which no hours are shown, e.g. Saturday and Sunday. The only working days illustrated in the above example are  Monday, Tuesday, Wednesday, Thursday and Friday.

Adding / Editing Default Days

You can either create a new series of default days by clicking the [add default days] button, or you can edit the the current default days, by clicking any of the current set of default days

As an example, let's set up default working hours for the 2008 calendar year. After clicking [add default days], you'll see:


Bika Calendar Setup - Edit Default Days

Complete the fields like this

Title: This is the title given for the period of default working days, lets call it 2008 Standard hours in this example

Date from: Date that this working day range starts from, 1 January 2008

Date to: Date at which this working day series ends, 31 December 2008

Beware not to overlook the date fields, they default to the system date when opening the screen

Enter these dates from the drop down menus by clicking on the down arrows next to the year, month, day or click the calendar icon to make a selection from a calendar graphic interface:

Graphical calendar UI

The set-up allows for a number of shifts per day for which start and end times can be provided. The length of each shift and total for the day will then be calculated

Lets enter 2 shifts per week day, 09:00 to 13:00 and 14:00 to 17:00 and  half a day for Saturdays 09:00 to 14:00

The completed screen will then look like this:


Default days set-up completed


Once you're finished editing or adding work day details, click [submit] to save the new configuration. You will be returned to the default days summary, showing your latest edits

Default days set-up completed summary


2.3. Setting up Holidays

Setting up holidays in Bika Calendar

Clicking on the |holidays| tab of the Bika Calendar set-up will list all currently configured holidays set-up in the system, title, date and whether it is a public holiday


Bika Calendar Setup - Holiday View


If no holidays have been set-up, the screen will be empty

Adding / Editing Holidays

You can either create a new holiday by clicking the [add new holiday] button, or  edit the current holidays  by clicking on it. In this example we'll edit 'Buy nothing day':


Bika Calendar Setup - Edit Holiday


The form shows:

Title: This is the title given to the holiday
Date: The holiday date
Public Holiday: This toggles the holiday as public holiday to differentiate between public holidays when all businesses are closed country wide, e.g. holidays as announced by government, and laboratory specific holidays, e.g. Summer breaks

Enter the date from the drop down menus by clicking on the down arrows next to the year, month, day or click the calendar icon to make a selection from a calendar graphic interface:

Graphical calendar UI

Once you are finished adding or editing the holiday, click [save] to submit the data

2.4. Setting up Exception Days

Setting up exception days in Bika Calendar

The |exception days| tab of the Bika Calendar set-up opens the corresponding management screen. Exception days are working days with working hours different  to default working day, typically longer working days for clearing backlogs or half days for special occasions


Bika Calendar Setup - Exception Day View



This screen shows a list of exception days, title, date, start and end end times of shifts, and the total working time

Adding / Editing Exception Days
You can either create a new exception day by clicking the [add new exception day] button, or edit a current exception day, by clicking it. In the example above, this would be the 'Backlog clearing' link, bringing up its configuration screen:


Bika Calendar Setup - Exception Day Edit



Title: Description for the exception day
Date: Date of the exception day
Sessions: Here you can enter the length of the different shifts for the day, 3 shifts are currently facilitated. Specify start and end times for each and its duration will be calculated

When done, click [save] to submit your edits

14. Typical Applications of Bika Calendar

Example of applications of Bika Calendar, as used for Bika LIMS 2.0 late analysis alerts and efficiency reports

14.1. Late analysis alerts

In Bika's LIMS, lab managers assign a maximum period of time allowed for every analysis service. When any analysis spends longer than that in the lab, an alert is raised and displayed to all staff

When samples are received, the due date and time for each analysis requested for it is calculated using the maximum time set-up for it and the true working hours available from the Bika Calendar

When the due date is passed and the analysis result has not been published yet, it is listed at top right on all screens in a 'late analysis' portlet with very visual header


Late analysis alert


Clicking on an individual analysis will take the user to its analysis request where it can be investigated further or the client details be obtained from. A full report of all late analyses - the right hand column on this page also indicates how late the analyses are


Late analysis page


14.2. TAT report. Turn around times

In Bika's LIMS, the calendar is also use to accurately report turnaround times

Both late and early analyses are reported and lab managers may use the report to  establish where bottlenecks are developing in the sample flow through the laboratory

The report can be run for any given time period and all or specific clients. An example:

TAT report

 

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