Skip to Content
Last modified by Danniar Firdausy on 2024/09/18 14:37
From version 5.1
edited by Erik Bakker
on 2022/08/29 14:52
Change comment: There is no comment for this version
To version 2.2
edited by Erik Bakker
on 2022/06/10 10:39
Change comment: Update document after refactoring.

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Making clear what you changed (auditability)
1 +intermediate-devops-perspectives-making-clear-what-you-changed
Default language
... ... @@ -1,1 +1,0 @@
1 -en
Content
... ... @@ -1,8 +1,13 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 += Making clear what you changed (auditability) =
3 +
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 4  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
8 +* Last update: August 4th, 2021
9 +* Required reading time: 6 minutes
10 +
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
22 + * The description is your way of communicating the history of the flow
23 + * Using vague descriptions (or placing a dot as description) hurts the auditability
24 + * For all things versioned in eMagiz it is crucial that you supply the correct description
25 + * eMagiz provides audit trails on Architectural overviews (Design and Deploy architecture) including a description
26 + * eMagiz provides audit trails on message definitions and transformations including a description
22 22  
28 +
29 +
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
35 + * The description is your way of communicating the history of the flow
36 + * Using vague descriptions (or placing a dot as description) hurts the auditability
37 + * For all things versioned in eMagiz it is crucial that you supply the correct description
38 + * eMagiz provides audit trails on Architectural overviews (Design and Deploy architecture) including a description
39 + * 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  
70 +
71 +
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
79 + * The description is your way of communicating the history of the flow
80 + * Using vague descriptions (or placing a dot as description) hurts the auditability
81 + * For all things versioned in eMagiz it is crucial that you supply the correct description
82 + * eMagiz provides audit trails on Architectural overviews (Design and Deploy architecture) including a description
83 + * eMagiz provides audit trails on message definitions and transformations including a description
75 75  
85 +
86 +
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,6 @@
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}}
93 +As this is a more theoretical microlearning we have no video for this.
94 +
95 +)))((({{toc/}}))){{/container}}{{/container}}