Last modified by Erik Bakker on 2024/08/26 12:38
From version 32.2
edited by Erik Bakker
on 2022/06/12 09:14
Change comment: Update document after refactoring.
To version 35.1
edited by Erik Bakker
on 2022/06/12 09:50
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -novice-soap-webservice-connectivity-configure-your-soap-webservice
1 +Configure your SOAP web service
Content
... ... @@ -1,67 +1,99 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -n some cases, the input you receive or the output that you need to send to an external party cannot handle all characters or the input or output is written with the help of a character set. In this microlearning, we will learn how you can define the character set for file-based connectivity to ensure that you can process and deliver files according to the specifications.
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 -Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
4 +Should you have any questions, please contact academy@emagiz.com.
5 5  
6 -* Last update: May 31th, 2021
6 +* Last update: June 10th, 2021
7 7  * Required reading time: 7 minutes
8 8  
9 9  == 1. Prerequisites ==
10 -
11 11  * Basic knowledge of the eMagiz platform
12 12  
13 13  == 2. Key concepts ==
13 +This microlearning centers around configuring your SOAP web service.
14 14  
15 -This microlearning centers around learning how to define the character set to ensure that eMagiz processes the information correctly.
15 +By configuring, we mean: Designing and determining the characteristics of the SOAP web service
16 16  
17 -By character set, we mean: The composite number of different characters that are being used and supported by computer software and hardware. It consists of codes, bit patterns, or natural numbers used in defining some particular character.
17 +Crucial parts in the configuration are:
18 +* Operation Name
19 +* SOAP Webservice Namespace
20 +* Validation
21 +* Authentication
18 18  
19 -* Some external system talk in a different character set
20 -* eMagiz talks in default UTF-8 as a character set and assumes everyone else also does this
21 -* In cases of mismatch correct is at the point where you talk with the other system (i.e. entry or exit)
23 +Of these four points, the last two will be discussed in separate microlearnings.
24 +
25 +== 3. Configure your SOAP Webservice ==
22 22  
23 -== 3. Character set ==
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.
24 24  
25 -In some cases, the input you receive or the output that you need to send to an external party cannot handle all characters or the input or output is written with the help of a character set. In this microlearning, we will learn how you can define the character set for file-based connectivity to ensure that you can process and deliver files according to the specifications.
29 +Crucial parts in the configuration are:
30 +* Operation Name
31 +* SOAP Webservice Namespace
32 +* Validation
33 +* Authentication
26 26  
27 -Sometimes external systems only talk in a specific character set. To ensure that all the data is properly communicated between eMagiz and the other system we need to make sure that we define which character set that is so we can tell it to eMagiz via a component. That way eMagiz will deviate from its default (i.e. UTF-8) and will process the file according to that different character set. In practice, we mainly see windows-1252 as an alternative that pops up once in a while. In various components that deal with file handling, you can define the character set on which eMagiz should act. Examples of such components are:
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.
28 28  
29 -- File to string transformer
30 -- Flat file to XML transformer
31 -- File outbound channel adapter
37 +=== 3.1 Operation Name ===
32 32  
33 -In all these components you have the option to define the character set within the Advanced tab of the component. In this microlearning, we will use the File to string transformer to illustrate how that will look.
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:
34 34  
35 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-characterset--characterset-configuration.png]]
41 +* Send{technicalnameoftheoperation}
36 36  
37 -In this field, you can define the character set of your choice. To make this work in eMagiz you need to navigate to the Create phase of eMagiz and open the entry flow in which you want to retrieve the file to a certain location. Within the context of this flow, we need to add functionality that will ensure that the correct character set is used. To do so first enter "Start Editing" mode on flow level. After that open, the File to string transformer, navigate to the Advanced tab, and fill in the correct character set. After you have defined the correct character set the only thing left to do is to Save the component. See the suggested additional readings section on the complete list of character sets that are supported by Java 8.
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:
38 38  
39 -Congratulations you have successfully learned how to specify the character set.
45 +* Send{technicalnameoftheoperation}Request
40 40  
47 +=== 3.2 SOAP Webservice Namespace ===
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 +
51 +=== 3.3 Configuration in eMagiz ===
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 +
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 +
41 41  == 4. Assignment ==
42 42  
43 -Configure an entry in which you define the component and configuration needed to process a file on a per-line basis.
79 +Configure a SOAP web service that consists of at least one operation and add it to Create.
44 44  This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
45 45  
46 46  == 5. Key takeaways ==
47 47  
48 -* Some external system talk in a different character set
49 -* eMagiz talks in default UTF-8 as a character set and assumes everyone else also does this
50 -* In cases of mismatch correct is at the point where you talk with the other system (i.e. entry or exit)
51 -* eMagiz provides several components within which you can define the character set
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
52 52  
53 53  == 6. Suggested Additional Readings ==
54 54  
55 -If you are interested in this topic and want more information on it please read the help text provided by eMagiz and read the following links:
93 +If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
56 56  
57 -* https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html
58 -* https://www.techopedia.com/definition/941/character-set
59 -* https://www.smashingmagazine.com/2012/06/all-about-unicode-utf8-character-sets/
60 -
61 61  == 7. Silent demonstration video ==
62 62  
63 -This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
97 +{{video attachment="novice-soap-webservice-connectivity-configure-your-soap-webservice.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
64 64  
65 -{{video attachment="novice-file-based-connectivity-characterset.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
66 -
67 67  )))((({{toc/}}))){{/container}}{{/container}}