Skip to Content

Changes for page SOAP Headers

Last modified by Erik Bakker on 2024/08/26 12:48
From version 48.1
edited by Erik Bakker
on 2024/08/26 12:48
Change comment: There is no comment for this version
To version 35.2
edited by Erik Bakker
on 2022/06/12 09:35
Change comment: Update document after refactoring.

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -SOAP Headers
1 +novice-soap-webservice-connectivity-validate-incoming-messages
Default language
... ... @@ -1,1 +1,0 @@
1 -en
Content
... ... @@ -1,70 +1,107 @@
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.
1 +{{container}}{{container layoutStyle="columns"}}(((
2 +When talking to external parties via a SOAP web service you need to define in eMagiz that you want to call a SOAP web service so eMagiz will form a correct SOAP message. On top of the call there is a support object in eMagiz that will help you with the analysis of your problems when calling the SOAP web service. In this microlearning, we will learn how to call a SOAP web service from eMagiz.
3 3  
4 4  Should you have any questions, please contact academy@emagiz.com.
5 5  
6 +* Last update: April 1st, 2022
7 +* Required reading time: 5 minutes
8 +
6 6  == 1. Prerequisites ==
7 7  * Basic knowledge of the eMagiz platform
8 8  
9 9  == 2. Key concepts ==
10 -This microlearning centers around SOAP Headers.
13 +This microlearning centers around calling a SOAP Webservice.
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
15 +With SOAP, we mean: A messaging protocol specification for exchanging structured information in the implementation of web services in computer networks.
13 13  
14 -You can exchange data from:
15 -* SOAP Header to Message Header
16 -* Message Header to SOAP Header
17 +* To call a REST Webservice you need either:
18 + ** A Web Service Outbound Gateway
19 +* Critical information when configuring this component:
20 + ** URL
21 + ** Retry Advice
22 + ** Error Handling
23 + ** Authentication
24 +
25 +== 3. Calling a SOAP Webservice ==
17 17  
18 -In both cases ensure that the correct information is exchanged.
27 +When talking to external parties via a SOAP web service you need to define in eMagiz that you want to call a SOAP web service so eMagiz will form a correct SOAP message. On top of the call there is a support object in eMagiz that will help you with the analysis of your problems when calling the SOAP web service. In this microlearning, we will learn how to call a SOAP web service from eMagiz.
19 19  
20 -== 3. SOAP Headers ==
29 +Calling a SOAP Webservice within eMagiz can be done with the help of a Web Service Outbound Gateway. To correctly configure this component you need to consider the following elements:
21 21  
22 -You can exchange data from:
23 -* SOAP Header to Message Header
24 -* Message Header to SOAP Header
31 +* URL
32 +* Retry Advice
33 +* Error Handling
34 +* Authentication
25 25  
26 -In both cases ensure that the correct information is exchanged.
36 +We will discuss the first three items in this list in this microlearning. In the microlearnings that will follow this microlearning, we will delve deeper into various authentication possibilities.
27 27  
28 -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-webservice-connectivity-securing-your-soap-webservice||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.
38 +Before we delve into the configuration of the component let us first move to Create and open an exit flow in which we want to call the SOAP Webservice. When you open the exit flow it will look similar to this:
29 29  
30 -In that microlearning, we also discussed the component that we need for this. The 'complex SOAP header mapper'.
40 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--exit-flow-starting-point.png]]
31 31  
32 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-soap-headers--complex-soap-header-mapper.png]]
42 +Now that we have opened the flow and are in "Start Editing" mode we need to add the web service outbound gateway to start with.
33 33  
34 -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.
44 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component.png]]
35 35  
36 -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:
46 +=== 3.1 URL ===
37 37  
38 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-soap-headers--mapping-from-message-header.png]]
48 +Now that we have added the correct component to the canvas it has become time to configure the component correctly. The first thing to configure when calling a SOAP Webservice is determining and registering the endpoint (URL) eMagiz should call to deliver the message too. As always in scenarios where an information element can change between environments, you should use a property reference and determine the correct value on a per-environment basis.
39 39  
40 -Once you are satisfied you can press Save and link the support object to the web service outbound gateway.
50 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-url.png]]
41 41  
42 -With this information, you can place SOAP Headers on message headers and vice versa every time you need it.
52 +=== 3.2 Retry Advice ===
43 43  
44 -== 4. Key takeaways ==
54 +The second setting we need to configure is the retry advice. With retry advice, you can guard your solution against temporary connection losses between eMagiz and the external party. As this can happen from time to time the best practice is to configure such a Retry Advice on every Web Service Outbound component. To add the Retry Advice move to the Advanced tab and move down to the Request handler advice chain segment. Within this segment, you will see a button called Retry Advice.
45 45  
46 -* You can exchange data from:
47 - ** SOAP Header to Message Header
48 - ** Message Header to SOAP Header
49 -* You need the SOAP structure and the message header name to make it work
56 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-retry-advice-button.png]]
50 50  
51 -== 5. Suggested Additional Readings ==
58 +When you click on the Retry Advice button you will be prompted with a pop-up. In here you need to configure the exact settings
52 52  
53 -* [[Crash Course (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]]
54 -** [[Crash Course API Gateway (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.WebHome||target="blank"]]
55 -*** [[Setting up Exit gate (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-setting-up-exit-gate||target="blank"]]
56 -* [[Novice (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Novice.WebHome||target="blank"]]
57 -** [[SOAP Web service Connectivity (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.WebHome||target="blank"]]
58 -*** [[Configure your SOAP web service (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-configure-your-soap-webservice-gen3.WebHome||target="blank"]]
59 -*** [[Securing your SOAP Webservice (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-securing-your-soap-webservice||target="blank"]]
60 -*** [[Validate Incoming Messages (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-validate-incoming-messages-gen3.WebHome||target="blank"]]
61 -*** [[Endpoint Check (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-endpoint-check-gen3.WebHome||target="blank"]]
62 -*** [[Calling a SOAP Web service (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-calling-a-soap-webservice||target="blank"]]
63 -*** [[Authorization - Calling a SOAP Webservice (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-authorization-calling-a-soap-webservice||target="blank"]]
64 -* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
65 -** [[SOAP Web service Connectivity (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.SOAP Web service Connectivity.WebHome||target="blank"]]
66 -* [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]
67 -** [[Webservice Security (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Webservice Security.WebHome||target="blank"]]
68 -* [[SOAP Headers (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=%22soap+headers%22||target="blank"]]
60 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-retry-advice-pop-up-empty.png]]
69 69  
62 +The best practice for this configuration is as follows for asynchronous solutions:
63 +* Select the option called Simple Retry Policy
64 +* Set the max attempts at 6
65 +* Select the Fixed back off policy
66 +* Set the backoff period at 5000 (ms)
67 +
68 +When you have done so the configuration should look as follows. The only thing left is to press Save to save your Retry Advice configuration
69 +
70 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-retry-advice-pop-up-filled-in.png]]
71 +
72 +=== 3.3 Error Handling ===
73 +
74 +When calling a SOAP Web service with the configuration we have defined up till here you could suffer from cryptic error response you get back when the SOAP web service call fails. To improve the error handling to make your life easier when analyzing the problem you need to add a support object to the canvas and link it to the web service outbound gateway. This support object is named "Detailed SOAP Fault Message Resolver".
75 +
76 +To link the support object to your web service outbound gateway you open the web service outbound gateway, navigate to the Advanced tab, and select the Fault message resolver. Afterward press Save to save the link between the components.
77 +
78 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-fault-message-resolver.png]]
79 +
80 +Now that we have configured the HTTP Outbound component to our liking we can press Save on the component level to store our changes. As a result the flow will look as follows:
81 +
82 +[[image:Main.Images.Microlearning.WebHome@microlearning/novice-soap-webservice-connectivity-calling-a-soap-webservice--flow-result.png]]
83 +
84 +== 4. Assignment ==
85 +
86 +Build a flow within your project in which you do a call to an external party that hosts a SOAP web service.
87 +This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
88 +
89 +== 5. Key takeaways ==
90 +
91 +* eMagiz will create a valid SOAP message when using this component
92 +* eMagiz provides a support object for better error handling of SOAP faults
93 +* There are four key configuration elements:
94 + ** URL
95 + ** Retry Advice
96 + ** Error Handling
97 + ** Authentication
98 +
99 +== 6. Suggested Additional Readings ==
100 +
101 +If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
102 +
103 +== 7. Silent demonstration video ==
104 +
105 +{{video attachment="novice-soap-webservice-connectivity-calling-a-soap-webservice.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
106 +
70 70  )))((({{toc/}}))){{/container}}{{/container}}