Changes for page Making clear what you changed (auditability)

Summary

• Page properties (5 modified, 0 added, 0 removed)

Details

Page properties

Title

...	...	@@ -1,1 +1,0 @@
1		-Making clear what you changed (auditability)

Parent

...	...	@@ -1,1 +1,0 @@
1		-WebHome

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.ebakker
	1	+XWiki.marijn

Default language

...	...	@@ -1,1 +1,0 @@
1		-en

Content

...	...	@@ -1,8 +1,20 @@
1		-{{container}}{{container layoutStyle="columns"}}(((
	1	+{{html wiki="true"}}
	2	+<div class="ez-academy">
	3	+ <div class="ez-academy_body">
	4	+
	5	+<div class="doc">
	6	+
	7	+
	8	+
	9	+= Making clear what you changed (auditability) =
	10	+
2	2	As you can imagine, there is a need to know what has changed when working with software tooling. By knowing you can assess the impact of your planned changes within the context of the integration data model. In this microlearning, we will look at what you can do to clarify what you changed within the eMagiz platform.
3	3
4		-Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
	13	+Should you have any questions, please contact academy@emagiz.com.
5	5
	15	+* Last update: August 4th, 2021
	16	+* Required reading time: 6 minutes
	17	+
6	6	== 1. Prerequisites ==
7	7
8	8	* Basic knowledge of the eMagiz platform
...	...	@@ -14,22 +14,24 @@
14	14	Auditability is defined as follows: A history trail that depicts who changed what at which moment in time containing an explanation of what has been changed
15	15
16	16	* The key aspects are:
17		- ** The description is your way of communicating the history of the flow
18		- ** Using vague descriptions (or placing a dot as description) hurts the auditability
19		- ** For all things versioned in eMagiz it is crucial that you supply the correct description
20		- ** eMagiz provides audit trails on Architectural overviews (Design and Deploy architecture) including a description
21		- ** eMagiz provides audit trails on message definitions and transformations including a description
	29	+ * The description is your way of communicating the history of the flow
	30	+ * Using vague descriptions (or placing a dot as description) hurts the auditability
	31	+ * For all things versioned in eMagiz it is crucial that you supply the correct description
	32	+ * eMagiz provides audit trails on Architectural overviews (Design and Deploy architecture) including a description
	33	+ * eMagiz provides audit trails on message definitions and transformations including a description
22	22
	35	+
	36	+
23	23	== 3. Making clear what you changed (auditability) ==
24	24
25	25	As you can imagine, there is a need to know what has changed when working with software tooling. By knowing you can assess the impact of your planned changes within the context of the integration data model. In this microlearning, we will look at what you can do to clarify what you changed within the eMagiz platform.
26	26
27	27	* The key aspects are:
28		- ** The description is your way of communicating the history of the flow
29		- ** Using vague descriptions (or placing a dot as description) hurts the auditability
30		- ** For all things versioned in eMagiz it is crucial that you supply the correct description
31		- ** eMagiz provides audit trails on Architectural overviews (Design and Deploy architecture) including a description
32		- ** eMagiz provides audit trails on message definitions and transformations including a description
	42	+ * The description is your way of communicating the history of the flow
	43	+ * Using vague descriptions (or placing a dot as description) hurts the auditability
	44	+ * For all things versioned in eMagiz it is crucial that you supply the correct description
	45	+ * eMagiz provides audit trails on Architectural overviews (Design and Deploy architecture) including a description
	46	+ * eMagiz provides audit trails on message definitions and transformations including a description
33	33
34	34	=== 3.1 Versioning by users ===
35	35
...	...	@@ -60,6 +60,8 @@
60	60
61	61	In all cases, you will find a History button on the page in question that will guide you to the history (audit trail) of what has changed by whom at which point in time.
62	62
	77	+===== Practice =====
	78	+
63	63	== 4. Assignment ==
64	64
65	65	Check out the history of (one of) your eMagiz data models, one of your flows, and your releases to see if you can determine how they have changed over time.
...	...	@@ -67,12 +67,14 @@
67	67	== 5. Key takeaways ==
68	68
69	69	* The key aspects are:
70		- ** The description is your way of communicating the history of the flow
71		- ** Using vague descriptions (or placing a dot as description) hurts the auditability
72		- ** For all things versioned in eMagiz it is crucial that you supply the correct description
73		- ** eMagiz provides audit trails on Architectural overviews (Design and Deploy architecture) including a description
74		- ** eMagiz provides audit trails on message definitions and transformations including a description
	86	+ * The description is your way of communicating the history of the flow
	87	+ * Using vague descriptions (or placing a dot as description) hurts the auditability
	88	+ * For all things versioned in eMagiz it is crucial that you supply the correct description
	89	+ * eMagiz provides audit trails on Architectural overviews (Design and Deploy architecture) including a description
	90	+ * eMagiz provides audit trails on message definitions and transformations including a description
75	75
	92	+
	93	+
76	76	== 6. Suggested Additional Readings ==
77	77
78	78	If you are interested in this topic and want more information please check out the help texts provided by eMagiz.
...	...	@@ -79,4 +79,11 @@
79	79
80	80	== 7. Silent demonstration video ==
81	81
82		-As this is a more theoretical microlearning we have no video for this.)))((({{toc/}}))){{/container}}{{/container}}
	100	+As this is a more theoretical microlearning we have no video for this.
	101	+
	102	+</div>
	103	+
	104	+</div>
	105	+</div>
	106	+
	107	+{{/html}}