Wiki source code of Cleaning up the CDM

Last modified by Eva Torken on 2023/08/08 17:11
Show last authors
1 {{container}}
2 {{container layoutStyle="columns"}}
3 (((
4 In this microlearning, we will focus on how you can clean up your CDM elements. It is necessary to understand how you can clean up your CDM elements to ensure that your CDM keeps being a good representation of which entities and attributes are actually used within your eMagiz solution. We have kept this part as a separate microlearning as cleaning up the CDM is not a trivial manner and should only be done after careful consideration.
5
6 Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
7
8 == 1. Prerequisites ==
9
10 * Basic knowledge of the eMagiz platform
11
12 == 2. Key concepts ==
13
14 In this microlearning, we will focus on how you can clean up your CDM elements.
15 With CDM elements we mean: Entities and attributes that make up the Canonical Data Model
16 With clean up we mean: Remove the entities and attributes that are not used anymore within the eMagiz solution
17
18 It is necessary to understand how you can clean up your CDM elements to ensure that your CDM keeps being a good representation of which entities and attributes are actually used within your eMagiz solution. We have kept this part as a separate microlearning as cleaning up the CDM is not a trivial manner and should only be done after careful consideration.
19
20 * Removed on CDM level means removed in Create (for all definitions and transformations)
21 * Removed on CDM level means removed in all CDM messages in Design
22 * Removed on CDM level means removed in all message transformations
23
24 == 3. Cleaning up the CDM ==
25
26 As we learned in our previous microlearnings there are easy ways to define which entities and attributes on CDM level are not used anymore. As a reminder, 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 In this microlearning we will use these selection views to identify which entities and attributes can be removed from our CDM. It is necessary to understand how you can clean up your CDM elements to ensure that your CDM keeps being a good representation of which entities and attributes are actually used within your eMagiz solution. We have kept this part as a separate microlearning as cleaning up the CDM is not a trivial manner and should only be done after careful consideration.
33
34 * Removed on CDM level means removed in Create (for all definitions and transformations)
35 * Removed on CDM level means removed in all CDM messages in Design
36 * Removed on CDM level means removed in all message transformations
37
38 === 3.1 Removal of entities and attributes ===
39
40 To remove entities and attributes you first need to navigate to the CDM in Design. In this overview you will see your CDM. When you press Start Editing you can start removing entities and attributes.
41
42 [[image:Main.Images.Microlearning.WebHome@intermediate-defining-your-message-structures-cleaning-up-the-cdm--cdm-overview-start-editing.png]]
43
44 To do so simply navigate with your mouse to the entity and/or attribute that you want to revome and open the context menu via a right-mouse click. If you right-mouse click above the line you can remove the entity. If you right-click below the line you can delete a specific attribute.
45
46 [[image:Main.Images.Microlearning.WebHome@intermediate-defining-your-message-structures-cleaning-up-the-cdm--remove-entity-context-menu.png]]
47
48 [[image:Main.Images.Microlearning.WebHome@intermediate-defining-your-message-structures-cleaning-up-the-cdm--remove-attribute-context-menu.png]]
49
50 Before you actually press the button ensure that you really want to delete the entity and/or attribute because deleting something on this level, as specified before, comes with grave consequences. To really ensure that the user is aware what he/she is doing you cannot remove anything from the CDM without reading the confirmation pop-up and pressing Yes within this pop-up. Only after you have confirmed your action eMagiz will remove the selected entity or attribute from the CDM.
51
52 [[image:Main.Images.Microlearning.WebHome@intermediate-defining-your-message-structures-cleaning-up-the-cdm--remove-confirmation-pop-up.png]]
53
54 As a gentle reminder, once more, this also means the following:
55
56 * Removed on CDM level means removed in Create (for all definitions and transformations)
57 * Removed on CDM level means removed in all CDM messages in Design
58 * Removed on CDM level means removed in all message transformations
59
60 == 4. Key takeaways ==
61
62 * It is necessary to understand how you can clean up your CDM elements to ensure that your CDM keeps being a good representation of which entities and attributes are actually used within your eMagiz solution. We have kept this part as a separate microlearning as cleaning up the CDM is not a trivial manner and should only be done after careful consideration.
63 * Removed on CDM level means removed in Create (for all definitions and transformations)
64 * Removed on CDM level means removed in all CDM messages in Design
65 * Removed on CDM level means removed in all message transformations
66 * Before removal you need to confirm your action via the conformation pop-up
67
68 == 5. Suggested Additional Readings ==
69
70 If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
71 )))
72
73 ((({{toc/}}))){{/container}}
74 {{/container}}