Device Configuration

Device configuration involves assembling device configuration profiles that consist of a collection of function-specific templates. Certain templates are augmented by collections of data, known as building blocks that define sets of transactions, definitions, schedules, and badge formats to be used by a device. Profiles are assigned and uploaded to one or more devices to uniquely configure them to communicate and exchange data with the Timekeeping system and the Universal Device Manager. With careful planning much the work of creating templates, building blocks, and profiles is done only once during the set up of the initial set of devices and does not have to be repeated when devices are added or modified.

Note: If templates or profiles are assigned to a device or device group, you cannot delete them. Default templates or profiles cannot be altered, but they can be copied. The device communication templates must be modified before they can be used. Other templates that you create can be modified at any time. If you modify a template that is assigned to one or more devices, download the configuration changes so that they take effect at the devices.

Select Configuration > Device from the main Universal Device Manager window to display the configuration grid. Click Tap View to toggle between the device and profile views of the grid.

In the device view, the configuration grid includes a row for each of the tenant's devices by default. The grid can show the following items for each device:

  • The device ID
  • The name of its device configuration profile (if any)
  • The device type
  • The name of its Communication Settings template (if any)
  • The name of its Application Configuration template (if any)
  • The name of its Default Transactions template (if any)
  • The name of its Soft Key Settings template (if any)
  • The name of its Transaction Settings template (if any)
  • The name of its General Settings template (if any)
  • The name of its Download Options template (if any)
  • The name of its Languages template (if any)
  • The name of its Cards and Readers template (if any)
  • The name of its Bells & Gates template (if any)

To reposition a column in the display, drag it to the desired location. With the exception of the first two columns, which are fixed, you can reposition other columns in the display by dragging the column to a different location. Condense or expand the grid by removing or adding any unpinned columns (columns with a blue heading). Click Tap Column Selection and select or deselect the appropriate columns. You can also remove a column by clicking tapping the downward open caret in the column heading and selecting Hide Column . Apply a sort to one or more columns by clicking tapping the downward open caret in the column heading and selecting Sort Ascending or Sort Descending . Select Remove Sort to remove the sorting from that column.

You can filter this list in several ways as needed:

  • By clicking tapping Filter and entering a full or partial search string in the empty cells immediately beneath the column headings.
  • By device groups and tags by selecting the check boxes corresponding to the desired device groups and tags in the Device Groups and Tags sections of the left panel. (Select the Available radio button to display all available groups and tags.) The filter applies OR logic across all selections to determine which devices or tags to display. You can also manage Manage device groups and Manage tags from these sections by clicking tapping Edit .
  • By status by selecting the check boxes next to one or more severity levels in the Filter View section of the left panel. Severity levels include Critical , Warning , Ok , Not Registered , Ignored , and Disabled . When a status is included in a filter, AND logic is used to populate the device grid.
Status Meaning

Critical

• When the device database reports a fatal error

• When the device database is full

• When the last device communication time exceeds six times the netcheck interval - 30 minutes by default (If a softload in progress, when the last device communication time exceeds 120 minutes )

Warning

• When the device database watermark is reached

Ok ,

• When the device is communicating with UDM

Not Registered

• When the device has been created in UDM, but the physical device has not yet registered/communicated with UDM
Ignored • When the device is in the Ignored state, will not report or alert on status changes
Disabled • When the device is disabled, it will not send punches into the system or accept downloads

The filters that have been applied are displayed just above the device list. A count of selected filters is also displayed. To remove a filter, click the next to its name.

To save the configuration grid as a .csv file, click tap Share Export .

Use the check boxes in the leftmost column of one or more rows to select or deselect one or more devices or click the check mark in the table header to select or deselect all devices.

The Actions that are available are dynamically generated depending on the selected device models. Click Tap the Action pull-down to see the available options and initiate these operations. Click Tap the New pull-down to add a new profile or device.

To update a device, click tap its device ID. The Update Device dialog is displayed.

