Skip to Content
Last modified by Erik Bakker on 2024/08/26 12:56
From version 34.2
edited by Erik Bakker
on 2022/06/12 09:34
Change comment: Update document after refactoring.
To version 35.1
edited by Erik Bakker
on 2022/06/12 09:35
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -novice-soap-webservice-connectivity-calling-a-soap-webservice
1 +Calling a SOAP Web service
Content
... ... @@ -1,92 +1,100 @@
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.
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: June 10th, 2021
7 -* Required reading time: 7 minutes
6 +* Last update: April 1st, 2022
7 +* Required reading time: 5 minutes
8 8  
9 9  == 1. Prerequisites ==
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.
13 +This microlearning centers around calling a SOAP Webservice.
14 14  
15 -By configuring, we mean: Designing and determining the characteristics of the SOAP web service
15 +With SOAP, we mean: A messaging protocol specification for exchanging structured information in the implementation of web services in computer networks.
16 16  
17 -Crucial parts in the configuration are:
18 -* Operation Name
19 -* SOAP Webservice Namespace
20 -* Validation
21 -* Authentication
22 -
23 -Of these four points, the last two will be discussed in separate microlearnings.
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 24  
25 -== 3. Configure your SOAP Webservice ==
25 +== 3. Calling a SOAP Webservice ==
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.
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.
28 28  
29 -Crucial parts in the configuration are:
30 -* Operation Name
31 -* SOAP Webservice Namespace
32 -* Validation
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:
30 +
31 +* URL
32 +* Retry Advice
33 +* Error Handling
33 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.
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.
36 36  
37 -=== 3.1 Operation Name ===
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:
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:
40 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--exit-flow-starting-point.png]]
40 40  
41 -* Send{technicalnameoftheoperation}
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.
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:
44 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component.png]]
44 44  
45 -* Send{technicalnameoftheoperation}Request
46 +=== 3.1 URL ===
46 46  
47 -=== 3.2 SOAP Webservice Namespace ===
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.
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.
50 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-url.png]]
50 50  
51 -=== 3.3 Configuration in eMagiz ===
52 +=== 3.2 Retry Advice ===
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.
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.
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.
56 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-retry-advice-button.png]]
56 56  
57 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice--combined-entry-check.png]]
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
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.
60 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-retry-advice-pop-up-empty.png]]
60 60  
61 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice--combined-entry-choice.png]]
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)
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.
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
64 64  
65 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice--combined-entry-soap-ws-namespace.png]]
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]]
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.
72 +=== 3.3 Error Handling ===
68 68  
69 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice--edit-integration.png]]
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".
70 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.
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.
72 72  
73 -=== 3.4 Add integration to Create ===
78 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-fault-message-resolver.png]]
74 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.
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:
76 76  
82 +[[image:Main.Images.Microlearning.WebHome@microlearning/novice-soap-webservice-connectivity-calling-a-soap-webservice--flow-result.png]]
83 +
77 77  == 4. Assignment ==
78 78  
79 -Configure a SOAP web service that consists of at least one operation and add it to Create.
86 +Build a flow within your project in which you do a call to an external party that hosts a SOAP web service.
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
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
88 88   ** Authentication
89 -* For ease, you can use the default naming convention of eMagiz
90 90  
91 91  == 6. Suggested Additional Readings ==
92 92  
... ... @@ -94,6 +94,6 @@
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"/}}
105 +{{video attachment="novice-soap-webservice-connectivity-calling-a-soap-webservice.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
98 98  
99 99  )))((({{toc/}}))){{/container}}{{/container}}