Article last updated on the 31st of October, 2024.
Contents
1. Introduction
In this article, we will describe and demonstrate the process of installing WorkPoint 365 using the installer introduced with version 4 of WorkPoint 365.
The new installation process automates many of the previously manual steps which admins had to carry out, which should result in an easier and more user-friendly way of installing brand new WorkPoint solutions.
Installing WorkPoint using the WorkPoint 365 version 4 installer is split into three processes:
- Agreeing to WorkPoint's Terms of Service agreement.
- Installing the WorkPoint 365 App on the tenant App Catalog.
- Creating a new solution.
All of these processes are described in this article.
2. Prerequisites
In order to successfully install a new WorkPoint solution using the Installation Wizard, the points are required:
- A valid WorkPoint 365 license.
- An App Catalog site collection on the customer's tenant (The customer or partner must ensure an app catalog exists).
- The user account used to install the WorkPoint 365 App and grant the necessary consents must be an global administrator and site collection administrator on the tenant app catalog site.
- All required agreements (terms of service, and required consents).
- If retention policies are set up, the App Catalog must be excluded.
3. Installation link
To begin installing your WorkPoint solution, please follow this link to open the WorkPoint 365 installer: https://install.workpoint365.com
The link opens the following page:
- To open the WorkPoint installation wizard, click the button.
You will now be prompted to log in using Microsoft365 credentials:
Once you have successfully logged in, you will be prompted to grant two consents needed for using the WorkPoint 365 version 4 installer:
- To proceed to the WorkPoint 365 version 4 installer, read the required permissions and click "Accept" to consent.
The permissions granted in pt. 2 are used by WorkPoint to identify which tenant context the installer needs to run in.
4. Terms of Service agreement
The first time running the WorkPoint 365 version 4 installation wizard, you will be required to accept WorkPoint's Terms of Service agreement.
Until this step is performed, you will not be able to use the subsequent processes in the wizard.
You can accept to the Terms of Service agreement in the following way:
- In the installation wizard, click the link to read the terms of service agreement, then click the "I Agree" button.
When you have agreed to the Terms of Service, the section is removed from the installer.
5. Installing the WorkPoint 365 App
This section covers the process of installing the WorkPoint 365 app in the tenant app catalog. Before performing the following steps, please ensure that a SharePoint App Catalog exists on the tenant.
We begin in the WorkPoint installation wizard:
- To begin the installation process of the WorkPoint 365 app in the app catalog, click the "Install" button.
- The next step is to read through which permissions is required for the WorkPoint API. You can expand the lists under "WorkPoint would like to" section to review which permissions are requested for the WorkPoint API.
- When you have read through the API permissions WorkPoint request, click the "Continue" button to move to the next step.
- The next step is to select whether you are happy with WorkPoint creating sites for various purposes in WorkPoint for you. WorkPoint greatly recommends to answer "Yes" to this. Selecting "No" requires you to develop your own automation for creating sites. Depending on which selection you make, the required permissions WorkPoint asks for in regards to the job engine changes. You can review which permissions WorkPoint requires based on your selecting in the "WorkPoint would like to"-section of the wizard.
- Once you have made your selection, you can proceed to the next step by clicking the "Authorize" button.
- Click on the global admin account you currently are signed in with.
- Next, the WorkPoint installer collects all the necessary permissions required by your selections, and asks for your acceptance. You can review the permissions you are about to grant by expanding each permission. To accept the permissions, click the "Accept" button.
Next, you should be returned to the installation wizard:
- At this point, you should see a confirmation message, letting you know that the permissions have successfully been granted. You are now ready to install the WorkPoint 365 app. To do so, click the "Install App" button.
If the installation fails at this point, please ensure that an App Catalog site exists in SharePoint.
The installer now goes through steps to consent to the selected permissions and installs the WorkPoint 365 Modern UI app in the tenant app catalog. It will also accept the necessary API requests. The progress can be followed in the UI:
Once the installation is complete, the installer should display the following page:
- To download the installation documentation, click the link. The installation documentation is a PDF document containing information about installation date and time, the accounts used to install the WorkPoint 365 app, and the options selected.
- To return to the front page of the installer, click the "Return" button.
The "Install WorkPoint 365 App" step should now be complete, and the "Create a new Solution" step should now be unlocked:
6. Creating a new WorkPoint solution
Users need the SharePoint Administrator role to add new solutions.
In this section, we will use the WorkPoint 365 installer to create a new WorkPoint solution.
This section assumes that the WorkPoint 365 App has been successfully installed on the customer's tenant app catalog, as per section 5 in this article.
To create a new WorkPoint solution, follow these steps:
- To create a new WorkPoint solution, click the "Install" button.
This opens the process to install a WorkPoint solution:
Next, you need to select which WorkPoint subscription to use for the new WorkPoint solution:
- Input your license key and click the "Add" button.
- After inputting your license key, the installer displays your available subscriptions.
- For each subscription, you can expand the subscription to view the features it includes.
- If you cannot find the subscription you are looking for, you can add additional subscriptions with other license keys.
- To select a subscription for the new WorkPoint solution, click the "Select" button.
- The selected subscription is framed in orange.
- To proceed to the next step in the installer, click the "Continue" button.
- Next, you can select to create an empty solution, or create a solution based on a solution template (if your chosen subscription includes standard solutions). In this instance, we have selected to create an empty solution. For each solution you can expand the section to view a description of the solution type.
- To proceed, we click the "Continue" button.
- In the "What is included" step, you can view more details about what is included in the solution type you selected.
- To proceed, click the "Continue" button.
This takes you to the "Solution Info" step. Here you can select on which site in SharePoint to install WorkPoint.
6.1. Selecting a site for WorkPoint
This section describes the options for which site to install WorkPoint on.
- The first option is whether to create a new SharePoint site for WorkPoint or to use an existing one.
The option selected changes the additional options on this step.
6.1.1. Using an existing site
Choosing to use an existing site for WorkPoint requires you to fill the following form:
- Type in the e-mail address of the person who should receive an e-mail when the WorkPoint solution has finished installation.
- Type in site URL of the SharePoint site on which you want to install WorkPoint.
- To proceed, click the "Continue" button.
6.1.2. Creating a new site
Choosing to use an existing site for WorkPoint requires you to fill the following form:
- Type in the e-mail address of the person who should receive an e-mail when the WorkPoint solution has finished installation.
- Type in a site title. This title will automatically fill in the "Solution URL" field as well, putting the site title as a suffix after /sites/ in the URL. The installer will inform you if the site in unavailable, otherwise it should display "The site address is available", as shown in the image.
- Next, select a user from the Azure Active Directory to be the primary administrator of the WorkPoint solution.
- Lastly, select a language and timezone for the WorkPoint solution.
- To proceed, click the "Continue" button.
6.2. Selecting a Solution Owner
This section describes how to select a solution owner for the WorkPoint solution:
The option selected for using an existing contact or creating a new one changes the additional options on this step.
6.2.1. Choosing an existing contact
Selecting "Choose an already existing contact" allows you to select a contact from your chosen license key provided in the first step of the installation wizard (not the Azure AD):
- Search for and select a person to be the Solution Owner.
- To proceed, click the "Continue" button.
Note, both the person set in the "Solution Info" step and the solution owner will receive an e-mail once the installation of the WorkPoint solution is completed.
6.2.2. Creating a new contact
Selecting "I'll provide the solution owner information" allows you to fill the following form to create a new contact on the license (not Azure AD), and use that person as Solution Owner:
- Type in the first- and last name of the Solution Owner.
- Type in the Job Title of the Solution Owner.
- Type in the e-mail address and telephone number of the Solution Owner.
- To proceed, click the "Continue" button.
Note, both the person set in the "Solution Info" step and the solution owner will receive an e-mail once the installation of the WorkPoint solution is completed.
Also note that using the method of inputting solution owner information will add that person to the license. The next time you create a new solution using the same license key, you will be able to select this user using the "Choose an already existing contact" option.
6.3. Confirm configuration
In this section you will be able to review the information you have provided before you let the installer start configuring and setting up your new WorkPoint solution.
This section looks like the following:
You can review the information and choices you have provided during the previous steps.
This step also informs you what the installer will be doing during the installation process.
- When you are ready to begin installing WorkPoint, click the "Start Configuration" button.
The installation wizard now starts configuring your WorkPoint solution. This may take up to 30 minutes or longer.
Once the installation of WorkPoint is complete, e-mails will be sent out, and the installer shows the following page:
- To go to the configured WorkPoint solution, click the "Configured site" link.
- To return to the front page of the WorkPoint Installer, click the "Return" button.
This concludes the installation guide for WorkPoint 365 version 4.
Comments
0 comments
Please sign in to leave a comment.