Message Settings
You can configure the messages the WBCS returns to the clocks. Messages
can contain plain text and tokens which act as variables. The value of the
variable is inserted when the message is displayed. For example, the token
^&F represents the employee’s first name. Any
message containing the
^&F token, sends the first name of the employee who
is performing the clock punch. The following tokens can be used:
| Token | Description |
|---|---|
| ^&F | First Name |
| ^&L | Last Name |
| ^&D | Labor Metric Description |
| ^&S | The greeting based on swipe type. Check the
message.validation.swipetypegreeting.x settings.
|
| ^&T | The timed greeting based on the time of day. Can only be
used in the
message.validation.swipetypegreeting.x settings.
|
| ^&N | New line (if supported by the reader) |
| ^&H | The hour of the swipe in 24 hour format. |
| ^&h | The hour of the swipe in 12 hour format. |
| ^&m | The minute of the swipe. |
| ^&M | The month of the swipe in the
MM format.
|
| ^&K | The month of the swipe in the
MMM format.
|
| ^&Y | The year of the swipe in
YYYY format.
|
| ^&y | The year of the swipe in
YY format.
|
| ^&d | The day of the swipe in
DD format.
|
| ^&e | The day of the swipe in
DDD format.
|
| ^&A | AM / PM indicator |
| ^&n | Labor Metric Name |
| ^&l | The employee's last swipe type (for example,
01,
02)
|
| ^&g | The employee's last swipe type (converts the type to string
found in
message.validation.swipetypegreeting.x).
|
| ^&t | The employee's last swipe time
(YYYYMMDDHHMM).
|
| ^&E | The employee's message field. |
| ^&s | The employee's status. |
| ^&B | The employee's badge. |
| ^&0 | The employee's
udf0 field.
|
| ^&1 | The employee's
udf1 field.
|
| ^&2 | The employee's
udf2 field.
|
| ^&3 | The employee's
udf3 field.
|
| ^&4 | The employee's
udf4 field.
|
| ^&5 | The employee's
udf5 field.
|
| ^&6 | The employee's
udf6 field.
|
| ^&7 | The employee's
udf7 field.
|
| ^&8 | The employee's
udf8 field.
|
| ^&9 | The employee's
udf9 field.
|
Generally, each clock validation has at least one success message and one failure message. For example, when punching in, the badge validation message displays whether or not a valid badge was swiped. If an invalid badge was swiped the failed badge validation message is displayed. The details of the messages determine what is sent to the clocks. Clock messages are listed in the following format:
-
message.validation.MSG.okmessage = -
message.validation.MSG.badmessage =
On the WB5500 Series Clock, you can also configure the color the clock's LED flashes for each successful and failed validation. Similarly, with the Virtual Clock, you can configure the color the prompt flashes for successful and failed validations. The available colors are red, green, and orange. The color settings are in the following format:
-
message.validation.MSG.okmessage.color = -
message.validation.MSG.badmessage.color =
Also, on the WB5500 Series Clock, you can configure the number of times the clock beeps for each successful and failed validation. The beep settings are in the following format:
-
message.validation.MSG.okmessage.beep = -
message.validation.MSG.badmessage.beep =
The following settings determine the messages sent from the WBCS:
| Setting | Description |
|---|---|
server.validation.messagetimeout = 02
|
Length of time (in seconds) the validation message is displayed on the clock. Value must be two digits. For example, specify 01 for 1 second. |
message.languages = fr
|
The display language of the messages. |
message.no_validation_required_message = NO VALIDATION
REQUIRED
|
The message displayed on the first display line if no validation was applied |
server.enrollment.ok_message = Enrollment OK
|
The message displayed for successful enrollment. |
server.enrollment.bad_message = Enrollment Failed. Server
Error
|
The message displayed for a server error during enrollment. |
server.enrollment.timeout_message = Enrollment Timeout.
|
The message displayed for a server timeout during enrollment. |
message.validation.TerminalIPValidation.
okmessage=Welcome to Workforce Management
|
The clock's idle message. For some readers this message is set in the download file. |
message.validation.TerminalIPValidation.
badmessage=Unconf Terminal
|
|
|
|
The
BadgeValidation messages and settings.
|
|
|
The
AreaValidation messages.
|
|
|
The
SupervisorValidation messages.
|
|
|
The
SupervisorEmployeeValidation messages.
|
|
|
The
SupervisorReaderValidation messages.
|
|
|
The
ScheduleValidation messages.
badmessage is used when the employee does not
have a schedule. 'badmessage2' is returned when the employee is scheduled, but
is attempting to punch in early.
|
message.validation.BreakLengthValidation.okmessage=Meal
|
The
BreakLengthValidation messages.
|
|
|
The
ConsecutiveTypesValidation messages.
|
|
|
The
JobValidation messages.
|
|
|
The
DocketValidation messages.
|
|
|
The
TimeCodeValidation messages.
|
|
|
The
DepartmentValidation messages.
|
|
|
The
ProjectValidation messages.
|
|
|
The
JobAreaValidation messages.
|
|
|
The
DocketAreaValidation messages.
|
|
message.validation.TimeCodeAreaValidation.badmessage=^&D not allowed here |
The
TimeCodeAreaValidation messages.
|
|
|
The
DepartmentAreaValidation messages.
|
|
|
The
ProjectAreaValidation messages.
|
|
|
The
StatusValidation messages.
|
|
|
The
PINValidation messages.
|
|
|
The
SameMinuteValidation messages.
|
|
|
The
LastSwipeValidation class messages.
|
|
|
The
EmployeeUDFValidation class messages.
|
|
|
The
BadgeValidationWithLocal class messages.
|
|
|
The
BioCheckValidation class messages.
|
|
|
The
NewEnrollementValidation class messages.
|
message.validation.timedgreeting.morning=Morn
|
The various timed greetings that change based on the time of day of the swipe. |
|
|
This greetings can access the timed greetings defined above. |
|
|
HTTP clock messages. |