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.

6

7

Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].

8

9

== 1. Prerequisites ==

10

11

* Basic knowledge of the eMagiz platform

12

13

== 2. Key concepts ==

14

15

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

16

* 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.

17

18

There are three separate selection views you can use to control the usage of CDM elements:

19

20

* Not assigned to any message types

21

* Not mapped in any message mappings

22

* Not present in Create phase integrations

23

24

== 3. Control usage of CDM elements ==

25

26

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.

27

28

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

29

30

* Not assigned to any message types

31

* Not mapped in any message mappings

32

* Not present in Create phase integrations

33

34

To access these views you can navigate to Design -> CDM and select the button Show unused items

35

36

[[image:Main.Images.Microlearning.WebHome@intermediate-defining-your-message-structures-control-usage-of-cdm-elements--show-unused-items.png]]

37

38

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

39

40

[[image:Main.Images.Microlearning.WebHome@intermediate-defining-your-message-structures-control-usage-of-cdm-elements--show-unused-items-pop-up.png]]

41

42

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.

43

44

Below we will specify per view what you can learn from each selection view.

45

46

=== 3.1 Not assigned to any message types ===

47

48

The first selection view we are going to look at is the selection view called not assigned to any message types.

49

50

[[image:Main.Images.Microlearning.WebHome@intermediate-defining-your-message-structures-control-usage-of-cdm-elements--show-unused-items-pop-up-not-assigned-to-any-message-type.png]]

51

52

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:

53

54

* The entities and attributes are brand new and have yet to be included in a CDM system message

55

* The entities and attributes have become obsolete after the removal of an integration from eMagiz

56

57

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.

58

59

=== 3.2 Not mapped in any message mappings ===

60

61

The second selection view we are going to look at is the selection view called not mapped in any message mappings.

62

63

[[image:Main.Images.Microlearning.WebHome@intermediate-defining-your-message-structures-control-usage-of-cdm-elements--show-unused-items-pop-up-not-mapped-in-any-message-mappings.png]]

64

65

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:

66

67

* The entities and attributes are brand new and have yet to be included in a message mapping

68

* The entities and attributes have become obsolete after the removal of an integration from eMagiz

69

70

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.

71

72

=== 3.3 Not present in Create phase integrations ===

73

74

The third selection view we are going to look at is the selection view called not present in Create phase integrations.

75

76

[[image:Main.Images.Microlearning.WebHome@intermediate-defining-your-message-structures-control-usage-of-cdm-elements--not-present-in-create-phase-integration.png]]

77

78

This realization could mean one of two things:

79

80

* The entities and attributes are brand new and have yet to be included in an integration in the Create phase

81

* The entities and attributes have become obsolete after the removal of an integration from the Create phase

82

83

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.

84

85

== 4. Key takeaways ==

86

87

* 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.

88

* There are three separate selection views you can use to control the usage of CDM elements:

89

** Not assigned to any message types.

90

** Not mapped in any message mappings.

91

** Not present in Create phase integrations.

92

* Regularly reviewing these views helps keep your CDM up-to-date and aligned with your active integrations.

93

94

== 5. Suggested Additional Readings ==

95

96

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:

97

98

