Skip to Content

Changes for page Endpoint Check

Last modified by Danniar Firdausy on 2024/09/04 10:26
From version 37.2
edited by Erik Bakker
on 2022/06/12 09:37
Change comment: Update document after refactoring.
To version 34.2
edited by Erik Bakker
on 2022/06/12 09:34
Change comment: Update document after refactoring.

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -novice-soap-webservice-connectivity-securing-your-soap-webservice
1 +novice-soap-webservice-connectivity-calling-a-soap-webservice
Content
... ... @@ -1,62 +1,92 @@
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 +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.
3 3  
4 4  Should you have any questions, please contact academy@emagiz.com.
5 5  
6 6  * Last update: June 10th, 2021
7 -* Required reading time: 5 minutes
7 +* Required reading time: 7 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 SOAP Headers.
13 +This microlearning centers around configuring your SOAP web service.
14 14  
15 -By SOAP Headers, we mean: headers within a SOAP Envelope that can be used to communicate metadata or authentication information between parties
15 +By configuring, we mean: Designing and determining the characteristics of the SOAP web service
16 16  
17 -You can exchange data from:
18 -* SOAP Header to Message Header
19 -* Message Header to SOAP Header
17 +Crucial parts in the configuration are:
18 +* Operation Name
19 +* SOAP Webservice Namespace
20 +* Validation
21 +* Authentication
20 20  
21 -In both cases ensure that the correct information is exchanged.
23 +Of these four points, the last two will be discussed in separate microlearnings.
22 22  
23 -== 3. SOAP Headers ==
25 +== 3. Configure your SOAP Webservice ==
24 24  
25 -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.
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.
26 26  
27 -You can exchange data from:
28 -* SOAP Header to Message Header
29 -* Message Header to SOAP Header
29 +Crucial parts in the configuration are:
30 +* Operation Name
31 +* SOAP Webservice Namespace
32 +* Validation
33 +* Authentication
30 30  
31 -In both cases ensure that the correct information is exchanged.
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.
32 32  
33 -In a previous microlearning, we already discussed one aspect of this. As you probably recall from our microlearning on [Securing your SOAP Webservice](novice-soap-web service-connectivity-securing-your-soap-webservice.md) 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.
37 +=== 3.1 Operation Name ===
34 34  
35 -In that microlearning, we also discussed the component that we need for this. The 'complex SOAP header mapper'.
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:
36 36  
37 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-soap-headers--complex-soap-header-mapper.png]]
41 +* Send{technicalnameoftheoperation}
38 38  
39 -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.
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:
40 40  
41 -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:
45 +* Send{technicalnameoftheoperation}Request
42 42  
43 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-soap-headers--mapping-from-message-header.png]]
47 +=== 3.2 SOAP Webservice Namespace ===
44 44  
45 -Once you are satisfied you can press Save and link the support object to the web service outbound gateway.
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.
46 46  
47 -With this information, you can place SOAP Headers on message headers and vice versa every time you need it.
51 +=== 3.3 Configuration in eMagiz ===
48 48  
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 +
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 +
57 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice--combined-entry-check.png]]
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 +
61 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice--combined-entry-choice.png]]
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 +
65 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice--combined-entry-soap-ws-namespace.png]]
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 +
49 49  == 4. Assignment ==
50 50  
51 -Call an external web service and send along some SOAP Headers.
79 +Configure a SOAP web service that consists of at least one operation and add it to Create.
52 52  This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
53 53  
54 54  == 5. Key takeaways ==
55 55  
56 -* You can exchange data from:
57 - ** SOAP Header to Message Header
58 - ** Message Header to SOAP Header
59 -* You need the SOAP structure and the message header name to make it work
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
60 60  
61 61  == 6. Suggested Additional Readings ==
62 62  
... ... @@ -64,6 +64,6 @@
64 64  
65 65  == 7. Silent demonstration video ==
66 66  
67 -{{video attachment="novice-soap-webservice-connectivity-soap-headers.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
97 +{{video attachment="novice-soap-webservice-connectivity-configure-your-soap-webservice.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
68 68  
69 69  )))((({{toc/}}))){{/container}}{{/container}}