Upgrading a WorkPoint solution from version 3 to version 4

In this article we will demonstrate how to update WorkPoint solutions from version 3.X to version 4.X.

We will also cover what you as a partner and the customer can do to prepare solutions for the update, as well as inform you about what specifically will happen during the update.

To update a WorkPoint solution from version 3.X to version 4.X, the following prerequisites must be met:

• The user performing steps in the WorkPoint installation wizard must be a tenant administrator.
• The user performing the steps in the WorkPoint Administration must be a SharePoint administrator.
• The license used for the solution must include the "Migrate to V4" feature. If this feature is not enabled on your license, please contact your WorkPoint partner or WorkPoint Sales at sales@workpoint.dk.
• If you are using WorkPoint Express, you must use at least WorkPoint Express Version 6.2, or preferably always the latest version.
• If the solution to be upgraded runs WorkPoint 365 version 3.21.0 or older, please ensure that the Root site recycle bin does not contain more than 5000 items.

1. Endpoint update: If the WorkPoint solution being upgraded uses our API, please change the API URL to https://api.workpoint365.com/ prior to upgrading the solution. This change is essential to ensure continued compatibility during the upgrade process.
2. FrontDoor routing: During the transition phase, despite using https://api.workpoint365.com/, requests will still be routed to the Version 3 backend through Azure FrontDoor. This ensures a seamless experience for users during the migration period and the integration will continue without interruption.
3. Automated Backend Transition: Once the solution is upgraded to Version 4, requests made to https://api.workpoint365.com/ will automatically be directed to the Version 4 backend. This automated redirection minimizes disruption for end-users and simplifies the transition process.
4. Endpoint Compatibility: It's important to note that the endpoints utilized in Version 3 will remain unchanged in Version 4, maintaining the same signatures. Consequently, there is no need for any modifications in the integration setup during the upgrade process.
5. Exploring New Integration Opportunities: Upon completing the upgrade to Version 4, you will gain access to numerous new integration possibilities. These enhanced capabilities can now be leveraged to further enhance the functionality and performance of your customers solution.

Before starting the process to update a WorkPoint solution from version 3 to version 4, it is a good idea to go through the following points to ensure as smooth a process as possible and to properly prepare the solution for the update:

• Check that all webparts on the root site and all master sites are functional.
• Action Management actions using the web hook to call Microsoft Power Automate flows will not work on version 4, so you should prepare what you can to eventually convert them to WorkPoint Automate system processes after the update. You can read more about how to call Power Automate flows from WorkPoint Automate system processes in this article.
• Check that there is not more than one WorkPoint app version installed. For example, you should not have more an one "WorkPoint 365 App 13" app installed. If the update process detects more than one WorkPoint app of the same version installed, it will fail.
• Make sure to schedule the update for a time where the workload on the solution is minimal. For example, please schedule the update to not take place at the same time as large data migration jobs.
• Remember that you can follow the progress of the update job status in the WorkPoint 365 Event Log.
• Please avoid updating solutions while a WorkPoint service window is active, i.e., when a new version of WorkPoint 365 is being released. You can see a list of planned service windows here and a list of upcoming releases here.
• Please ensure that you have updated to the latest version of WorkPoint 365 version 3 before updating to version 4.

By following these steps, you minimize the risk of something going wrong during the update to version 4 job.

In this section, we will outline exactly what the job to update a WorkPoint solution from version 3 to version 4 does in chronological order.

1. Store WorkPoint App information on the solution.
2. Reassign Event Receivers.
   • About 5 seconds per entity site, dependent on tenant load.
3. Update the release type for the solution in the database.
4. Add Front door rules for the solution.
5. Solution Update.
6. Update Modern UI for the solution.
7. Update the WorkPoint 365 Modern UI app on all site collections.
   • About 5 seconds per entity site, dependent on tenant load.
8. Update Client-Side Component Ids on all site collections.
9. Update Client-Side Component Ids for the root site.
10. Update Client-Side Component Ids for all unassigned bucket site collections.

The status of the update job can always be inspected in the WorkPoint 365 event log.

To do this, you can filter events by the "Migrate to v4" job as shown in the following image:

When the event receiver is moved, the actual move does not happen to V4. Instead, it is moved to app.workpoint365.com via Azure FrontDoor. FrontDoor will then route requests to either V3 or V4. The update of the FrontDoor rule only happens once the event receivers have been correctly moved. Generally, users will not experience errors in the solution during an update of event receivers.

The following is a chronological list of all actions performed during the update job:

The update from version 3 to version 4 of WorkPoint 365 is performed inside the WorkPoint administration:

1. In your WorkPoint solution, click the "Home" button.

2. In the side panel, click the gear-icon to access the WorkPoint administration.

3. In the global settings menu in the WorkPoint administration, click "Update".

This opens the "Update" page for the solution:

The first thing you need to do is to make sure you have granted all necessary permissions and then install the WorkPoint 365 App to the tenant app catalog. This is done using the WorkPoint installer.

To do this, follow these steps:

4. To open the WorkPoint installer, click the "here"-link.

This opens the welcome page for the WorkPoint installer:

From here, please refer to the this article and follow the steps in sections 3, 4, and 5 and install the WorkPoint 365 App. Then return to this point in this article.

Once the WorkPoint 365 App has been successfully installed, and added to the root site of the WorkPoint solution we want to update, we can return to the "Update" page in the WorkPoint 365 administration of the solution we want to update to Version 4:

6. Next, we need to add the SharePoint Add-in for Version 4 of WorkPoint 365. We can do this by clicking the "Add SharePoint Add-in for version 4" button. This process way take a couple of seconds to complete after pressing the button.

Once the SharePoint Add-in has been added, the page changes to the following, and we can now continue with the upgrade process:

6. To continue the update process, click the link.

This will redirect you to the WorkPoint Administration dashboard. This page will now display a message, letting you know there is a new update for WorkPoint 365 available:

7. To proceed, click the link in the info message panel.

This opens the "Update" page, which should now display the 4.x.x.x as the latest version of WorkPoint 365:

To continue the update process, follow these steps:

8. Click the "update solution to version 4" button.

This opens the "update to version 4" page. To start the migration job, follow the following steps:

9. In the "update to version 4" page, click the "Start Migration Job" button.

Once the migration job h as been started, the progress can be followed in the "update to version 4" page: