Skip to main content

Manage Tenant Properties for Atlas

Peter Harrison
  • Updated

Version_3.x.png  AtlasAvailability-40.png

Please note that this is considered Advanced Configuration for Atlas and requires Microsoft 365 Administrator permissions.

This feature requires Atlas 3.0 or later. If you would like to arrange an upgrade please speak to your main Atlas Contact.

From Atlas 3.0 onwards, there is a new Tenant Properties page which allows a number of Atlas settings to be managed from a single location only accessible to Microsoft 365 Administrators. Please be aware that these are very much considered Advanced settings and should not be changed without good reason. Changing these settings could cause parts of Atlas to break if not set correctly.

 

In this article:

 

Access the Tenant Properties page

Access to this page requires Microsoft 365 Administrator permissions.

  1. Navigate to the Atlas Configuration workspace. This workspace can be found by searching for "configuration" in Atlas ConneX, or by manually navigating to the site at /sites/atlasconfiguration in your M365 tenant.
  2. Go to Site contents in the top right menu:
    launch1.png
  3. Click on the Site Pages library (at the bottom of this list) to open it, find the page Tenant-Properties.aspx and open the page. If you see the following message then you do not have sufficient permissions to make the changes and will need to speak to an Administrator:
    mceclip0.png
  4. If you have sufficient permissions then you'll see something more like this:
    mceclip1.png

Settings available from this page

In this section we'll list all the settings that can be managed from the Tenant Properties page. Each setting has a description with further information on what it does but please get in touch if you are unsure.

Warning, advice and best practice

Some of these tenant properties are critical to specific functionality so should not be altered, however, some properties should be altered depending on your requirements. Due to the sensitive and complex administrative capability within the tenant properties area we advise you coordinate with your implementation lead or CSA for any changes.

The list is laid out as follows:

  • Tenant Property
    • Description
    • Can and should the field be edited?

