Control usage of CDM elements
In this microlearning, we will explore how to effectively monitor and control the usage of Canonical Data Model (CDM) elements—namely, entities and attributes—to ensure that your CDM accurately reflects the components actively used in your integrations. By understanding how to manage these elements, you can maintain a robust and relevant CDM. Let’s dive into the key concepts and tools available to help you with this task.
Should you have any questions, please contact academy@emagiz.com.
1. Prerequisites
- Basic knowledge of the eMagiz platform
2. Key concepts
In this microlearning, we will focus on how you can control the usage of CDM elements. With CDM elements we mean: Entities and attributes that make up the Canonical Data Model
- By "usage" we mean: Determining whether these entities and attributes are still active and in use. It is crucial to understand how to monitor and control the usage of CDM elements to ensure that your CDM accurately reflects the components that are actively utilized within your eMagiz solution.
There are three separate selection views you can use to control the usage of CDM elements:
- Not assigned to any message types
- Not mapped in any message mappings
- Not present in Create phase integrations
3. Control usage of CDM elements
In this microlearning, we will focus on how you can control the usage of CDM elements. It is necessary to understand how you can control the usage of CDM elements to ensure that your CDM keeps being a good representation of which entities and attributes are actually used within your eMagiz solution.
It is necessary to understand how you can control the usage of CDM elements to ensure that your CDM keeps being a good representation of which entities and attributes are actually used within your eMagiz solution. There are three separate selection views you can use to control the usage of CDM elements
- Not assigned to any message types
- Not mapped in any message mappings
- Not present in Create phase integrations
To access these views you can navigate to Design -> CDM and select the button Show unused items
After you have selected this button a pop-up will appear. Within this pop-up we can make a cross section of the CDM based on the selection views detailed above
As you can see in this pop-up you will see all unused items within your eMagiz solution. Within this pop-up you can zoom in by opting for a specific selection view.
Below we will specify per view what you can learn from each selection view.
3.1 Not assigned to any message types
The first selection view we are going to look at is the selection view called not assigned to any message types.
With this selection view eMagiz will show you all entities and attributes that are part of your Canocical Data Model (CDM) but are not part of any of the CDM message types (accessible via the right panel of your screen). This realization could mean one of two things:
- The entities and attributes are brand new and have yet to be included in a CDM system message
- The entities and attributes have become obsolete after the removal of an integration from eMagiz
When the former is the case no further action is needed. If the latter is the case you should also remove these entities and attributes from your CDM to ensure that your CDM is a good and solid representation of reality.
3.2 Not mapped in any message mappings
The second selection view we are going to look at is the selection view called not mapped in any message mappings.
With this selection view eMagiz will show you all entities and attributes that are part of your Canocical Data Model (CDM), are part of at least one of the CDM message types (accessible via the right panel of your screen) but are not mapped between system and CDM message. So in other words no line is drawn between in any of the message mappings in Design for those entities and/or attributes. This realization could mean one of two things:
- The entities and attributes are brand new and have yet to be included in a message mapping
- The entities and attributes have become obsolete after the removal of an integration from eMagiz
When the former is the case no further action is needed. If the latter is the case you should also remove these entities and attributes from your CDM to ensure that your CDM is a good and solid representation of reality.
3.3 Not present in Create phase integrations
The third selection view we are going to look at is the selection view called not present in Create phase integrations.
This realization could mean one of two things:
- The entities and attributes are brand new and have yet to be included in an integration in the Create phase
- The entities and attributes have become obsolete after the removal of an integration from the Create phase
When the former is the case no further action is needed. If the latter is the case you should also remove these entities and attributes from your CDM to ensure that your CDM is a good and solid representation of reality.
4. Key takeaways
- It is essential to know how to manage the usage of CDM elements (i.e., entities and attributes) to ensure your Canonical Data Model accurately represents the components actively used in your eMagiz solution.
- There are three separate selection views you can use to control the usage of CDM elements:
- Not assigned to any message types.
- Not mapped in any message mappings.
- Not present in Create phase integrations.
- Regularly reviewing these views helps keep your CDM up-to-date and aligned with your active integrations.
5. Suggested Additional Readings
If you are interested in this topic and want more information on it please read the help text provided by eMagiz and read the following links: