Last modified by Erik Bakker on 2024/08/26 12:38
From version 34.1
edited by Erik Bakker
on 2022/06/12 09:34
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 -Configure your SOAP web service
Parent
... ... @@ -1,1 +1,0 @@
1 -WebHome
Content
... ... @@ -1,99 +1,85 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -When setting up a point at which your customers can talk to you eMagiz offers various methods of creating such a point. One of those options is by hosting a SOAP Webservice in eMagiz that handles XML messages asynchronously or synchronously. In this microlearning, we will learn the basics of this configuration in the various phases of the platform so you can easily set up your SOAP web service.
2 += Annotations =
3 3  
4 -Should you have any questions, please contact academy@emagiz.com.
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 5  
6 -* Last update: June 10th, 2021
7 -* Required reading time: 7 minutes
6 +Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
8 8  
8 +* Last update: May 9th, 2021
9 +* Required reading time: 5 minutes
10 +
9 9  == 1. Prerequisites ==
12 +
10 10  * Basic knowledge of the eMagiz platform
11 11  
12 12  == 2. Key concepts ==
13 -This microlearning centers around configuring your SOAP web service.
14 14  
15 -By configuring, we mean: Designing and determining the characteristics of the SOAP web service
17 +This microlearning centers around using annotations.
18 +With annotations, we mean: A piece of text to explain something to yourself and others
16 16  
17 -Crucial parts in the configuration are:
18 -* Operation Name
19 -* SOAP Webservice Namespace
20 -* Validation
21 -* Authentication
20 +Annotations can be used for:
22 22  
23 -Of these four points, the last two will be discussed in separate microlearnings.
24 -
25 -== 3. Configure your SOAP Webservice ==
22 +* Describing a best practice everyone should follow
23 +* Describing (more complex) parts of the flow
24 +* Describe (parts of) your message definitions
26 26  
27 -When setting up a point at which your customers can talk to you eMagiz offers various methods of creating such a point. One of those options is by hosting a SOAP Webservice in eMagiz that handles XML messages asynchronously or synchronously. In this microlearning, we will learn the basics of this configuration in the various phases of the platform so you can easily set up your SOAP web service.
28 28  
29 -Crucial parts in the configuration are:
30 -* Operation Name
31 -* SOAP Webservice Namespace
32 -* Validation
33 -* Authentication
34 34  
35 -Of these four points, the last two will be discussed in separate microlearnings. In this microlearning, we will focus on the first two aspects of the configuration. As you might have noticed I did not mention the fact whether the integration is synchronous or asynchronous as a crucial part of the configuration. The reason being that when configuring a (SOAP) web service you always need to send an acknowledgment back to the client calling the web service to let them know what the status of the message is. In case you want to set up the rest of your integration asynchronously you can send an empty message back as acknowledgment. In case you want to set up the rest of your integration synchronously you need to send the response you have received from the backend operation back to the client. More on the choice between asynchronous and synchronous in a later stage.
28 +== 3. Annotations ==
36 36  
37 -=== 3.1 Operation Name ===
30 +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.
38 38  
39 -Let us first zoom in on the parts of the configuration before we learn how you can implement it in eMagiz. Starting with the operation name. When you have dealt with the API Gateway offering of eMagiz in the past or have some knowledge of how APIs work the notion of an operation name should not be unfamiliar. In essence, it is a unique name that defines a certain operation. In eMagiz the best practice for naming the operation is as follows:
32 +Annotations can be used for:
40 40  
41 -* Send{technicalnameoftheoperation}
34 +* Describing a best practice everyone should follow
35 +* Describing (more complex) parts of the flow
36 +* Describe (parts of) your message definitions
42 42  
43 -When you are in Create you will notice that eMagiz uses the default suffix of Request and Response is added to the operation name. Therefore the full operation name a client needs to call to get the desired result if you adhere to the best practice is:
38 +To clarify the use cases let us take a look at how annotations can be added within the eMagiz platform. In our first example, we will take a look at asynchronous routing. In many eMagiz projects, a best practice is followed on how to add something to the asynchronous routing (or change something within the asynchronous routing). Because the best practice contains multiple steps it makes sense to use the annotation functionality of eMagiz to define all these steps and register them at the place you need them (i.e. the asynchronous routing). Having done so will result in something like this:
44 44  
45 -* Send{technicalnameoftheoperation}Request
40 +[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--annotation-best-practice-async-routing.png]]
46 46  
47 -=== 3.2 SOAP Webservice Namespace ===
42 +The second example is about using annotations on the flow level to describe parts of the flow. In this example, we will use the annotation to describe that we use a filter to determine which messages are picked up from a local directory and how we filter. That way anyway opening the flow has to merely read the annotation to get the context. Having done so will result in something like this:
48 48  
49 -The second part of the configuration is the SOAP Webservice Namespace. When hosting a SOAP Webservice via the standard eMagiz tooling you need to define a namespace. To smoothen this process eMagiz automatically generates a namespace based on the configuration settings you choose in the Design phase of eMagiz.
44 +[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--describe-parts-of-flow.png]]
50 50  
51 -=== 3.3 Configuration in eMagiz ===
46 +The third example does not take place on the flow level but the message definition level. Therefore instead of going to Create, we go to Design. In Design when you navigate to the CDM, API Gateway Data model, Event Streaming Data model, message definitions, etc. you have the option to add annotations to the canvas. In this example, we want to make clear to all that make changes that a certain part of our CDM is used by a lot of integrations within eMagiz and therefore everyone should be careful and think twice before adjusting anything related to that part. Having done so will result in something like this:
52 52  
53 -Now that we know what configurations are required, we can see how we can implement this in eMagiz. In the Capture phase, nothing changes. You simply draw a system on the canvas including at least one line that goes from the system towards eMagiz. When you are done you move to the Design phase in eMagiz. In this phase, you need to correctly set up the operation name(s) and the SOAP Webservice Namespace.
48 +[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--describe-crucial-part-of-cdm.png]]
54 54  
55 -The configuration in Design starts at the system level. At the system level, you need to define the technical name (or let eMagiz automatically fill it in for you) and select the checkbox called Combined Entry Connector. By selecting this checkbox you tell eMagiz that you want to host an endpoint for others to call.
50 +Now that we saw some examples let us turn our attention to the how. How can I add an annotation and how can I link it. Adding the annotation is simple. You drag the annotation icon from the left context menu onto the canvas. As a result, an empty annotation will be shown on the canvas. By double-clicking on it you can type whatever you want. Note that you need to be in "Start Editing" mode to change anything, including annotations.
56 56  
57 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice--combined-entry-check.png]]
52 +[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--annotation-icon-context-menu.png]]
58 58  
59 -As you can see, selecting this option opens up a new choice to make. In this case between SOAP Webservice and Custom.
54 +When you are satisfied with what you have written down you can press the Save button. After you have done so you can rescale the annotation to ensure that the complete text is visible. To link the annotation to a component (on flow level) or an entity (on message definition level) you hover over the annotation until your mouse indicator changes to a + icon, execute a right-click and drag from the annotation to the component in question.
60 60  
61 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice--combined-entry-choice.png]]
56 +Now you know what annotations are good for and how you can add them within the eMagiz platform.
62 62  
63 -In this case, we opt for the SOAP web service. After you have done so eMagiz will automatically define the SOAP Webservice Name and SOAP Webservice Namespace.
64 64  
65 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice--combined-entry-soap-ws-namespace.png]]
66 66  
67 -With this, you are done with your configuration on the system level. Don't forget to update the status of your task. Now that we have configured the system it is time to configure the integration that is drawn from the system to eMagiz. We can do so by double-clicking on it (or by accessing the context menu and selecting the edit option). When you open the Edit page on the integration level you will notice that a new segment is added (compared to other integrations). This segment defines the settings on the system level we have just specified and defines the operation name.
68 -
69 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice--edit-integration.png]]
70 -
71 -As you can see eMagiz has already prefilled the operation name for you based on the best practice at eMagiz. If you want to change you have the option to do so. Do note that for the sake of consistency it would be smart to use the same naming convention within a single project to avoid confusion.
72 -
73 -=== 3.4 Add integration to Create ===
74 -
75 -Now that we have finished the configuration in Design the last step of this microlearning is to add the integration to Create. You can simply do so by navigating to Create -> Add integrations and selecting the integration to move it to Create. After you have selected it press Save to add the integration to Create.
76 -
77 77  == 4. Assignment ==
78 78  
79 -Configure a SOAP web service that consists of at least one operation and add it to Create.
62 +Add annotation on the flow level that describes how (a part of) a flow works.
80 80  This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
81 81  
82 82  == 5. Key takeaways ==
83 83  
84 -* Crucial parts in the configuration are:
85 - ** Operation Name
86 - ** SOAP Webservice Namespace
87 - ** Validation
88 - ** Authentication
89 -* For ease, you can use the default naming convention of eMagiz
67 +* Annotations can be used for:
68 + * Describing a best practice everyone should follow
69 + * Describing (more complex) parts of the flow
70 + * Describe (parts of) your message definitions
71 +* You can add annotations by dragging and dropping the annotation icon on the canvas.
90 90  
73 +
74 +
91 91  == 6. Suggested Additional Readings ==
92 92  
93 -If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
77 +There are no suggested additional readings on this topic
94 94  
95 95  == 7. Silent demonstration video ==
96 96  
97 -{{video attachment="novice-soap-webservice-connectivity-configure-your-soap-webservice.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
81 +This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
98 98  
83 +{{video attachment="novice-devops-perspectives-annotations.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
84 +
99 99  )))((({{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