Changes for page Configure your SOAP web service
Last modified by Erik Bakker on 2024/08/26 12:38
From version 38.1
edited by Erik Bakker
on 2022/12/30 11:26
on 2022/12/30 11:26
Change comment:
There is no comment for this version
To version 30.2
edited by Erik Bakker
on 2022/06/10 13:23
on 2022/06/10 13:23
Change comment:
Update document after refactoring.
Summary
-
Page properties (4 modified, 0 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 - Configureyour SOAP webrvice1 +novice-file-based-connectivity-characterset - Parent
-
... ... @@ -1,1 +1,1 @@ 1 - Main.eMagiz Academy.Microlearnings.Novice.SOAPWebservice Connectivity.WebHome1 +WebHome - Default language
-
... ... @@ -1,1 +1,0 @@ 1 -en - Content
-
... ... @@ -1,88 +1,104 @@ 1 1 {{container}}{{container layoutStyle="columns"}}((( 2 - When settingupapoint atwhichyour customerscantalkto youeMagizoffersvariousmethodsof creatingsuch a point. One ofthose optionsisby hostinga SOAP Webservice ineMagizthathandlesXMLmessages asynchronously or synchronously. In this microlearning, we will learnthe basicsofthis configurationin the variousphasesof the platformsoyou caneasilyset upyourSOAP webservice.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 - Byconfiguring,wemean: Designinganddeterminingthecharacteristics oftheSOAP web service15 +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. ConfigureyourSOAPWebservice ==23 +== 3. Processing a File per Line == 23 23 24 - When settingupapoint atwhichyour customerscantalkto youeMagizoffersvariousmethodsof creatingsuch a point. One ofthose optionsisby hostinga SOAP Webservice ineMagizthathandlesXMLmessages asynchronously or synchronously. In this microlearning, we will learnthe basicsofthis configurationin the variousphasesof the platformsoyou caneasilyset upyourSOAP webservice.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 thesefour points,thelasttwowillbediscussed in separate microlearnings.In this microlearning, wewill focus onthefirst two aspectsofthe configuration. As youmighthave noticed I did not mention thefactwhetherthe integrationis synchronous orasynchronouss a crucial part of the configuration. Thereasonbeing that when configuring a (SOAP) webserviceyoualwaysneed to send an acknowledgment back to the client calling the web serviceto let them know what the status ofthemessage is. Inaseyou wanttosetup therest of yourintegration asynchronously you can send an empty message back as acknowledgment. In case you want to set up therest ofyourintegration synchronouslyyou needto sendtheresponseyou have receivedfromthe backendoperation back to theclient. More onthe 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 OperationName===31 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--file-item-reader-directory.png]] 35 35 36 - Letusfirstzoom in on the partsof theconfigurationbeforewe learn howyou canimplementit in eMagiz.Startingwiththeoperationname.Whenyouhavedealtwith theAPI GatewayofferingofeMagiz inthe past orhavesome knowledgeof how APIs workthenotion of an operation name should not be unfamiliar. Inessence, itis a unique name that definesa certainoperation.In eMagizthebest practice fornaming theoperation 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 - WhenyouareinCreate youwillnotice thateMagizuses thedefault suffixofRequest andResponse isaddedtotheoperationname.Therefore the fulloperationnameaclientneeds to call toget thedesiredresult ifyou adhereto thebestpractice 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}Request39 +[[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 WebserviceNamespace===41 +Based on your choice the exact configuration will differ. 45 45 46 - Thesecond part of the configuration is the SOAP Webservice Namespace.When hostingaSOAP Webservicevia the standard eMagiztoolingyou needto define a namespace.To smoothen this process eMagiz automatically generates a namespace basedon theconfigurationsettings you choose in the Design phase of eMagiz.43 +==== 3.1.1 Stax Event Item Reader ==== 47 47 48 - ===3.3Configuration 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 weknow what configurationsarerequired, wecan see how we can implement this in eMagiz. In the Capture phase,nothingchanges.You simply draw a system onthe canvasincluding atleastone linehatgoes from the system towards eMagiz. When you aredone you move to the Design phaseineMagiz. In this phase, you need to correctly set uptheoperationname(s) andtheSOAP WebserviceNamespace.47 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--stax-event-item-reader-config.png]] 51 51 52 - Theconfiguration 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 eMagizthatyou want to host a SOAP endpoint for others to call. Afteryou have done so eMagiz will automaticallydefine the SOAP Webservice Name andSOAP WebserviceNamespace.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 aredonewithyourconfigurationonheystem level.Don't forgettoupdate the status ofyour task.Nowthatwehaveconfiguredthe systemitstime toconfigure theintegration thatis drawnfrom the systemto eMagiz.We can dooby double-clickingonit(or byaccessing thecontextmenuandselecting the editoption).WhenyouopentheEditpageonthe integrationlevel youwill notice thata newsegmentisadded (compared toother integrations). Thissegmentdefinesthesettingson thesystemlevelwehavejustspecifiedanddefinestheoperationname.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 alreadyprefilledtheoperationnameforyoubased onthe bestpracticet eMagiz. If you want to changeyou havethe optionto doso. Do note thatforthesakeof consistencyit wouldbe smart to usethe same naming convention withina single projectto avoidconfusion.60 +For the remainder of this microlearning, we will assume that the option pass through line mapper is chosen. 61 61 62 - === 3.4 AddintegrationCreate===62 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--flat-file-item-reader-passthrough.png]] 63 63 64 - Nowthatwehavefinished thenfigurationin Design thelaststepofthismicrolearning is toaddthe integration toCreate.Youcan simplydosoby navigatingtoCreate->Addintegrationsand selecting the integration tomoveitto Create.Afteryou haveselecteditpressSavetoaddtheintegrationtoCreate.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 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--flat-file-item-reader-passthrough-advanced.png]] 67 + 68 +=== 3.2 Poller === 69 + 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: 71 + 72 +- Fixed Delay Trigger 73 +- Fixed Rate Trigger 74 +- Cron Trigger 75 + 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 + 66 66 == 4. Assignment == 67 67 68 -Configure a SOAPwebservice thatconsistsof at leastoneoperationand addittoCreate.84 +Configure an entry in which you define the component and configuration needed to process a file on a per-line basis. 69 69 This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment. 70 70 71 71 == 5. Key takeaways == 72 72 73 -* Crucial parts in the configuration are: 74 - ** Operation Name 75 - ** SOAP Webservice Namespace 76 - ** Validation 77 - ** Authentication 78 -* For ease, you can use the default naming convention of eMagiz 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 79 79 80 80 == 6. Suggested Additional Readings == 81 81 82 - Ifyouareinterested inthis topic and wantmoreinformation onitpleasereadthe help text provided by eMagiz.96 +There are no suggested additional readings on this topic 83 83 84 84 == 7. Silent demonstration video == 85 85 86 - {{videoattachment="novice-soap-webservice-connectivity-configure-your-soap-webservice.mp4"reference="Main.Videos.Microlearning.WebHome"/}}100 +This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned. 87 87 102 +{{video attachment="novice-file-based-connectivity-processing-a-file-per-line.mp4" reference="Main.Videos.Microlearning.WebHome"/}} 103 + 88 88 )))((({{toc/}}))){{/container}}{{/container}}