Configure Flow for Microsoft Teams

UKG Flow allows you to punch The entries on a timecard that mark the beginning (in-punch) or end (out-punch) of a work interval, such as the beginning of a shift or transfer., submit requests, and view schedules in Microsoft Teams™ without the need to switch applications.

See the Overview of Flow topic.

  1. Gather the following tenant details and credentials:

    • Vanity URL (basic vanity URL or SSO URL)
    • Client ID
    • Client Secret

  2. Search for and download the UKG Flow app from the Teams marketplace.

  1. Configure the system setting as follows:

    1. Click Tap Main Menu  > Administration > Application Setup > System Configuration > System Settings > Global Values tab.
    2. Define the Flow Service callback URL. In global.oAuth.authCode.redirection.uris, add https://useast1-gateway.ukg.net/flex/flow/callback to the list of URLs. Separate this URL by a comma from any other URLs in the list.
    3. Click Tap Save.

  2. Configure the FAP as follows:

    1. Click Tap Main Menu  > Administration > Application Setup > Access Profiles > Function Access Profiles.
    2. Select the profile. Click Tap Edit.
    3. (Optional) Enter a Description.
    4. From Function, select APIs and do the following:
      1. To support attested punches, in Initiate Business Processes An organized flow of activities or tasks that achieves a business goal. An automated business process minimizes the amount of paperwork and manual tasks to complete that process by way of automatic actions, online forms, and automatically generated messages. API, select Allowed in Access Scope.
      2. Select Rest API. In Current User Information API, select Allowed in Access Scope.
    5. Click Tap Save & Return.
    6. Repeat for other people's FAPs.

UKG Flow supports notifications for the following request subtypes Classifications of schedule requests from employees.:

These notifications go to the Home page The page that is presented to the user upon login, which contains the tiles that let the user access or navigate to common tasks. and to the UKG Flow chat window.

Note: To receive the notifications, the recipients must have the UKG Flow application installed and registered.

Configure notifications for the request subtypes

  1. Click Tap Main Menu  > Administration > Application Setup > Employee Self Service > Request Subtypes.
  2. Select the time off or shift swap request subtype.
  3. Select the following:
    • For time off requests:
      • For Employee Pending Notification, select Request Status Change—Employee.
      • For Manager Notification, select Submission Notification—Manager.
    • For shift swap requests:
      • For Employee (Requester) Notification, select Shift Swap Request for Requester.
      • For Employee (Recipient) Notification, select Shift Swap Request for Recipient.

        Note: Manager notification is not needed for auto-approved shift swap requests.

  4. Click Tap Save.
  5. Repeat for another request subtype.

Connect the workflow notifications to Flex Flow services

  1. Click Tap Main Menu  > Administration > Application Setup > Event/Notification > Workflow Notifications Informs people to run business processes or integrations, complete forms, or respond to events in business processes. Example: Approve a time-off request.. 
  2. Select a workflow notification for the request subtype. Click Tap Edit.

    Workflow names are not standardized and can be named as needed. Example workflow names for the request subtypes include the following:

    • Request Status Change Employee
    • Submission Notification Manager
    • Shift Swap Request for Requester
    • Shift Swap Request for Recipient
  3. Select Trigger Business Process.
  4. In Template, select the most recent version of the Flex Flow Service Notification template.
  5. In Business Process will run as, select System User so that the notification is sent from the system account.
  6. Click Tap Save.
  7. Repeat for another workflow notification.
  1. Log in to the Microsoft Teams client.
  2. Click Tap Apps.
  3. Search for and select the UKG Flow app and click tap Add.
  4. In the Chat sidebar, click tap the UKG Flow app. If you don't find it, enter UKG Flow in the search bar.
  5. At the Register Tenant prompt of the Teams UKG Flow chat window, click tap Register Tenant.

    Note: If you need to re-register the tenant such as with a new URL — for example to change the vanity URL to move from UAT to Production — enter update registration and complete the registration process with the updated details.

  6. In UKG Flow Tenant Registration, enter the following credentials for the tenant:
    • Vanity URL
    • Client Id
    • Client Secret

    Note: To confirm that the entries are correct, you can click tap Show Credentials.

  7. Click Tap Register Tenant.
  8. To finish the configuration, the login page opens. This step does not log you in but it maps the tenant to the Teams workspace.

    Do the following:

    1. Enter your Username and Password.
    2. Click Tap Log In.
    3. Close the browser.
  1. Log in to Microsoft Teams with an employee user account.

  2. Click Tap the message input field of the Chat to verify that the following commands are available:

  3. Before you select a command, enter Login. Otherwise, you are prompted to log in each time that you select a command:
    1. You must click tap Login.

      Note: The log-in is valid for 7 days. During this time, you do not need to log in each time you access the commands.

    2. When you see the message that you successfully logged in, return to Teams.
  4. Click Tap or enter the command for each of the following:
    • Punch — Check that the Punch and View Punches buttons are shown, and that you can clock in or clock out. The available options vary depending on the attestation profile.
    • Request Time Off — Check that the Time Off Status and Time Off buttons are shown, and that you can submit a request.
    • My Schedule — Check that your schedule is shown.
    • Help — Check that definitions of the commands are shown.