Any properties that we advise should be reviewed for editing may have other related properties which also need to be altered depending on specific use cases.

  • Atlas.ConfigurationTeam.URL       
    • Atlas Configuration path URL. This is fixed on deployment and ensures the Atlas code base is connected to the Configuration site and incorporates any content or settings made there.
    • No - do not edit
  • Atlas.Addit.RelativeUrl   
    • JSON config relative path. This is not used from Atlas version 4.1 onwards
    • No - do not edit
  • Atlas.Addit.Url          
    • URL to main Add It page - this is the master URL for which version of Add It is used. On newer versions you will only be able to use the "new" version.
    • No - do not edit
  • Atlas.LandingPage.Url       
    • Configure the URL to the main Atlas Home workspace which is linked from the logo in the top-left of the main menu. This should be altered before go-live when the final home workspace and home page URL has been finalised. You can link this up ahead of training so that the project team and the champions using Atlas can always navigate to the homepage.
    • Yes.
  • MainNavigationSecurityTrimming            
    • Main navigation security trimming is on by default, meaning all options in the main menu are vetted for each user and only display if that user has permissions/access to the content. If they do not have access the option will not show for them. Switching this tenant property off will disable the security trimming meaning all options will show for everyone, and if a user with no access clicks they will be sent to an 'access denied' page.
    • No - we advise this is not edited unless there is a very particular use case. The security trimming and subsequent caching of the main menu is one of Atlas's core features in terms of usability and personalisation.
  • Atlas.ShowExtranet
    • This controls if extranet controls are shown or not. This is mainly brought in via the ConneX provisioning form to limit the taxonomy options used in the workspace, so external users cannot browse your taxonomy if they are added as members to a workspace or when sharing content with edit permissions. You can read more about Atlas Extranet features in this article.
    • Yes - you can alter this property with ClearPeople's guidance & recommendation
  • OpenGraphID         
    • Open Graph ID. This is the unique ID to the OpenGraph API which was set-up on deployment of Atlas. This enables External Insights data to be fetched automatically through Add It. 
    • No - do not edit
  • UserVoice    
    • User Voice code   - This property is deprecated since the migration from UserVoice to Atlas Feedback.            
    • No - do not edit
  • Atlas.Connect.Workspace.API.URL         
    • Workspace API URL           
    • No - do not edit
  • Atlas.Connect.User.API.URL          
    • User API URL             
    • No - do not edit
  • Atlas.Connect.API.ID         
    • Azure App Id for Connect API          
    • No - do not edit
  • Atlas.ExternalUsers.GroupID         
    • Azure AD group ID to trust external users in the system. On Deployment we set-up a group called 'Atlas Trusted External Users'. This is a dynamic AD Group that adds all external users which do not have your '@business.com' email suffix BUT are also elevated from Guest to Member permissions in your Azure Active Directory. You can read more about this AD Group in this article.              
    • No - do not edit
  • Atlas.AlternateLandingPage.Url  
    • URL to an alternative Atlas Landing page for extranet workspaces. The alternate landing page sends external users to a different homepage than internal users if configured. Please note that they will need permissions to the landing page you set here, which is likely to be a standard workspace with bespoke design and custom permissions geared towards external users.
    • Yes - you can edit with ClearPeople's assistance and completed pre-requisites being set-up and tested (such as workspace landing page design and permissions)
  • Atlas.SearchScopes.Groups        
    • Search Scopes are the button options you see appear in Atlas when you click the 'search' tool (magnifying glass icon) from the main menu. They help limit the user's search to a pre-defined content type (such as documents or news) and send the user to a search listing page showing this content type only. These search scopes can be removed (if you would like to remove any options not in scope for your Atlas), to centralise the search listing pages sat behind the search scopes (as OOTB they are dynamic and will keep users within their workspace), to alter wording, or even to create unique search scopes for your digital workplace (i.e. policies search). You can read more about Search Scopes and how to configure them in this article here.
      • This property needs specific formatting or the search window will not load correctly.
    • Yes - only with CP Support
  • Atlas.CustomActions.TenantWideExtensions    
    • [True|False] Indicates if the custom actions are deployed at tenant level.                  
    • No - do not edit
  • Atlas.Launchpad.Settings 
    • Launchpad configuration settings including text and icon. From here you can alter the Launchpad icon to another icon from within the Microsoft Fluent UI Icon library, as well as change the label (text). The formatting here will account for different languages available within Atlas - even if not switched on, so we advise changes are only made to the necessary languages.
    • Yes - with CP Support
  • Atlas.Build.Version  
    • Atlas current build version. This is created dynamically from the deployment of Atlas and updated automatically with any Atlas upgrades. This is the information that shows under the 'MyAtlas' window next to the Atlas Cache Refresh button.
    • No - do not edit
  • Atlas.QuickAccess.MyAtlas         
    • My Atlas button configuration settings including text and icon. From here you can alter the My Atlas icon to another icon from within the Microsoft Fluent UI Icon library, as well as change the label (text) of the 'My Atlas' wording in the fly-out window. The formatting here will account for different languages available within Atlas - even if not switched on, so we advise changes are only made to the necessary languages.
    • Yes - with CP Support
  • Atlas.QuickAccess.AddIt  
    • Add It button configuration settings including text and icon. From here you can alter the Add It icon to another icon from within the Microsoft Fluent UI Icon library, as well as change the label for the hoverstate. The formatting here will account for different languages available within Atlas - even if not switched on, so we advise changes are only made to the necessary languages.          
    • Yes - Only with CP Support
  • Atlas.QuickAccess.Search           
    • Search button configuration settings including text and icon. From here you can alter the Search icon to another icon from within the Microsoft Fluent UI Icon library, as well as change the label which appears in the hoverstate. The formatting here will account for different languages available within Atlas - even if not switched on, so we advise changes are only made to the necessary languages.
    • Yes - Only with CP Support
  • Atlas.QuickAccess.Feedback     
    • Feedback button configuration settings including tooltip and icon. From here you can alter the Feedback icon to another icon from within the Microsoft Fluent UI Icon library, as well as change the label which appears in the hoverstate. The formatting here will account for different languages available within Atlas - even if not switched on, so we advise changes are only made to the necessary languages.  
    • No - do not edit
  • Atlas.Header.HighlightedItems    
    • Add or remove Atlas menu highlight option. On deployment of Atlas, the Launchpad and the My Atlas tools in the main menu will be highlighted in your chosen Atlas Theme colour - giving them a different look and feel to the other options in the main menu. You can switch these off so that this branded colour do not appear over these tool icons, or switch them around if needed (for example, that only the Search magnifying glass appears in your theme colour. The value will need to be updated with true (to add) or false (to remove).       
    • Yes
  • Atlas.EnableScriptEditor    
    • This controls if the Atlas Secure Script Editor webpart is switched on in your tenant. This webpart is much like the Microsoft 'Embed' webpart which can display external content via code but it has some restrictions lifted.
    • Yes
  • Atlas.Header.Navigation.Rows    
    • If using the ‘Hover’ menu option, the number of navigation rows to display can be amended. Any number of rows between 6 and 12 (only integers, if a number is below 6 or above 12, 6 or 12 will be taken as default) can be displayed  
    • Yes.
  • Atlas.Header.Navigation.Settings           
    • Choose the main menu layout by selecting either 'MegaMenu' or 'Hover'.        
    • Yes.
  • Atlas.Header.Disable365Search
    • This property can be set to show or hide the default Microsoft 365 search box at the top of the page for workspaces created using ConneX. We advise hiding this bar so that the Atlas search is the only option available, as leaving the Microsoft search switched on can confuse users because two different search options will be available and if users use the Microsoft search they will be taken outside of Atlas to search, and will not have filtering options and other features.
    • Yes - we will switch this off soon after deployment as a project set-up tasks
  • Atlas.QuickAddIt.Title         
    • This property can be set up to change the Quick Add It modal's default title on the left of the metadata form under the Quick Add It icon.
    • No - do not edit
  • Atlas.QuickAddIt.Description       
    • This property can be set to change the default description of the Quick Add It modal, which is located under the Quick Add It title on the left of the metadata form.
    • No - do not edit

Properties available from 4.1 onwards

  • Atlas.InFocusEverywhere.SmartHubDataSource.API.ClientAppID   
    • For customers that have the SmartHub integration enabled, this property set up the Client App ID to be able to connect with SmartHub Service.  
    • No    
  • Atlas.QuickAddit.Url
    • URL to Quick Add It page (new Add It experience). More information about the usage in this page.
    • No
  • Atlas.UseQuickAddit  
    • Boolean property that when enabled will provision new Add It in any new workspaces. More information about the usage in this page.
    • No
  • Atlas.AddIt.ExcludedFields            
    • List of excluded fields for the new version of Add It. Because Add It works dynamically, in some tenants there are additional fields that are created at the same time as provisioning a new workspace and are automatically shown in Add It within the content fields/columns shown as available. You can fetch the GUID/Internal name of each column you want to hide and insert it as a value within this tenant property to force hiding the unwanted fields.  
    • Yes - with CP support
  • Atlas.AddIt.ExcludedListsLibraries            
    • List of excluded lists/libraries for New Add It. As Add It works dynamically, in some tenants there are additional lists and libraries that are created at the same time as provisioning a new workspace and are automatically shown within Add It or from the site contents view. You can fetch the GUID/Internal name and insert it as a value within this tenant property to force hide the unwanted list or library.
    • Yes - with CP support
  • Atlas.InFocusEverywhere.SmartHubDocumentPreview.API.Url        
    • For customers that have the SmartHub integration enabled, this property set up the API to the SmartHub SmartPreview Service.  
    • No - do not edit.

Properties available from 4.2 onwards

  • Atlas.Header.Navigation.FontColor        
    • Select your own font colour within the main menu by using a Hexadecimal code. Out of the box the menu will appear with white text, unless the main navigation banner is switched off, and in that case will default to black.       
    • Yes
  • Atlas.PagesToolBar.HideNewButton       
    • Hide the Microsoft OOTB "New" button from content pages, site contents and lists and libraries. These options bypass our content wizard 'Add It', so you can remove these options for users so they need to use Add It to create content. Set this property to True to hide them.
      • Please note that we cannot guarantee this will work forever as Microsoft may change how the buttons are displayed and bypass our work to hide them.
    • Yes.
  • Atlas.SPSideBar.HideNewButton  
    • Hide New button from SharePoint side bar. Within the browser window when you are in SharePoint, there is a grey bar on the left-hand side which has a 'New' button a the top. If a user selects this new button they effectively bypass our content wizard tool 'Add It' so if you would like to remove this option for users you can set this property to True.
    • Yes
  • Atlas.AddIt.LimitEditPermissions   
    • Enable the ability for users to limit the edit permissions for an item during Add it creation. 
    • Yes - with CP Support
  • Atlas.AddIt.ItemLevelPermissions
    • Enable the ability for users to apply custom permissions to items created from Add It.
    • Yes - with CP Support
  • Atlas.Header.ShowBannerImage            
    • Display banner image. If you want your main menu area to be white, you can switch off the banner image and then alter the menu font colour for a unique main menu experience.
    • Yes - with CP Support
  • Atlas.InFocus.EnableMultiGeoSearch                
    • This property is a boolean value (true/false) and specify the value EnableMultiGeoSearch property in Atlas In Focus web parts. It should be always set up to false as MultiGeo is not a tested scenario and could make the queries fail if MultiGeo is enabled in the tenant.
    • No   

Properties available from 4.3 onwards

  • Atlas.Alerts.Styles                
    • From here you can alter the Alert branding and style, including the alert background colour, text colour, bell icon colour and even the icons for all three severity levels, using HEX codes for colours and the Microsoft Fluent UI Icon Library for icons.
    • Yes
  • Atlas.LearningAndDevelopment.URL                 
    • This is the URL for your Learning & Development Centre which is set-up on deployment. This does not need to be edited.
    • No
  • Atlas.LearningProfile.TeamScope                       
    • There is an option within our Learning and Development to 'view your team's progress'. Out of the box you will only be able to search for people below you in the tenant organisation hierarchy (i.e. those that have you in their manager field). Anyone who isn't a manager will only be able to see people who share the same manager. If you wanted to open this field up so that a user can search for anyone in the business, regardless of manager or team, you can alter this tenant property.
    • Yes - with CP Support

Properties available from 5.0 onwards

  • Atlas.Theme.Accent
    • There is an additional theme colour available which can be leveraged in In Focus webparts to apply a colour filter to the thumbnail images. You should insert a colour HEX number that reflects your branding guidelines but is in addition to the single theme colour you selected for the main Atlas theme.
    • Yes

Properties available from 5.1 onwards

  • Atlas.Search.PartialKeyword
    • When Partial Keyword is enabled, In Focus webparts will automatically insert a wildcard '*' after each search term (each word) which will alter how results are returned.
    • Yes - with CP advice. We recommend some testing be done before making this change.
  • Atlas.ConneX.Regionalsettings
    • This allows the baseline regional settings to be altered from UK to another regional time, locale, or calendar view, inside all Atlas workspaces as well as all template designs from ConneX for newly provisioned workspaces.
    • The inputs here need specific 'code' from Microsoft in order to process the requirements correctly - please visit the following sites to learn more about the codes.
    • Yes

Properties available from 5.2 onwards

  • Atlas.Analytics.Script
    • Atlas Analytics Script allows you to insert into each Atlas page, including the Atlas Header, with a tracking code of a third-party analytics platform.
    • Yes - with CP advice. 

 

 

Permissions Issue (Error making HttpClient request in queryable [403])

  • If you receive the following error trying to edit any of these Tenant Properties, please ensure your user profile has the following permissions:
  • Global Administrator
  • Owner of the App Catalog site
  • In order to set yourself as an owner of the App Catalog site, you must already be a Global Administrator. If you are a Global Administrator, then follow these steps:
  • Access the following location in your ATLAS site: https://YourATLAS/sites/appcatalog/SitePages/Home.aspx
  • Click the cog-wheel on the top right
  • Click site permissions
  • Click Advanced permission settings
  • From there you should be brought to a screen like the below:
  • Inside the Owner group, select "New" and add yourself as a member of that group. You are now an Owner of the App Catalog site.
  • You can now attempt to edit the Tenant Property again, you should not see this error.
  •  
  • Still need help?
  • If you still need assistance with any of the above please contact support or your CSM.
Was this article helpful?
1 out of 1 found this helpful
Return to top

Related articles

Comments

0 comments

Please sign in to leave a comment.