Changes for page Configure your SOAP web service
Last modified by Erik Bakker on 2024/08/26 12:38
From version 34.1
edited by Erik Bakker
on 2022/06/12 09:34
on 2022/06/12 09:34
Change comment:
There is no comment for this version
To version 28.1
edited by Erik Bakker
on 2022/06/10 13:12
on 2022/06/10 13:12
Change comment:
There is no comment for this version
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 - Configureyour SOAP web service1 +Header line - Content
-
... ... @@ -1,99 +1,70 @@ 1 1 {{container}}{{container layoutStyle="columns"}}((( 2 - Whensettingup a pointatwhichyour customers cantalk to youeMagizoffersvariousmethods of creatingsuchapoint.Oneof thoseoptionsisby hostingaSOAP WebserviceneMagizthathandlesXML messagesasynchronouslyor synchronously.Inthis microlearning,we will learnthebasics ofthisconfigurationinthevarious phasesofthe platformsoyou caneasilyset up your SOAPweb service.2 +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. 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: June10th, 20217 -* Required reading time: 7minutes6 +* Last update: May 28th, 2021 7 +* Required reading time: 5 minutes 8 8 9 9 == 1. Prerequisites == 10 + 10 10 * Basic knowledge of the eMagiz platform 11 11 12 12 == 2. Key concepts == 13 -This microlearning centers around configuring your SOAP web service. 14 14 15 - Byconfiguring,wemean: DesigninganddeterminingthecharacteristicsoftheSOAP webservice15 +This microlearning centers around learning how to place a header line on a flat-file output. 16 16 17 -Crucial parts in the configuration are: 18 -* Operation Name 19 -* SOAP Webservice Namespace 20 -* Validation 21 -* Authentication 17 +By header line we mean: A line in the output that defines the naming of the various columns 22 22 23 -Of these four points, the last two will be discussed in separate microlearnings. 24 - 25 -== 3. Configure your SOAP Webservice == 19 +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. 26 26 27 - Whensetting up a point at which your customers can talk to you eMagiz offers various methods of creating such a point.Oneof those options is by hostingaSOAP Webservice in eMagiz that handles XML messages asynchronouslyor synchronously. In this microlearning, wewill learn the basics of this configuration in the various phases of the platform so you can easily set up your SOAP web service.21 +== 3. Header line == 28 28 29 -Crucial parts in the configuration are: 30 -* Operation Name 31 -* SOAP Webservice Namespace 32 -* Validation 33 -* Authentication 23 +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. 34 34 35 - Of these fourpoints,thelasttwo will beiscussedinseparatemicrolearnings.In this microlearning, we willfocusonthefirsttwo aspectsoftheconfiguration.AsyoumighthavenoticedI did not mentionthefact whethertheintegrationis synchronousor asynchronousasacrucialpartoftheconfiguration.Thereasonbeingthatwhenconfiguring a (SOAP) webserviceyoualwaysneed tosendanacknowledgment backtothe clientcallingthewebservice to let them know whatthe statusof themessage is. Incaseyouwant toset upherest ofyourintegrationasynchronouslyyou cansendanemptymessage back as acknowledgment.In case youwant to setup therestof your integrationsynchronouslyyouneedtosendtheesponseyou havereceived fromthebackendoperationbackto the client.More on thechoicebetweenasynchronousandsynchronousinalaterstage.25 +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. 36 36 37 - ===3.1OperationName===27 +Ensure that the directory to which you reference is the same as in your functional file outbound channel adapter. 38 38 39 - Let us first zoomin on the parts of the configurationbefore welearnhow you canimplement it in eMagiz.Starting with theperation name. Whenyou havedealt with theAPI Gatewayoffering ofeMagizinthepast or have some knowledgeof how APIs work the notionof an operation nameshould noteunfamiliar. In essence, it isauniquenamethatdefines a certainoperation.In eMagiz the bestpractice fornamingthe operation is as follows:29 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--file-outbound-channel-header-line.png]] 40 40 41 - *Send{technicalnameoftheoperation}31 +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. 42 42 43 - Whenyouaren Createyou willnoticethat eMagiz uses the defaultsuffix of Request andResponses addedto theoperationname. Therefore the full operationname aclientneeds to call to get thesired resultif youadhere to the best practiceis:33 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--file-outbound-channel-header-line-advanced.png]] 44 44 45 - *Send{technicalnameoftheoperation}Request35 +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: 46 46 47 - === 3.2 SOAP WebserviceNamespace===37 +'Header1;Header2;Header3;Header4' 48 48 49 - The secondpartoftheconfigurationistheSOAP Webservice Namespace. When hostingaSOAP WebserviceviathestandardeMagiztooling you need todefine a namespace.To smoothenthis processeMagizautomaticallygenerates anamespacebasedonthe configurationsettings you chooseintheDesignphase ofeMagiz.39 +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. 50 50 51 - === 3.3 ConfigurationMagiz ===41 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--define-columns-names.png]] 52 52 53 - Nowthatweknowwhatconfigurationsarerequired,wecansee howwe can implementthisin eMagiz.In theCapturephase,nothingchanges.Yousimplydrawasystemonthecanvasincludingatleast onelinethatgoesfromthesystem towards eMagiz.Whenyou areoneyoumove to theDesignphase in eMagiz.Inthis phase,you needto correctlysetupthe operationname(s)and theSOAPWebserviceNamespace.43 +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: 54 54 55 - The configurationin Design starts at the systemlevel. At the system level, youneed to definethe technical name(or let eMagiz automaticallyfill it in for you) and select the checkbox calledCombined Entry Connector. By selectingthis checkbox you tell eMagiz that you want to host anendpoint forothersto call.45 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--wiretap-result.png]] 56 56 57 - [[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice--combined-entry-check.png]]47 +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. 58 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 - 77 77 == 4. Assignment == 78 78 79 -Configure a SOAPwebservice thatconsistsofatleastone operationandaddittoCreate.51 +Configure an exit in which you define and write a header line to a flat-file output before adding functional lines. 80 80 This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment. 81 81 82 82 == 5. Key takeaways == 83 83 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 56 +* The header line contains the names of the columns of the flat file output 57 +* Use the Ignore mode to ensure the header line is created once 58 +* Use the wiretap to ensure the header line is created first 90 90 91 91 == 6. Suggested Additional Readings == 92 92 93 - Ifyouareinterested inthis topic and wantmoreinformation onitpleasereadthe help text provided by eMagiz.62 +There are no suggested additional readings on this topic 94 94 95 95 == 7. Silent demonstration video == 96 96 97 - {{videoattachment="novice-soap-webservice-connectivity-configure-your-soap-webservice.mp4"reference="Main.Videos.Microlearning.WebHome"/}}66 +This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned. 98 98 68 +{{video attachment="novice-file-based-connectivity-header-line.mp4" reference="Main.Videos.Microlearning.WebHome"/}} 69 + 99 99 )))((({{toc/}}))){{/container}}{{/container}}