Changes for page Configure your SOAP web service
Last modified by Erik Bakker on 2024/08/26 12:38
From version 28.2
edited by Erik Bakker
on 2022/06/10 13:13
on 2022/06/10 13:13
Change comment:
Update document after refactoring.
To version 32.2
edited by Erik Bakker
on 2022/06/12 09:14
on 2022/06/12 09:14
Change comment:
Update document after refactoring.
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 -novice- file-based-connectivity-processing-a-file-per-line1 +novice-soap-webservice-connectivity-configure-your-soap-webservice - Content
-
... ... @@ -1,10 +1,10 @@ 1 1 {{container}}{{container layoutStyle="columns"}}((( 2 - Inthismicrolearning,wewilllearnhowyoucanfine a headerlineinwhichyou specifythenamingofthevarious columns.Some externalsystemsrequireaheaderlinewhenyousupply themwithdatavia aflatfilethat isplacedsomewhere.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. 3 3 4 4 Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]]. 5 5 6 -* Last update: May 28th, 20217 -* Required reading time: 5minutes6 +* Last update: May 31th, 2021 7 +* Required reading time: 7 minutes 8 8 9 9 == 1. Prerequisites == 10 10 ... ... @@ -12,59 +12,56 @@ 12 12 13 13 == 2. Key concepts == 14 14 15 -This microlearning centers around learning how to placeaheaderline on aflat-fileoutput.15 +This microlearning centers around learning how to define the character set to ensure that eMagiz processes the information correctly. 16 16 17 -By h eaderline we mean:Aline in theoutput that defines the namingofthevariouscolumns17 +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. 18 18 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. 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) 20 20 21 -== 3. Headerline ==23 +== 3. Character set == 22 22 23 -In thismicrolearning,wewill learnhowyou can defineaheaderline in which youspecifythe namingofthevariouscolumns.Someexternalsystemsrequirea headerlinewhenyousupplythemwithdataviaaflatfile thatisplacedsomewhere.Theheader lineisthefirstlinein the flatfile output. Withinthisline,the variouscolumnnames are specified forclarity.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. 24 24 25 - Toaddsucha headerline in eMagizyouneedtonavigateto theCreatephase ofeMagiz and openthe exitflowin whichyou wanttodropthefiletocertainlocation.Within thecontextof thisflow, we need to add functionality that willensure thata header line iswrittentotheoutputbeforeanyfunctionalnesareadded. Todosofirstenter"StartEditing"modeonflowlevel.Afteryou have donesopleaseadd afile outboundchanneladapter totheflow includinganinputchannel.Wewill usethis component towrite ourheader line totheflatfile output.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: 26 26 27 -Ensure that the directory to which you reference is the same as in your functional file outbound channel adapter. 29 +- File to string transformer 30 +- Flat file to XML transformer 31 +- File outbound channel adapter 28 28 29 - [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--file-outbound-channel-header-line.png]]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. 30 30 31 - Nowit is time to turn ourattentionto the Advanced tab.For theMode select Ignore. Select this option to ensure that the headerlineisonly writtendown oncewhen thereis no output createdyet andnot somewhere inthe middle, in the end, or every time. Furthermore, selecttheoption Append New Line to ensuret theremainderof theinformationis not appended to the same line.35 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-characterset--characterset-configuration.png]] 32 32 33 - [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--file-outbound-channel-header-line-advanced.png]]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. 34 34 35 - After you have done so we need to add a standard transformerthatdefinesthe variouscolumn names to be written to the flat fileoutput. To doso add thetandard transformer component to the canvas including an input channel. AfteryouhavedonesodefinetherelevantSpEL expression.In thiscase, we advise using apropertyvaluethat representsa string ofcolumn names. The value ofthepropertyshould besomething as follows:39 +Congratulations you have successfully learned how to specify the character set. 36 36 37 -'Header1;Header2;Header3;Header4' 38 - 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. 40 - 41 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--define-columns-names.png]] 42 - 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: 44 - 45 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--wiretap-result.png]] 46 - 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. 48 - 49 49 == 4. Assignment == 50 50 51 -Configure an e xit in which you defineand write aheaderlineoa flat-fileoutputbefore addingfunctionallines.43 +Configure an entry in which you define the component and configuration needed to process a file on a per-line basis. 52 52 This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment. 53 53 54 54 == 5. Key takeaways == 55 55 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 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 59 59 60 60 == 6. Suggested Additional Readings == 61 61 62 - Thereare no suggestedadditionalreadingson thistopic55 +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: 63 63 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 + 64 64 == 7. Silent demonstration video == 65 65 66 66 This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned. 67 67 68 -{{video attachment="novice-file-based-connectivity-h eader-line.mp4" reference="Main.Videos.Microlearning.WebHome"/}}65 +{{video attachment="novice-file-based-connectivity-characterset.mp4" reference="Main.Videos.Microlearning.WebHome"/}} 69 69 70 70 )))((({{toc/}}))){{/container}}{{/container}}