Welcome to Online Help
Search help and discover learning resources
Using Help
You can access help topics from the Help icon
The help is designed to display on a monitor, tablet, or mobile device. Depending on your device, you may need to scroll to view some content.
Navigate help topics from the menus at the top of the help window. Topics are organized to reflect the Main Menu in the product.
You can search within all topics (the default) or you can filter your search for a specific product area (for example, Timekeeping) or topic type (for example, How do I). To filter your search, click in the search box and select a filter.
To improve your search results, try these suggestions when entering search criteria:
- Enclose search strings in quotes (for example, "open a dataview").
- Ensure that there are no misspelled words.
- Try using a synonym instead.
- Remove terms if the search yields too many results, or add terms if the search yields too few results.
- Try using short phrases instead of entering a question.
- Check if you have a filter selected. You may be searching for information that is included in a different product area and may need to select another filter.
The information herein is subject to change without notice and should not be construed as a commitment by the manufacturer. The manufacturer is not responsible for any technical inaccuracies or typographical errors which may appear. This information or any part thereof may not be reproduced in any form without the written permission of the manufacturer. All rights reserved. © 2024 UKG Inc
Mobile app
A new version of the Mobile App client for iOS, version 2.7.3, is now available for download from the Apple App Store. The Android app remains at version 2.7.0 and is available for download from the Google Play Store. These versions contain minor bug fixes and enhancements. The Mobile App requires devices to be running at least Android version 6 or iOS version 12. Information about the Mobile App can be found in this online help system, in the Administration section.
Accessibility
The Main Menu is used to navigate the system, switch roles, and manage personal settings.
When the Main Menu is opened, focus lands on the Close button. Keyboard focus is trapped within the Main Menu until it is closed. To close the Main Menu, navigate to and activate the Close button, or press Esc.
The features in the Main Menu include:
- Employee Settings
- Edit Profile
- Sign out
- Navigation Search
- Navigation menu of user-enabled features
Use the Tab and Shift + Tab keys to navigate between these top-level items.
Employee Settings is available if you have multiple roles or work in a company with multiple Employer Identification Numbers (EIN) and need to switch between them.
Activate Employee Settings by pressing space or Enter to expand the section. This reveals the Roles section and EIN section.
If necessary, expand the Roles section by pressing space or Enter. Your available roles are implemented as a list of buttons. Press Tab or arrow through the list of roles. Activating a role immediately closes the main menu and reloads the home page with the features and permissions of the new role.
Press Enter to activate Edit Profile. A new Edit Profile page opens where you can manage the following:
- Password
- Picture
- Settings
- Locale
These topics are implemented as tabs and tab panels. Navigate between them using the up/left and down/right arrow keys. Open or close a section using space or Enter key. Only one section can be open at time. Navigate within a section using Tab and Shift + Tab.
- Arrow keys move between the top-level items, such as Change Picture and Reset Settings.
- When an item is expanded, you can tab through the interactive contents in the panel. Pressing Shift + Tab from the first interactive element in an open panel puts focus on the top-level item. For example, with focus on the Upload button, press Shift + Tab to put focus on Change Picture.
- When focus is on the last interactive item in an open panel press Tab to put focus on the next top-level item.
The Search field is the first element in the navigation menu. As you enter text in the Search field, the menu items are filtered and the screen reader announces the number of results. A Clear Search button becomes enabled once you have entered text into the Search field. Search results are displayed. If the search finds a submenu item, the top-level item is also displayed. For example, if you search for “emp,” the matching submenu Employee Summary is displayed as well as its associated top-level item, Time.
Menu Item Navigation
- The up and down arrows, as well as Tab and Shift + Tab, navigate through the top-level menu items. When the last top-level item has been focused, the next Tab or arrow moves focus back to the first top-level menu item.
- Press Enter or right arrow to expand a top-level menu item and put focus into the submenu.
- If a submenu is already open, press Tab to move focus from the top level item into the submenu.
- Submenu items navigate to a new page and are identified as links.
- The up and down arrows navigate items in the submenu and wrap to keep focus within the submenu.
- Press Shift + Tab to move focus out of a submenu to its associated top-level item. Press Tab within a submenu to focus the next top-level item. The submenu remains open.
- Press left arrow within a submenu to close the submenu and focus the associated top-level item.
- Press Tab or down arrow to move from the search input into the top-level menus.
- Press Shift + Tab to move from Home menu item back to the search, or to clear the search button if it is enabled.
You can access many of the most important actions in the system through tiles on the Home page. These tiles may include access to leave, time card information, punching in and out, notifications, and other functionality. The tiles you can access are determined by your organization.
Tile appearance
Tiles may appear in two different forms. If you are on the desktop, and Zoom is set to 200% or less, the tiles appear on screen with all content within them visible. If you are on mobile, or if the browser Zoom has been increased to more than 200%, the tiles visually appear as large buttons containing the name of the tile, and a decorative image. In either case, the tiles can be tabbed to, and any screen reader will read the name of the tile, followed by its state. For instance, “My Time Off Tile, 1 of 5, button collapsed”.
Navigating between tiles
Tiles are displayed on the Home page and you can Tab to them. Press Shift + Tab to go back to a previous tile. When you find the tile you want to interact with, press Enter or space to expand or enter the tile. Screen readers will announce Expanded, and focus is placed on the first interactive element in the tile. To collapse or leave a tile and return to where you can navigate between them, press Esc.
Navigating and reviewing information within tiles
Once you have entered a specific tile, you can navigate between interactive elements using Tab and Shift + Tab.
Tiles contain many different element types. Many of these elements are also found in other portions of the application. In general, you can navigate and interact with the following tile elements using the same methods throughout the system.
- Buttons usually perform an action within the tile itself and can be activated with Enter or space. In some cases, buttons may also take you to another page within the system. They can also frequently open sliders with further options and controls.
- Links are intended to take you somewhere else in the application, such as to the full-featured page related to the tile. You can activate links with Enter.
- List boxes can be opened with Enter or space. Use the up and down arrows to select the option you want, and press Enter to choose it. This closes the List box containing the option you chose, and you can Tab to the next element.
- Toggle buttons can be activated or deactivated with Enter or space. These buttons toggle an option from Yes to No or from enabled to disabled.
Not all content in a tile is interactive. When reviewing a tile with a screen reader, you can return to browse mode (NVDA) or Virtual PC cursor mode (JAWS) to read non-interactive content. When in this mode, try your screen reader’s quick access commands, such as “H” for heading.
- Press Tab to get to the Dataview items list.
- Press Tab to progress through the list options, including Dataview type and details buttons.
- Press space or Enter on the Dataview type button to go directly to the Dataview landing page.
- Press space or Enter on the details button to open a slider.
- Use browse mode and arrow keys to access the information within the slider and press Tab to get to the open Dataview link, then press space or Enter to activate.
- Press Tab to get to the action bar containing a row of buttons.
- Press space to activate the available buttons. This activates a dialog box or presents a list of options that you can navigate by using the arrow keys and pressing Enter to select.
- To make all buttons available, select one or more rows from the table.
- When buttons are disabled, they are skipped when using the keyboard and not announced when using NVDA.
- Press Tab to get to the Hyperfind selector link.
- Press space to activate the link to launch a searchable edit field.
- Press Tab to get to the options list.
- Use the up and down arrow keys to traverse the items and press Enter to select.
- With focus on an item, use the left and right arrow keys to discover if an item can be edited or deleted.
- Press Tab to access a find-by-location link.
- Press Enter to activate.
- A dialog box opens that contains a search field, additional fields containing dates that can be changed, and a business structure selector.
- Press Tab to get to the Cancel button to exit this dialog box.
- Press Tab to open the Timeframe Selector menu.
- Press space to expand the drop-down.
- Use the arrow keys to select a timeframe.
- Press space or Enter to select. While in the selections list, press Tab to access the date range button. Press Enter to activate.
- Edit fields containing start and end dates are presented by pressing Tab to access these fields. Use the arrow keys to change the dates in the Start Date and End Date fields.
- Press Tab to access the Cancel and Apply buttons and press Enter to activate.
- Press Tab to access the Previous and Next buttons to progress through pay periods without having to select from the Timeframe Selector menu.
The Employee Selector drop-down appears on landing pages to select employees.
- Press Tab to access the combo box and press space to expand it. Focus lands in a Search field so you can search for specific employees.
- Tab into the employees list and use the arrow keys to progress through the list of employees. Press Enter to select.
There are also buttons that enable you to progress through next and previous employees by pressing the Tab key to access these buttons, and then pressing Enter or space to select. Screen readers announce the number of employees in the list and where the user is within the list, for example, 1 of 40.
- When you are tabbing through sliders and other dialogs, date input fields contain the current date. By default, the date is in mm/dd/yyyy format in US locales.
- When in Leave, press Tab within the Edit Date fields to progress through the month, day, and year.
- Use the up and down arrow keys to change the month, day, and year.
- You can also tab to the Calendar button, press space, and use arrow keys and Enter to select a day that populates the date input field.
Note: Most date input fields only allow for typing in the full date in mm/dd/yyyy format and contain a pre-populated date. Other date selectors may not contain a pre-populated date.
- Press Tab to enter the column headers associated with the table
- The first column header allows for filtering of data. Press space to expand and arrows to progress through the list of toggle options. Press space to show or hide.
- Press Tab to get to a check box to select all rows, and then press space to select.
- Press Tab to hear the list of column headers from left to right along with their associated menus.
- Press space to expand the menus, use arrow keys to progress through options list, and press space to select and collapse the menu.
- Press Tab from the column header menus to get to the first column of check boxes to select individual rows, and press space to select.
- Alternatively, you can press the arrow keys when focused on a column header title to go directly to the table rows.
- Use the arrow keys to navigate within the table cells.
- Press space on a cell to activate a glance view menu that contains additional options. These options can also be located on the action bar
- Press Tab to get to and progress through the options list on the glance menu.
- Press space to activate a button that opens a slideout panel that appears from the right side of the screen.
- Press Escape to exit the slideout panel or to exit the glance menu.
- Press Tab to access the Table View button on the action bar and press space or Enter to change the view from Gantt View to Table View. Table View is the accessible view.
- Press the T key if only using the keyboard to place focus on the action bar, grid, and add-ons section.
- After selecting an action from the Quick Actions menu, navigate to the table using either Tab or the T key, and use the arrow keys and press space to apply an action to a scheduled shift. Quick Actions may not work properly when using NVDA.
- Glance menus containing different options can be activated depending on where in the grid they are activated.
- Press space when on the Employee column to activate a glance that contains options specific to employees.
- Press space on an empty or shift cell to activate a glance that contains options specific to shifts.
- You can add Dataview columns to the Schedule Planner grid. To access these options, tab from the action bar to the grid and then press the left arrow to land on the Employees column. Press the up-arrow, then press space on the Column Selection menu button to activate a menu containing check boxes that can be checked to display or unchecked to hide.
- Tabbing to cancel does not modify the grid columns.
- Select Apply after making selections to modify the grid to show or hide specific columns.
- Press the right arrow from the Show/Hide column menu to go to the Expand and Collapse column button. Press space on this button to show or hide columns in the grid.
- Press Enter when focused on a column header to sort by none, ascending, or descending. Note that you must press Enter each time a new sort selection is made. The Sort By value is announced by screen readers when focused on a column header.
- Press the left arrow when focus is on the column header button or use the up-arrow when focused on the first column of check boxes to place focus on the Select All menu. Press space twice to select or unselect all employees in the grid.
Note: Screen readers in focus mode should be enabled to access this menu.
Note: Hiding columns only displays the Employee name column in the grid, so if additional column selections were made, they will no longer be displayed.
Note: The Schedule Planner contains different views that can be accessed using the View By menu. These views include Employee (default view), Schedule Groups, Employment Terms, and Jobs. After making a selection, navigate in Table View as normal.
Note: The Jobs View does not have a Table View. It only has a Gantt View, which is not accessible at this time.
- Press Tab to access the column headers associated with the table.
- The first menu allows for filtering of data. Press space to expand and Tab to progress through the list of toggle options. Press space to show or hide. Press Esc to close.
- Press Tab to access the Select All check box, which places focus on the Select All Rows button. A confirmation message displays how many rows will be selected. Press Esc to close.
- Press Tab to return to the grid and the original Select All Rows check box.
- Press Tab to hear the list of column headers from left to right along with their associated menus.
- Press space on a column header to sort ascending, descending, or no sort.
- Press Enter to expand these column header menus.
- Use the arrow keys to progress through the options list and press space or Enter to apply.
- If no options are selected, press Esc to close this menu.
- Press Tab from the column header menus to get to the first column of check boxes to select individual rows. Press space to select. Alternatively, you can press the down-arrow key when focused on the Select All check box to go directly to the table rows.
- Use the arrow keys to navigate within the table cells.
- Press space on a cell to activate a glance view menu that contains additional options that are also located on the action bar.
- Press Tab to get to and progress through the options list on the glance menu.
- Press space or Enter to activate a button that opens a slider from the right side of the screen.
- Press Esc to exit the slider or exit the glance menu.
Focus is returned to the Unselect Rows button. Press space to unselect all rows. No confirmation message is provided.
Note: Focus may jump to a Select All button located in the action bar. Tab back to the table.
- To activate the Control Center notification icon in the top navigation bar, press space or Enter. The icon will expand to list the notifications. Tab through the individual notifications in the list and use the corresponding buttons to perform one of up to three displayed, available options. Press Enter on the entire card to open the notification item in the Control Center. Press Escape to close the panel.
- To access all notifications within the Control Center landing page, press space or Enter on the View All Notifications button or on a notification card.
- From the Control Center landing page, press Tab to access the action bar, category menu to the left of the notifications view, and to access the Details panel to the right of the notifications.
- Press Tab to access the Notification Categories list and use the arrow keys and Enter to navigate through and select an option to update the notifications list. The notifications are presented as a list located in the center of the page. Use the arrow and Tab keys to navigate through each of the notifications.
- Press Tab to view details and press space to select and deselect check boxes associated with notifications. After selected, details are updated in the Details panel and notifications can be approved, refused, or deleted from this panel or the action bar.
- Press Tab twice to access the primary details associated with each notification and press Enter to place focus on the Details panel.
- Press Enter on the Back to List button within this panel leads back to the last selected notification within the list.
- A filter drop-down menu contains options associated with specific types of notifications. Press space to expand, use the up- and down-arrows to navigate, and press Enter to select and collapse the drop-down.
- There are additional options to refine the notifications list by selecting a time period from the timeframe selector menu and selecting a Hyperfind from the Hyperfind menu. By default, these are set to None.
- Press the List View button to change the format layout of the timecard data.
- The data switches from a table to a list of items that are presented from left to right, top to bottom.
- Press Tab to get to the items list.
- Press Tab to progress through the items list and associated details.
- Press space on the date or punch pairs buttons to activate the same slider.
Note: You can use arrow keys to quickly navigate to specific day options.
If your timecard has been setup with accessible options, the approval and sign-off indicators appear like this:
All days approved by employee | |
Partly approved (multiple managers) This indicates that there are multiple approvers for the timecard and only some of the managers have approved the time that belongs to them on a given day. This indicator only appears if the timecard has been configured to show it. Note: The Partly approved (multiple managers) indicator only appears for daily approval values. The manager approval indicator for the date range will only appear blank (the date range is not fully approved) or solid (the date range is fully approved). |
|
All days approved by manager | |
All days signed off |
You can access many of the most important actions in the system through tiles on the Home page. These tiles may include access to leave, time card information, punching in and out, notifications, and other functionality. The tiles you can access are determined by your organization.
Tile appearance
Tiles may appear in two different forms. If you are on the desktop, and Zoom is set to 200% or less, the tiles appear on screen with all content within them visible. If you are on mobile, or if the browser Zoom has been increased to more than 200%, the tiles visually appear as large buttons containing the name of the tile, and a decorative image. In either case, the tiles can be tabbed to, and any screen reader will read the name of the tile, followed by its state. For instance, “My Time Off Tile, 1 of 5, button collapsed”.
Navigating between tiles
Tiles are displayed on the Home page and you can Tab to them. Press Shift + Tab to go back to a previous tile. When you find the tile you want to interact with, press Enter or space to expand or enter the tile. Screen readers will announce Expanded, and focus is placed on the first interactive element in the tile. To collapse or leave a tile and return to where you can navigate between them, press Esc.
Navigating and reviewing information within tiles
Once you have entered a specific tile, you can navigate between interactive elements using Tab and Shift + Tab.
Tiles contain many different element types. Many of these elements are also found in other portions of the application. In general, you can navigate and interact with the following tile elements using the same methods throughout the system.
- Buttons usually perform an action within the tile itself and can be activated with Enter or space. In some cases, buttons may also take you to another page within the system. They can also frequently open sliders with further options and controls.
- Links are intended to take you somewhere else in the application, such as to the full-featured page related to the tile. You can activate links with Enter.
- List boxes can be opened with Enter or space. Use the up and down arrows to select the option you want, and press Enter to choose it. This closes the List box containing the option you chose, and you can Tab to the next element.
- Toggle buttons can be activated or deactivated with Enter or space. These buttons toggle an option from Yes to No or from enabled to disabled.
Not all content in a tile is interactive. When reviewing a tile with a screen reader, you can return to browse mode (NVDA) or Virtual PC cursor mode (JAWS) to read non-interactive content. When in this mode, try your screen reader’s quick access commands, such as “H” for heading.
- If you are only using the keyboard in Scheduling, press the T key to access the add-ons area from the grid and press space to expand. You can also Tab from the Schedule Planner grid to access these add-ons.
- When in the Timecard, Dataviews, and Leave and Attendance, press Tab to navigate to the add-ons area and press space to expand.
- Press Tab to access an additional button that expands and collapses the add-on content.
- After the add-on has been expanded, press Tab to navigate to the Search field or Filter drop-down menu.
- Press Shift + Tab to return focus to the Collapse Add-On button and press space to close the add-on content but not the entire add-on.
- Press Shift + Tab to navigate back to the Close Add-On button that closes the entire add-on.
Note: When viewing Timecards and Dataviews in List View format, add-ons also display in this format. If using Table View, add-ons display as a table. The Table View is not optimized for screen readers, but can be navigated through and modified using the keyboard.
Note: Only Accruals, Totals, Work Summary, and Comments add-ons in Timekeeping and Scheduling are accessible in List View format.
- If you are using the keyboard or screen reader in focus mode, press Tab to progress through the edit fields, combo boxes, and buttons within the slider.
- Press space to activate buttons, use arrows to select radio buttons or check boxes, and press space or Enter to expand combo boxes.
- Press Tab to access the options list within the combo box containing a Search field and press Enter to select and collapse.
- Press the Apply button to confirm selections that may open additional sliders.
- Press the Cancel or Close button, or press Esc, to exit sliders.
Note: Interacting with content in browse mode using NVDA will read additional read-only content within sliders.
Note: If invalid date is entered in input fields, there may be errors that are announced, or the focus will remain in the field until you enter correctly formatted data.