Last modified by Erik Bakker on 2024/08/26 12:38
Hide last authors
Erik Bakker 21.1 1 {{container}}{{container layoutStyle="columns"}}(((
Carlijn Kokkeler 47.1 2 In this microlearning, we’ll explore how to configure a SOAP web service in eMagiz. Proper configuration is key to ensuring your SOAP web service operates smoothly and efficiently. We’ll cover the essentials, including setting the Operation Name and SOAP Webservice Namespace. While we’ll touch on these two aspects in this session, validation and authentication will be addressed in separate microlearnings. Let’s dive into how to set up these crucial elements to get your SOAP web service up and running.
eMagiz 1.1 3
Erik Bakker 34.1 4 Should you have any questions, please contact academy@emagiz.com.
eMagiz 1.1 5
6 == 1. Prerequisites ==
7 * Basic knowledge of the eMagiz platform
8
9 == 2. Key concepts ==
Erik Bakker 34.1 10 This microlearning centers around configuring your SOAP web service.
eMagiz 1.1 11
Erik Bakker 34.1 12 By configuring, we mean: Designing and determining the characteristics of the SOAP web service
eMagiz 1.1 13
Erik Bakker 34.1 14 Crucial parts in the configuration are:
15 * Operation Name
16 * SOAP Webservice Namespace
17 * Validation
18 * Authentication
eMagiz 1.1 19
Erik Bakker 34.1 20 Of these four points, the last two will be discussed in separate microlearnings.
Erik Bakker 36.1 21
Erik Bakker 34.1 22 == 3. Configure your SOAP Webservice ==
eMagiz 1.1 23
Erik Bakker 34.1 24 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.
eMagiz 1.1 25
Erik Bakker 34.1 26 Crucial parts in the configuration are:
27 * Operation Name
28 * SOAP Webservice Namespace
29 * Validation
30 * Authentication
eMagiz 1.1 31
Erik Bakker 34.1 32 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.
eMagiz 1.1 33
Erik Bakker 34.1 34 === 3.1 Operation Name ===
eMagiz 1.1 35
Erik Bakker 34.1 36 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:
eMagiz 1.1 37
Erik Bakker 34.1 38 * Send{technicalnameoftheoperation}
eMagiz 1.1 39
Erik Bakker 34.1 40 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:
eMagiz 1.1 41
Erik Bakker 34.1 42 * Send{technicalnameoftheoperation}Request
eMagiz 1.1 43
Erik Bakker 34.1 44 === 3.2 SOAP Webservice Namespace ===
45
46 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.
47
48 === 3.3 Configuration in eMagiz ===
49
50 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.
51
Erik Bakker 38.1 52 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 SOAP Entry Connector. By selecting this checkbox you tell eMagiz that you want to host a SOAP endpoint for others to call. After you have done so eMagiz will automatically define the SOAP Webservice Name and SOAP Webservice Namespace.
Erik Bakker 34.1 53
Erik Bakker 38.1 54 [[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice-gen3--soap-entry-check.png]]
Erik Bakker 34.1 55
56 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.
57
58 [[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice--edit-integration.png]]
59
60 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.
61
62 === 3.4 Add integration to Create ===
63
64 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.
65
Eva Torken 41.1 66 == 4. Key takeaways ==
eMagiz 1.1 67
Erik Bakker 34.1 68 * Crucial parts in the configuration are:
69 ** Operation Name
70 ** SOAP Webservice Namespace
71 ** Validation
72 ** Authentication
73 * For ease, you can use the default naming convention of eMagiz
eMagiz 1.1 74
Eva Torken 41.1 75 == 5. Suggested Additional Readings ==
eMagiz 1.1 76
Carlijn Kokkeler 43.1 77 * [[Novice (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Novice.WebHome||target="blank"]]
78 ** [[SOAP Web service Connectivity (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.WebHome||target="blank"]]
79 *** [[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"]]
Carlijn Kokkeler 45.1 80 *** [[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"]]
81 *** [[Endpoint Check (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-endpoint-check-gen3.WebHome||target="blank"]]
Carlijn Kokkeler 44.1 82 *** [[SOAP Headers (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-soap-headers||target="blank"]]
83 *** [[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"]]
84 *** [[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"]]
Carlijn Kokkeler 46.1 85 * [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
86 ** [[SOAP Web service Connectivity (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.SOAP Web service Connectivity.WebHome||target="blank"]]
87 * [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]
88 ** [[Webservice Security (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Webservice Security.WebHome||target="blank"]]
Erik Bakker 48.1 89 * [[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=%22soap+web+service%22||target="blank"]]
eMagiz 1.1 90
Erik Bakker 21.1 91 )))((({{toc/}}))){{/container}}{{/container}}