Installing the WBCS in GUI mode (Windows, Linux/UNIX)

You must complete the prerequisite tasks before starting the installation in GUI mode.

See Before installing WBCS in GUI mode (Windows/Linux/UNIX)

The automated installer artifact requires a valid Java runtime environment (JRE) to run. You will receive a "Could not find a valid Java virtual machine to load" error if you do not have a valid JRE installed. See the Infor Workforce Management Hardware and Software Requirements Guide for information on a valid JRE that you can use.

  1. Browse to the location of the wbcs_setup_*.exe/bin file.
  2. Launch the executable file.
    In Linux/UNIX, use this command: ./wbcs_setup_*.bin
  3. On the Introduction screen click Next.
  4. Click Choose.. to specify the installation directory you want to use for the Clock Server and supporting files. The default installation path will depend on the operating system.
  5. Click Next to display the Shortcut Directory screen and select the location of the product icons and shortcuts.
  6. Click Next to display the Clock Server Service screen and specify this information:
    Specify Clock Server Service Name
    Specify the name for the Clock Server service on the machine. Use this name to find the service later.
    Initial Heap Size (MB)
    Specify the amount of memory on the server initially dedicated to the Java Virtual Machine.
    Maximum Heap Size (MB)

    Specify the maximum amount of memory on the server that can be dedicated to the Java Virtual Machine.

  7. Click Next to display the Clock Server Configuration screen and specify this information:
    Clock Server Name

    Specify the server name. This value must match the value of a server name specified in the Reader Server field in the system. To view existing clock servers or add new servers, select this menu path: Maintenance > Reader Setup > Reader Organization > Reader Servers.

    Badge Length
    Specify the number of characters of the employee badges or their swipe ID.
    Longest On (minutes)
    Specify the time (in minutes) after which a subsequent swipe is regarded as another ON swipe. Used for handling logical ON/OFF swipes. To disable this feature, enter 0 (zero). This field is used only by Synel clocks.
    Online Swipe Time (seconds)
    Used to determine if a swipe is considered offline. If the time (in seconds) between the swipe time and the Clock Server time exceeds this value, the swipe is considered offline. For example, if this value is 10, and the difference between the swipe and the Clock Server time is 30, the swipe is considered offline and treated as such. This field is used only by CMI clocks.
    Export Rejected Swipes

    Used to export rejected swipes from the Clock Server to the system. Applies to swipes that are rejected by validation failures only.

    E-mail Notification Support

    Select the check box to enable the feature that sends e-mail notifications of clock problems to a specified e-mail address. Clear the check box to disable this feature.

    Export Biometric Templates

    Import Employee Schedules

    Enables the importing of employee schedules to the clock server. The schedules are used to support employee schedule validation. Enables the exporting of biometric templates to the system. Used only when biometric clocks are used and biometric templates are required to be stored in the system database.

    Allow User Propagation Across Clocks
    For CMI clocks: When enabled, WBCS sends employee biometric information to all clocks in the employee’s reader group. This feature does not apply to Synel clocks, as they send biometric information to the clocks in the employee’s reader group in real-time as required.
  8. Click Next to display the Clock Server Task Schedule screen and specify this information:
    Update Local Database Interval (seconds)
    Enables the exporting of biometric templates toSpecify how often the database is updated.
    Export Swipes Interval (seconds)
    Specify the interval with which swipes are exported to the system.
    Export Reader Status Interval (seconds)
    Specify the interval with which the clock’s status is sent to the system.
    Schedule for Import Employee Schedules (HH:mm)
    Specify the time of day when schedules are retrieved from WFM. This option only appears if you selected the Import Employee Schedules check box on the previous screen.
    E-mail Notification Interval (seconds)
    Specify the interval at which email notifications are sent for terminal problems. This option only appears if you selected the E-mail Notification Support check box on the previous screen.
    Local Database Purge Schedule (HH:mm)
    Specify the time of day when the clock’s database is purged.
  9. Click Next to display the Clock Server Data Retention screen and specify this information:
    Journal Records
    Specify the length of time (in days) between the purging of the Journal table.
    System Messages
    Specify the length of time (in days) between the purging of the Message table.
  10. Click Next to display the WFM Communication screen and specify this information:
    Web Service URL
    Specify the URL to access the system instance. For example, http://hostname:port/axis/services
    WFM Username
    Specify the username used to access the system. For example, a systems administrator-level user.
    WFM Password
    Specify the password used to access the system. For example, a systems administrator-level user.
    Reader Server Name
    Specify the Reader Server name.
  11. Click Next. If you selected the E-Mail Notification Support check box on the Clock Server Configuration screen (in a previous step), the E-Mail Notification Settings screen is displayed. Specify this information:
    Mail Server (SMTP)
    Specify the Internet address of the mail server to use for sending the e-mail notifications.
    Username
    Specify the username needed to access the mail server.
    Password
    Specify the password needed to access the mail server.
    “From” E-mail Address
    Specify the e-mail address from which the notification will appear to have been sent. This address does not need to be valid.
    “From” Name
    Specify the name of the account or person from which the notification will appear to have been sent. This account does not need to be valid.
    “Reply To” E-mail Address
    Specify the e-mail address used by the recipient when replying.
    “To” E-mail Address
    Specify the e-mail address to which the notification will be sent. This address must be valid. This address can be an individual e-mail address or a group e-mail alias or distribution list address.
    Message Subject
    Specify the heading to be displayed as the subject for all e-mail notifications. For example, Clock Server Alert!
    “Ignore” Interval (seconds)
    Specify the length of time (in seconds) that the clock server does not consider as a change of reader status. This time setting affects whether or not an e-mail notification is sent. For example, if this setting is entered as 300 seconds, and the online reader goes offline for 50 seconds but comes back online, an e-mail notification is not sent.
    Note: After installation, these settings are included in the settings.conf file, and can be modified at any time after installation. 
    mail.server = mailserver.companyname.com