In the profile view, the grid includes a row for each of the tenant's device configuration profiles by default. The grid can show the following items for each profile:

  • The name the its device configuration profile. The number of devices that are currently assigned to that profile appear in parenthesis just before the name.
  • The device type assigned to the profile.
  • The name of its Communication Settings template (if any).
  • The name of its Application Configuration template (if any).
  • The name of its Default Transactions template (if any).
  • The name of its Soft Key Settings template (if any).
  • The name of its Transaction Settings template (if any).
  • The name of its General Settings template (if any).
  • The name of its Download Options template (if any).
  • The name of its Languages template (if any).
  • The name of its Cards and Readers template (if any).
  • The name of its Bells & Gates template (if any).

To reposition a column in the display, drag it to the desired location. With the exception of the first column, which is fixed, you can reposition other columns in the display by dragging the column to a different location. Condense or expand the grid by removing or adding any unpinned columns (columns with a blue heading). ClickTap Column Selection and select or deselect the appropriate columns. You can also remove a column by clickingtapping the downward open caret in the column heading and selecting Hide Column . Apply a sort to one or more columns by clickingtapping the downward open caret in the column heading and selecting Sort Ascending or Sort Descending. Select Remove Sort to remove the sorting from that column.

You can filter this list by clicking tapping Filter and entering a search string in the empty cells immediately beneath the column headings.

To save the configuration grid as a .csv file, click tap Share Export .

Use the check boxes in the leftmost column of one or more rows to select or deselect one or more profiles or click the check box in the table header to select or deselect all profiles.

The actions that are available are dynamically generated depending on the device type assigned to the profile. Click Tap the Action pull-down to see the available options and initiate these operations. Click Tap the New pull-down to add a new profile or device.

To see a list of all devices to which a profile is assigned, select the number in brackets that precedes the profile name. The name and ID of each device is listed.

Device Configuration Profile

Templates are rolled up into a device configuration profile. The device configuration profile consolidates all the configuration information into a single profile that can be downloaded to one or more devices. One device configuration profile is assigned to each device. Multiple devices can use the same device configuration profile or different device configuration profiles.

Before creating a template for a device, you must create a device configuration profile. Templates are assigned to profiles. Profiles are assigned to devices.

You can configure templates in any order, although when a new device is first deployed the Communications Setting template is usually configured first, assigned to a profile, and then downloaded to the device in order to validate the configuration. Many templates of the same type may be configured to establish different device configurations.

Configuration modifications are made by changing a template, then downloading the configuration information to the devices that use the configuration profile that contains the template.

Add a new profile to the configuration grid by navigating to Configuration > Device and using one of the following methods:

  • From either device or profile view, select New > Profile.
  • From device view, on the plus-sign in the Profile column in the row for a device without an assigned profile. When you use this method, the new profile is automatically assigned to the device listed in the row.

In either of these cases:

  1. On the Create New Profile page, specify a name of up to 50 characters for the profile.
  2. Indicate the type of device to which the profile will apply. The type of device that you specify determines which configuration options Universal Device Manager will make available to you when you configure the templates that will be assigned to this profile.

Note: When creating a profile with InTouch DX as the device type, you will also need to select a profile type: Community or Individual.

  1. You can choose to start with the default profile or an existing profile. If you choose the latter, select the radio button for the profile that should be used as the basis for this one.
  2. ClickTap Next. The Application Configuration template displays. You can now proceed to create this or any other templates in this profile by clicking the template name in the template.

You can later edit this profile and its templates by clickingtapping its name in either device or profile view from the Device Configuration page or in the details panel of the Device Details page of a device to which the profile is assigned.

The InTouch DX allows devices to be configured with two profile types: Community and Individual.

Community Profile

A Community Profile is agnostic to employees and supports “punch and go”, where an employee can walk up to the clock, present their badge and be punched in for the day. When accessing transactions, employees need to authenticate every time they select a different transaction. A Community profile must be configured regardless of what mode the clock is in.

