Skip to Content

Changes for page Annotations

Last modified by Erik Bakker on 2024/08/26 12:17
From version 32.1
edited by Erik Bakker
on 2024/08/26 12:17
Change comment: There is no comment for this version
To version 22.1
edited by Erik Bakker
on 2022/06/10 13:05
Change comment: Renamed from xwiki:Migrated Pages.Annotations

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,0 @@
1 -Annotations
Parent
... ... @@ -1,1 +1,0 @@
1 -WebHome
Default language
... ... @@ -1,1 +1,0 @@
1 -en
Content
... ... @@ -1,8 +1,13 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -In this microlearning, we’ll dive into the use of annotations within the eMagiz platform. Annotations are simple text notes that help clarify your thought process and provide essential explanations for yourself and others. Whether you’re detailing best practices, explaining complex flow components, or highlighting important parts of your message definitions, annotations are a valuable tool. We’ll explore how to effectively use and add annotations to enhance understanding and maintain clarity throughout your projects.
2 += Annotations =
3 3  
4 +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.
5 +
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,8 +48,15 @@
48 48  
49 49  Now you know what annotations are good for and how you can add them within the eMagiz platform.
50 50  
51 -== 4. Key takeaways ==
52 52  
59 +
60 +== 4. Assignment ==
61 +
62 +Add annotation on the flow level that describes how (a part of) a flow works.
63 +This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
64 +
65 +== 5. Key takeaways ==
66 +
53 53  * Annotations can be used for:
54 54   * Describing a best practice everyone should follow
55 55   * Describing (more complex) parts of the flow
... ... @@ -56,13 +56,16 @@
56 56   * Describe (parts of) your message definitions
57 57  * You can add annotations by dragging and dropping the annotation icon on the canvas.
58 58  
59 -== 5. Suggested Additional Readings ==
60 60  
61 -* [[Novice (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Novice.WebHome||target="blank"]]
62 -** [[Lifecycle Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Lifecycle Management.WebHome||target="blank"]]
63 -*** [[What is Lifecycle Management (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Lifecycle Management.novice-lifecycle-management-what-is-lifecycle-management||target="blank"]]
64 -** [[DevOps Perspectives (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.DevOps Perspectives.WebHome||target="blank"]]
65 -*** [[Using ILM tollgates while executing sprints (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.DevOps Perspectives.novice-devops-perspectives-using-ilm-tollgates-while-executing-sprints||target="blank"]]
66 -* [[Annotation (Search Result)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=%22annotation%22||target="blank"]]
67 67  
75 +== 6. Suggested Additional Readings ==
76 +
77 +There are no suggested additional readings on this topic
78 +
79 +== 7. Silent demonstration video ==
80 +
81 +This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
82 +
83 +{{video attachment="novice-devops-perspectives-annotations.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
84 +
68 68  )))((({{toc/}}))){{/container}}{{/container}}
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