Skip to Content

Changes for page SOAP Headers

Last modified by Erik Bakker on 2024/08/26 12:48
From version 40.1
edited by Erik Bakker
on 2022/08/22 15:56
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 -SOAP Headers
Parent
... ... @@ -1,1 +1,0 @@
1 -WebHome
Default language
... ... @@ -1,1 +1,0 @@
1 -en
Content
... ... @@ -1,66 +1,85 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -When communicating via SOAP web service calls it can happen that an exchange of data needs to happen between the message headers on your message and the SOAP headers. In this microlearning, we will learn about this exchange in both directions. SOAP Headers are headers within a SOAP Envelope that can be used to communicate metadata or authentication information between parties.
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 +Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
7 +
8 +* Last update: May 9th, 2021
9 +* Required reading time: 5 minutes
10 +
6 6  == 1. Prerequisites ==
12 +
7 7  * Basic knowledge of the eMagiz platform
8 8  
9 9  == 2. Key concepts ==
10 -This microlearning centers around SOAP Headers.
11 11  
12 -By SOAP Headers, we mean: headers within a SOAP Envelope that can be used to communicate metadata or authentication information between parties
17 +This microlearning centers around using annotations.
18 +With annotations, we mean: A piece of text to explain something to yourself and others
13 13  
14 -You can exchange data from:
15 -* SOAP Header to Message Header
16 -* Message Header to SOAP Header
20 +Annotations can be used for:
17 17  
18 -In both cases ensure that the correct information is exchanged.
22 +* Describing a best practice everyone should follow
23 +* Describing (more complex) parts of the flow
24 +* Describe (parts of) your message definitions
19 19  
20 -== 3. SOAP Headers ==
21 21  
22 -When communicating via SOAP web service calls it can happen that an exchange of data needs to happen between the message headers on your message and the SOAP headers. In this microlearning, we will learn about this exchange in both directions. SOAP Headers are headers within a SOAP Envelope that can be used to communicate metadata or authentication information between parties.
23 23  
24 -You can exchange data from:
25 -* SOAP Header to Message Header
26 -* Message Header to SOAP Header
28 +== 3. Annotations ==
27 27  
28 -In both cases ensure that the correct information is exchanged.
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.
29 29  
30 -In a previous microlearning, we already discussed one aspect of this. As you probably recall from our microlearning on [[Securing your SOAP Webservice>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-web service-connectivity-securing-your-soap-webservice.WebHome||target="blank"]] we needed to exchange data between the SOAP header that our client was sending and a message header on the message so we could check whether or not the client was authorized to call the operation.
32 +Annotations can be used for:
31 31  
32 -In that microlearning, we also discussed the component that we need for this. The 'complex SOAP header mapper'.
34 +* Describing a best practice everyone should follow
35 +* Describing (more complex) parts of the flow
36 +* Describe (parts of) your message definitions
33 33  
34 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-soap-headers--complex-soap-header-mapper.png]]
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:
35 35  
36 -As you can see you can map from and to message headers with regards to the SOAP Headers. As we already discussed the first scenario in an earlier microlearning I will for now continue with the other scenario. This scenario is mainly needed when eMagiz calls a SOAP web service that is hosted by an external party. Since we would normally do this in an exit (gate/flow) let us open such an exit in eMagiz and enter "Start Editing" mode.
40 +[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--annotation-best-practice-async-routing.png]]
37 37  
38 -The first step we need to take is to ensure that the information that we need to send to the SOAP web service in question (in this a unique reference number) is available in a message header. This can be done by verifying in all steps that preceded before the message entered the exit whether or not this piece of information was already added to a message header. In this case, we assume that this is the case since we want to focus on the 'complex SOAP header mapper' component and its relation to the web services outbound gateway. To correctly exchange data from a message header to a SOAP header we need to define a valid SpEL expression. See the help text of the component for a suggestion of what a valid SpEL expression is. The key part in this is knowing how the external party wants to receive the header(s) and how you (or one of your colleagues) has named the message header. When you have those two information elements you can write the correct expression. The result should be something as follows:
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:
39 39  
40 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-soap-headers--mapping-from-message-header.png]]
44 +[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--describe-parts-of-flow.png]]
41 41  
42 -Once you are satisfied you can press Save and link the support object to the web service outbound gateway.
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:
43 43  
44 -With this information, you can place SOAP Headers on message headers and vice versa every time you need it.
48 +[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--describe-crucial-part-of-cdm.png]]
45 45  
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.
51 +
52 +[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--annotation-icon-context-menu.png]]
53 +
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.
55 +
56 +Now you know what annotations are good for and how you can add them within the eMagiz platform.
57 +
58 +
59 +
46 46  == 4. Assignment ==
47 47  
48 -Call an external web service and send along some SOAP Headers.
62 +Add annotation on the flow level that describes how (a part of) a flow works.
49 49  This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
50 50  
51 51  == 5. Key takeaways ==
52 52  
53 -* You can exchange data from:
54 - ** SOAP Header to Message Header
55 - ** Message Header to SOAP Header
56 -* You need the SOAP structure and the message header name to make it work
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.
57 57  
73 +
74 +
58 58  == 6. Suggested Additional Readings ==
59 59  
60 -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
61 61  
62 62  == 7. Silent demonstration video ==
63 63  
64 -{{video attachment="novice-soap-webservice-connectivity-soap-headers.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.
65 65  
83 +{{video attachment="novice-devops-perspectives-annotations.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
84 +
66 66  )))((({{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