Registry Dispatch Classic Board (sys-viewer-vdsptchbrd-classic)

Purpose:

If this registry entry is not created, standard system defaults (and the various sys-dispatchboard-colors registry entries) will be used to display the Classic Board. The entries made in this registry override those used by default.

Usage:

The default classic board configuration used in the absence of this registry entry is described in Default Classic Board Configuration .

A Powerpoint presentation on setting dispatch board registry entries is available. Contact your support representative to obtain this step-by-step presentation.

Error Handling of Bad or Incomplete Registries

In releases prior to 9.1.611.043, it was possible to completely disable the Classic and./or Day boards by making an incorrect or missing infof# registry entries: a Runtime error: Key is missing would be displayed and the board could not be accessed.  In version 9.1.611.043 and above, a missing infof# setting will be replaced by the default WorkOrder,10,0@0 setting instead so that the user will at least be able to access the board. This also corrects a second 'Key is missing' error when the #infoFields registry key used by the Day and/or Classic board registries is missing.

Important Fields:

Id:

 sys-viewer-vdsptchbrd-classic

Maximum Calls

Setting Key: maxcalls Setting Value: #

This line controls the maximum number of calls (information cells) that will appear on the classic board per technician. The default value is set to 50. Since the Classic Board only displays one day at a time, you would typically set this field based on the number of techs on the board (plus ‘unassigned’) and the maximum number of work orders per day that might be assigned to a tech. A large number of calls may impact performance.

Default Font

Setting Key: font Setting Value: facename:pointsize:bold

This option sets the default font and point size for the Classic board infocells. Note that the :bold specification is optional. This default may be overridden for individual fields.

 Examples:

 Setting Key: font Setting Value: arial:7:bold

 Setting Key: font Setting ValueL: tahoma:8

Default Forground (text) Color

Setting Key: foreground Setting Value: 0:ClrDefault or foreground=color:Custom

This option sets the default text color for the Classic board. The default option sets the text to black. To set a custom color, do the following.

A. To enter the index number, enter all information up to the word Custom. In this example, you would type foreground=color:

B. After entering the colon : double-click on the line to display the Windows color selector palette, click on the desired color and then click OK.

Warning: Do Not Choose Dithered Colors on standard Citrix Systems)
On systems with color limitations (e.g., standard Citrix desktops), dithered colors should not be selected. Doing so may result in the text being indistinguishable from the background. Dithered colors can be identified by their spotty appearance on the color palette.

C. The system will replace the color text that you typed with the system color you selected in the palette.

Background Color – Empty Cells

Setting Key: background Setting Value: color:Custom

This option sets the default background color for the Classic board for cells that are not occupied by a work order. See the Foreground option above for details on setting the custom color.

Important Note: all registry options that use the color functionality must be correctly configured or a system primitive error will appear when the Dispatch Board is opened. These entries will NOT be ignored if an ‘x’ is placed in from of them to temporarily disable them.

Background Colors – Occupied Cells

Setting Key: infobackground Setting Value: field or

Setting Value: infobackground Setting Value: color:Custom

This registry sets the infocell background color based on a specific field (Priority, Work Code, Status or Service Zone) or to a specific color. By default, this field is set to status.

The field option sets the color by keying it to the dispatch board field that is referenced in one of the following settings:

sys-dispatchboard-colors (to set by Priority)

sys-dispatchboard-colors-status (to set by Status)

sys-dispatchboard-colors-workcode (to set by Work Code)

sys-dispatchboard-colors-zone (to set by Service Zone)

Tip: This colors the entire cell background, and may make the text difficult to read. You may prefer to set the foreground text (or background behind the text) of one or more of your info fields to your color-coding scheme as discussed in the colf# entry discussed below.

Column Header Settings

Setting Key: colforeground Setting Value: 0:ClrDefault or color:Custom

This option sets the column header text color for the Classic board. The default option sets the text to black.

Setting Key: colbackground Setting Value: color:Custom

This option sets the column header background color for the Classic board.

Setting Key: colheight Setting Value: #pixels

