Wiki source code of Calling a SOAP Web service
Last modified by Erik Bakker on 2024/08/26 12:56
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
35.1 | 1 | {{container}}{{container layoutStyle="columns"}}((( |
| |
40.1 | 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 that configuration 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. |
| |
1.1 | 3 | |
| |
34.1 | 4 | Should you have any questions, please contact academy@emagiz.com. |
| |
1.1 | 5 | |
| 6 | == 1. Prerequisites == | ||
| 7 | * Basic knowledge of the eMagiz platform | ||
| 8 | |||
| 9 | == 2. Key concepts == | ||
| |
35.1 | 10 | This microlearning centers around calling a SOAP Webservice. |
| |
1.1 | 11 | |
| |
35.1 | 12 | With SOAP, we mean: A messaging protocol specification for exchanging structured information in the implementation of web services in computer networks. |
| |
1.1 | 13 | |
| |
35.1 | 14 | * To call a REST Webservice you need either: |
| 15 | ** A Web Service Outbound Gateway | ||
| 16 | * Critical information when configuring this component: | ||
| 17 | ** URL | ||
| 18 | ** Retry Advice | ||
| 19 | ** Error Handling | ||
| 20 | ** Authentication | ||
| |
34.1 | 21 | |
| |
35.1 | 22 | == 3. Calling a SOAP Webservice == |
| |
1.1 | 23 | |
| |
35.1 | 24 | 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: |
| 25 | |||
| 26 | * URL | ||
| 27 | * Retry Advice | ||
| 28 | * Error Handling | ||
| |
34.1 | 29 | * Authentication |
| |
1.1 | 30 | |
| |
35.1 | 31 | 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. |
| |
1.1 | 32 | |
| |
35.1 | 33 | 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: |
| |
1.1 | 34 | |
| |
35.1 | 35 | [[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--exit-flow-starting-point.png]] |
| |
1.1 | 36 | |
| |
35.1 | 37 | 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. |
| |
1.1 | 38 | |
| |
35.1 | 39 | [[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component.png]] |
| |
1.1 | 40 | |
| |
35.1 | 41 | === 3.1 URL === |
| |
1.1 | 42 | |
| |
35.1 | 43 | 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. |
| |
34.1 | 44 | |
| |
35.1 | 45 | [[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-url.png]] |
| |
34.1 | 46 | |
| |
35.1 | 47 | === 3.2 Retry Advice === |
| |
34.1 | 48 | |
| |
35.1 | 49 | 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. |
| |
34.1 | 50 | |
| |
35.1 | 51 | [[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-retry-advice-button.png]] |
| |
34.1 | 52 | |
| |
35.1 | 53 | 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 |
| |
34.1 | 54 | |
| |
35.1 | 55 | [[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-retry-advice-pop-up-empty.png]] |
| |
34.1 | 56 | |
| |
35.1 | 57 | The best practice for this configuration is as follows for asynchronous solutions: |
| 58 | * Select the option called Simple Retry Policy | ||
| 59 | * Set the max attempts at 6 | ||
| 60 | * Select the Fixed back off policy | ||
| 61 | * Set the backoff period at 5000 (ms) | ||
| |
34.1 | 62 | |
| |
35.1 | 63 | 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 |
| |
34.1 | 64 | |
| |
35.1 | 65 | [[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-retry-advice-pop-up-filled-in.png]] |
| |
34.1 | 66 | |
| |
35.1 | 67 | === 3.3 Error Handling === |
| |
34.1 | 68 | |
| |
35.1 | 69 | 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". |
| |
34.1 | 70 | |
| |
35.1 | 71 | 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. |
| |
34.1 | 72 | |
| |
35.1 | 73 | [[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-fault-message-resolver.png]] |
| |
34.1 | 74 | |
| |
35.1 | 75 | 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: |
| |
34.1 | 76 | |
| |
35.1 | 77 | [[image:Main.Images.Microlearning.WebHome@microlearning/novice-soap-webservice-connectivity-calling-a-soap-webservice--flow-result.png]] |
| 78 | |||
| |
37.1 | 79 | == 4. Key takeaways == |
| |
1.1 | 80 | |
| |
35.1 | 81 | * eMagiz will create a valid SOAP message when using this component |
| 82 | * eMagiz provides a support object for better error handling of SOAP faults | ||
| 83 | * There are four key configuration elements: | ||
| 84 | ** URL | ||
| 85 | ** Retry Advice | ||
| 86 | ** Error Handling | ||
| |
34.1 | 87 | ** Authentication |
| |
1.1 | 88 | |
| |
37.1 | 89 | == 5. Suggested Additional Readings == |
| |
1.1 | 90 | |
| |
39.1 | 91 | * [[Crash Course (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]] |
| 92 | ** [[Crash Course API Gateway (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.WebHome||target="blank"]] | ||
| 93 | *** [[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"]] | ||
| 94 | * [[Novice (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Novice.WebHome||target="blank"]] | ||
| 95 | ** [[SOAP Web service Connectivity (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.WebHome||target="blank"]] | ||
| 96 | *** [[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"]] | ||
| 97 | *** [[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"]] | ||
| 98 | *** [[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"]] | ||
| 99 | *** [[Endpoint Check (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-endpoint-check-gen3.WebHome||target="blank"]] | ||
| 100 | *** [[SOAP Headers (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-soap-headers||target="blank"]] | ||
| 101 | *** [[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"]] | ||
| 102 | * [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]] | ||
| 103 | ** [[SOAP Web service Connectivity (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.SOAP Web service Connectivity.WebHome||target="blank"]] | ||
| 104 | * [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]] | ||
| 105 | ** [[Webservice Security (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Webservice Security.WebHome||target="blank"]] | ||
| |
40.1 | 106 | * [[Calling a SOAP Web service (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=%22calling+a+SOAP+Web+service%22||target="blank"]] |
| |
1.1 | 107 | |
| |
21.1 | 108 | )))((({{toc/}}))){{/container}}{{/container}} |