Configure Custom Tiles for Virtual Roster

How to configure custom tiles for Virtual Roster.

Configure custom tiles to embed Virtual Roster (MyVR) in the UKG Pro Workforce Management control center. If firewall, domain, and other rules permit when you select the tile, you are logged in to Virtual Roster automatically.

Virtual Roster Tiles for Managers

MyVR custom tiles for managers who use Virtual Roster

Managers can use the MyVR tile to do the following:

  • Manually approve or reject time-off requests for filtered groups, by accounting for seniority, accruals balances, and impacts on quotas.
  • Manually approve or reject shift swaps on selected dates between selected groups.
  • Set quotas for time off and short notice.
  • View budgets versus hours versus forecasts and standards.
Note: Do not enable scheduling or time-off request features in UKG Pro Workforce Management because all of these features are provided by MyVR. If needed, you can enable some read-only analytics scheduling features in UKG Pro Workforce Management.

Virtual Roster Tiles for Employees

MyVR custom tiles for employees who use Virtual Roster

UKG Pro Workforce Management provides employees with timecards, punches, attestation (if needed), and other time and attendance features. Employees who use Virtual Roster have different needs depending on the available feature set.

Note: To avoid redundant configuration in both systems:
  • Do not enable any scheduling or scheduling-related features in UKG Pro Workforce Management, including schedule edits, pick up or giveaway of shifts, entry of availabilities, or forecasting.
  • Do not enable time-off requests and related features in UKG Pro Workforce Management.

Schedules MyVR tiles

Custom tiles for Virtual Roster schedules allow employees to do the following:

  • Swap shifts with employees.
  • View and filter the Noticeboard to advertise and search for swaps, pick ups, and giveaways of shifts.
  • Pick up shifts that were made available by scheduling and by other employees.
  • Enter availabilities for shifts.
  • People, regardless of incompatible skills, can swap shifts so that all shifts are filled.
  • Customize rules for staff-to-staff swaps independently from schedule rule violations.

Configure Virtual Roster MyVR tiles for schedules as follows:

  • Label: MyVR Upcoming Shifts

  • Icon: icon-k-schedule

  • URL: <MyVR Address>/WfmIntegrationHandler.ashx?vrsName=<VRS Name>&tile=schedule

  • Navigation Label: My Schedule

  • Navigation URL: <MyVR Address>/WfmIntegrationHandler.ashx?vrsName=<VRS Name>&tab=roster

    Examples:

    URL: https://www.company.com/ESS/WfmIntegrationHandler.ashx?vrsName=PIP&tile=schedule

    Navigation URL:

    https://www.company.com/ESS/WfmIntegrationHandler.ashx?vrsName=PIP&tab=roster

Accruals balance MyVR tiles

Configure Virtual Roster MyVR tiles for accruals balances as follows:

  • Label: MyVR Accrual Balance

  • Icon: icon-k-wfr-accruals

  • URL: <MyVR Address>/WfmIntegrationHandler.ashx?vrsName=<VRS Name>&tile=leaveBalance

  • Navigation Label: Request Time Off

  • Navigation URL: <MyVR Address>/WfmIntegrationHandler.ashx?vrsName=<VRS Name>&tab=leave

    Examples:

    URL: https://www.company.com/ESS/WfmIntegrationHandler.ashx?vrsName=PIP&tile=leaveBalance

    Navigation URL:

    https://www.company.com/ESS/WfmIntegrationHandler.ashx?vrsName=PIP&tab=leave

Messaging MyVR tiles

Custom tiles for Virtual Roster messages show employees the following notifications:

  • Notifications by apps, SMS, and email about schedule changes, time-off approvals, and ad-hoc messages.
  • Global notifications by department to all employees.
  • Notifications about shift swap opportunities.
  • Drip-feed notifications about advertised shifts, with increasing frequency based on how soon the shift is scheduled to start.

Configure custom tiles for Virtual Roster MyVR messages and notifications as follows:

  • Label: MyVR Notifications

  • Icon: icon-k-alerts

  • URL: <MyVR Address>/WfmIntegrationHandler.ashx?vrsName=<VRS Name>&tile=messages

  • Navigation Label: Go to MyVR

  • Navigation URL: <MyVR Address>/WfmIntegrationHandler.ashx?vrsName=<VRS Name>&tab=messages

    Examples:

    URL: https://www.company.com/ESS/WfmIntegrationHandler.ashx?vrsName=PIP&tile=messages

    Navigation URL:

    https://www.company.com/ESS/WfmIntegrationHandler.ashx?vrsName=PIP&tab=messages

No embedded-content MyVR tiles

You can configure custom tiles for Virtual Roster that show no embedded content if you cannot make content available directly from the on-premises Virtual Roster application to UKG Pro Workforce Management. If you configure this no embedded-content tile, do not configure any other Virtual Roster tiles.

Use this tile if you cannot make embedded content available from the on-premises Virtual Roster to UKG Pro Workforce Management. If you use this tile, do not configure the other Virtual Roster tiles.

