Configuring Dashboards

Forms See also

DASHBOARD—DashboardOptions Form

DASHBOARD—Designer Form

DASHBOARD—MDIDashboard Form

DASHBOARD—PropertiesWindow Form

DASHBOARD—Toolbar Form

Viewing Dashboards

Appendix - Program Settings

Configuring the Dashboard Application

Overview

Dashboards are used to design, script and preview CCLAS EL custom screen (SCR) files. SCR files contain screen layout definitions and VBScript to provide the interaction logic.

A custom screen viewed using the Dashboard application allows laboratory managers to view live laboratory status, from a controlling viewpoint.

This process is pertinent to LIMS and laboratory managers who configure the LIMS, and dashboards in particular.

Process

Dashboard design is managed using the Dashboard application.

Creating and Opening Dashboards in the Design Mode

Create a screen file

Existing screen files can be edited using the Dashboard application. The LIMS may be configured to make a backup copy of the opened file by copying the file to a BAK file in the same folder as the script.

Open a screen file in design mode

Note: Dashboards contained in SCR files that are saved in UTF-16 and UTF-8 UniCode format can be opened and updated by the Dashboard application, but can only be saved to SCR file in UTF-16 UniCode format.

Designing Dashboards

Grid lines are used to assist with the designing of screens. The LIMS may be configured to display grid lines by default, and set the height and width of grid rows and columns. Grid lines can be turned on or off, as required.

Toggle grid lines in screen design mode

When a dashboard is created, a Form control is added to the dashboard. A Form control defines the type of window display for the screen.

'FORM,1000,100,15000,10285,1