This option sets the column header height in pixels. It should match (or be larger which allows for scrolling) the gp-col-height-classic setting in the sys-viewer-dsptchbrd registy. If it is larger, however, lines will appear in the column header. (Note that the column width is effectively set by the infocellsize entry described below.)

Setting Key colfont Setting Value: facename:pointsize:bold

This entry sets the default font and point size for the Classic board column headers. Note that the :bold specification is optional. This default may be overridden for individual fields in the column header.

Setting Key: colfields Setting Value: #

This entry specifies the number of fields that will appear in the column headers of the Classic board. You must create a conf# entry (described below) for the number of colfields that you specify.

Setting Key: colf#

Setting Value: fieldname,#char,x@y,facename:pointsize:bold,endx@y,background,foreground

These entries define how the fields will be displayed in the column headers.

Fieldname

The following fieldnames pertain to corresponding fields in the Technician record – except for Hours. If you create an Hours entry, the total Hours selected for that Technician/Day will be displayed.

ID, Name, User1, User2, Skills (Special Skills? – displays as Y or N)
Insurance (Insurance? – displays as Y or N), Zip, Addrs1, Addrs2, State, City
Phone, Pager, Cell, Email, EmailFax, EmailPager
Hours (Estimated Hours for All calls for this tech – always set to 7 characters)

#characters

The number of characters that will be displayed for this fieldname.

x@y

The position of the text in pixels as defined by the upper left-hand corner of the first character.

facename:pointsize:bold

This font information is optional: it will default from the colfont= entry if not specified here.

endx@y

This setting is optional and only needs to be included if you are specifying the background and foreground colors of this field.

background,foreground

These optional settings enable you to control the foreground and background colors of this field.

 

Row Header Configurations

Setting Key: rowforeground=0:ClrDefault or rowforeground=color:Custom

This option sets the row header text color for the Classic board. The default option sets the text to black.

Setting Key: rowbackground=color:Custom

This option sets the row header background color for the Classic board.

Setting Key: rowwidth=#pixels

This option sets the row header width in pixels. It should correspond to the gp-row-width-classic setting in the sys-viewer-dsptchbrd register setting. (Note that the header row height is effectively set by the infocellsize entry described below.)

rowfont=facename:pointsize:bold

This entry sets the default font and point size for the Classic board row headers. Note that the :bold specification is optional. This default may be overridden for individual fields in the row header.

Setting Key: rowfields=1

Setting Key: rowf1=Index,#character,x@y

By default, the system displays an index number for each row. We do not recommend overriding the default settings.

Infocell Settings

Setting Key: infocellsize Setting Value: x@y

This option specifies the size, in pixels, of the information cells in the Classic board. This also effectively sets the column width and the row height of the headers.

Setting Key: infofields Setting Value: #

This entry specifies the number of fields that will appear in the information cells of the Classic board. You must create a infof# entry (described below) for each field you add or change.

Setting Key: infof#

Setting Value: fieldname,#char,x@y,facename:pointsize:bold,endx@y,background,foreground

Create one entry for each of the infofields you want to add or change from the default. These entries define how the fields will be displayed in the information cells of the Classic Board.

Fieldname

Valid fieldnames correspond to the fields labels displayed in the dispatch board’s work order list (for example, Site Alpha, Work Order, Workcode, Pr, Zone, etc.).

#char
The number of characters that will be displayed for this field.

x@y

The pixel position within the cell of the text as defined by the upper left-hand corner of the first character (e.g, 0@20).

facename:pointsize:bold

This font information is optional: it will default from the font entry if not specified here.

endx@y

This setting is optional and only needs to be included if you are specifying the background or foreground colors of this field.

background,foreground

These optional settings enable you to control the foreground and background colors of this field. You may specify a custom color, or the field used to set the color-coding scheme.

Example:
Assuming a color-coding scheme of Status, the following entry displays the first 15 characters of the work order’s Site Alpha text at the upper left-hand corner of the cell in Arial 10pt bold text. The text is displayed in black (0:ClrDefault) against a background the color determined by the status of this work order.

infof1=Site Alpha,15,0@0,Arial:10:bold,0@0,Status,0:ClrDefault