Configure the Virtual Roster tiles without embedded content as follows:

  • Label: MyVR Link

  • Tile Type: External URL

  • URL: <MyVR Address>/WfmIntegrationHandler.ashx?vrsName=<VRS Name>

  • URL Text: Go to MyVR

  • Description: Access schedules, automatic time-off request approval, Shift bids, Early-out lists, and more from MyVR.

  • Example URL: https://www.company.com/ESS/WfmIntegrationHandler.ashx?vrsName=PIP
    Note: You can use any URL that links to any MyVR tile. If you don't specify the tile, the link goes to the Home tab.

Configure Virtual Roster for custom tiles

How to configure Virtual Roster to support custom tiles.

  1. Disable all default scheduling and time-off related tiles or features for UKG Pro Workforce Management clients who will use Virtual Roster because Virtual Roster will provide these features.
  2. White-list the URL for VR Employee Self Service on the UKG Pro Workforce Management tenant.
    1. Get the URL from the Virtual Roster team.
    2. Enter a ticket to request and update the following tenant-specific system setting: global.oAuthToken.redirection.domain.whiteList
  3. When the system is configured to use UKG Authentication, provide the credentials for the custom tiles to the Virtual Roster team so that they can set up the integration. For information about the upgrade to UKG Authentication, refer to the Authentication Resources page.

Create Virtual Roster tiles

How to create custom tiles in UKG Pro Workforce Management for Virtual Roster.

Administration > Application Setup > Common Setup > Custom Tile.
  1. Select Main Menu > Administration > Application Setup > Common Setup > Custom Tile.
  2. Click Create .
  3. Enter a unique Name.
  4. Enter a Label. Examples: Enter MyVR Accrual Balance, MyVR Notifications, or MyVR Upcoming Shifts.
  5. In Tile Type, select Embedded Content to show the Virtual Roster data in the tile.
    1. In Icon, enter the path to a graphical icon to show in the tile.
      Note: This icon identifies the Virtual Roster tile in UKG Pro.
    2. (Optional) In Content Provider, select the organization that publishes the embedded content.
    3. In URL, enter the uniform resource locator as a fully qualified domain name (FQDN) to the location of the server for the integration handler.
      • Breakdown: https://<client URL>/<HANDLER>?vrsName=<VRSNAME>&tile=<TILE>
        Caution: The VRS name (Virtual Roster Service (VR Service) vrsName) is required and is the name of the VRS instance of the connection and also the Name of the ESS configuration. Example: vrsName=PIP.
        Note: URLs are case-sensitive. Make sure that the entire path is correct, in particular check the upper- and lower-case characters. The customer URL must match exactly the URL that users get when they log in to MyVR, in particular check /ess/ and /ESS/.
      • Example: https://www.acme.com/ESS/WfmIntegrationHandler.ashx?vrsName=PIP&tile=schedule
      • If a Content Provider is selected, the URL can be a relative or absolute path.

        To minimize maintenance, use a relative path. In a relative path, the (tenantExternalName) variable updates the company name only when the page loads. Example: /ta/ (tenantExternalName).hcmembed?InFrameset=1&navlink= hcmwidgets/pay#hcmwidgets/pay

      • If a Content Provider is not selected, the URL must be an absolute path.
    4. Select Navigation to configure more details about navigation to the embedded content.
      • In Navigation Type, select one of the following:

        Navigate to open Virtual Roster directly in the tile. This setting is preferable for UKG Pro.

        New Tab to open Virtual Roster in a new browser tab. This is suitable for desktop applications.

      • Ignore Navigation Menu.
      • In Navigation Label, enter a label for the tile. This label appears at the bottom of the tile and is clickable.
      • In Navigation URL, enter the uniform resource locator of the site to go to when the Navigation Label is clicked. Normally, this is the same address as in URL.

        Breakdown: https://<client URL>/<HANDLER>?vrsName=<VRSNAME>&tile=<TAB>

        Example: https://www.company.com/ESS/WfmIntegrationHandler.ashx?vrsName=PIP&tab=roster

  6. Click Save.
  7. Repeat for other tiles.

Assign the tiles

How to assign the Virtual Roster tiles to people.

Assign the Virtual Roster tiles to the display profiles and home pages of the people who need to see the tile. Assign the profiles to the people according to their role.

Note: For details about all of the options, refer to the Home Page Management and Display Profiles help topics.
  1. Click Tap Main Menu > Administration > Application Setup > Display Preferences > Home Page Management.
  2. Select a profile to update. Click Tap Edit .
  3. In Tiles, select the Virtual Roster tiles to add them to the profile.
  4. Click Tap Save.
  5. Repeat for other profiles.
  6. Click Tap Main Menu > Administration > Application Setup > Display Preferences > Display Profiles.
  7. Assign the Home Page Profile to the person's Display Profiles.
  8. Repeat for other profiles.