Wiki source code of Setting Up the CDM

Last modified by Eva Torken on 2023/05/09 10:42
Show last authors
1 {{container}}{{container layoutStyle="columns"}}(((
2 In the last microlearning, we learned what the CDM is and how you should use it when building messaging integrations.
3 In this microlearning how you should go about whilst setting up the CDM.
4
5 Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
6
7 == 1. Prerequisites ==
8
9 * Basic knowledge of the eMagiz platform
10
11 == 2. Key concepts ==
12
13 This microlearning centers around setting up the CDM via eMagiz.
14 By setting up we mean: Creating the CDM for the first time and maintaining it when changes occur
15
16 Key considerations when setting up the CDM are:
17
18 * When you throw something away that is already used in Create you also lose that
19 * Be careful with promoting to CDM. This can lead to replication of entities (i.e. Order and Order_1)
20 * Choose one naming convention and one language
21 * Discuss which characteristics (i.e. attributes) belong to which entities
22
23 == 3. Setting Up the CDM ==
24
25 In the last microlearning, we learned what the CDM is and what it represents within the context of eMagiz.
26 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.
27
28 === 3.1 Delete behavior ===
29
30 Before we start discussing how you should create the first contours of the CDM and how you can manage the CDM
31 properly we would like to first address the fact that when you delete something in the CDM it can impact a lot of integrations within your landscape.
32
33 So before deleting anything from the CDM always consult with at least one colleague before proceeding.
34
35 === 3.2 Promoting to CDM ===
36
37 An easy way to start building your CDM is to use the Promote to CDM functionality.
38 However, this functionality has two downsides you need to be aware of before thinking of using this functionality:
39
40 * If you already have a CDM message for the message type for which you press Promote to CDM it will overwrite that CDM Message (which could lead to loss of data across your integration landscape)
41 * If a certain entity already exists in the CDM the Promote to CDM **won't** override it but will create a new entity with a \_1 behind it. So Order will become Order_1
42
43 Having said that, when the CDM is still empty and you have a dominant system within your integration landscape that feeds most data this is a useful method to quickly start building your CDM.
44
45 === 3.3 One naming convention ===
46
47 A third consideration before adding entities and attributes to the canvas is the naming convention that will be used.
48 This naming convention consists of two aspects:
49
50 * The language (choose one language and don't mix languages)
51 * The notation of the names of entities and attributes. Do you start each word with a capital for example (i.e. PaymentCompensation)? Or do you start each new word with capital with exception of the first word (i.e. paymentCompensation)
52
53 === 3.4 What belongs to what ===
54
55 The fourth consideration you should take into account when setting up and maintaining your CDM is how you are going to assign certain attributes to certain entities.
56 For example, if you have an Order with the following attributes there are two distinct ways of creating this in your CDM:
57
58 * ID
59 * Name
60 * Description
61 * ExecutionDateTime
62 * ReceivedDateTime
63
64 The first option would be to add all these characteristics to the Order entity which will result in the following solution in your CDM.
65
66 [[image:Main.Images.Microlearning.WebHome@crashcourse-messaging-setting-up-the-cdm--first-option.png]]
67
68 A second option would be to create a separate entity for DateTime which has a Type and a Value.
69
70 [[image:Main.Images.Microlearning.WebHome@crashcourse-messaging-setting-up-the-cdm--second-option.png]]
71
72 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.
73
74 === 3.5 Building the CDM ===
75
76 Now that we have discussed the key considerations let us turn our attention to actually learning how to build the CDM. There are two distinct methods of adding information to the CDM:
77
78 * Drag and drop entities to the canvas and manually add attributes (as we learned in the crash course platform)
79 * Use the promote CDM button on the message level
80
81 In this microlearning, we will not explain the dragging and dropping of entities and adding attributes again.
82 Instead, we will explain a new piece of functionality we have not explained yet called the Promote to CDM.
83
84 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.
85 If it is filled in you can promote the structure that is represented in the system message to the CDM
86
87 [[image:Main.Images.Microlearning.WebHome@crashcourse-messaging-setting-up-the-cdm--promote-to-cdm.png]]
88
89 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.
90 To remind you of that eMagiz shows you the following pop-up
91
92 [[image:Main.Images.Microlearning.WebHome@crashcourse-messaging-setting-up-the-cdm--promote-to-cdm-warning.png]]
93
94 When you are confident that this is the right move you can press the Promote button.
95 This will promote the system message to the CDM message and in turn, will add the entities and attributes to the CDM.
96 This behavior is shown below
97
98 [[image:Main.Images.Microlearning.WebHome@crashcourse-messaging-setting-up-the-cdm--promote-to-cdm-result.png]]
99
100
101 == 4. Key takeaways ==
102
103 * Key considerations when setting up the CDM are:
104 ** When you throw something away that is already used in Create you also lose that
105 ** Be careful with promoting to CDM. This can lead to replication of entities (i.e. Order and Order_1)
106 ** Choose one naming convention and one language
107 ** Discuss which characteristics (i.e. attributes) belong to which entities
108 * Always take these considerations in mind when maintaining your CDM
109
110 == 5. Suggested Additional Readings ==
111
112 If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
113
114 )))((({{toc/}}))){{/container}}{{/container}}