Atlas 4.0+ - Deployment Form Help

Introduction

The following document is a Help Document that will help customers fill in the Atlas deployment information form that will help in the Deployment of Version 4.0 of Atlas. This form will explain in detail what each question in the form is and how to answer the questions asked. 

Form Questions and Definitions

The following is the list of the questions asked in the Form and a definition for each as well as detailed instructions on how to gather information to answer the form.

Full Name

Full Name of the Person inside your Organization that is responsible for the new ATLAS Deployment (be this a New ATLAS Deployment or an Upgrade of the existing ATLAS to Version 4.0). This data is informative and used to identify the Person who will be in charge for the deployment of ATLAS within your organization.

Organization Name

Organization Name, name of the Company (Organization) where ATLAS is deployed. This data is informative and used to identify the organization.

Environment

Environment, where the Atlas deployment is located or to be deployed. Production or Non-Production. Select the appropriate environment option.

Initial Azure AD Domain

ConneX.adDomain, the organization’s Azure Active Directory Domain Name. This is the domain name that was defined when the Azure AD Tenant was setup.

To access this information from your tenant:

• open your browser in the Azure Portal (https://portal.azure.com).
• Select the Azure Active Directory Service.
• On the left navigation pane, select Custom domain names under Manage. Here you will see all the custom domains assigned to your tenant. One of which will have the initial domain name <domainname>.onmicrosoft.com. This domain is the initial domain name that was created when the azure tenant was created. 

• When you select this domain from the list you will see in the Type field Initial.

• Type in the full domain name in the Form (yourdomain.onmicrosoft.com).

NOTE: The domain referred to here is from the Microsoft 365 Tenant. This tenant may be different from that where the Subscription with Resource Group was or will be created.

Admin User ID

ConneX.adminUserID is the Object ID of a Global Administrator Account that will be Owner of all Workspaces created within ATLAS. If you do not need any specific Account from your Azure AD to be owner, answer this question in the form with the value:

00000000-0000-0000-0000-000000000000

If you wish for a particular Azure AD Account to be the Owner of all the workspaces created within ATLAS. 

• Open your browser in the Azure Portal (https://portal.azure.com).
• Select the Azure Active Directory Azure Service.
• On the left navigation pane, select Users under Management. Select the User Account from the list of users displayed.

• You can Copy and Paste the Object ID of the User into the Form.

NOTE:  If you do not remember your previous setting for this value when upgrading to Atlas 4.0, you can review this in your environment.

• Open your browser in the Azure Portal (https://portal.azure.com).  You will need to connect to the tenant where your Atlas Resource Group is Deployed.
• Open the Resource Group and locate the Function App named func-atlas-wf-xxxx-xxxx (the last part of the name will depend on your company name acronym and environment name).

• In the open Functional App select Configuration in the Settings section and locate the Application Setting Named Provisioning:AdminUserId.  This will show the value set in your actual Atlas Deployment.

Atlas Environment Name

ConneX.atlasEnvironmentName is an abbreviation used to define the atlas deployment environment. For example Production or User Acceptance Testing. This value will be used to compose the names of the resources and the URLs of the function App and APIs during deployment, as well as, for other resources. When updating Atlas you may wish to verify the Resource Names in the Resource Group to verify the Environment Name that was used in the current version:

• Open your browser in the Azure Portal (https://portal.azure.com).
• Select Subscriptions under Manage, click on your Subscription, then with the subcription choose Resource Groups. Open the Atlas Resource Group (starting with rg) and you will see the Deployed Resources within. These Resource Names will have the Environment Name in the Last part of the Name. You will use this for this value.

For a new deployment of Atlas, the Environment Name will also be part of the Resource Group Name in Question 8 of this form. You will need to type in a maximum of 4 characters that represents the environment (prod – Production or uat – User Acceptance Testing).

Company Name Acronym

ConneX.clientAcronym this is your company name acronym. E.g. If your company name is Microsoft you could use the acronym msft. Maximum length of the answer is 6 characters.

This value will be used to compose the names of the resources and the URLs of the function App and APIs during deployment, as well as, for other resources. When updating Atlas you may wish to verify the Resource Names in the Resource Group to verify the Environment Name that was used in the current version:

• Open your browser in the Azure Portal (https://portal.azure.com).
• Select Subscriptions under Manage, click on your Subscription, then with the subcription choose Resource Groups. Open the Atlas Resource Group (starting with rg) and you will see the Deployed Resources within. These Resource Names will have the Company Name Acronym in the Second from Last part of the Name. You will use this for this value.

For a new deployment of Atlas, the Company Name Acronym will also be part of the Resource Group Name in Question 8 of this form. This same acronym can be used when defining the Resource Group Name (e.g. rs-atlas-msft-prod) in Question 8.

Atlas Resource Group Name

ConneX.resourceGroup is the Microsoft Azure Resource Group Names are restricted to 1-90 characters in length and can be Upper or Lower case, Numbers, Underscore, Hyphens or Periods. We recommend the following naming convention to be used: e.g. rg-atlas-msft-prod

• rg – Short for Resource Group to identify the Azure Object being created.
• atlas – Product that the resource group will contain.
• msft – Your company name, can be an acronym. Can be the same as answer to Question 7.
• prod – Environment (uat – User Acceptance Testing, prod – Production). Can be the same as answer to Question 6.

If you are in the process of upgrading your ATLAS deployment to version 4.0 this Resource Groups will already exist in a Subscription in your Microsoft Azure Tenant. To verify the Name:

• Open your browser in the Azure Portal (https://portal.azure.com).
• Select the Resource Groups
• Select the specific subscription where the Resource Group is in, or you can select all your subscriptions and apply a search by name.

• Once you have located the Resource Group you can type in the name in the Form.
  
  

If you are installing ATLAS for the first time, type in your own resource group name.

IMPORTANT: This Resource Group Name will be created in one of the Organization’s Azure Subscriptions by a User who is Owner. Remember the Resource Group created must match the name in this question of the Form. This Resource Group will be created by following the Runbook provided to you along with the results of this Form.

NOTE: We recommend that you use the above naming convention as this will help in future ATLAS updates when following our documentation.

Synchronise Taxonomy

ConneX.disableSynchroniseTaxonomy is a Boolean value that will indicate if to disable the taxonomy backup service. Select FALSE for most types of deployments.

Synchronise Users

Connex.disableSynchroniseUsers is a Boolean value that will indicate if to disable user synchronization. Select TRUE for all deployments. 

Except if your organization is using additional custom Active Directory Properties to Sync for SharePoint user profiles, in which case select FALSE. 

Atlas First Deployment

ConneX.firstDeployment is a Boolean value that indicates if the ATLAS deployment is a First install in which case Select TRUE and if it’s an upgrade Select FALSE.

SharePoint Administrator Account ID

ConneX.office365AdminUserId is the Object ID of a user account with a SharePoint Administrator Role. This user account will also be added as Owner in the Atlas Configuration Workspace during deployment.

• Open your browser in the Azure Portal (https://portal.azure.com).
• Select the Azure Active Directory Azure Service.
• On the left navigation pane, select Users under Manage
• Select the User Account from the list of users.

• You can Copy and Paste the Object ID of the User into the Form.

SharePoint Administrator UPN

ConneX.office365AdminUserUpn is the User Principal Name of the User Account used in the previous question.

NOTE: The user’s UPN could be of a Custom domain ([e-mail]) in your tenant and does not have to be the Initial domain ([e-mail]) as the example image above shows. Use the UPN for the user as it appears in the Azure Portal.

Microsoft 365 Tenant ID

ConneX.office365TenantId this is the Tenant ID associated with Azure AD of your Microsoft 365 (the tenant where your M365 Users are located). 

NOTE: The domain referred to here is from the Microsoft 365 Tenant. This tenant may be different from that where the Subscription with Resource Group was or will be created.

• Open your browser in the Azure Portal (https://portal.azure.com).
• Select the Azure Active Directory Azure

• Copy and Paste the Tenant ID from the Overview in the Azure AD Tenant.

Azure Resource Region

ConneX.resourcesLocation is the Region where all Resources will be deployed within the Resource Group. Even though Resource Groups may have a region defined, the resources deployed within the Resource Group can be deployed in a different region from that of the Resource Group. 

If Upgrading ATLAS you can review in which Region the deployed resources are currently located.

• Open your browser in the Azure Portal (https://portal.azure.com).
• Select the Resource Groups
• Select the specific subscription where the Resource Group is in, or you can select all your subscriptions and apply a search by name (locate the Resource Group Name in Question 8 of this form).

• Once the Resource Group is selected you will see the Resources within and can verify in the list where these resources are currently deployed.

• Select the same Region Location as where the Resources are currently deployed.

If you are deploying ATLAS for the first time:

• You may wish to select a region close to your organization.

If selecting Other on the form enter the Region Display name in the text box. Choose the Right Azure Region for You | Microsoft Azure

Open Graph ID

spSettings.misc.openGraphID is a key from Open Graph. This is a third party component that is required when deploying ATLAS. This component is necessary when showing content from outside your tenant. 

If you are deploying ATLAS for the first time you will be required to Get an Open Graph Key. To do this you will need to create an account in https://www.opengraph.io/. The account used, requires an email address to sign up. 

NOTE: There is a Free Plan with 100 request per month. This may be enough for a non production environment but will probably not be enough for Production environment of ATLAS. You can initially select the Free Plan and then move to a Paid plan once you identify the number of requests required by your Atlas Deployment.

• To access the API Key to enter, log on to the open graph portal and copy the key into the Form.

NOTE: If you do not have access to the Open graph Portal or have not documented Open Graph ID for your Atlas deployment, you will be able to extract this information running a few PowerShell commands using PnP PowerShell Module.  The user running the script will have to be SharePoint Administrator.

Connect-PnPOnline-URL[SharePoint Admin URL] -Interactive

(Get-PnPStorageEntity -Key OpenGraphID).Value

• Once completed all the questions in the form, select the Submit button to transmit your answers to ClearPeople.

What happens next?

After you submit your form, ClearPeople will review you Form answers and process these to generate a csv file. You will then be contacted by ClearPeople who will provide you with:

1. A file named “Variable_Group.csv” with the processed Form answers, specific for your deployment.
2. A compressed “Deployment Files” folder with the necessary scripts to Deploy Atlas.
3. An Atlas 4.0 Runbook with instructions on how to deploy Atlas. This runbook will either be:
   • An Upgrade Runbook. If you are Upgrading from Atlas 3.3
   • A Deployment Runbook. If you are installing Atlas 4.0 for the first time.

NOTE: Please allow for 24/48 hours for these items to be made available to you.