Skip to Content

Changes for page Setting Up the CDM

Last modified by Danniar Firdausy on 2024/08/21 15:41
From version 12.1
edited by eMagiz
on 2022/05/10 11:16
Change comment: There is no comment for this version
To version 30.1
edited by Danniar Firdausy
on 2024/08/21 15:41
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,0 +1,1 @@
1 +Setting Up the CDM
Parent
... ... @@ -1,0 +1,1 @@
1 +WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.marijn
1 +XWiki.dfirdausy
Content
... ... @@ -1,21 +1,8 @@
1 -{{html wiki="true"}}
2 -<div class="ez-academy">
3 - <div class="ez-academy_body">
1 +{{container}}{{container layoutStyle="columns"}}(((
2 +In the previous microlearning session, we explored the concept of the CDM (Canonical Data Model) and its role in messaging integrations. In this microlearning, we will dive deeper into the practical steps of setting up and maintaining your CDM within the eMagiz platform. By the end of this microlearning, you will have a clear understanding of how to create and manage your CDM effectively as your integration landscape evolves.
4 4  
5 -<div class="doc">
4 +If you have any questions along the way, feel free to reach out to us at [[academy@emagiz.com>>mailto:academy@emagiz.com]].
6 6  
7 -
8 -
9 -= Setting Up the CDM =
10 -
11 -In the last microlearning, we learned what the CDM is and how you should use it when building messaging integrations.
12 -In this microlearning how you should go about whilst setting up the CDM.
13 -
14 -Should you have any questions, please contact academy@emagiz.com.
15 -
16 -* Last update: February 26th, 2021
17 -* Required reading time: 7 minutes
18 -
19 19  == 1. Prerequisites ==
20 20  
21 21  * Basic knowledge of the eMagiz platform
... ... @@ -23,7 +23,7 @@
23 23  == 2. Key concepts ==
24 24  
25 25  This microlearning centers around setting up the CDM via eMagiz.
26 -By setting up we mean: Creating the CDM for the first time and maintaining it when changes occur
13 +* With setting up we mean: Creating the CDM for the first time and maintaining it when changes occur
27 27  
28 28  Key considerations when setting up the CDM are:
29 29  
... ... @@ -32,20 +32,10 @@
32 32  * Choose one naming convention and one language
33 33  * Discuss which characteristics (i.e. attributes) belong to which entities
34 34  
35 -
36 -
37 37  == 3. Setting Up the CDM ==
38 38  
39 -In the last microlearning, we learned what the CDM is and what it represents within the context of eMagiz.
40 -In this microlearning, we will take a closer look at the CDM in terms of how you can create the CDM and maintain the CDM when your integration landscape grows.
24 +In the last microlearning, we learned what the CDM is and what it represents within the context of eMagiz. In this microlearning, we will take a closer look at the CDM in terms of how you can create the CDM and maintain the CDM when your integration landscape grows.
41 41  
42 -There are several key considerations we should take into account when setting up and managing the CDM:
43 -
44 -* When you throw something away that is already used in Create you also lose that
45 -* Be careful with promoting to CDM. This can lead to replication of entities (i.e. Order and Order_1)
46 -* Choose one naming convention and one language
47 -* Discuss which characteristics (i.e. attributes) belong to which entities
48 -
49 49  === 3.1 Delete behavior ===
50 50  
51 51  Before we start discussing how you should create the first contours of the CDM and how you can manage the CDM
... ... @@ -84,11 +84,11 @@
84 84  
85 85  The first option would be to add all these characteristics to the Order entity which will result in the following solution in your CDM.
86 86  
87 -<p align="center">[[image:crashcourse-messaging-setting-up-the-cdm--first-option.png||]]</p>
64 +[[image:Main.Images.Microlearning.WebHome@crashcourse-messaging-setting-up-the-cdm--first-option.png]]
88 88  
89 89  A second option would be to create a separate entity for DateTime which has a Type and a Value.
90 90  
91 -<p align="center">[[image:crashcourse-messaging-setting-up-the-cdm--second-option.png||]]</p>
68 +[[image:Main.Images.Microlearning.WebHome@crashcourse-messaging-setting-up-the-cdm--second-option.png]]
92 92  
93 93  Both options have their advantages and disadvantages. The point of the matter is that you should make consistent choices with regards to which option you choose for your CDM.
94 94  
... ... @@ -105,49 +105,41 @@
105 105  If you navigate to Design and access the context menu to get to the system message you will see a canvas in which the system message is filled in or not.
106 106  If it is filled in you can promote the structure that is represented in the system message to the CDM
107 107  
108 -<p align="center">[[image:crashcourse-messaging-setting-up-the-cdm--promote-to-cdm.png||]]</p>
85 +[[image:Main.Images.Microlearning.WebHome@crashcourse-messaging-setting-up-the-cdm--promote-to-cdm.png]]
109 109  
110 110  You can do so after you have left Start Editing Mode. By selecting this button any existing creation on the CDM message level will be wiped clean.
111 111  To remind you of that eMagiz shows you the following pop-up
112 112  
113 -<p align="center">[[image:crashcourse-messaging-setting-up-the-cdm--promote-to-cdm-warning.png||]]</p>
90 +[[image:Main.Images.Microlearning.WebHome@crashcourse-messaging-setting-up-the-cdm--promote-to-cdm-warning.png]]
114 114  
115 115  When you are confident that this is the right move you can press the Promote button.
116 116  This will promote the system message to the CDM message and in turn, will add the entities and attributes to the CDM.
117 117  This behavior is shown below
118 118  
119 -<p align="center">[[image:crashcourse-messaging-setting-up-the-cdm--promote-to-cdm-result.png||]]</p>
96 +[[image:Main.Images.Microlearning.WebHome@crashcourse-messaging-setting-up-the-cdm--promote-to-cdm-result.png]]
120 120  
121 -===== Practice =====
98 +== 4. Key takeaways ==
122 122  
123 -== 4. Assignment ==
124 -
125 -Add the content of a system message to the CDM via the drag and drop functionality eMagiz offers on the CDM level.
126 -This assignment can be completed with the help of your (Academy) project you have created/used in the previous assignment.
127 -
128 -== 5. Key takeaways ==
129 -
130 130  * Key considerations when setting up the CDM are:
131 - * When you throw something away that is already used in Create you also lose that
132 - * Be careful with promoting to CDM. This can lead to replication of entities (i.e. Order and Order_1)
133 - * Choose one naming convention and one language
134 - * Discuss which characteristics (i.e. attributes) belong to which entities
101 +** Consistent Naming Conventions: Choose a single language and adhere to a consistent naming convention for entities and attributes to avoid confusion and maintain clarity.
102 +** Entity and Attribute Assignment: Decide carefully how to assign attributes to entities, whether grouping them under one entity or creating separate entities for specific attributes.
103 +** Promoting to CDM: The "Promote to CDM" feature can overwrite existing CDM messages or create new entities with suffixes (e.g., Order_1). Use this function with caution and ensure it's the right approach for your setup.
104 +** Impact of Deletion: Deleting elements from the CDM can affect multiple integrations. Always consult with a colleague before making deletions.
105 +** Maintenance Considerations: Regularly review and maintain your CDM with these considerations in mind to ensure its effectiveness and integration with your evolving landscape.
135 135  * Always take these considerations in mind when maintaining your CDM
136 136  
108 +== 5. Suggested Additional Readings ==
137 137  
110 +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 link:
138 138  
139 -== 6. Suggested Additional Readings ==
140 -
141 -If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
142 -
143 -== 7. Silent demonstration video ==
144 -
145 -This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
146 -
147 -<iframe width="1280" height="720" src="../../vid/microlearning/crashcourse-messaging-setting-up-the-cdm.mp4" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
148 -
149 -</div>
150 -</div>
151 -</div>
152 -
153 -{{/html}}
112 +* [[Crash Courses (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]]
113 +** [[Crash Course Platform (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.WebHome||target="blank"]]
114 +*** [[Creating a message definition (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-design-creating-a-message-definition||target="blank"]]
115 +** [[Crash Course Messaging (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Messaging.WebHome||target="blank"]]
116 +*** [[Understanding the eMagiz CDM (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Messaging.crashcourse-messaging-what-is-cdm||target="blank"]]
117 +* [[Intermediate Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
118 +** [[Defining message structures (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Defining message structures.WebHome||target="blank"]]
119 +*** [[Cleaning up the CDM (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Defining message structures.intermediate-defining-your-message-structures-cleaning-up-the-cdm||target="blank"]]
120 +*** [[Control usage of CDM elements (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Defining message structures.intermediate-defining-your-message-structures-control-usage-of-cdm-elements||target="blank"]]
121 +* [[Setting Up the CDM (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=%22setting+up+the+CDM%22||target="blank"]]
122 +)))((({{toc/}}))){{/container}}{{/container}}
crashcourse-messaging-setting-up-the-cdm--first-option.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.ebakker
Size
... ... @@ -1,0 +1,1 @@
1 +3.7 KB
Content