Individual Profile

An Individual Profile allows users to access session based, employee specific homepages. Users must log into the Individual Profile via a soft key on the Community homepage unless a device has been configured only to use Individual Profiles. Individual Profiles can be configured per employee, or the same profile can be assigned to many employees.

In an Individual Profile, users see their employee photo, name, and access transactions. Employees do not have to re-authenticate to perform many transactions, and can perform a Time Off Request and View Accruals without having to present their badge.

The Individual Profile settings have a subset of the Community Profile building blocks. The clock will utilize the communication, hardware settings, etc. from the default Community Profile configuration but show different soft keys and transaction configuration for the Individual Profile homepage.

Once an Individual Profile has been configured, it must be assigned to an employee profile in UKG Pro Workforce Management™. To assign an InPeople > Device Information > Individual Profile.

Note: If a non-home employee tries to access an Individual Profile, they will receive an Individual homepage with Community Profile transactions.

SmartLanding (Individual Mode)

SmartLanding notifies employees of their most recent unread messages from Message Center after they log into Individual Mode. The notifications can be dismissed by swiping up/down/right/left, they can be marked as read by selecting Close, or they can be selected for the user to read more information.

The notification display a max of 5 with the fifth card displaying that there are more unread messages to read. Selecting the fifth card will take the user the Message Center homepage.

To configure SmartLanding, users can select Enable employee message notification in the Individual Mode profile Transaction Settings.

 

Device Configuration templates and building blocks

Device Configuration templates are high-level templates that organize the parameters used to configure devices and control device functions. For example, all parameters that affect device communication with Device Manager are included in Communication Settings template. Certain templates, such as the Application Configuration and Cards and Readers templates, are augmented by collections of data, known as building blocks that define sets of transactions, definitions, schedules, and badge formats to be used by a device.

Configure one of each type of high-level template (except Transaction Settings) for a device configuration profile. If you are using a combination of device communication protocols (server-initiated and device-initiated), configure at least two Device Communication Settings templates.

Use the Communication Settings template to establish the communication protocol, server SSL setting, primary server and server port, primary instance ID, NetCheck interval, download retries, data collection setting, and device-initiated authentication.

The Communications Settings template is usually configured first.

Use the Application Configuration template and its building blocks and sub-templates to specify configuration settings for optional device parameters.

Use the Default Transactions template to specify the transactions that are generated when employees key in their badge numbers or swipe their badges at a local or remote reader.

Use the Configurable Transactions building block to define configurable transactions that may be assigned to soft keys.

Use the Total Definitions building block to configure devices to list totals definitions for home employees. A totals definition contains the sum of a specific calculation, such as hours worked or sick time earned.

Use the Work Rule Definitions building block to assign a device work rule to a device. Device work rule definitions map pay rules to work rules. Therefore, a single device work rule can be used at a device for work rule transfers.

Use the Soft Key Settings template to assigns transactions and schedules to soft keys after the transaction and schedules are configured in lower-level templates.

For the InTouch, use the soft keys settings editor to specify a soft key language, a default theme color, and device language setting for each soft key.

Use the Soft Key Schedules building block to specify the time range that a soft key is available for employees to access on a device.

Use the Smart Views building block to configure transactions to be displayed in the list of transactions that can be assigned to soft keys in the employee or manager mode.

Use the template to specify a range of items that may be configured so that a task is completed automatically or users are prompted for data.

Use the General Settings template to control how information appears on the device screen.

Use the Download Options template to select the options for downloading information from the timekeeping application to a device.

Use the Languagestemplate to assign languages to devices.

Use the Cards and Readers template to configure properties and formats for biometric devices, badges, bar code readers, proximity and smart card readers, and magnetic stripes.

Use the Generic Badge Formatsbuilding block to configure the format used by Generic Badges.

Use the Bells & Gates template to configure bell and/or gate schedules for those devices that support them.

