Site Arrangements¶

A Site Arrangement is a hierarchy of SharePoint hub sites and spoke sites in your tenancy.

You can use a Site Arrangement to easily create and maanage a hierarchy of hub sites, and easily deploy and update Mercury products to the entire hierarchy.

Generate a Site Arrangement¶

You can create a new Site Arrangement from an existing hierarchy of hub sites using the Generate Button. Enter the URL of your existing top-level hub site and My Mercury will detect the hierarchy and create a new Site Arrangement.

When you do this, be sure to hit Save so the arrangement is committed to My Mercury.

Create a new Site Arrangement¶

You can create a new site arrangement, which will be initialised with a blank top-level site.

You must enter a site URL, as well as specify who the primary site owner is (by default, it's you as the logged in user).

You can then enter other settings as required for the top level site.

Manage the hierarchy¶

You can add child sites at any level, provided the parent site is marked as a hub site, from the Actions Menu. When you click Add Child Site you must remember to enter a Site URL for this child site. When you save your changes, the Site Arrangement is automatically saved into My Mercury.

Create the hierarchy structure in SharePoint¶

A Site Arrangement is a configuration of a hub hierarchy that you want to create in SharePoint. Any changes you make to the hierarchy arrangement is not immediately reflected in SharePoint. In order to apply your changes to SharePoint, you must Ensure the structure.

If you click Ensure Structure from the command bar at the top, the entire structure is committed into SharePoint.

But you can start the process of creating and configuring sites at any level in your hierarchy, by choose Provisioning -> Ensure Site from the Actions menu of the site you want to apply to SharePoint.

Installing Apps¶

You can use Site Arrangements to install Mercury products to the sites in your hierarchy, from any level. Normally you may want to start this process from the top-level site and have the products installed onto every child in the hierarchy.

From the Actions menu, choose Provisioning -> Install/Uninstall Apps to Site. Choose the products that you want to deploy, and indicate if you want these apps also installing to all children under the selected site.

If you choose Force reinstall product, then any existing apps from that product are uninstalled and reinstalled. This can be useful in rare troubleshooting scenarios.

If you choose Uninstall product, then all apps assocaited from the product are uninstalled from the site and not reinstalled.

Configuring a Site¶

You can perform additional configuration options in a Site by using Provsioning -> Configure Site

Taxonomy Field Config¶

Use this to correct the configuration of a Taxonomy Field that may be broken due to an incorrect site script.

Internal Name: Set this to the internal name of the SharePoint Taxonomy Field
Term Store ID: Set this to the Term Store GUID that is available from the Term Store management page within SharePoint
Term Set ID: Set this to the Term Set GUID that is available from the Term Store management page within SharePoint

Custom Action Settings¶

Use this to apply properties to an existing SPFX Application Customizer deployed to this site.

Custom Action Component ID: Set this to the Component ID of the Application Customizer
Custom Action Component Properties JSON: Enter here the JSON text of the properties that this Application Customizer will use

Search Settings¶

Enter the URL of the search centre, which is where searches from the Suite Bar at the top of the page will navigate to.

Custom Branding Settings (if applicable)¶

If your product installation includes Custom Branding, then you can set additional properties here, such as a custom URL to the CSS file that is loaded, and the URL to a favicon that will be used for this site.

Replicate Site Assets / Templates¶

You can use this option under Provisioning to copy files stored in Site Assets or Page Templates to other sites. This is useful when a Mercury configuration file needs copying to other sites, if you want to distribute Page Templtes to other sites in the hierarchy.

Delete¶

Note

Deleting a site from a site arrangement does not delete the site from SharePoint

Site Actions¶

Under this section you will find quick shortcuts to various frequently used "back end" pages of the SharePoint site.

Export / Import¶

You can export & import a site arrangement to a JSON file either for backup purposes or to use to quickly generate a new site hierachy. If you use this to copy the hierarchy to another SharePoint tenant, ensure you use Bulk Edit to change the hostname of the sites, as well as set a new Primary Site Owner.

App Reports¶

App Reports are reports of which of your products are installed on sites in the arrangement. You can generate a report for the whole arrangement from the option in the toolbar.

App Reports can sometimes take some time to generate, so they are generated in the background and stored. You can view a list of generated reports from the option in the Toolbar download reports for review.

Reports are in JSON format for flexibility of use.