Article last updated on the 1st of July 2024.
Contents
1. Introduction
With meta data inheritance it is possible for you to propagate meta data from a defined set of business module columns to lists on entity sites. This is especially useful for the end-user as it requires them to enter less data overall, as the system automatically fills certain fields.
This is useful if working in many different documents libraries, but information about the overall responsible person of the given entities is important.
When users of e.g. a Company module allow inheritance of meta data such as contact information or account numbers, this information can be inherited to any projects created as a child entity to the company.
Note that WorkPoint supports data inheritance up to 5 level down.
2. Requirements
There are currently no requirements for the utilization of this feature.
3. Configuration
In this example, we will set up inheritance on the documents lists on Projects to show the Project Responsible person. Note, however, that inheritance can be done on multiple lists and with multiple fields.
In this example, we have a project called “Setup on Main Street” with a responsible person, Sam Wilson, set:
The Documents library on the project site, however, does not display this information:
We can set up inheritance from the WorkPoint Administration:
- Click the “Home”-button of the solution.
- Click the cog-icon to access the WorkPoint Administration.
- Click the header of the business module for which data inheritance should be set up.
- Click the “Inheritance”-menu item.
- Click the enable inheritance. Inheritance jobs can, depending on the scale, be costly performance-wise, and there might also be other scenarios where inheritance should be temporarily disabled. This can be done simply by disabling inheritance here.
Once inheritance is enabled, the page displays further configuration options:
- Click the enable “Inherit” for the Documents library.
- Click the enable “On Entity Updated". This ensures that the inherited metadata is re-inherited if it changes on the source entity, e.g., if the Responsible person changes on the project, the new metadata will be inherited to the target documents and other elements.
- In the "Folders & Document sets" column, we can select whether data should be inherited to folders and document sets. In this instance, we want folders and document sets to also get the inherited data, so we check the checkbox.
- Click the empty field in the “Fields” to get a selection of fields that you can add. You can add multiple fields, but in this case, we just want to inherit the “Responsible” from the project to the list, thus “Responsible” is selected.
- In the "Editable fields" we can select which of the inherited fields should be editable on the target elements.
- Click the either the “Save”-button or the “Save and run inheritance”-button once the configuration is complete. In this case, we click the “Save and run inheritance”-button.
Depending on the amount of entities in the business module as well as how many fields to inherit, the inherit operation might take a while. WorkPoint displays this message:
If this is not an issue, click the “OK”-button to proceed. Otherwise, click the “Cancel”-button.
Also note that running data inheritance will overwrite any information currently in the fields to inherit. WorkPoint displays this message:
If this is again not an issue, simply click the “OK”-button to proceed. Otherwise, click the “Cancel”-button.
The “Log”-section of the page displays the progress of the inheritance job:
- To update the list and follow the progress, click the “Refresh”-button.
- You can stop the job prematurely by clicking the “Stop”-button in the log
Once the operation is complete, we can see that the project responsible person now shows in a column in the Documents lists:
This requires the enabling of the “Responsible”-column in the selected view of the Documents list.
4. Inheriting to child module lists
It is possible to inherit data from a parent module to a child module list. You can, e.g. inherit data from a Companies list to a child Projects list. An example of the use of this could be to inherit data such as the company responsible person to projects in the Projects list.
This functionality is exemplified in the diagram below:
Child module inheritance can be set up from the WorkPoint Administration:
- In the WorkPoint Administration, click the header of the business module for which child module inheritance should be set up.
- Click "Inheritance".
- In the Inheritance Settings page for the business module for which inheritance is being set up (in this case the "Companies" module), check "Inheritance to child modules enabled" on.
- Check on the child modules of the module which should inherit data from the parent module. Note that WorkPoint supports data inheritance up to 5 levels of child modules down. In this case, Level 1 Projects is a child module of the Companies module. Level 2 Projects is a child module of the Level 1 Projects module, and thus a grand-child module of the Companies module. Level 3 Projects is a child of the Level 2 Projects module and thus a grand-grand-child module of the Companies module. This relationship can be seen in the indentation of the modules in the "Child Modules" list.
- Select the fields that should be inherited. In this case, we inherit the person in the "Responsible" field from the Companies module to all levels of projects modules.
- Click the "Save and run inheritance" button to save and run the inheritance immediately.
Inheritance to child modules is now set up.
5. Notes
In certain circumstances it may be wise to disable data inheritance temporarily. An example of this is during data migration. This can be done by simply going to the inheritance settings page for a given business module and disabling the setting. The configurations persist, and if re-enabled inheritance will work as prior to disabling it.
Also note that lookup fields with lookup values exceeding 225 characters inherited to document lists are converted into single line of text fields. This may cause issues so best practice is to limit this to less than 225 characters.
5.1. Feature support White List
WorkPoint Data Inheritance supports a range of features;
- supports inheritance of data from business module list to child entity list
- supports inheritance of data from parent business module to child module entity
- supports inheritance of all data types
Be aware that lookup fields inherited to another site collection will be converted from lookup fields to text fields.
Comments
0 comments
Article is closed for comments.