Skip to Content

Changes for page Annotations

Last modified by Erik Bakker on 2024/08/26 12:17
From version 28.1
edited by Erik Bakker
on 2022/08/22 13:19
Change comment: There is no comment for this version
To version 22.2
edited by Erik Bakker
on 2022/06/10 13:05
Change comment: Update document after refactoring.

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Annotations
1 +novice-devops-perspectives-annotations
Default language
... ... @@ -1,1 +1,0 @@
1 -en
Content
... ... @@ -1,8 +1,13 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 += Annotations =
3 +
2 2  In this microlearning, we will focus on using annotations to clarify your thought process. In the annotation, you either describe a best practice everyone should follow when they change that flow (i.e. within the asynchronous routing), describe how the (more complex) parts of the flow work or describe (parts of) of your message definitions (i.e. CDM, API Gateway Data model, system message, etc.). This will help yourself and others every time changes are needed.
3 3  
4 4  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
8 +* Last update: May 9th, 2021
9 +* Required reading time: 5 minutes
10 +
6 6  == 1. Prerequisites ==
7 7  
8 8  * Basic knowledge of the eMagiz platform
... ... @@ -18,6 +18,8 @@
18 18  * Describing (more complex) parts of the flow
19 19  * Describe (parts of) your message definitions
20 20  
26 +
27 +
21 21  == 3. Annotations ==
22 22  
23 23  In this microlearning, we will focus on using annotations on the flow level to clarify our thought process. In the annotation, you either describe a best practice everyone should follow when they change that flow (i.e. within the asynchronous routing) or describe how the (more complex) parts of the flow work. This will help yourself and others every time changes are needed within the flow.
... ... @@ -48,6 +48,8 @@
48 48  
49 49  Now you know what annotations are good for and how you can add them within the eMagiz platform.
50 50  
58 +
59 +
51 51  == 4. Assignment ==
52 52  
53 53  Add annotation on the flow level that describes how (a part of) a flow works.
... ... @@ -61,6 +61,8 @@
61 61   * Describe (parts of) your message definitions
62 62  * You can add annotations by dragging and dropping the annotation icon on the canvas.
63 63  
73 +
74 +
64 64  == 6. Suggested Additional Readings ==
65 65  
66 66  There are no suggested additional readings on this topic
novice-devops-perspectives-annotations--annotation-best-practice-async-routing.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.ebakker
Size
... ... @@ -1,0 +1,1 @@
1 +25.7 KB
Content
novice-devops-perspectives-annotations--annotation-icon-context-menu.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.ebakker
Size
... ... @@ -1,0 +1,1 @@
1 +774 bytes
Content
novice-devops-perspectives-annotations--describe-crucial-part-of-cdm.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.ebakker
Size
... ... @@ -1,0 +1,1 @@
1 +15.5 KB
Content
novice-devops-perspectives-annotations--describe-parts-of-flow.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.ebakker
Size
... ... @@ -1,0 +1,1 @@
1 +18.9 KB
Content