Wiki source code of Making clear what you changed (auditability)
Version 11.1 by Danniar Firdausy on 2024/09/04 16:51
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{container}}{{container layoutStyle="columns"}}((( | ||
| 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 | |||
| 4 | Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]]. | ||
| 5 | |||
| 6 | == 1. Prerequisites == | ||
| 7 | |||
| 8 | * Basic knowledge of the eMagiz platform | ||
| 9 | |||
| 10 | == 2. Key concepts == | ||
| 11 | |||
| 12 | This microlearning centers on making clear what you changed (auditability). | ||
| 13 | |||
| 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 | |||
| 23 | == 3. Making clear what you changed (auditability) == | ||
| 24 | |||
| 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 | |||
| 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 | ||
| 33 | |||
| 34 | === 3.1 Versioning by users === | ||
| 35 | |||
| 36 | Three key parts within eMagiz require versioning by a user. These parts are: | ||
| 37 | |||
| 38 | * eMagiz data models (i.e. CDM, API Gateway Data Model, Event Streaming Data Model) in Design | ||
| 39 | * eMagiz flows in Create | ||
| 40 | * eMagiz releases in Deploy | ||
| 41 | |||
| 42 | ==== 3.1.1 eMagiz Data Model ==== | ||
| 43 | |||
| 44 | On the eMagiz data model level in Design, you can version your eMagiz Data model. By doing this you can register per the eMagiz data model what you have changed. If you want practical help in learning how you can version your eMagiz data model please check out this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Defining message structures.intermediate-defining-your-message-structures-audit-emagiz-data-models||target="blank"]]. Doing so is crucial in telling others now (and in the future) what you have changed and why you have changed that portion of the eMagiz data model. | ||
| 45 | |||
| 46 | ==== 3.1.2 eMagiz Flows ==== | ||
| 47 | |||
| 48 | On the eMagiz flow level in Create, you need to create a new flow version when you are satisfied with your changes (if any are needed). Note that eMagiz allows the ability to use temporary versions while developing. When using these do note that you need to create a definitive version at some point to prevent confusion now (and in the future). If you want practical help in learning how you can version your eMagiz flows please check out this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-promote-flows-to-deploy||target="blank"]]. On the flow level, it must become clear to anyone what you have changed. That will determine whether a certain flow version is ready to be released much easier. | ||
| 49 | |||
| 50 | ==== 3.1.3 eMagiz Releases ==== | ||
| 51 | |||
| 52 | On the eMagiz release level, you need to create a new version whenever you want to include new versions of flows in a release. There is one exception to this rule and that is when someone else has already created a new release that is not yet deployed or made active. In that scenario, you can both combine all changes that need to de deployed to create a more efficient deployment. With eMagiz releases, you have two ways of notifying others what the release is all about. The first one is the name of the release and the second one is the description of a release. If you want to learn how to create a release please check out this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-deploy-create-new-release||target="blank"]]. If you want to learn more about managing releases please check out this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Release Management.intermediate-release-management-autoclean-releases||target="blank"]]. | ||
| 53 | |||
| 54 | === 3.2 Versioning by eMagiz === | ||
| 55 | |||
| 56 | Apart from the fact that users need to version certain parts of the integration data model within the eMagiz platform, eMagiz also keeps a log of changes that are executed on other parts. The main parts on which eMagiz keeps an audit trail are: | ||
| 57 | |||
| 58 | * Architectural overviews (Design and Deploy Architecture) | ||
| 59 | * Message definitions and transformations | ||
| 60 | |||
| 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 | |||
| 63 | == 4. Key takeaways == | ||
| 64 | |||
| 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 | ||
| 71 | |||
| 72 | == 5. Suggested Additional Readings == | ||
| 73 | |||
| 74 | If you are interested in this topic and want more information on it please read the help text provided by eMagiz and read the following links: | ||
| 75 | |||
| 76 | * [[Intermediate Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]] | ||
| 77 | ** [[Defining message structures (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Defining message structures.WebHome||target="blank"]] | ||
| 78 | *** [[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"]] | ||
| 79 | ** [[Release Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Release Management.WebHome||target="blank"]] | ||
| 80 | *** [[Autoclean releases (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Release Management.intermediate-release-management-autoclean-releases||target="blank"]] | ||
| 81 | )))((({{toc/}}))){{/container}}{{/container}} |