Skip to Content

Changes for page Setting Up the CDM

Last modified by Danniar Firdausy on 2024/08/21 15:41
From version 29.3
edited by Danniar Firdausy
on 2024/08/21 15:40
Change comment: There is no comment for this version
To version 20.2
edited by Erik Bakker
on 2022/06/13 11:17
Change comment: Update document after refactoring.

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Setting Up the CDM
1 +crashcourse-messaging-setting-up-the-cdm
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.dfirdausy
1 +XWiki.ebakker
Content
... ... @@ -1,8 +1,14 @@
1 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.
2 += Setting Up the CDM =
3 3  
4 -If you have any questions along the way, feel free to reach out to us at [[academy@emagiz.com>>mailto:academy@emagiz.com]].
4 +In the last microlearning, we learned what the CDM is and how you should use it when building messaging integrations.
5 +In this microlearning how you should go about whilst setting up the CDM.
5 5  
7 +Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
8 +
9 +* Last update: February 26th, 2021
10 +* Required reading time: 7 minutes
11 +
6 6  == 1. Prerequisites ==
7 7  
8 8  * Basic knowledge of the eMagiz platform
... ... @@ -10,7 +10,7 @@
10 10  == 2. Key concepts ==
11 11  
12 12  This microlearning centers around setting up the CDM via eMagiz.
13 -* With setting up we mean: Creating the CDM for the first time and maintaining it when changes occur
19 +By setting up we mean: Creating the CDM for the first time and maintaining it when changes occur
14 14  
15 15  Key considerations when setting up the CDM are:
16 16  
... ... @@ -19,10 +19,20 @@
19 19  * Choose one naming convention and one language
20 20  * Discuss which characteristics (i.e. attributes) belong to which entities
21 21  
28 +
29 +
22 22  == 3. Setting Up the CDM ==
23 23  
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.
32 +In the last microlearning, we learned what the CDM is and what it represents within the context of eMagiz.
33 +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.
25 25  
35 +There are several key considerations we should take into account when setting up and managing the CDM:
36 +
37 +* When you throw something away that is already used in Create you also lose that
38 +* Be careful with promoting to CDM. This can lead to replication of entities (i.e. Order and Order_1)
39 +* Choose one naming convention and one language
40 +* Discuss which characteristics (i.e. attributes) belong to which entities
41 +
26 26  === 3.1 Delete behavior ===
27 27  
28 28  Before we start discussing how you should create the first contours of the CDM and how you can manage the CDM
... ... @@ -95,28 +95,32 @@
95 95  
96 96  [[image:Main.Images.Microlearning.WebHome@crashcourse-messaging-setting-up-the-cdm--promote-to-cdm-result.png]]
97 97  
98 -== 4. Key takeaways ==
99 99  
115 +
116 +== 4. Assignment ==
117 +
118 +Add the content of a system message to the CDM via the drag and drop functionality eMagiz offers on the CDM level.
119 +This assignment can be completed with the help of your (Academy) project you have created/used in the previous assignment.
120 +
121 +== 5. Key takeaways ==
122 +
100 100  * Key considerations when setting up the CDM are:
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. Consistency in this approach is crucial for maintaining a well-organized CDM.
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.
124 + * When you throw something away that is already used in Create you also lose that
125 + * Be careful with promoting to CDM. This can lead to replication of entities (i.e. Order and Order_1)
126 + * Choose one naming convention and one language
127 + * Discuss which characteristics (i.e. attributes) belong to which entities
106 106  * Always take these considerations in mind when maintaining your CDM
107 107  
108 -== 5. Suggested Additional Readings ==
109 109  
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:
111 111  
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"]]
132 +== 6. Suggested Additional Readings ==
133 +
134 +If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
135 +
136 +== 7. Silent demonstration video ==
137 +
138 +This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
139 +
140 +{{video attachment="crashcourse-messaging-setting-up-the-cdm.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
141 +
122 122  )))((({{toc/}}))){{/container}}{{/container}}