Upgrade the Return to the Workplace solution
This article provides step-by-step instructions for how to upgrade the existing Return to the Workplace solution to the latest version. If you're deploying the solution for the first time, see Deploy the Return to the Workplace solution. Follow the steps to upgrade the solution, and then follow the upgrade path that is applicable for you.
Prerequisites
You must be a global administrator or Microsoft Power Platform administrator to do the installation.
You must be a global administrator and must have a Power BI Pro license to configure and publish reports.
You must have installed the earlier version of Return to the Workplace and have the environment details.
Tip
Upgrading the solution affects the user experience. We recommend that you upgrade the solution outside of normal business hours. Also, test the changes on a development or test environment before moving the solution to a production environment.
Step 1: Update the solution
You can update the Return to the Workplace solution by using the Power Platform admin center.
Note
If you're a US Government customer, you'll have to update the solution by using the latest version of the deployment package available on GitHub. More information: Appendix: Deploy the app and publish Power BI dashboard (US Government customers only)
Sign in to the Power Platform admin center.
On the left pane, select Environments, and then select the environment where you want to update the solution.
On the left pane, select Resources > Dynamics 365 apps. From the list of apps, select Power Platform Return to the Workplace - Apps, which is the Return to the Workplace solution.
The status field indicates that there's an update available for Power Platform Return to the Workplace - Apps. From the command bar, select Update or select the Update Available status to start the update process. From the command bar, you can also select Details to see the progress of the installation.
For more information about the update process, go to Manage Dynamics 365 apps.
Step 2: Update Power BI dashboards
When a new version of the Return to the Workplace solution is available, you can be notified in two ways:
An update banner appears in the Power BI Service informing you that a new app version is available.
You'll receive a notification on the Power BI notification pane.
Note
If you're a US Government customer, you'll have to update the Power BI dashboard using the latest version of the deployment package available on GitHub. More information: Appendix: Deploy the app and publish Power BI dashboard (US Government customers only)
To install the update, either select Get it on the notification banner or in the notification center, or find the app in the Microsoft AppSource marketplace and select Get it now. If you have a direct link for the update, select the link.
You'll be asked whether you want to overwrite the current version or to install the new version in a new workspace. By default, Overwrite an existing version is selected.
If you already installed the existing version, leave it on Overwrite an existing version. Select Install to a new workspace to install a fresh version of the workspace and app that you need to reconfigure (connect to data, define navigation and permissions).
Install the app in a new workplace by following these steps in the deploy article:
Upgrade from version 1.0 to 1.1
Step 1: Install the Workplace Care Management dashboard
You can use the Workplace Care Management dashboard to track overall employee cases. More information: Use the Workplace Care Management dashboard
To install the Workplace Care Management dashboard, follow the instructions in Deploy the Return to the Workplace solution.
Step 2: Update facilities
With the new version, we are introducing the notion of areas and floors for a facility. A floor indicates how many levels are present within a facility. An area allows you to define a space within a floor that has a certain capacity. Through bookings in the Employee app, you can book an area. More information: Use the Facility Safety Management app.
Facilities now also have entry windows defined, which allow you to indicate in which time window people can enter the building. More information: Use the Facility Safety Management app.
Step 3: Define capacity for your reopen phases
Capacity is defined for an area, but it's also bound by the phase your facility is in. Every reopen phase defines the percentage by which capacity will be limited. More information: Configure the solution
Step 4: Make employee cases inactive
In the new version of the solution, employee cases become inactive when they're completed. More information: Use the Workplace Care Management app
Upgrade from version 1.1 to 1.2
Step 1: Configure the solution settings
With the introduction of version 1.2, you will see more options in the solution settings. Numerous features are now configurable in the solution settings. For guests, we added new terms of agreements that are required. More information: Configure the solution
Step 2: Set up duplicate detection rules for employee cases
To limit the number of employee cases on an employee, it's possible to set up duplicate detection rules that warn you when making multiple employee cases. More information: Configure the solution
Step 3: Facility access available
In previous versions, it was possible to indicate on an employee case whether the employee is allowed to enter a facility. This release changes the process so it blocks the employee from entering a facility. More information: Manage employee cases - Monitoring
Step 4: Send guest pass
With the introduction of guest passes, you can share passes with guests. From within the employee app, these Share buttons send an email through Outlook to the guest who is invited. To set this up, go to Deploy the solution - Turn on Flows.
Upgrade from version 1.2 to 1.3
Step 1: Return to the Workplace portal
With version 1.3, we are introducing the Return to the Workplace portal, which allows third-parties to indicate they are coming to the facility. The portal is installed separate, which allows you to choice if you want to install it. What the portal can do, you can find in Return to the Workplace portal. On how to install the portal, you will find that in the Deploy the solution.
Step 2: Access control
In version 1.2, we allowed case manager to block employees from access to the facility. We made this feature more generic, which allows you to block employees in multiple ways, such as from Power Automate or the API. If you blocked employees earlier, please create access controls now. More information: Facility Access
Step 3: Notifications
With the introduction of version 1.3, we implemented notifications for employees about important events. They will receive these notifications either in the employee app or by other methods of communication. Out of the box, we supply email notifications. More information: Enable Flows
Step 4: Power BI dashboards
The Power BI dashboards now contain information about the activities in the Return to the Workplace portal. We also implemented county-level and state-level details for the United States to get a more detailed view of the virus spread. More information: Location Readiness dashboard
Upgrade from version 1.3 to 1.4
Step 1: Configure the solution settings for 24-hour format
A new option to switch between a 12-hour or 24-hour time format for employee passes is introduced in the solution settings. More information: Configure the solution
Upgrade from version 1.4 to 1.5
Step 1: Configure the solution settings for vaccination attestation (Preview)
New solution settings are provided to enable and disable vaccination attestation functionalities in the employee app. More information: Configure the solution
Step 2: Set up roles and field security profiles
Setting up users with Return to the Workplace - Verifier role and field security profiles are required to enable the vaccination attestation feature.
See Set security roles to assign roles to users and Assign users to field security profiles for more information on how to set up the field security profiles.
Step 3: Enable vaccination attestation flows (Preview)
Important
Some or all of this functionality is available as part of a preview release. The content and the functionality are subject to change.
In version 1.5, we included two cloud flows that are required to be enabled. Follow the steps in Enable Flows to enable them.
| Flow name | Details |
|---|---|
| Vaccination Attestation - Auto-Lapse scheduled flow | It runs every day to check if any vaccination attestations have lapsed before that day, and for those lapsed vaccination attestations the status will be changed to Lapsed. |
| Vaccination Attestation - Update Employee status and Send Notification | It sends notification to the employee if either vaccination attestation is Lapsed or Declined. In addition, it updates employee vaccination status as Active or Inactive if employee has any Approved attestations. |
Upgrade from version 1.5 to 1.6
The new features introduced in version 1.6 of Microsoft Return to the Workplace center around portal support for vaccination & test attestations. For upgrades that use the portal app, it is recommended to install version 1.6 of both of the Return to the Workplace and Return to the Workplace - Portal apps.
Step 1: Configure the Solution settings for portal app vaccination & test attestation (Preview)
The following new & updated solution settings are provided to enable and disable test & vaccination attestation (Preview) functionalities for the portal app. For more information on the settings and how to configure them, see Configure the solution.
New and updated Return to the Workplace (RTW) Portal settings include:
- Enable day pass
- Allow unauthenticated guests to create a pass (disabled the field & deprecated the feature in version 1.6)
- Enable test attestation (Preview)
- Enable manual verification of test attestations (Preview)
- Test attestation terms and conditions (Preview)
Important
The portal Enable day pass setting is introduced in this version. When upgrading from Return to the Workplace version 1.5 or earlier, ensure that this setting is set to Yes. This setting will keep the portal Create pass functionality enabled in the portal app.
Global vaccination attestation settings (Preview) for both the employee and portal apps include:
- Enable vaccination attestation
- Health attestation required to create a day pass
- Enable manual verification
- Vaccination attestation terms and conditions
Step 2: Set up Test types (Preview)
Follow the steps described in this section to create the Test types used for Test attestation feature.
Step 3: Set up Health & safety plans (Preview)
Follow the steps described in this section to create Health & safety plans used for Test attestation feature.
Step 4: Enable the new flows
During the upgrade process, some of the existing flows may be turned off after the solutions are installed. Follow the steps in Enable Flows to enable them.
In version 1.6, we included the following cloud flows to support the portal vaccination & test attestation (Preview) features.
| Flow name | Details |
|---|---|
| Child flow - Calculate current to plan value | Updates the worker's Current to plan value based on the Health & safety plan assigned to the worker as well as their latest Test attestations. |
| Child flow - Calculate test results validity | Determines if a worker's Test attestation falls within their Health and safety plan. E.g. If a worker is assigned a weekly Health and safety plan, and if the worker's latest Test attestation Test result date is still within the last 7 days, then the worker is considered as current to their Health & safety plan (Current to plan = Yes). |
| Contact - Update current to plan (Triggered) | Updates the worker's Current to plan value based on the Health & safety plan assigned to the worker as well as their latest Test attestations. This flow is triggered when a worker record is created or updated. |
| Contact - Update current to plan status (Scheduled) | This is a scheduled flow that updates the workers' Current to plan values based on the Health & safety plan assigned to the worker as well as their latest Test attestations. This flow is Off by default. Additional configurations & testing on this flow is recommended when processing more than 5k worker records. |
| Test attestation - Calculate contact's current to plan status | Updates the worker's Current to plan value based on the Health & safety plan assigned to the worker as well as their latest Test attestations. This flow is triggered when a Test attestation record is created or updated and their Approval status is Approved. |
| Test attestation - Send notification for declined test results | Creates a notification for a worker when their Test attestation is denied. |
| Test results - Auto-approve on creation | Updates the Test attestation - Approval status to Approved when the Solution Setting - Enable manual verfication of test attestations is set to No. |
| Vaccination Record - On create - Process requests | Updates the Vaccination attestation - Status reason to Approved when the Solution Setting - Enable manual verfication (for vaccination attestations) is set to No. In addition, it also calculates the Lapsed date of the Vaccination attestation if the associated Vaccination type has an existing Lapse period (days). |
Upgrade from version 1.6 to 1.7
Step 1: Configure the Solution settings display text for when a day pass not granted to a worker.
| Setting name | Details |
|---|---|
| "Day pass denied" message | Instructions provided when a day pass cannot be issued to a worker. |
For more information on the settings and how to configure them, see Configure the solution.
Step 2: Enable the new flows
During the upgrade process, some of the existing flows may be turned off after the solutions are installed. Follow the steps in Enable Flows to enable them.
In version 1.7, we included a new cloud flow described below to create additional notifications for workers.
| Flow name | Details |
|---|---|
| Access Action - Create notification when unblocked | This flow is triggered as soon as an existing active Access action on a worker is deactivated. The flow creates a notification record informing workers that they have regained access to a facility. |
Give feedback about the solution
To provide feedback about the Return to the Workplace solution, visit aka.ms/rtw-community.