mail.username = ussername
mail.password = *******
mail.from = clockserver@companyname.com
mail.fromname = CompanyName Clock Server
mail.replyto = sysadmin@companyname.com
mail.to = sysadmin@companyname.com
mail.subject = Clock Server Alert
thread.mail.interval = 300
mail.formatter.ignore = 60
mail.formatter.class =
com.infor.wfm.clock.server.lib.StandardEmailFormatter

    The value of thread.mail.interval is the frequency at which the E-mail Notification thread runs. The default value is 300 seconds.

  12. Click Next to display the Reader Types screen.
  13. Select the check boxes next to the types of clocks you are connecting to the Clock Server. You can choose from these clock types:
    • HTML clock
    • CMI
    • Synel
    • Virtual Clock
    • Kronos
    • ATS
    • ATS 2-Finger Geometry
  14. Click Next. If you selected the HTML clock or Virtual Clock, the Clock Protocols screen is displayed.
    When specifying information for HTTP and HTTPS, you should keep in mind these considerations:
    • If HTTPS is configured incorrectly or partially configured, the HTTP protocol will not work either.
    • If you plan on using both HTTP and HTTPS, you must ensure that both are configured correctly.

    Specify this information for HTTP:

    Enable
    Select the check box to enable the HTTP protocol. If you are enabling both HTTPS and HTTP, you must select different port numbers for each protocol.
    Port
    Specify the default port for the HTTP protocol. The default port is 8500.

    Specify this information for HTTPS:

    Enable
    Select the check box to enable the HTTPS protocol.
    Port
    Specify the default port for the HTTPS protocol. The default port is 8443.
    Note: If you are enabling both HTTPS and HTTP, you must select different port numbers for each protocol.
    Keystore Location
    Specify the full path and name of the file where certificate keys are stored.
    Note: The directory and the certificate must be created before you run the installer. The default value of etc/keystore in the installer is a directory of etc and a certificate file named keystore. For more information, see Requesting a signed certificate for WBCS.
    Keystore Password
    Specify the password used to access the keystore.
    Key Manager Password
    Specify the password used to manage the keystore.
    Show Password
    Select the check box to display the password as clear text.
  15. Click Next to display the Admin Console Reader Commands screen.
    Note: This screen does not apply to the HTML clock and may appear in different locations depending on the type of clock you are installing.
  16. Select which Admin Console commands you want to enable by selecting one or more of these check boxes:
    Upload Program
    Sends the clock program to the clock.
    Set Message
    Sets the clock’s idle message.
    Enable Beep
    Enables warning/alarm beeps.
    Enroll User
    Enroll employees at the clock.
    Clear

    Clear information from the clock’s memory. The information cleared is clock-specific. For example, on a Synel clock, all offline transactions are cleared; on a CMI biometric clock, all biometric templates are cleared.

    Disconnect

    For the CMI clock only. Force the clock into offline mode, and the clock automatically tries to reestablish a connection with the WBCS.

    Set Retry Number
    Set the number of times the clock attempts to connect to the WB application.

    These commands are accessed in the Admin Console. You can only use the commands supported by the clocks connected to the WBCS.

  17. Click Next. If you selected either the HTML clock or the Virtual Clock clock types, the Name Resolution screen is displayed.

    Select the appropriate check boxes (HTML Clock, Virtual Clock) for your clocks and then specify this information:

    Field Containing Terminal Name
    Specify the system field name that contains the clock’s name which is defined when setting up clocks in the system. By default, udf0 is used. See the section related to your clock in the Infor Workforce Management Clock Installation and Configuration Guide.
    Name Resolution Refresh Rate
    By default, the refresh rate is 1 hour so that clock names are refreshed once an hour. Specify 0 to configure the clock server to perform a search with each communication session between the clock and the clock server. We do not recommend using the 0 option as too many system resources may be consumed.
  18. Click Next. If you selected the HTML clock, the Scheduled Swipes screen is displayed. Specify this information for Synchronization:
    Enable
    Select the check box to enable Scheduled Swipe synchronization.
    Interval
    Specify the interval in minutes between successive synchronization of Scheduled Swipes. Default is 5 minutes.

    Specify this information for Enable with Swipe Types:

    Clock In
    Select the check box to enable the presentation of Scheduled Swipes when performing a clock in swipe.
    Clock Out
    Select the check box to enable the presentation of Scheduled Swipes when performing a clock out swipe.
    Meal Start/End
    Select the check box to enable the presentation of Scheduled Swipes when performing a meal start or end swipe.

    If you are enabling Scheduled Swipes, you must select at least one swipe type.

    Specify this information for Display Threshold:
    Backward
    Specify the duration in minutes that the Scheduled Swipe display logic should “look back" when determining whether or not to display an individual scheduled swipe record. Default is 300 minutes.
    Forward
    Specify the duration in minutes that the Scheduled Swipe display logic should “look forward" when determining whether or not to display an individual scheduled swipe record. Default is 300 minutes.

    For more information on configuring Scheduled Swipes, see Using the Scheduled Swipes module (HTML clock) and Infor Workforce Management Scheduled Swipes Administration Guide.

  19. Click Next to display the Transaction Validation Selection screen.
  20. Select the check boxes corresponding to the types of transaction validations you want performed on clock punches as they are received by the clock server. These validations are available:
    Clock Address

    Validates that the clock’s IP address is correct, according to the records in the Terminals database table. This validation is only used with “push” clocks such as Synel. Other clock types do not use this type of validation.

    Employee Badge
    Validates that the employee’s badge is valid for the WBCS.
    Employee Schedule

    Validates that the employee is scheduled to work at the time of the clock punch, taking grace periods into consideration.

    Employee Supervisor

    Validates that the supervisor is the employee’s supervisor for supervisor-authorized transactions.

    Reader Supervisor

    Validates that the supervisor belongs to the reader group of the clock based on the employee group assignment. This does not apply to the 8000 Series Clock.

    Employee Area

    Validates that the employee is allowed to perform punches on the specific clock (the employee and clock both belong to the same reader group).

    Employee PIN
    Validates that the employee’s PIN is valid.
    Department
    Validates that the department associated with the clock punch is valid.
    Docket
    Validates that the docket with the clock punch is valid.
    Job
    Validates that the job with the clock punch is valid.
    Project
    Validates that the project with the clock punch is valid.
    Time Code
    Validates that the time code with the clock punch is valid.
    Break Length

    Used when employees perform a clock punch to end their break. This field validates that the break was long enough according to pay and schedule rules.

    Consecutive Types
    Validates that specific swipe types are not repeated consecutively in a specific time frame.
    Server
    Returns the version of the WBCS to be displayed on the reader.
    Supervisor
    Used for approval punches. This field validates that the approving supervisor is a supervisor.
    Job Area
    Validates that the job is valid for the clock’s reader group.
    Department Area
    Validates that the department belongs to the clock’s reader group.
    Docket Area
    Validates that the docket belongs to the clock’s reader group.
    Project Area
    Validates that the project belongs to the clock’s reader group.
    Time Code Area
    Validates that the time code belongs to the clock’s reader group.
    Same Minute

    Validates that the clock punch was not performed during the same minute as the previous swipe for the same employee.

    Last Swipe
    Returns the last swipe details to be displayed on the reader.
    Employee UDF
    Returns the contents of the employee’s UDF field to be displayed on the reader.
    Swipe Order
    Validates the order of the swipes.

    Depending on your previous selections, the Validation Failure Messages screen is displayed.

  21. Specify the validation messages to display on the clocks. For each validation you can supply an ‘OK’ message, used when the validation passes, and a ‘Bad’ message, used when the validation fails. Plain text messages are displayed as typed, but you can also use ‘tokens’, variables that display their value when the message is displayed. For example, specify ^&H:^&M to display the current time as part of a validation message.
    Note: These validation messages do not apply to the HTML clock.

    You can use any of these tokens in the validation messages:

    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. This token gets values from the greeting messages, configured in a previous step. This token can only be used in the message.validation.swipetypegreeting.x settings, also configured in a previous step.
    ^&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 or 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 value of the employee's udf0 field.
    ^&1 The value of the employee's udf1 field.
    ^&2 The value of the employee's udf2 field.
    ^&3 The value of the employee's udf3 field.
    ^&4 The value of the employee's udf4 field.
    ^&5 The value of the employee's udf5 field.
    ^&6 The value of the employee's udf6 field.
    ^&7 The value of the employee's udf7 field.
    ^&8 The value of the employee's udf8 field.
    ^&9 The value of the employee's udf9 field.
  22. Click Next. If you selected the Employee Schedule validation on the Transaction Validation Selection screen, the Schedule Validation Parameters screen is displayed.

    Specify this information in Apply to Swipe Types:

    Clock In
    Enables schedule validation for the Clock In swipe type.
    Clock Out
    Enables schedule validation for the Clock Out swipe type.
    Meal Start/End
    Enables schedule validation for the Meal Start/End swipe types.

    Specify this information in Configuration:

    Legacy Mode
    Select this check box to default to pre-7.2.0.0 behavior in the clock. This setting disables all other settings in this section. See the Infor Workforce Management Administration Guide for the 8000 or 9000 Series clock for more information on enabling schedule validation for your clock.
    Warn When No Schedule
    Select this check box for a swipe to be accepted with warning when no schedule exists at the time of swipe. See the Infor Workforce Management Administration Guide for the 8000 or 9000 Series clock for more information on enhanced schedule validation for your clock.
    Ignore Validation for Time Codes
    List of time codes which are always accepted even if there is no schedule.
    Furthest Schedule (minutes)
    Maximum duration between swipe time and schedule time to be considered early or late.

    Specify this information in Messages:

    No Schedule
    The message when no schedule is present.
    Early
    The message for an early swipe.
    Late
    The message for a late swipe.
  23. Click Next. If you selected the Break Length validation, the Break Length Parameters screen is displayed.

    Specify this information:

    Time Code
    Specify the time code used for breaks. By default, the BRK time code is used. To specify more than one time code, separate with a comma (,) or a semi-colon (;). For example, BRK,MEAL,COFFEE or BRK;MEAL;COFFEE.
    Break Length
    Specify the length of time allowed for breaks.
    Failure Message
    Specify the format of the validation message. See the previous step for the Validation Failure Messages screen for information on formatting tokens that can be used in this message.

    If you selected the Consecutive Types validation, the Consecutive Types Parameters screen is displayed. Specify this information:

    Minimum Time Between Swipes of the Same Type (min)

    Specify the minimum amount of time, in minutes, allowed between clock punches with the same swipe type.

    Swipe Types

    Specify the two-digit numbers of the swipe types you want to include in the consecutive types validation.

    Failure Message
    Specify the format of the validation message. See the previous step for the Validation Failure Messages screen for information on formatting tokens that can be used in this message.

    If you did not select Break Length or Consecutive Types validation, the corresponding parameter screens are not displayed.

    If you selected Swipe Order validation, the Swipe Order Validation Parameters screen is displayed. Specify this information in Apply to Swipe Types:

    Clock In
    Select to enable swipe order validation on Clock In.
    Clock Out
    Select to enable swipe order validation on Clock Out.
    Meal Start/End
    Select to enable swipe order validation for meal start or end.

    Specify this information in Configuration:

    Failure Message
    Specify the message to be displayed to the employee when the swipe order validation fails. Note that this is not applicable to HTML clocks.
    Proximity Threshold
    Specify the time gap between current and previous swipes within which swipe order validation is applied.
  24. Click Next to display the Swipe Responses screen where you can specify a message for different types of swipes. You must provide a value for at least one swipe type on this screen to proceed.
    Default response
    The default fallback response message format for a swipe.
    On
    Response message format for an On swipe.
    Off
    Response message format for an Off swipe.
    Timecode
    Response message format for a timecode change.
    Job
    Response message format for job change.
    Department
    Response message format for a department change.
    Docket
    Response message format for a docket change.
    Project
    Response message format for a project change.
    Directionless
    Response message format for a directionless swipe.
    New Employee
    Response message format for a new employee swipe.

    See the previous step for the Validation Failure Messages screen for information on formatting tokens that can be used in these messages.

  25. Click Next to display the Greetings Customization screen. This screen does not apply to the HTML Clock or Virtual Clock.
  26. Specify the greeting messages displayed on the clocks during different times of the day when employees perform clock punches. You can supply messages for any swipe type, such as when employees clock in or out. However, the actual swipe types used, and therefore the messages that are displayed on the clocks, depends on the type of clocks connected to the clock server and how they are configured.

    You can use any of the tokens described in the previous steps to create the messages. Ensure that the messages fit on the displays of the clocks connected to the clock server.

    To supply greeting messages, specify this information:

    Morning
    Specify the morning greeting displayed in any swipe type message that uses the ^&T token. This message is displayed between the time specified in the Morning Starts at (HH:mm) and Afternoon Starts at (HH:mm) field.
    Afternoon
    Specify the afternoon greeting displayed in any swipe type message that uses the ^&T token. This message is displayed between the time specified in the Afternoon Starts at (HH:mm) and Evening Starts at (HH:mm) field.
    Evening
    Specify the evening greeting displayed in any swipe type message that uses the ^&T token. This message is displayed between the time specified in the Evening Starts at (HH:mm) and Morning Starts at (HH:mm) field.
    Morning Starts at (HH:mm)
    Specify the time when the morning starts. This time setting is used to determine which timed greeting to display.
    Afternoon Starts at (HH:mm)
    Specify the time when the afternoon starts. This time setting is used to determine which timed greeting to display.
    Evening Starts at (HH:mm)
    Specify the time when the evening starts. This time setting is used to determine which timed greeting to display.
    ON Swipe
    Specify the greeting message displayed when an employee starts to perform an ON clock punch.
    OFF Swipe
    Specify the greeting message displayed when an employee starts to perform an OFF clock punch.
    Directionless Swipe
    Specify the greeting message displayed when an employee starts to perform a directionless clock punch.
    Job Swipe
    Specify the greeting message displayed when an employee starts to perform a job clock punch.
    Department Swipe
    Specify the greeting message displayed when an employee starts to perform a department clock punch.
    Project Swipe
    Specify the greeting message displayed when an employee starts to perform a project clock punch.
    Docket Swipe
    Specify the greeting message displayed when an employee starts to perform a docket clock punch.
    Time Code Swipe
    Specify the greeting message displayed when an employee starts to perform a time code clock punch.
  27. Click Next and select a supported Java runtime environment (JRE) for the WBCS by selecting one of these options. You must select a valid JRE and not the JDK. For example, C:\Java\<jdk>\jre\bin\java.exe is a valid selection, whereas C:\Java\<jdk>\bin\java.exe is not a valid selection.
    Note: You must set the PATH variable for Java before starting the installation. For more information, see Before installing WBCS in GUI mode (Windows/Linux/UNIX).
    Choose Java Executable
    Select this button if you want to manually select the java.exe file on your machine.
    Search Another Location
    Select this button if you want the installer to search for a supported Java VM on your machine.
    Note: See your Infor Workforce Management Release Notes for more information on the supported version of Java for the Clock Server.
  28. After locating a supported version of Java in the previous step, select the version of Java you want to use and click Next to display the Pre-Installation Summary screen.
  29. Review your installation option selections. Use Previous and Next to make changes to your selections.
  30. Click Install to begin the installation. The installation may take several minutes to complete.
  31. Click Done to complete the installation.
    If you are installing on Linux/UNIX, you will need to manually start the WBCS process after the installation has completed successfully. For more information, see Starting the WBCS (Linux/UNIX).