Getting Started
CMap PIM setup and install
Use this guide as a reference when you are installing CMap PIM with your consultant during Onboarding.
Please note: The installation can only be done by a Microsoft 365 Global Administrator
We also recommend that you have set up the CMap PIM Support user account ahead of the install, so that it can granted the relevant permissions when deploying the software.
Installation Process
Introduction
Your consultant will work with you to configure your Microsoft 365 tenancy to work with the CMap PIM platform. During the installation session, your consultant will work with you over a shared screen to configure your Azure AD and SharePoint/Teams sites in preparation for deploying the CMap PIM software. You will work through this guide together with your consultant, but please feel free to take a look through the steps to get an idea of the process you will be following.
Gathering the initial information
CMap PIM is configured hierarchically with a Hubsite that's the parent of all the project sites.
To start your CMap PIM setup and install you will first need to decide your Hubsite name, which will be seen by user appear in the hubsite URL. E.g. A Hubsite called CMap PIM Hub would have a Hubsite URL https://mycompany.sharepoint.com/sites/CMapPIMHub
Access Rights
To perform all of the configuration steps you will need to have Global SharePoint Administrator access to your Microsoft 365 tenancy.
If you do not have this level of access, please contact someone within your organisation who can perform these steps for you.
Additionally, so our team can have access to help set up and troubleshoot your CMap PIM Hubsite, we ask for our own user account on your tenant with access to the SharePoint sites.
This requires a Microsoft 365 license to be assigned to that user. Please assign the CMap PIM Support User SharePoint Admin access for deployment/bug fix work
CMap PIM App Consent
To allow CMap PIM to be installed in your SharePoint tenancy, a Global SharePoint Administrator must first grant CMap PIM access to your tenancy.
Your consultant will send across the the relevant consents for your Global SharePoint Administrator to grant.
When consenting to the application access, you will see a list of the different access rights the CMap PIM software asks for.
The consent only allows CMap PIM to use that access on behalf of the person using CMap PIM. It doesn't grant any additional rights to them or the CMap PIM software.
Configure App Catalog
The next step is to add CMap PIM to your SharePoint tenancy. This will be done by adding the CMap PIM Application to your App Catalog. The App Catalog is a special SharePoint site where third party applications such as CMap PIM are uploaded and made available.
If you don't already have an App Catalog, you will have to create one:
- Go to the SharePoint Admin Centre
- Click on 'More Features' (on the left hand panel)
- Find the tile called 'Apps' then click the 'Open' button underneath it
- This will prompt the App Catalog creation to start automatically. You will see the message 'Creating the site for storing apps' (please note, this can take a few minutes)
- Once created, the App Catalog will be available to use
Downloading CMap PIM
You will now need to download the CMap PIM software package to your computer in order to upload it into the SharePoint App Catalog.
Your consultant will either share the download link with you or send the file over.
Once downloaded, extract the content of the zip folder to a location you can find easily. Once extracted, you will be left with a spfx file.
Uploading CMap PIM
Next, you will need to upload the extracted spfx file to the App Catalog.
Head back to the App Catalog, then click 'Upload' (just below 'Manage Apps') and select the extracted spfx file.
A pop up box called 'atvero-client-side-solution' will appear, click 'Enable app' to proceed with the installation.
Approve API Settings
The next step is to grant CMap PIM's APIs the correct permission within your tenancy.
To do this press the Go to API access page once you have enabled the app.
When the page has loaded, select the 10 rows one by one clicking the Approve Button in the command bar to allow the API Access.
Once Approved the request will moved into the Organization-wide approvals section.
Occasionally, the request may fail the first time. If this occurs, first repeat the process and if it is still unsuccessful contact your consultant.
Active Sites
You will now need to grant yourself (as Global Administrator) and the CMap PIM Support User, access to the App Catalog. To do this, in the SharePoint Admin Centre, go to 'Active Sites' in the left-hand panel. Find the App Catalog by searching for 'Apps' in the search bar.
Once you find it, select it using the tick box, then click on 'Membership'.
In the pop out panel called 'Apps', add yourself and the CMap PIM Support User as Site Admins.
This will allow yourself and the CMap PIM User to update the version of CMap PIM on your tenancy.
Confirm your selection by clicking OK.
Hubsite Set Up
The final step to setting up CMap PIM is to set up your Hubsite, where all your projects will be accessed from.
To do this, navigate to back to the 'Active sites' page in SharePoint Admin and click on '+ Create'. From here, click on 'Communication site'.
In the 'Select a template' pop out, select 'Standard communication' then 'Use template'
You will be asked to give your Site a name, this is where you enter the Hubsite Name mentioned at the start of this article. For example, the 'CMap PIM Hub' or 'Projects Hub'. Once this name has been set, it cannot be changed, so make sure you have discussed the choice with the wider team and received approval.
You will now need to turn your current communication site into an official Hubsite. To do this, head back to 'Active Sites' in the SharePoint Admin Centre. Search and find the communication site you have just created and select it using the tick box.
Once selected, click on the button called 'Hub', then in the dropdown box click on 'Register as hub site'.
In the panel that opens called 'Register as hub site', in the field called 'People who can associate with this hub', type in the 'everyone expect external users' and select it once it appears as a dropdown option.
Head back to the 'Active sites' page on SharePoint Admin, click on the URL of your new Hubsite (found in the URL column). This will take you to your new Hubsite.
Once here, send the Hubsite's URL to your consultant so that they can update the details of your account. Then, click on '+ New' and then 'Page'. In the 'Pages' panel that opens, click on 'Apps' then click on CMap PIM (or Atvero) then click on 'Create Page'.
A new panel will open called 'App page details'. In the following fields, add this information:
Title: Setup
Page Part: bootstrap
Please note the information has been entered EXACTLY as referenced above
Then, click on the green 'Save' button
Setup Checklist
In the page that appears, click the Consent buttons one at a time to allow further CMap PIM API access for our third party integrations.
Once these consent options have completed, select the Provision Hubsite button. Please note, this make take a few minutes.
The final step of the installation is setting up your organisation as a company. To do this, fill out the required information
Once provisioning has completed, create your company with your organisation's details in the pop-out panel. Make sure 'Internal' has been selected in the field called 'Company Role'. This will ensure your organisation's details are registered to the projects when they are created.
Your CMap PIM setup is now Complete!