Cleaning up the CDM

(((

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

== 3. Cleaning up the CDM ==

27

28

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

29

30

* Not assigned to any message types

31

* Not mapped in any message mappings

32

* Not present in Create phase integrations

33

34

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.

35

36

* Removed on CDM level means removed in Create (for all definitions and transformations)

37

* Removed on CDM level means removed in all CDM messages in Design

38

* Removed on CDM level means removed in all message transformations

39

40

=== 3.1 Removal of entities and attributes ===

41

42

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.

43

44

[[image:Main.Images.Microlearning.WebHome@intermediate-defining-your-message-structures-cleaning-up-the-cdm--cdm-overview-start-editing.png]]

45

46

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.

47

48

[[image:Main.Images.Microlearning.WebHome@intermediate-defining-your-message-structures-cleaning-up-the-cdm--remove-entity-context-menu.png]]

49

50

[[image:Main.Images.Microlearning.WebHome@intermediate-defining-your-message-structures-cleaning-up-the-cdm--remove-attribute-context-menu.png]]

51

52

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.

53

54

[[image:Main.Images.Microlearning.WebHome@intermediate-defining-your-message-structures-cleaning-up-the-cdm--remove-confirmation-pop-up.png]]

55

56

As a gentle reminder, once more, this also means the following:

57

58

* Removed on CDM level means removed in Create (for all definitions and transformations)

59

* Removed on CDM level means removed in all CDM messages in Design

60

* Removed on CDM level means removed in all message transformations

== 4. Assignment ==

Analyze your CDM and based on your analysis of the previous microlearning remove one attribute from your CDM that can be safely deleted.

65

This assignment can be completed within the Design phase of your (Academy) project that you have created/used in the previous assignment.

66

67

== 5. Key takeaways ==

68

69

* 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.

70

* Removed on CDM level means removed in Create (for all definitions and transformations)

71

* Removed on CDM level means removed in all CDM messages in Design

72

* Removed on CDM level means removed in all message transformations

73

* Before removal you need to confirm your action via the conformation pop-up

74

75

== 6. Suggested Additional Readings ==

76

77

If you are interested in this topic and want more information on it please read the help text provided by eMagiz.

78

79

== 7. Silent demonstration video ==

80

81

This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.

82

83

{{video attachment="intermediate-defining-your-message-structures-cleaning-up-the-cdm.mp4" reference="Main.Videos.Microlearning.WebHome"/}}

84

)))

85

86

((({{toc/}}))){{/container}}

87

Wiki source code of Cleaning up the CDM

Navigation

version	line-number	content
38.1	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
	25
	26	== 3. Cleaning up the CDM ==
	27
	28	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
	29
	30	* Not assigned to any message types
	31	* Not mapped in any message mappings
	32	* Not present in Create phase integrations
	33
	34	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.
	35
	36	* Removed on CDM level means removed in Create (for all definitions and transformations)
	37	* Removed on CDM level means removed in all CDM messages in Design
	38	* Removed on CDM level means removed in all message transformations
	39
	40	=== 3.1 Removal of entities and attributes ===
	41
	42	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.
	43
	44	[[image:Main.Images.Microlearning.WebHome@intermediate-defining-your-message-structures-cleaning-up-the-cdm--cdm-overview-start-editing.png]]
	45
	46	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.
	47
	48	[[image:Main.Images.Microlearning.WebHome@intermediate-defining-your-message-structures-cleaning-up-the-cdm--remove-entity-context-menu.png]]
	49
	50	[[image:Main.Images.Microlearning.WebHome@intermediate-defining-your-message-structures-cleaning-up-the-cdm--remove-attribute-context-menu.png]]
	51
	52	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.
	53
	54	[[image:Main.Images.Microlearning.WebHome@intermediate-defining-your-message-structures-cleaning-up-the-cdm--remove-confirmation-pop-up.png]]
	55
	56	As a gentle reminder, once more, this also means the following:
	57
	58	* Removed on CDM level means removed in Create (for all definitions and transformations)
	59	* Removed on CDM level means removed in all CDM messages in Design
	60	* Removed on CDM level means removed in all message transformations
	61
	62	== 4. Assignment ==
	63
	64	Analyze your CDM and based on your analysis of the previous microlearning remove one attribute from your CDM that can be safely deleted.
	65	This assignment can be completed within the Design phase of your (Academy) project that you have created/used in the previous assignment.
	66
	67	== 5. Key takeaways ==
	68
	69	* 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.
	70	* Removed on CDM level means removed in Create (for all definitions and transformations)
	71	* Removed on CDM level means removed in all CDM messages in Design
	72	* Removed on CDM level means removed in all message transformations
	73	* Before removal you need to confirm your action via the conformation pop-up
	74
	75	== 6. Suggested Additional Readings ==
	76
	77	If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
	78
	79	== 7. Silent demonstration video ==
	80
	81	This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
	82
	83	{{video attachment="intermediate-defining-your-message-structures-cleaning-up-the-cdm.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
	84	)))
	85
	86	((({{toc/}}))){{/container}}
	87	{{/container}}