Article last updated on the 27th of June 2024.
Contents
1. Introduction
2. Configuring The WorkPoint Master Site Settings
3. Opening The Master Site Settings For A Business Module
4. Editing The Master Site Settings
5. Synchronizing Sites With The Master Site
5.1. Synchronizing A Single Site
5.2. Synchronizing All Sites In A Business Module
5.3. Synchronizing sites from a specific entity and onwards
5.4. Synchronizing the Teams site of the Master site to all entities
5.4.1. Master site Teams synchronization White List
5.4.1.1. Tabs and Apps
5.4.1.2. Channels
5.4.1.3. Team Settings
1. Introduction
Master sites enable super users to setup web parts and lists, and act as a template for other entity sites in the same business module.
Master site synchronization takes the changes to a master site and synchronizes them to other entity sites.
Note that WorkPoint does not support synchronization of individual files larger than 10 MBs in size.
Also note that Master Site Synchronization is also able to affect Buffer Sites. You can read more about buffer sites in this article.
2. Configuring The WorkPoint Master Site Settings
The Master Site settings are located in the WorkPoint Administration.
- Click on the Home button on the solution.
- Then click the cog to access the WorkPoint Administration.
3. Opening The Master Site Settings For A Business Module
- Choose a business module and click on the "..." button next to it.
- Click on "Master Sites".
4. Editing The Master Site Settings
Note that p.t. 1 through 9 in the following image are only relevant, and indeed are only shown, if the business module being configured is utilizing the One entity per site collection architecture.
- Set this tick to enable the Master Site feature for this business module.
- Enter the server relative URL to the Master Site.
- Enable or disable the use of Master Site Collection Templates. If enabled, a new template for the Master Site Collection is created whenever a change is made to the Master Site Collection.
- Click the "Delete template" to delete the current Master site collection template, if one exists. If Master site collection templates are enabled in p.t. 3, a new template is automatically created after the deletion of the current template. The template is used when creating new entities based on the Master site collection. WorkPoint 365 automatically detects most changes to master sites based on a change log. Sometimes, however, the change log does not catch all changes. In case you make changes to your master site, but do not see the changes reflected on sites being synchronized, click the "Delete Template" button to force a refresh of the Master Site template. This should resolve this issue.
- Click the "Sync Master Content Types to Hub" button to synchronize the content types from the Master site to the Content type hub. This button relates to the Content Type hub feature, which you can read more about in this article.
- Enable or disable the synchronization of site columns from the Master site collection onto new site collections.
- Enable or disable the synchronization of content types from the Master site collection onto new site collections.
- Enable or disable the synchronization of language resources for fields, content types, and terms from the Master site collection onto new site collections.
- Enable or disable the synchronization of site collection term sets from the Master site collection onto new site collections.
- Enable or disable the synchronization of site collection features from the Master site collection onto new site collections.
- Enable or disable the synchronization of Spfx packages from the Master site collection onto new site collections.
- Set this option to synchronize all lists and their items to entity sites. (including content types, fields, list items and list settings) Please note that items only are inserted on entity sites and can not be deleted via the Master Site feature.
- Set this option to synchronize the master site's field resources/localization to other sites. IMPORTANT: This is very resource intensive, and should be used only when strictly necessary.
- Set this option to overwrite all views that exist on entity sites' lists with the views configured on the Master Site and its sub-lists.
- Set this option to delete existing views all the existing views for all lists that are replicated. This will delete all views that are not present on the master site lists. Personal views will not be replicated or deleted.
- Set this option to synchronize web parts from the master site to the entity sites. Please note that the web parts must be exportable and that List View Web Parts and App parts aren't supported. Click here to configure a web part to be exportable.
- Set this to synchronize features from the master site onto other sites.
- Set this to synchronize Quick Launch Navigation from the master site onto other sites.
- Set this to replicate content types on lists where "allow content type management" is disabled. This will only apply on lists that have "replicate content types" enabled, and will replicate any content types on lists where "allow content type management" is disabled.
- Set this to synchronize Nintex Workflows from the master site onto other sites.
- Set this to synchronize the Team Settings from the master site to other entities.
- Set this to remove any Team tabs not on the master site's Team from the synchronized entity's Team.
- Click on "Save" to continue.
5. Synchronizing Sites With The Master Site
- In the WorkPoint Administration click on the "..." button of a business module.
- Click on "Master Sites Synchronization".
This opens the Master Site Synchronization page for the given business module.
5.1. Master site synchronization options
Note that options in the "Master Site Collection" section (pt. 29) in the following image are only relevant and only shown if the business module being configured is utilizing the One entity per site collection architecture.
Also note that the options in this section is only synchronized if the are in use on the master site. For example, if you select to replicate site columns, only site columns which are currently in use on the master site, will be replicated to the target.
- Select which aspects from the master site collection to synchronize to other site collections. This section is only available if the selected business module is of type "One site collection per entity".
- Select which aspects from the master site to synchronize to other sites.
- Select which aspects from the master site's Microsoft Team to synchronize to other site's Microsoft Teams.
- Select which lists and which aspects from each list from the master site to synchronize to other site lists. Each list can be expanded to reveal more options for which aspects of each list to synchronize.
- In the "Synchronization scope" menu, you have the following options:
- All entities: Use this option if you want to synchronize all entities in the business module.
- Single Entity: Use this option to synchronize a single entity in the business module. You must provide the ID of the entity you want to synchronize in the "The internal id of the item to be synchronized" field.
- Start From Entity: Use this option if you want to synchronize all entities starting from a specified entity. You must provide the ID of the entity from which you want to start the synchronization. The entity with the provided ID is included in the synchronization.
- View: Use this option if you want to synchronize all entities returned by a specified view. You must select the view to use in the "View" field.
- CAML: Use this option if you want to provide a CAML query and synchronize the entities returned by it. Before you start the synchronization, you can validate the CAML query and see if it returns any entities. You can also generate a CAML query to use based on a view on the business module list.
- Buffer sites: Use this option if you want to synchronize the buffer sites on the business module.
- Select a schedule for the synchronization. If you wish to run it now, select "Run now". If you wish to schedule the synchronization for a later time, select "Schedule" and select a date and time in the "Start Date And Time" field.
- To start the synchronization, click the "Synchronize" button. If you have selected to schedule the synchronization for later, this button saves the scheduled job.
When synchronizing more than a single entity within a business module, the synchronization motor will start a parent job, which will be responsible for starting and keeping track of the individual entity synchronization sub-jobs. These jobs can be viewed in the Job Queue page:
In this example, a synchronization using the "All entities" option has been started. The parent synchronization job has the "Master Site Synchronization Job" type, and each individual entity synchronization job has the "Master Site Sub-execution Synchronization Job" type.
Note that stopping the parent synchronization job also cancels all pending sub-execution synchronization jobs. If the parent job is then retried using the "Retry" button, all previously canceled sub-execution jobs are also restarted.
- To view information about an individual job in the job queue, including which entity a specific sub-job synchronizes, you can click the job's type. This will open the following page, showing information about that specific job:
In some cases, only specific areas or lists need to be synchronized from the master site. In this case, one should only select the relevant aspects to synchronize, as master site synchronization can be a relatively heavy task for the system, and may take a while, depending on the amount of sites and aspects to synchronize.
Note that even synchronization jobs started based on a CAML query that only targets a single entity will start a parent synchronization job.
Also note that the maximum number of master site synchronization jobs that can run concurrently is defined in the "Management" queue options in the Job Queue Manager settings page. For more information, please visit this article.
Finally, note that Master Site Synchronization does not support replication of folders containing the "+" symbol in it's name.
5.2. Synchronizing All Sites In A Business Module
Note that settings in the "Master Site Collection" section in the following image are only relevant and only shown if the business module being configured is utilizing the One entity per site collection architecture.
- In the "Master Site Collection" section, select which aspects of the master site collection you want to synchronize to all site collection on the selected business module. Note that this section of the page is only displayed if the business module selected utilizes the "One entity per site collection" architecture. In this example, we have not selected any aspects of the master site collection to synchronize.
- In the "Master Site" section, select which aspects from the master site of the selected business module to synchronize to the other sites on the business module. In this example, we have selected to synchronize the web parts on the sites, the features on the site, and the Quick Launch settings.
- In the "Master Team" section, select which aspects from the Microsoft Team associated with the master site to synchronize to Teams associated with the other sites on the business module. In this example, we have not selected to synchronize any of the Master Team aspects.
- In the "Master Site Lists Synchronization" section, select which aspects on each list of the master site to synchronize to the other sites on the business module. In this example, we have selected to only synchronize the Documents library and the Tasks list.
- In the "Synchronization Scope" option, select "All Entities". This will ensure that the synchronization is run on all entities on the business module.
- In the "Schedule" section, select when the synchronization should run. In this example, we have selected to run the synchronization now (when we click the "Synchronize" button).
- To start the synchronization, we click the "Synchronize" button.
In some cases, only specific areas or lists need to be synchronized from the master site. In this case, one should only select the relevant aspects to synchronize, as master site synchronization can be a relatively heavy task for the system, and may take a while, depending on the amount of sites and aspects to synchronize.
Note that Master Site Synchronization does not support replication of folders containing the "+" symbol in it's name.
5.3. Synchronizing sites from a specific entity and onward
Note that settings in the "Master Site Collection" section in the following image are only relevant and only shown if the business module being configured is utilizing the One entity per site collection architecture.
Through master site synchronization, it is also possible to select a business module entity and synchronize from the master site onto that entity site, and onwards to other entity sites after that one.
An example could be a Project Manager wanting to update the sites of ongoing projects, but does not wish to disturb the already closed projects in his projects list. He can then select the ID of the first entity that he wants to synchronize, and select to synchronize that one and the following ones.
To do this, follow these steps:
- In the "Master Site Collection" section, select which aspects of the master site collection you want to synchronize to the scoped site collections on the selected business module. Note that this section of the page is only displayed if the business module selected utilizes the "One entity per site collection" architecture. In this example, we have selected to synchronize only the site columns.
- In the "Master Site" section, select which aspects from the master site of the selected business module to synchronize to the other sites on the business module. In this example, we have selected to synchronize only the web parts on the sites.
- In the "Master Team" section, select which aspects from the Microsoft Team associated with the master site to synchronize to Teams associated with the other sites on the business module. In this example, we have not selected to synchronize any of the Master Team aspects.
- In the "Master Site Lists Synchronization" section, select which aspects on each list of the master site to synchronize to the other sites on the business module. In this example, we have selected to only synchronize the views on the Documents libraries.
- In the "Synchronization Scope" option, select "Start From Entity". This will ensure that the synchronization is run on entities starting with the entity with the ID we input in the "The internal id of the item to start a synchronization from" field onward.
- In the "The internal id of the item to start a synchronization from" field, input the ID of the first entity you want to target with this synchronization. This entity and all entities on the business module following this one will be synchronized.
- In the "Schedule" section, select when the synchronization should run. In this example, we have selected to run the synchronization now (when we click the "Synchronize" button).
- To start the synchronization, we click the "Synchronize" button.
All entity sites from entity ID 365 and onward will be synchronized with the master site. This can be a good way to reduce the work load of the operation if you have knowledge of a specific start entity you want to synchronize from.
Note that Master Site Synchronization does not support replication of folders containing the "+" symbol in it's name.
5.4. Synchronizing the Teams site of the Master site to all entities
As WorkPoint integrates with Microsoft Teams, the Team sites can be synchronized from the Team site of Master Sites in WorkPoint to underlying Entities' Team sites. The relevant settings for this operation is shown in the image below:
- The Replicate Teams checker can be set ON to synchronize the Master Site's Team settings to the other sites on the business module.
- The Remove Additional team Tabs checker can be set ON if other Team tabs exist on other sites that differ from those of the Master Site's Team site. These existing tabs will then be removed.
- In the "Synchronization Scope" option, select the scope of the synchronization job.
- In the "Schedule" option, select when to run the job.
- Click the "Synchronize" button to start or schedule the synchronization job.
IMPORTANT!
Please note that deleting a channel in Microsoft Teams moves the channel to a sort of Recycle Bin. One issue with this is that the channel name is still in use at this point, until the channel is cleared from the Recycle Bin - something which is done automatically by Teams after a certain amount of days from deletion.
This means that you cannot create a new channel with the same name as a channel in the Recycle Bin.
By extension, this means that if a channel is to be synchronized from a Master Site to an Entity's Team, it cannot use the same name as a channel in the Recycle Bin, as this will result in an error.
Please also be aware that settings on tenant level overrule settings made in the Teams interface. This means that if in the Teams Administration Center "Guest Access" is disallowed, settings for guests in Teams will be overruled.
5.4.1. Master site Teams synchronization White List
WorkPoint supports synchronizing various aspects of Microsoft Teams with the Business Module master entities. There may, however, also be certain aspects within Microsoft Teams which are not yet supported by WorkPoint Master Site Synchronization.
The purpose of this white list is to provide information about which aspects of Microsoft Teams are supported by WorkPoint Master Site Synchronization - "supported" meaning that these a tested and verified to work with Master site synchronization.
5.4.1.1 Tabs and Apps
The following apps and tabs are verified to work with WorkPoint Synchronization:
- All WorkPoint developed tabs (e.g. ListView, Relations, Tasks, etc.)
- SharePoint Document Library
- YouTube
5.4.1.2. Channels
The following aspects of Channels in Microsoft Teams are verified to work with WorkPoint Master Site Synchronization:
- Creation and updating of Master site channels
5.4.1.3. Team Settings
The following Team settings are synchronizable from the Master Site:
- Member permissions
- Guest permissions
- @mentions
- Team code
- Fun stuff
Please also be aware that settings on tenant level overrule settings made in the Teams interface. This means that if in the Teams Administration Center "Guest Access" is disallowed, settings for Guest permissions in Teams will be overruled.
If there are any aspects of Teams which you believe should be supported by WorkPoint 365 Master Site Synchronization, please contact WorkPoint support at support@workpoint.dk, and relay your suggestion. Thank you!
Comments
0 comments
Please sign in to leave a comment.