Once a Form control is added to the dashboard, the following control types are available for adding to the form. Shown along with the control is how the control is referenced in the associated script, with its comma-separated set of parameters. This full set of parameters is: ControlType, Fieldname, Tag, Caption, Tooltip, Top, Left, Width, Height, Mask, LookupTable, LookupField, LookupWhereClause, LookupOrderClause, ReadOnly, Script[,Frame]. Note that some controls do not require some of the parameters to be set as they are not relevant to that type of control.

  • Label

    'LABEL, Fieldname, Tag, Caption, Tooltip, Top, Left, Width, Height, Mask, , , , , ReadOnly, ,Frame(=Frame to which control is added; default is base frame)

    For example:

    'LABEL,Label11,,Label1 caption,Label1 tip,1035,75,1380,300,,,,,,,

  • Frame

    'FRAME, Fieldname, Tag, Caption, Tooltip, Top, Left, Width, Height, , , , , , , ,Frame(=Frame to which control is added; default is base frame)

    For example:

    'FRAME,Frame11,,Frame1,Frame11 TIP,525,1770,1065,1080,,,,,,,

    Associated events: Click, MouseDown, MouseMove, MouseUp.

  • TextBox

    'TEXTBOX, Fieldname, Tag, Caption, Tooltip, Top, Left, Width, Height, Mask, , , , , , ,Frame(=Frame to which control is added; default is base frame)

    For example:

    'TEXTBOX,TextBox11,,Textbox1 caption,TextBox1 tip,675,3045,1515,315,,,,,,,

    Associated events: Change, Click, DblClick, GotFocus, KeyDown, KeyPress, KeyUp, LostFocus, MouseDown, MouseMove, MouseUp, Validate.

  • MTextBox

    'MTEXTBOX, Fieldname, Tag, Caption(=Text box text), Tooltip, Top, Left, Width, Height, Mask, , , , , ReadOnly, ,Frame(=Frame to which control is added; default is base frame)

    For example: Change, Click, DblClick, KeyPress, Validate.

    'MTEXTBOX,MTextBox11,,MTextBox1 caption,MTextBox1 tip,540,4980,1515,675,,,,,,,

    Associated events: Change, Click, DblClick, KeyPress, Validate.

  • DTPicker

    'DTPICKER, Fieldname, Tag, Caption(=converted to Date), Tooltip, Top, Left, Width, Height, Mask, , , , , ReadOnly, ,Frame(=Frame to which control is added; default is base frame)

    For example:

    'DTPICKER,DTPicker11,,15/03/2007,DTPicker1 tip,1980,165,1215,345,,,,,,,

    Associated events: Change, Click, DblClick, GotFocus, KeyDown, KeyPress, KeyUp, LostFocus, MouseDown, MouseMove, MouseUp, Validate.

  • CheckBox

    'CHECKBOX, Fieldname, Tag, Caption, Tooltip, Top, Left, Width, Height, , , , , , ReadOnly, ,Frame(=Frame to which control is added; default is base frame)

    For example:

    'CHECKBOX,CheckBox11,,CheckBox1 caption,CheckBox1 tip,2025,1920,1890,360,,,,,,,

    Associated events: Click, GotFocus, KeyDown, KeyPress, KeyUp, LostFocus, MouseDown, MouseMove, MouseUp, Validate.

  • OptionButton

    'OPTIONBUTTON, Fieldname, Tag, Caption, Tooltip, Top, Left, Width, Height, , LookupTable(=Integer to set alignment), , , , ReadOnly, , Frame(=Frame to which control is added; default is base frame)

    For example:

    'OPTIONBUTTON,OptionButton1,,OptionButton1,Option Button 11 tip,1995,4275,1215,315,,0,,,,,

    Associated events: Click, DbklClick, GotFocus, KeyDown, KeyPress, KeyUp, LostFocus, MouseDown, MouseMove, MouseUp, Validate.

  • ListBox

    'LISTBOX, Fieldname, Tag, , Tooltip, Top, Left, Width, Height, , LookupTable, LookupField, LookupWhereClause, LookupOrderClause, ReadOnly, ,Frame(=Frame to which control is added; default is base frame)

    For example:

    'LISTBOX,ListBox11,listbox1,,ListBox1 tip,1830,5985,1560,450,,STAFF,STAFF_CODE,,,,

    Associated events: Click, DblClick, GotFocus, KeyDown, KeyPress, KeyUp, LostFocus, MouseDown, MouseMove, MouseUp, Validate.

  • MListBox

    'MLISTBOX, Fieldname, Tag, , Tooltip, Top, Left, Width, Height, , LookupTable, LookupField, LookupWhereClause, LookupOrderClause, ReadOnly, ,Frame(=Frame to which control is added; default is base frame)

    For example: Click, KeyDown, KeyPress, KeyUp, Validate.

    'MLISTBOX,MListBox11,MListbox1,,MlistBox1 tip,1800,7920,1740,450,,STAFF,STAFF_CODE,,,,

    Associated events: Click, KeyDown, KeyPress, KeyUp, Validate.

  • ComboBox

    'COMBOBOX, Fieldname, Tag, , Tooltip, Top, Left, Width, Height, , LookupTable, LookupField, LookupWhereClause, LookupOrderClause, ReadOnly, ,Frame(=Frame to which control is added; default is base frame)

    For example:

    'COMBOBOX,ComboBox11,,ComboBox1 Caption,Combobox1 tip,2775,105,2175,345,,STAFF,STAFF_CODE,,,,

    Associated events: Change, Click, DblClick, DropDown, GotFocus, KeyDown, KeyPress, KeyUp, LostFocus, Validate.

  • ListCombo

    'LISTCOMBO, Fieldname, Tag, , Tooltip, Top, Left, Width, Height, , LookupTable, LookupField, LookupWhereClause, LookupOrderClause, ReadOnly, ,Frame(=Frame to which control is added; default is base frame)

    For example:

    'LISTCOMBO,ListCombo11,,,ListCombo1 tip,2790,2595,1215,345,,STAFF,STAFF_CODE,,,,

    Associated events: Click, KeyDown, KeyPress, KeyUp, Validate.

  • CommandButton

    'COMMANDBUTTON, Fieldname, Tag, Caption, Tooltip, Top, Left, Width, Height, , , , , , ReadOnly, ,Frame(=Frame to which control is added; default is base frame)

    For example:

    'COMMANDBUTTON,CommandButton11,,CommandButton1 caption,CommandButton1 tip,2670,4185,1440,540,,,,,,,

    Associated events: Click, GotFocus, KeyDown, KeyPress, KeyUp, LostFocus, MouseDown, MouseMove, MouseUp.

  • PictureBox

    'PICTUREBOX, Fieldname, Tag, Caption(=Converted global variable containing the URL of the iimage), Tooltip, Top, Left, Width, Height, , , , , , ReadOnly(=whether to autosize), ,Frame(=Frame to which control is added; default is base frame)

    For example:

    'PICTUREBOX,PictureBox11,,,PictureBox1 tip,2685,6255,1365,540,,,,,,,

    Associated events: Click, GotFocus, KeyDown, KeyPress, KeyUp, LostFocus, MouseDown, MouseMove, MouseUp, Validate.

  • Grid

    'GRID, Fieldname, Tag, , Tooltip, Top, Left, Width, Height, , LookupTable, LookupField, LookupWhereClause, LookupOrderClause, ReadOnly, ,Frame(=Frame to which control is added; default is base frame)

    For example:

    'GRID,Grid11,,,Grid1 tip,2565,8310,1560,990,,STAFF,STAFF_CODE,,,,

  • F1Book

    'F1BOOK, Fieldname, Tag, , Tooltip, Top, Left, Width, Height, , LookupTable, LookupField, LookupWhereClause, LookupOrderClause, ReadOnly, ,Frame(=Frame to which control is added; default is base frame)

    For example:

    'F1BOOK,F1Book11,,,F1Book1 tip,3345,225,1500,1215,,STAFF,STAFF_CODE,,,,

  • CCPFD

    'CCPFD, Fieldname, Tag(=Converted global variable containing the INI file name), , Tooltip, Top, Left, Width, Height, Mask(=Update interval as a double byte numeric value), LookupTable(=Scroll bars as a long value), LookupField(=Boolean to indicate whether a border is displayed), LookupWhereClause(=Diagram name), , ReadOnly, ,Frame(=Frame to which control is added; default is base frame)

    For example:

    'CCPFD01,CCPFD11,\\PREDATOR\ELSITES\ACME\ACME_SET\CCPFD\CCPFD.INI,CCPFD00002,CCPFD1 tip,3585,2100,1200,450,1,0,0,CCPFD00002,,,

  • Chart

    'CHART, Fieldname, Tag, , Tooltip, Top, Left, Width, Height, , LookupTable, LookupField, LookupWhereClause, LookupOrderClause, ReadOnly, ,Frame(=Frame to which control is added; default is base frame)

    For example:

    'CHART,Chart11,,,Chart1 tip,3555,3765,1290,510,,STAFF,STAFF_CODE,,,,

  • TabStrip

    'TABSTRIP, Fieldname, Tag, , Tooltip, Top, Left, Width, Height, Mask(=Number of tabs, if >0, used to set tab captions), LookupTable(='~' delimited tab keys), LookupField(='~' delimited tab items), , , ReadOnly, ,Frame(=Frame to which control is added; default is base frame)

    For example:

    'TABSTRIP,TabStrip11,,,TabStrip1 tip,3690,5415,2085,435,3,KEY1~KEY2~KEY3~,Key1~key2~Key3~,,,,

  • ProgressBar

    'PROGRESSBAR, Fieldname, Tag, , Tooltip, Top, Left, Width, Height, Mask(=Min, if >0; default is 0), LookupTable(=Max, if >0; default is 100), LookupField(=Value, if >0; default is 100), , , ReadOnly, ,Frame(=Frame to which control is added; default is base frame)

    For example:

    'PROGRESSBAR,ProgressBar11,,,ProgressBar1 tip,3810,8205,1215,315,0,100,0,,,,

  • RichTextBox

    'RICHTEXTBOX, Fieldname, Tag, Caption(=Rich text box text), Tooltip, Top, Left, Width, Height, , , , , , ReadOnly, ,Frame(=Frame to which control is added; default is base frame)

    For example:

    'RICHTEXTBOX,RichTextBox11,RichText,RichTextBox1 caption,RichTextBox1 tip,5025,165,2055,450,,,,,,,

  • IExplore

    'IEXPLORE, Fieldname, Tag(=Converted global variable containing the navigated page), , Tooltip, Top, Left, Width, Height, , , , , , , ,Frame(=Frame to which control is added; default is base frame)

    For example:

    'IEXPLORE,IExplore11,,,IExplore1 tip,5010,2820,1995,450,,,,,,,

  • UniTextBox

    'UNITEXTBOX, Fieldname, Tag, Caption, Tooltip, Top, Left, Width, Height, Mask, , , , , ReadOnly, ,Frame(=Frame to which control is added; default is base frame)

    For example:

    'UNITEXTBOX,UniTextBox11,,UniTextBox1 caption,UniTextBox1 tip,4755,5220,1650,690,,,,,,,

    Associated events: Change, Click, DblClick, GotFocus, KeyDown, KeyPress, KeyUp, LostFocus, MouseDown, MouseMove, MouseUp, Validate.

  • MUniTextBox

    'MUNITEXTBOX, Fieldname, Tag, Caption(=Text box text), Tooltip, Top, Left, Width, Height, Mask, , , , , ReadOnly, ,Frame(=Frame to which control is added; default is base frame)

    For example:

    'MUTEXTBOX,MUTextBox11,,MUTextbox1 caption,MUTextBox1 tip,4815,7245,1800,735,,,,,,,

    Associated events: Change, Click, DblClick, KeyPress, Validate.

  • UniComboBox

    'UNICOMBOBOX, Fieldname, Tag, , Tooltip, Top, Left, Width, Height, , LookupTable, LookupField, LookupWhereClause, LookupOrderClause, ReadOnly, ,Frame(=Frame to which control is added; default is base frame)

    For example:

    'UNICOMBOBOX,UniComboBox11,,UniCombobox1 Caption,UniComboBox1 tip,4965,9330,1785,345,,STAFF,STAFF_CODE,,,,

    Associated events: Change, Click, DblClick, DropDown, GotFocus, KeyDown, KeyPress, KeyUp, LostFocus, Validate.

  • UniListBox

    'UNILISTBOX, Fieldname, Tag, , Tooltip, Top, Left, Width, Height, , LookupTable, LookupField, LookupWhereClause, LookupOrderClause, ReadOnly, ,Frame(=Frame to which control is added; default is base frame)

    For example:

    'UNILISTBOX,UniListBox11,,,UniListBox1 tip,5955,195,1905,450,,STAFF,STAFF_CODE,,,,

    Associated events: Click, DblClick, GotFocus, KeyDown, KeyPress, KeyUp, LostFocus, MouseDown, MouseMove, MouseUp, Validate

  • Timer

    'TIMER, Fieldname, Tag, , Tooltip, Top, Left, , , , LookupTable(=Interval), , , , ReadOnly, , Frame(=Frame to which control is added; default is base frame)

    For example:

    'TIMER,Timer1,,,,5955,2850,405,405,,0,,,,,

    Associated events: Timer.

  • DriveListBox

    'DRIVELISTBOX, Fieldname, Tag, , Tooltip, Top, Left, Width, Height, , , , , , ReadOnly, , Frame(=Frame to which control is added; default is base frame)

    For example:

    'DRIVELISTBOX,DriveListBox1,,,DriveListBox11 tip,5940,3675,1215,450,,,,,,,

    Associated events: Change, GotFocus, KeyDown, KeyPress, KeyUp, LostFocus, Scroll, Validate.

  • DirListBox

    'DIRLISTBOX, Fieldname, Tag, , Tooltip, Top, Left, Width, Height, , , , , , ReadOnly, , Frame(=Frame to which control is added; default is base frame)

    For example:

    'DIRLISTBOX,DirListBox1,,,DirListBox11 tip,5925,5310,1215,450,,,,,,,

    Associated events: Change, Click, GotFocus, KeyDown, KeyPress, KeyUp, LostFocus, Scroll, Validate.

  • FileListBox

    'FILELISTBOX, Fieldname, Tag, Caption(=Boolean to indicate whether read-only), Tooltip, Top, Left, Width, Height, , LookupTable(=Boolean to indicate whether archive), LookupField(=Boolean to indicate whether hidden), LookupWhereClause(=Boolean to indicate whether system), LookupOrderClause(=Pattern), ReadOnly, , Frame(=Frame to which control is added; default is base frame)

    For example:

    'FILELISTBOX,FileListBox1,,True,FileListBox11 tip,5895,6885,1215,450,,True,False,False,*.*,,

    Associated events: Click, DblClick, GotFocus, KeyDown, KeyPress, KeyUp, LostFocus, PathChange, PatternChange, Scroll, Validate.

  • Shape

    'SHAPE, Fieldname, Tag, Caption(=Hexadecimal border colour), , Top, Left, Width, Height, Mask(=Integer border style), LookupTable(=Integer shape), LookupField(=Hexadecimal fill colour), LookupWhereClause(=Integer fill style), , , , Frame(=Frame to which control is added; default is base frame)

    For example:

    'SHAPE,Shape1,,&H00000000,,6795,330,1215,495,1,0,&H8000000F,0,,,

  • Image

    'IMAGE, Fieldname, Tag, , Tooltip, Top, Left, Width, Height, , LookupTable(=URL of picture), LookupField(=Boolean to indicate whether to stretch to space), , , ReadOnly, , Frame(=Frame to which control is added; default is base frame)

    For example:

    'IMAGE,Image1,,,Image11 tip,6795,1860,1215,495,,,False,,,,

    Associated events: Click, DblClick.

  • OLEContainer

    'OLECONTAINER, Fieldname, Tag, , , Top, Left, Width, Height, , LookupTable(=Class), LookupField=(Source document; if LookupWhereClause=0, then create link using LookupField and LookupTable; if LookupWhereClause<>0, then embed from LookupField and LookupTable), LookupWhereClause(=Integer to set whether OLE type is allowed), LookupOrderClause(=Integer to set the display type), , , Frame(=Frame to which control is added; default is base frame)

    For example:

    'OLE,OLE1,,,,6870,3675,405,405,,,,2,0,,

    Associated events: Click, DblClick, GotFocus, KeyDown, KeyAscii, KeyUp, LostFocus, ObjectMove, Resize, Updated, Validate.

  • HScrollBar

    'HSCROLLBAR, Fieldname, Tag, Caption(=Integer to set large change), , Top, Left, Width, Height, Mask(=Integer to set small change), LookupTable(=Integer to set min), LookupField(=Integer to set max), LookupWhereClause(=Integer to set value), , ReadOnly, , Frame(=Frame to which control is added; default is base frame)

    For example:

    'HSCROLLBAR,HScrollBar1,,1,,6885,4695,1215,315,1,0,32767,0,,,

    Associated events: Change, GotFocus, KeyDown, KeyPress, KeyUp, LostFocus, Scroll, Validate.

  • VScrollBar

    'VSCROLLBAR, Fieldname, Tag, Caption(=Integer to set large change), , Top, Left, Width, Height, Mask(=Integer to sett small change), LookupTable(=Integer to set min), LookupField(=Integer to set max), LookupWhereClause(=Integer to set value), , ReadOnly, , Frame(=Frame to which control is added; default is base frame)

    For example:

    'VSCROLLBAR,VScrollBar1,,1,,6690,6615,315,1215,1,0,32767,0,,,

    Associated events: Change, GotFocus, KeyDown, KeyPress, KeyUp, LostFocus, Scroll, Validate.

  • Line

    'LINE, Fieldname, Tag, Caption(=Integer to set border width), , Top(Y1=Top), Left(X1=Left), Width(X2=Left+Width), Height(Y2=Top+Height), Mask(=Integer to set border style), , , , , , , Frame(=Frame to which control is added; default is base frame)

    For example:

    'LINE, Line1,,2,,10,20,1000,1200,1,,,,,,

  • GenericControl and Mask is like "VB.*", that is, one of: VB.TEXTBOX, VB.LISTBOX, VB.COMBOBOX, VB.CHECKBOX, VB.COMMANDBUTTON, VB.OPTIONBUTTON, VB.PICTUREBOX, VB.FRAME, VB.TIMER, VB.DRIVELISTBOX, VB.DIRLISTBOX, VB.FILELISTBOX, VB.SHAPE, VB.LINE, VB.IMAGE, VB.OLE

    'GENERICCONTROL, Fieldname, Tag, , Tooltip, Top(top for any control except VB.LINE where Y1=Top), Left(left for any control except VB.LINE where X1=Left), Width(width for any control except VB.LINE where X2=Left+Width), Height(height for any control except VB.LINE where Y2=Top+Height), Mask(=VB control type, otherwise implement clsCtlExtender), , , , , , , Frame(=Frame to which control is added; default is base frame)

  • GenericControl and Mask is NOT like "VB.*"

    'GENERICCONTROL, Fieldname, Tag, , Tooltip, Top, Left, Width, Height, Mask(=The licence for the control), , , , , , , Frame(=Frame to which control is added; default is base frame)