* [[Crash Courses (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]]

99

** [[Crash Course Platform (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.WebHome||target="blank"]]

100

*** [[Creating a message definition (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-design-creating-a-message-definition||target="blank"]]

101

** [[Crash Course Messaging (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Messaging.WebHome||target="blank"]]

102

*** [[Setting up the CDM (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Messaging.crashcourse-messaging-setting-up-the-cdm||target="blank"]]

103

* [[CDM Elements (Search Results)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&l_space_facet=10&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=%22cdm+elements%22||target="blank"]]

104

)))((({{toc/}}))){{/container}}{{/container}}

author	version	line-number	content
		1	{{container}}
		2	{{container layoutStyle="columns"}}
		3	(((
		4
		5	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.
		6
		7	Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
		8
		9	== 1. Prerequisites ==
		10
		11	* Basic knowledge of the eMagiz platform
		12
		13	== 2. Key concepts ==
		14
		15	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
		16	* 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.
		17
		18	There are three separate selection views you can use to control the usage of CDM elements:
		19
		20	* Not assigned to any message types
		21	* Not mapped in any message mappings
		22	* Not present in Create phase integrations
		23
		24	== 3. Control usage of CDM elements ==
		25
		26	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.
		27
		28	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
		29
		30	* Not assigned to any message types
		31	* Not mapped in any message mappings
		32	* Not present in Create phase integrations
		33
		34	To access these views you can navigate to Design -> CDM and select the button Show unused items
		35
		36	[[image:Main.Images.Microlearning.WebHome@intermediate-defining-your-message-structures-control-usage-of-cdm-elements--show-unused-items.png]]
		37
		38	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
		39
		40	[[image:Main.Images.Microlearning.WebHome@intermediate-defining-your-message-structures-control-usage-of-cdm-elements--show-unused-items-pop-up.png]]
		41
		42	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.
		43
		44	Below we will specify per view what you can learn from each selection view.
		45
		46	=== 3.1 Not assigned to any message types ===
		47
		48	The first selection view we are going to look at is the selection view called not assigned to any message types.
		49
		50	[[image:Main.Images.Microlearning.WebHome@intermediate-defining-your-message-structures-control-usage-of-cdm-elements--show-unused-items-pop-up-not-assigned-to-any-message-type.png]]
		51
		52	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:
		53
		54	* The entities and attributes are brand new and have yet to be included in a CDM system message
		55	* The entities and attributes have become obsolete after the removal of an integration from eMagiz
		56
		57	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.
		58
		59	=== 3.2 Not mapped in any message mappings ===
		60
		61	The second selection view we are going to look at is the selection view called not mapped in any message mappings.
		62
		63	[[image:Main.Images.Microlearning.WebHome@intermediate-defining-your-message-structures-control-usage-of-cdm-elements--show-unused-items-pop-up-not-mapped-in-any-message-mappings.png]]
		64
		65	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:
		66
		67	* The entities and attributes are brand new and have yet to be included in a message mapping
		68	* The entities and attributes have become obsolete after the removal of an integration from eMagiz
		69
		70	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.
		71
		72	=== 3.3 Not present in Create phase integrations ===
		73
		74	The third selection view we are going to look at is the selection view called not present in Create phase integrations.
		75
		76	[[image:Main.Images.Microlearning.WebHome@intermediate-defining-your-message-structures-control-usage-of-cdm-elements--not-present-in-create-phase-integration.png]]
		77
		78	This realization could mean one of two things:
		79
		80	* The entities and attributes are brand new and have yet to be included in an integration in the Create phase
		81	* The entities and attributes have become obsolete after the removal of an integration from the Create phase
		82
		83	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.
		84
		85	== 4. Key takeaways ==
		86
		87	* 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.
		88	* There are three separate selection views you can use to control the usage of CDM elements:
		89	** Not assigned to any message types.
		90	** Not mapped in any message mappings.
		91	** Not present in Create phase integrations.
		92	* Regularly reviewing these views helps keep your CDM up-to-date and aligned with your active integrations.
		93
		94	== 5. Suggested Additional Readings ==
		95
		96	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:
		97
		98	* [[Crash Courses (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome\|\|target="blank"]]
		99	** [[Crash Course Platform (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.WebHome\|\|target="blank"]]
		100	*** [[Creating a message definition (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-design-creating-a-message-definition\|\|target="blank"]]
		101	** [[Crash Course Messaging (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Messaging.WebHome\|\|target="blank"]]
		102	*** [[Setting up the CDM (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Messaging.crashcourse-messaging-setting-up-the-cdm\|\|target="blank"]]
		103	* [[CDM Elements (Search Results)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&l_space_facet=10&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=%22cdm+elements%22\|\|target="blank"]]
		104	)))((({{toc/}}))){{/container}}{{/container}}

Wiki source code of Control usage of CDM elements

Navigation