To add a new template:

  1. Create a new template in the configuration grid by navigating to Configuration > Device and using one of the following methods:
    • Click Tap the name in the Profile column of the profile to which you want to add the template and then click tap the link for the template in the profile's template list.
    • Click Tap the plus-sign (+) in the column corresponding to the template in one of the rows in the configuration grid. In Device view, the Universal Device Manager assumes by default that you intend to associate this template with the device and profile listed in that row. In Profile view, it assumes that you intend to associate this template with the profile listed in that row and all of its devices. In either view, if no profile is listed in that row, you are asked to create a new profile.
  3. The new template inherits the values of its default template. Required fields are marked by an asterisk (*).
  4. Make the desired edits to the template, Consult the template's online help for descriptions of its fields. When you are done with your edits:
  5. Ensure that the Name field is not blank. It should contain the unique name of the template that you are creating.
  6. In Device view the Save changes to option lists the selected device; in Profile view it lists the selected profile. Click Tap Save to save your edits or click tap Cancel to dispose of them.

To edit an existing template:

  1. Open an existing template in the configuration grid by navigating to Configuration > Device and using one of the following methods:
    • Click Tap the name in the Profile column of the profile for which you want to change the template and then click tap the link for the template in the profile's template list.
    • Click Tap the name of the template in its row in the configuration grid. In Device view, the Universal Device Manager assumes by default that you intend to change this template for the device and profile listed in that row. In Profile view, it assumes that you intend to change this template for the profile listed in that row and all of its devices.
  3. The currently assigned template is displayed.
  4. Make the desired edits to the template, Required fields are marked by an asterisk (*). Consult the template's online help for descriptions of its fields.
  5. When you are done with your edits, select one of the Save changes to options. In Device view, you can save to either the individual device or to "All devices and profiles using this template." In Profile view, you can save the template to either the individual device or to "All profiles using this template.
  6. Click Tap Save to save your edits or click tap Cancel to dispose of them.
  7. When you click tapSave, the Universal Device Manager automatically determines the Save options that are possible when templates are modified in a given context. Doing so enforces the logic by which device profiles are bound: No single device profile can have two different versions of the same template.
  8. Consider any Guided Save options that Universal Device Manager suggests in the following scenarios.

Use case 1 — Device is assigned to a unique profile; the template being edited is used only by that profile.

Save changes to New template name required? New profile name required?
This device No No

Use case 2 — Device is assigned to a unique profile; the template being edited is used by more than one profile.

Save changes to New template name required? New profile name required?
All devices and profiles using this template No No
This device Yes No

Use case 3 — Multiple devices are assigned to the same profile; the template being edited is unique to that profile.

Save changes to New template name required? New profile name required?
All devices and profiles using this template No No
This device Yes Yes

Use case 4 — Many devices are assigned to the same profile; the template being edited is used by more than one profile.

Save changes to New template name required? New profile name required?
All devices and profiles using this template No No
This device Yes Yes

Use case 1 — Template being edited is unique to the profile.

Save changes to New template name required?
This profile No

Use case 2 — Template being edited is shared across multiple profiles.

Save changes to New template name required?
All profiles using this template No
This profile Yes

To assign a different template to a selected device or profile:

  1. Open an existing template in the configuration grid by navigating to Configuration > Device and using one of the following methods:
    • Click Tap the name in the Profile column of the profile for which you want to change the template and then click tap the link for the template in the profile's template list.
    • Click Tap the name of the template in its row in the configuration grid. In Device view, the Universal Device Manager assumes by default that you intend to change this template for the device and profile listed in that row. In Profile view, it assumes that you intend to change this template for the profile listed in that row and all of its devices.
  3. The currently assigned template is displayed.
  4. To assign a different template to the selected device in Device view:
  5. Click TapSelect existing, The "Select and save a template" panel appears.
  6. Select the template's name, and click tap Save to proceed (or Cancel to cancel the dialog and return to the configuration page). In Device view, a warning message appears that explains that saving the template will update only the selected device.
  7. Click Tap OK to continue saving the template (or Cancel twice to abort the save operation).
  8. You may be prompted to choose a new profile name for the selected device. Enter the new name and click tapApply.
  9. To assign a different template to the selected profile and all devices to which it is assigned in Profile view
  10. Click TapSelect existing,
  11. Select the template's name, and click tap Save. In Profile view, a warning message appears to explain that saving the template will be applied to the selected profile and all devices to which that profile is assigned..
  12. Click Tap OK to continue saving the template (or Cancel twice to abort the save operation).
  13. Click Tap Cancel to exit.

To make a copy of an existing template:

  1. Open an existing template in the configuration grid by navigating to Configuration > Device and using one of the following methods:
    • Click Tap the name in the Profile column of the profile for which you want to change the template and then clicktap the link for the template in the profile's template list.
    • Click Tap the name of the template in its row in the configuration grid. In Device view, the Universal Device Manager assumes by default that you intend to change this template for the device and profile listed in that row. In Profile view, it assumes that you intend to change this template for the profile listed in that row and all of its devices.
  3. The currently assigned template is displayed.
  4. Click Tap Duplicate.
  5. A dialog box appears with an editable text field with a value of <template-name>.copy.
  6. Rename this value as desired.
  7. Click TapSave to save the copy of the template or Cancel to cancel the operation.

 

To rename an existing template:

  1. Open an existing template in the configuration grid by navigating to Configuration > Device and using one of the following methods:
    • Click Tap the name in the Profile column of the profile that you want to rename and then clicktap the link for the template in the profile's template list.
    • Click Tap the name of the template in its row in the configuration grid. In Device view, the Universal Device Manager assumes by default that you intend to rename this template for the device and profile listed in that row. In Profile view, it assumes that you intend to rename this template for the profile listed in that row and all of its devices.
  3. The currently assigned template is displayed.
  4. Click Tap Edit to the right of the template name to modify it.
  5. A dialog box appears with an editable text field with a value of <template-name>.copy. Rename this value as desired.
  6. Note: If the template has unsaved changes when you click tap Edit , you will be asked to either cancel the edit and save the changes or discard the changes and proceed with the renaming.
  7. Click TapSave to save the renamed template or Cancel to cancel the operation.

To restore an assigned template to its default template:

  1. Open an existing template in the configuration grid by navigating to Configuration > Device and using one of the following methods:
    • Click Tap the name in the Profile column of the profile for which you want to restore the default template and then click tap the link for that template in the profile's template list.
    • Click Tap the name of the template that you want to restore to the default in its row in the configuration grid. In Device view, the Universal Device Manager assumes that you intend to restore the default template for the device and profile listed in that row. In Profile view, it assumes that you intend to restore the default template for the profile listed in that row and all of its devices.
  3. The currently assigned template is displayed.
  4. To restore a default template to the selected device in Device view:
    1. Click Tap Restore to default.
    2. In the informational window that appears, click tap Save to restore the default template (or Discard to cancel the dialog and return to the configuration page without changing the template).
    3. You may be prompted to choose a new profile name for the selected device. Enter the new name and click tap Apply.
  5. To restore a default template to the selected profile in Profile view, and all devices to which it is assigned:
    1. Click Tap Restore to default.
    2. In the informational window that appears, click tap Save to restore the default template (or Discard to cancel the dialog and return to the configuration page without changing the template).
    3. Click Tap Cancel to exit.

To delete one or more unused profiles or templates:

  1. Navigate to Configuration > Device.
  2. Select Action > Delete Profiles & Templates.
  3. In the Unassigned Profiles tab, select those profiles that you want to delete.
  4. In the Unassigned Templates tab, select those templates that you want to delete.
  5. Click Tap Delete.
  6. Click Tap OK to confirm the deletion.