Parameters, as (.Name,.Value) pairs, associated with control events:

  • Change: None

  • Click: None

  • DblClick: None

  • DropDown: None

  • GotFocus: None

  • KeyAscii: ("KeyAscii", KeyAscii as Integer)

  • KeyDown: ("KeyCode", KeyCode as Integer), ("Shift", Shift as Integer)

  • KeyPress: ("KeyPress", KeyAscii as Integer)

  • KeyUp: ("KeyCode", KeyCode as Integer), ("Shift", Shift as Integer)

  • LostFocus: None

  • MouseDown: ("Button", Button as Integer), ("Shift", Shift as Integer), ("X", X as Single), ("Y", Y as Single)

  • MouseMove: ("Button", Button as Integer), ("Shift", Shift as Integer), ("X", X as Single), ("Y", Y as Single)

  • MouseUp: ("Button", Button as Integer), ("Shift", Shift as Integer), ("X", X as Single), ("Y", Y as Single)

  • ObjectMove: ("Left", Left as Single), ("Top", Top as Single), ("Width", Width as Single), ("Height", Height as Single)

  • PathChange: None

  • PatternChange: None

  • Resize: ("HeightNew", HeightNew as Single), ("WidthNew", WidthNew as Single)

  • Scroll: None

  • Timer: None

  • Updated: ("Updated", Code as Integer)

  • Validate ("Cancel", Cancel as Boolean).

