Skip to Content
Last modified by Erik Bakker on 2024/08/26 12:38
From version 43.1
edited by Carlijn Kokkeler
on 2024/08/21 16:23
Change comment: There is no comment for this version
To version 30.2
edited by Erik Bakker
on 2022/06/10 13:23
Change comment: Update document after refactoring.

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Configure your SOAP web service
1 +novice-file-based-connectivity-characterset
Parent
... ... @@ -1,1 +1,1 @@
1 -Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.WebHome
1 +WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.CarlijnKokkeler
1 +XWiki.ebakker
Default language
... ... @@ -1,1 +1,0 @@
1 -en
Content
... ... @@ -1,81 +1,104 @@
1 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.
2 +In some cases, you want to treat each unique part of your input file as its message instead of processing the complete file as its message. In this microlearning, we will learn how you can process a (large) file on a per-line basis.
3 3  
4 -Should you have any questions, please contact academy@emagiz.com.
4 +Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
6 +* Last update: May 31th, 2021
7 +* Required reading time: 7 minutes
8 +
6 6  == 1. Prerequisites ==
10 +
7 7  * Basic knowledge of the eMagiz platform
8 8  
9 9  == 2. Key concepts ==
10 -This microlearning centers around configuring your SOAP web service.
11 11  
12 -By configuring, we mean: Designing and determining the characteristics of the SOAP web service
15 +This microlearning centers around learning how to process an incoming file per line.
13 13  
14 -Crucial parts in the configuration are:
15 -* Operation Name
16 -* SOAP Webservice Namespace
17 -* Validation
18 -* Authentication
17 +By processing per line, we mean: Splitting up the input into discernable pieces that each will become a unique message
19 19  
20 -Of these four points, the last two will be discussed in separate microlearnings.
19 +* Easy way of reading a file line by line and sending it to eMagiz (Low on memory)
20 +* Ability to process each line based on distinctive logic that is relevant on line level
21 +* Can be used for flat file as well as XML input files
21 21  
22 -== 3. Configure your SOAP Webservice ==
23 +== 3. Processing a File per Line ==
23 23  
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.
25 +In some cases, you want to treat each unique part of your input file as its message instead of processing the complete file as its message. In this microlearning, we will learn how you can process a (large) file on a per-line basis.
25 25  
26 -Crucial parts in the configuration are:
27 -* Operation Name
28 -* SOAP Webservice Namespace
29 -* Validation
30 -* Authentication
27 +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 each line is read and processed separately and will become its unique message. To do so first enter "Start Editing" mode on flow level. After you have done so please add a file item reader message source to the flow. We will use this component to read and process our input file on a per-line basis.
31 31  
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.
29 +The first step would be to define the directory from which we read our messages. As always reference to the directory with the help of a property.
33 33  
34 -=== 3.1 Operation Name ===
31 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--file-item-reader-directory.png]]
35 35  
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:
33 +Secondly, just as when reading the file as a whole ensure that you use a filter to retrieve only the correct files from the directory.
37 37  
38 -* Send{technicalnameoftheoperation}
35 +=== 3.1 Item reader Type ===
39 39  
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:
37 +Now it is time to select our Item reader Type. As the help text of the eMagiz component suggest there are two choices with this component. The first (and most frequently used) option is the Flat file item reader. With this option, you can read each line within the flat file input file and output is at a separate message. The second option is called the Stax event item reader. With this option, you can read your input XML and output messages on a per-record basis.
41 41  
42 -* Send{technicalnameoftheoperation}Request
39 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--item-reader-type-options.png]]
43 43  
44 -=== 3.2 SOAP Webservice Namespace ===
41 +Based on your choice the exact configuration will differ.
45 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.
43 +==== 3.1.1 Stax Event Item Reader ====
47 47  
48 -=== 3.3 Configuration in eMagiz ===
45 +For the Stax event item reader, you need to define the name of the element on which you want to split the XML and define whether you want to throw an error in case no such element exists in the input file (By (de)selecting the option Strict). The default setting of eMagiz is advisable for this option.
49 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.
47 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--stax-event-item-reader-config.png]]
51 51  
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.
49 +==== 3.1.2 Flat File Item Reader ====
53 53  
54 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice-gen3--soap-entry-check.png]]
51 +For the Flat File item reader, there are some more choices and configurations to be made. There are three options you can choose from:
52 +- Pass through line mapper
53 +- Default line mapper
54 +- Pattern matching composite line mapper
55 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.
56 +Each of these options has some advantages and disadvantages. Adhering to the best practices of eMagiz (i.e. no transformation in the entry) the best option would be to use the pass-through line mapper. As the name suggests this option does nothing except give a string back to the flow on a per line basis. However, choosing this option means that the actual transformation from that string to XML needs to happen later in the process (most likely in the onramp) with the help of a flat-file to XML transformer (more on that component in a later course).
57 57  
58 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice--edit-integration.png]]
58 +The other two options transform the input line into an XML output. So you win one step in the process. However, no standard eMagiz error handling is advisable when you start transforming data within the entry. So in case, something goes wrong to analyze the error will become more difficult. Furthermore, another potential disadvantage is that when one line fails the processing of the rest of the file also halts.
59 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.
60 +For the remainder of this microlearning, we will assume that the option pass through line mapper is chosen.
61 61  
62 -=== 3.4 Add integration to Create ===
62 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--flat-file-item-reader-passthrough.png]]
63 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.
64 +As you can see on the Basic level we are done. However, it is always good to check out the settings on the Advanced tab, especially in this case, to see if there are additional configuration options that could benefit us. The setting of most interest, in this case, is the Lines to Skip setting (default setting is 0). With this setting, you can define whether or not you want to process the header line(s) that exists within your input file. The remainder of the settings is (in most cases) good the way eMagiz has set them up.
65 65  
66 -== 4. Key takeaways ==
66 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--flat-file-item-reader-passthrough-advanced.png]]
67 67  
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
68 +=== 3.2 Poller ===
74 74  
75 -== 5. Suggested Additional Readings ==
70 +Now that we have selected and configured the item reader type it becomes time to fill in the last part of the configuration, the poller. For polling eMagiz offers three options:
76 76  
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"]]
72 +- Fixed Delay Trigger
73 +- Fixed Rate Trigger
74 +- Cron Trigger
80 80  
76 +Of these options, the cron trigger is used most frequently in eMagiz. The reason being is that you can define this option via a property that you can alter without having to alter the flow version in Create.
77 +
78 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--poller-config.png]]
79 +
80 +After finishing all these configuration steps we can press Save to save our work and ensure that we can process the input file on a per-line basis.
81 +
82 +== 4. Assignment ==
83 +
84 +Configure an entry in which you define the component and configuration needed to process a file on a per-line basis.
85 +This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
86 +
87 +== 5. Key takeaways ==
88 +
89 +* Easy way of reading a file line by line and sending it to eMagiz (Low on memory)
90 +* Ability to process each line based on distinctive logic that is relevant on line level
91 +* Can be used for flat file as well as XML input files
92 +* Try to avoid complex transformations within the entry
93 +
94 +== 6. Suggested Additional Readings ==
95 +
96 +There are no suggested additional readings on this topic
97 +
98 +== 7. Silent demonstration video ==
99 +
100 +This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
101 +
102 +{{video attachment="novice-file-based-connectivity-processing-a-file-per-line.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
103 +
81 81  )))((({{toc/}}))){{/container}}{{/container}}