Skip to Content

Wiki source code of Control usage of CDM elements

Last modified by Martijn Woudstra on 2022/08/24 09:57
Show last authors
1 {{container}}
2 {{container layoutStyle="columns"}}
3 (((
4
5 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.
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 With usage we mean: Are the entities and attributes still being used within the 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
17
18 * Not assigned to any message types
19 * Not mapped in any message mappings
20 * Not present in Create phase integrations
21
22 == 3. Control usage of CDM elements ==
23
24 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.
25
26 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
27
28 * Not assigned to any message types
29 * Not mapped in any message mappings
30 * Not present in Create phase integrations
31
32 To access these views you can navigate to Design -> CDM and select the button Show unused items
33
34 [[image:Main.Images.Microlearning.WebHome@intermediate-defining-your-message-structures-control-usage-of-cdm-elements--show-unused-items.png]]
35
36 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
37
38 [[image:Main.Images.Microlearning.WebHome@intermediate-defining-your-message-structures-control-usage-of-cdm-elements--show-unused-items-pop-up.png]]
39
40 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.
41
42 Below we will specify per view what you can learn from each selection view.
43
44 === 3.1 Not assigned to any message types ===
45
46 The first selection view we are going to look at is the selection view called not assigned to any message types.
47
48 [[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]]
49
50 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:
51
52 * The entities and attributes are brand new and have yet to be included in a CDM system message
53 * The entities and attributes have become obsolete after the removal of an integration from eMagiz
54
55 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.
56
57 === 3.2 Not mapped in any message mappings ===
58
59 The second selection view we are going to look at is the selection view called not mapped in any message mappings.
60
61 [[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]]
62
63 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:
64
65 * The entities and attributes are brand new and have yet to be included in a message mapping
66 * The entities and attributes have become obsolete after the removal of an integration from eMagiz
67
68 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.
69
70 === 3.3 Not present in Create phase integrations ===
71
72 The third selection view we are going to look at is the selection view called not present in Create phase integrations.
73
74 [[image:Main.Images.Microlearning.WebHome@intermediate-defining-your-message-structures-control-usage-of-cdm-elements--not-present-in-create-phase-integration.png]]
75
76 This realization could mean one of two things:
77
78 * The entities and attributes are brand new and have yet to be included in an integration in the Create phase
79 * The entities and attributes have become obsolete after the removal of an integration from the Create phase
80
81 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.
82
83 == 4. Assignment ==
84
85 Analyze your CDM and control per selection view the usage of CDM elements.
86 This assignment can be completed within the Design phase of your (Academy) project that you have created/used in the previous assignment.
87
88 == 5. Key takeaways ==
89
90 * 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.
91 * There are three separate selection views you can use to control the usage of CDM elements
92 * Not assigned to any message types
93 * Not mapped in any message mappings
94 * Not present in Create phase integrations
95
96
97
98 == 6. Suggested Additional Readings ==
99
100 If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
101
102 == 7. Silent demonstration video ==
103
104 This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
105
106 {{video attachment="intermediate-defining-your-message-structures-control-usage-of-cdm-elements.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
107
108 )))
109
110 ((({{toc/}}))){{/container}}
111 {{/container}}