The Pointer control is used to select controls that are already on the form.

Add a control to a screen

Important: A known issue is that the height is not controllable when a control is placed on a screen.
Also, if a control is added within a frame and goes over the edge of the frame (usually when it is added near the bottom of the framed area), then the control is placed in the background, under the frame control. To ensure that this problem does not occur, it is best to place controls on the form first so that they can be resized to the desired height before adding the frame.

When a control is added to the screen, the LIMS may be configured to snap the control to the grid by default. Snapping controls to grid can be turned on or off, as required.

Toggle snap to grid in screen design mode

Align controls on a screen

Set screen controls to the same width and/or height

Once the screen is designed, it can be previewed.

Preview a screen file

Editing the SCR File in an Editor

The CCLAS default script editor can be used to edit SCR files directly, however, the LIMS may be configured to use a UniCode compliant editor. The default script editor is not UniCode compliant and will not display the characters for locales that use UniCode characters.

Edit a SCR file using an editor

Saving Dashboard Prompts to the LANGUAGE_ITEM Table

Prompts in dashboards (or any SCR file) are saved to the LANGUAGE_ITEM table so that the prompts can be localised to other languages.

Field in the LANGUAGE_ITEM Table Setting

LANGUAGEID

Current language set in use.

MESSAGETYPE

3

MESSAGENUMBER

n, incremented for each prompt on the Dashboard screen.

PROGRAMCODE

DASHBOARD

CONTROLTYPE

Type of control.

MESSAGECODE

Name of control.

PROMPT

Prompt text.

TOOLTIP

Prompt tool tip.

ISTRANSLATED

NULL

Note: Where controls have the same type and name in different dashboards, keep the names of controls used across dashboards unique to the individual dashboard so that there are no duplicate records in the LANGUAGE_ITEM table.

Save screen prompts to the LANGUAGE_ITEM table

Configuring Dashboards to Display in View Mode upon Application Startup

Once dashboards are configured for the laboratory, various users may want to run the Dashboard application and have their dashboard automatically presented to them. To do this, place the SCR files in the CCLAS Dashboard folder defined by the CCPFDDirectory DASHBOARD program setting, for example, %CCLASRootDirectory%CCPFD, and set the DashboardStartupScreen DASHBOARD program setting to the dashboard file, for example, %CCLASRootDirectory%Config\DashBoard.SCR.