Skip to Content
Last modified by Danniar Firdausy on 2024/09/18 14:37
From version 11.6
edited by Danniar Firdausy
on 2024/09/18 14:37
Change comment: There is no comment for this version
To version 11.2
edited by Danniar Firdausy
on 2024/09/05 10:38
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,5 +1,5 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -In the world of software tooling, it's crucial to understand what changes have been made to effectively evaluate their impact. This microlearning will guide you through the process of clarifying changes within the eMagiz platform, focusing on the importance of clear and detailed descriptions for auditability. By the end of this microlearning, you will know how to properly document and version your changes to maintain a clear history and facilitate better integration management.
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  
... ... @@ -10,8 +10,16 @@
10 10  == 2. Key concepts ==
11 11  
12 12  This microlearning centers on making clear what you changed (auditability).
13 -* By auditability, we mean: A history trail that depicts who changed what at which moment in time containing an explanation of what has been changed
14 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 +
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 +
15 15  == 3. Making clear what you changed (auditability) ==
16 16  
17 17  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.
... ... @@ -54,10 +54,12 @@
54 54  
55 55  == 4. Key takeaways ==
56 56  
57 -* Ensure that all descriptions are detailed and specific to effectively communicate the history of changes.
58 -* For all versioned elements within the eMagiz platform, including data models, flows, and releases, providing precise descriptions helps in tracking modifications and understanding their impact.
59 -* Utilize the audit trails provided by eMagiz for Architectural overviews, message definitions, and transformations to keep a comprehensive history of changes. This feature is vital for maintaining transparency and accountability in your integration processes.
60 -* By maintaining clear and accurate documentation of changes, you improve the ability to assess impacts and manage integration data models more effectively, ensuring smoother operations and fewer misunderstandings.
65 +* The key aspects are:
66 + ** The description is your way of communicating the history of the flow
67 + ** Using vague descriptions (or placing a dot as description) hurts the auditability
68 + ** For all things versioned in eMagiz it is crucial that you supply the correct description
69 + ** eMagiz provides audit trails on Architectural overviews (Design and Deploy architecture) including a description
70 + ** eMagiz provides audit trails on message definitions and transformations including a description
61 61  
62 62  == 5. Suggested Additional Readings ==
63 63  
... ... @@ -66,11 +66,9 @@
66 66  * [[Crash Courses (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-design-defining-a-message-format||target="blank"]]
67 67  ** [[Crash Course Platform (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.WebHome||target="blank"]]
68 68  *** [[Promote flows to deploy (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-promote-flows-to-deploy||target="blank"]]
69 -*** [[Creating a new Release (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-deploy-create-new-release||target="blank"]]
70 70  * [[Intermediate Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
71 71  ** [[Defining message structures (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Defining message structures.WebHome||target="blank"]]
72 72  *** [[Audit eMagiz Data Models (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Defining message structures.intermediate-defining-your-message-structures-audit-emagiz-data-models||target="blank"]]
73 73  ** [[Release Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Release Management.WebHome||target="blank"]]
74 74  *** [[Autoclean releases (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Release Management.intermediate-release-management-autoclean-releases||target="blank"]]
75 -* [[Making clear what you changed (Search Results)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&l_space_facet=10&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=%22making+clear+what+you+changed%22||target="blank"]]
76 76  )))((({{toc/}}))){{/container}}{{/container}}