Changes for page Configure your SOAP web service

Last modified by Erik Bakker on 2024/08/26 12:38

From 28.1 to 27.2 From 46.1 to 45.1

From version 45.1

edited by Carlijn Kokkeler
on 2024/08/21 16:25

Change comment: There is no comment for this version

To version 28.1

edited by Erik Bakker
on 2022/06/10 13:12

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (5 modified, 0 added, 0 removed)

Details

Page properties

Title

@@ -1,1 +1,1 @@
--Configure your SOAP web service
++Header line

Parent

@@ -1,1 +1,1 @@
--Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.WebHome
++WebHome

Author

@@ -1,1 +1,1 @@
--XWiki.CarlijnKokkeler
++XWiki.ebakker

Default language

...	...	@@ -1,1 +1,0 @@
1		-en

Content

@@ -1,86 +1,70 @@
  {{container}}{{container layoutStyle="columns"}}(((
--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.
++In this microlearning, we will learn how you can define a header line in which you specify the naming of the various columns. Some external systems require a header line when you supply them with data via a flat file that is placed somewhere.
--Should you have any questions, please contact academy@emagiz.com.
++Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
++* Last update: May 28th, 2021
++* Required reading time: 5 minutes
++
  == 1. Prerequisites ==
++
  * Basic knowledge of the eMagiz platform
  == 2. Key concepts ==
--This microlearning centers around configuring your SOAP web service.
--By configuring, we mean: Designing and determining the characteristics of the SOAP web service
++This microlearning centers around learning how to place a header line on a flat-file output.
--Crucial parts in the configuration are:
--* Operation Name
--* SOAP Webservice Namespace
--* Validation
--* Authentication
++By header line we mean: A line in the output that defines the naming of the various columns
--Of these four points, the last two will be discussed in separate microlearnings.
++Some external parties require that the first line in the flat file output (i.e. CSV) is filled with column names (i.e. headers). In eMagiz, we call this line a header line.
--== 3. Configure your SOAP Webservice ==
++== 3. Header line ==
--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.
++In this microlearning, we will learn how you can define a header line in which you specify the naming of the various columns. Some external systems require a header line when you supply them with data via a flat file that is placed somewhere. The header line is the first line in the flat file output. Within this line, the various column names are specified for clarity.
--Crucial parts in the configuration are:
--* Operation Name
--* SOAP Webservice Namespace
--* Validation
--* Authentication
++To add such a header line in eMagiz you need to navigate to the Create phase of eMagiz and open the exit flow in which you want to drop the file to a certain location. Within the context of this flow, we need to add functionality that will ensure that a header line is written to the output before any functional lines are added. To do so first enter "Start Editing" mode on flow level. After you have done so please add a file outbound channel adapter to the flow including an input channel. We will use this component to write our header line to the flat file output.
--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.
++Ensure that the directory to which you reference is the same as in your functional file outbound channel adapter.
--=== 3.1 Operation Name ===
++[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--file-outbound-channel-header-line.png]]
--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:
++Now it is time to turn our attention to the Advanced tab. For the Mode select Ignore. Select this option to ensure that the header line is only written down once when there is no output created yet and not somewhere in the middle, in the end, or every time. Furthermore, select the option Append New Line to ensure that the remainder of the information is not appended to the same line.
--* Send{technicalnameoftheoperation}
++[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--file-outbound-channel-header-line-advanced.png]]
--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:
++After you have done so we need to add a standard transformer that defines the various column names to be written to the flat file output. To do so add the standard transformer component to the canvas including an input channel. After you have done so define the relevant SpEL expression. In this case, we advise using a property value that represents a string of column names. The value of the property should be something as follows:
--* Send{technicalnameoftheoperation}Request
++'Header1;Header2;Header3;Header4'
--=== 3.2 SOAP Webservice Namespace ===
++Do note that the separator, in this case, needs to match the requirements of the external system. At the flow configuration level, the standard transformer should look as follows.
--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.
++[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--define-columns-names.png]]
--=== 3.3 Configuration in eMagiz ===
++Our last step is to ensure that this piece of logic is tied to the main flow and is executed before writing the functional line(s) to the output file. To make that happen we need to add a wiretap to the flow. With the help of this functionality, you can define which part of the logic takes precedence over another part of the logic. To do so double click on the channel on which you want to place a wiretap, select the option wiretap and select the correct wiretap channel. After you have done this the result should be something as follows:
--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.
++[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--wiretap-result.png]]
--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.
++With these couple of steps, you have now successfully added logic to your flow that will ensure that a header line is added before any functional line(s) are written to the output file.
--[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice-gen3--soap-entry-check.png]]
++== 4. Assignment ==
--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.
++Configure an exit in which you define and write a header line to a flat-file output before adding functional lines.
++This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
--[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice--edit-integration.png]]
++== 5. Key takeaways ==
--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.
++* The header line contains the names of the columns of the flat file output
++* Use the Ignore mode to ensure the header line is created once
++* Use the wiretap to ensure the header line is created first
--=== 3.4 Add integration to Create ===
++== 6. Suggested Additional Readings ==
--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.
++There are no suggested additional readings on this topic
--== 4. Key takeaways ==
++== 7. Silent demonstration video ==
--* Crucial parts in the configuration are:
--    ** Operation Name
--    ** SOAP Webservice Namespace
--    ** Validation
--    ** Authentication
--* For ease, you can use the default naming convention of eMagiz
++This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
--== 5. Suggested Additional Readings ==
++{{video attachment="novice-file-based-connectivity-header-line.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
--* [[Novice (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Novice.WebHome||target="blank"]]
--** [[SOAP Web service Connectivity (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.WebHome||target="blank"]]
--*** [[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"]]
--*** [[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"]]
--*** [[Endpoint Check (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-endpoint-check-gen3.WebHome||target="blank"]]
--*** [[SOAP Headers (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-soap-headers||target="blank"]]
--*** [[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"]]
--*** [[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"]]
--
  )))((({{toc/}}))){{/container}}{{/container}}