Article published on the 8th of July, 2021.
Contents
1. Introduction
Rule-based Master Site Synchronization allows you to synchronize specific parts of the master site of a module onto a set of entities based on field rules.
As an example a Projects business module could include a field called "Project Size" with a set of options; Small, Medium, and Large. With rule-based master site synchronization, we could set up a rule which makes the system synchronize the "External documents" library from the master site onto new projects only if the project size is "Medium" or "Large". With this setup, small projects will not include an "External documents" library.
Another use case for rule based master site synchronization could be that when creating an new project, it should be possible for the user to decide whether to have a Note list available. If this is not decided, the Note list can be added at a later point.
A third and final use case could be differentiating between what the welcome page for projects should be, based on some field, e.g. Project Size.
Rule-based Master Site Synchronization works by setting up activation conditions and master site synchronization rules.
Master site synchronization rules are executed if the activation conditions they are associated with are met, i.e. the activation conditions determine if master site synchronization rules should activate.
Due to this relationship, the first step should be to create activation conditions, and then create the rules which should be activated based on these.
2. Requirements
Please refer to the following table to see the license requirements for Rule-based Master Site Synchronization:
V3 - Standard | V3 - Business | V3 - Enterprise | WorkPoint 365 Core | V4 Package |
---|---|---|---|---|
Included | WorkPoint 365 Core |
Rule-based Master Site Synchronization requires a WorkPoint Enterprise license, and is issued on request.
3. Configuration
Setting up Rule-based Master Site Synchronization is done from the WorkPoint Administration:
- On the WorkPoint solution, click the "Home" button.
- In the bottom of the side panel, click the cog icon to access the WorkPoint Administration.
- In the WorkPoint Administration, click the header of the business module for which you wish to configure rule-based master site synchronization.
- In the menu, click "Master Site Synchronization Rules".
This opens the setup page for master site synchronization rules:
- To add a new activation condition, click the "Add activation condition" button.
- To add a new synchronization rule, click the "Add synchronization rule" button.
- To save the setup, click the "Save" button.
3.1. Creating activation conditions
To add a new activation condition for rule based master site synchronization, follow step 5 in this guide.
This opens the "Add activation condition" page:
- We need to provide a title for the activation condition. This is for later identification when pairing the activation condition with a synchronization rule.
- We also need to select a field for the activation condition. The field combined with a value (provided in pt. 10) are what defined what the activation condition checks for.
- When a field is selected in pt. 9, a value for the field can be selected in a control dependent on which type of field is selected. This means that is a field of type "single line of text" is selected, you can type in a value, if a field of type "Choice" is selected, you can choose from the field's options, etc.
- To save the activation condition, click the "Save" button. To cancel and return to the previous page, click "Back".
3.2. Creating synchronization rules
To add a new activation condition for rule based master site synchronization, follow step 6 in this guide.
This opens the "Add/Modify synchronization rule" page:
- You can activate or deactivate the synchronization rule using the "Active" checker. Active synchronization rules will execute if the activation condition they are paired with are met, wheres inactive synchronization rules will not.
- The synchronization rule also requires a title.
- In the "Activation Conditions" selector, you can select one or multiple activation conditions to pair this synchronization rule with. Activation conditions can be added by following the steps in section 3.1. If this (or these) activation condition(s) are met, the synchronization rule will execute.
- In the "Activation Condition Criteria" selector, you can select if any or all of the selected activation conditions from pt. 14 need to be met in order for the synchronization rule to execute. You can e.g. select "Any" if any one of the activation conditions needs to be met for the rule to execute, or "All" if all selected conditions need to simultaneously be met for the rule to execute.
- In the "Scope" selector, you can select the scope that the synchronization rule targets. This affects the options in step 17.
- List: Select this if you want to synchronize a specific list from the Master Site to the affected entity(ies). With this option, a list must be specified in step 17.
- Items: Select this if you want synchronize a specific item from the Master site to the affected entity(ies). For this option, you can select a list to get the item from, as well as a "Limitation field" and a "Limitation value" in step 17 in order to identify the item you want to synchronize.
- Quick launch: Select this if you want to synchronize one or more components of the Master Site's Quick Launch menu to the affected entity(ies). with this option, in step 17 you can check or uncheck the Master Site's quick launch components you want or do not want to synchronize.
- Welcome pages: Select this if you want to synchronize a specific welcome page from the Master Site to the affected entity(ies). The Master site could have multiple welcome pages configured, and you might want to use one over another in specific scenarios. In step 17 you can select which specific welcome page to synchronize out.
- SharePoint Feature: Select this to synchronize specific SharePoint Features from the Master Site to the affected entity(ies). If the module on which you are currently configuring rule based master site synchronization is of type "One entity per site collection", you get two selectors in step 17; one for site collection features, and one for site features. You can use these to select which SharePoint features from each category to synchronize to affected entities.
- In step 17, you define settings related to the selection in step 16. See each elements from that step for elaborations.
- To save the configuration, click the "Save" button. To cancel and go back to the previous page, click "Back".
3.3. Example configuration
In this example case, we have a Projects list with a Choice field used to designate projects as either "Small project" or "Large project". We want to use rule-based master site synchronization to determine which lists should be present on Small and Large projects. We will also control which "welcome pages" to use for either project size. Finally, we will configure the Quick Navigation menus for both project sizes.
We start by navigating to the settings page for rule-based master site synchronization:
- In the WorkPoint Administration, we click the header of the Projects business module.
- In the business module menu, we click "Master Site Synchronization Rules".
We start by creating two activation conditions; one for small projects, and one for large projects:
- In the "Edit master site synchronization rules for Projects" page, under "Conditions", we click "Add activation condition".
- We give the new activation condition the title "Small", for small projects.
- For the "Field", we select the "Project Size" field. This is a choice field used to designate projects as either "Small" or "Large".
- For "Value", we select "Small".
- To finish configuring the activation condition, we click the "Save" button.
The new activation condition now appears in the list of activation conditions:
In the same way, we create the activation condition for large projects:
Now we can begin creating the rules for which elements should by synchronized from the master site to either small or large projects. First, we create rules for which lists should be synchronized to small projects:
- In the "Edit master site synchronization rules for Projects" page, under "Master Site Synchronization Rules", we click "Add synchronization rule".
- First, we activate the rule.
- We provide an informative title for the rule.
- For "Activation Conditions", we select the "Small" condition we created previously.
- For "Activation Condition Criteria", we select "Any condition". In this case, this setting is not very important as we only have one condition.
- For "Scope", we select "List".
- For "List", we select the "Documents" library.
- We click the "Save" button to save the configuration.
The rule now appears in the list of Master Site Synchronization Rules:
In the same way, we create a similar rule for the Emails library:
Next, we will configure the navigation menu for "Small" projects:
- We again click the button to create a new master site synchronization rule.
- We begin by activating the rule.
- We provide the title "Small - Quick Navigation" to the rule.
- For "Activation Conditions", we select the "Small" condition.
- For "Activation Condition Criteria", we select "Any Condition". In this case, this setting is not very important as we only have one condition.
- For "Scope", we select "Quick Launch".
- In the list of Quick Launch elements from the Master Site, we select only the "Home", "Documents", and the "Emails" elements.
- We click the "Save" button to save the configuration.
The rule now appears in the list of master site synchronization rules:
As a last rule for the "Small" activation condition, we select which "Welcome page" to use for small projects:
- Again, we click the "Add synchronization rule" button.
- We activate the rule.
- We title the rule "Small - Welcome page".
- For "Activation Conditions", we select the "Small" condition.
- For "Activation Condition Criteria", we select "Any condition".
- For "Scope", we select "Welcome pages".
- "For "Welcome pages", we can select between all pages created for the Master Site. In this instance, we have created a specific welcome page for small projects, which simply contains two List View webparts showing the Documents library and the Emails library. We select this welcome page here.
- We save the master site synchronization rule by clicking the "Save" button.
We have now configured all the necessary rules for small projects:
Next, we can proceed to set up the library rules for the Large projects:
- Once again, we click to create a new master site synchronization rule.
- First, we activate the rule.
- We provide the title "Large - Documents" for the rule.
- For "Activation Conditions", we select the "Large" condition we created previously.
- For "Activation Condition Criteria", we select "Any condition". In this case, this setting is not very important as we only have one condition.
- For "Scope", we select "List".
- For "List", we select the "Documents" library.
- We click the "Save" button to save the configuration.
The rule now appears in the list of master site synchronization rules:
We now create similar rules for all available libraries for Large projects:
For Quick Navigation for Large projects, we create the following rule:
- We activate the rule.
- We call the rule "Large - Quick Navigation".
- For "Activation Conditions", we select the "Large" condition.
- For "Activation Condition Criteria", we select "Any condition".
- For "Scope", we select "Quick Launch".
- In the list of Quick Launch elements, we select all.
- We save the configuration by clicking the "Save" button.
The rule now also appears in the list of master site synchronization rules:
We can now enable the master site synchronization rules:
- In the top of the settings page, we check the option to enable the master site synchronization rules.
- In the bottom of the settings page, we click the "Save" button.
We can now try and create two projects; one for each project size:
- In this case, we have created two projects; "Road construction" which is a "Small" project, and "Foundation project" which is a large project. Both of these reside on the same business module - the Projects module. But due to our Master Site Synchronization rules, they have vastly different sites:
Road construction (small):
Foundation project (large):
4. Notes
4.1. Lists with no rules
Note that lists from a master site are always synchronized to entities, unless a rule is set up for the given list.
In the example presented in this article, we created a rule for the Documents and Emails libraries for both Project Sizes. This is technically unnecessary, because if we simply did not create any rules for these libraries, they would automatically be synchronized onto projects, regardless of their project size designation.
If we only want a list/library on one of the project size types, we would only need to create a rule for that project size. The system then knows to exclude the other, and the list/library will only be synchronized onto the project size type for which there is a rule.
4.2. Conflicting rules
The only identified case where master site synchronization rules can conflict is if multiple rules attempt to set different welcome pages for the same entity type. In this case, the default welcome page will be set and an error will be sent to the event log.
Comments
0 comments
Article is closed for comments.