Changes for page Configure your SOAP web service
Last modified by Erik Bakker on 2024/08/26 12:38
From version 30.1
edited by Erik Bakker
on 2022/06/10 13:22
on 2022/06/10 13:22
Change comment:
There is no comment for this version
To version 27.1
edited by Erik Bakker
on 2022/06/10 13:05
on 2022/06/10 13:05
Change comment:
Deleted image "novice-devops-perspectives-annotations--describe-parts-of-flow.png"
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 - ProcessingaFile per Line1 +Annotations - Content
-
... ... @@ -1,10 +1,10 @@ 1 1 {{container}}{{container layoutStyle="columns"}}((( 2 -In s ome cases,youwantreateachuniquepart ofyourinputfile asitsmessage insteadofprocessing the complete fileasits message.Inhismicrolearning,we willlearnhowyoucanprocessa (large)fileon aper-linebasis.2 +In this microlearning, we will focus on using annotations to clarify your thought process. In the annotation, you either describe a best practice everyone should follow when they change that flow (i.e. within the asynchronous routing), describe how the (more complex) parts of the flow work or describe (parts of) of your message definitions (i.e. CDM, API Gateway Data model, system message, etc.). This will help yourself and others every time changes are needed. 3 3 4 4 Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]]. 5 5 6 -* Last update: May 31th, 20217 -* Required reading time: 7minutes6 +* Last update: May 9th, 2021 7 +* Required reading time: 5 minutes 8 8 9 9 == 1. Prerequisites == 10 10 ... ... @@ -12,84 +12,57 @@ 12 12 13 13 == 2. Key concepts == 14 14 15 -This microlearning centers around learning how to process an incoming file per line. 15 +This microlearning centers around using annotations. 16 +With annotations, we mean: A piece of text to explain something to yourself and others 16 16 17 - By processing per line, we mean: Splitting up the input intodiscernable piecesthateach willbecomeaunique message18 +Annotations can be used for: 18 18 19 -* Easy way ofreading afilelinebylineandsendingit toeMagiz (Lowon memory)20 -* Abilitytoprocesseachlinebasedondistinctive logic that is relevantonline level21 -* Canbeusedforflat fileaswellas XMLinputfiles20 +* Describing a best practice everyone should follow 21 +* Describing (more complex) parts of the flow 22 +* Describe (parts of) your message definitions 22 22 23 -== 3. ProcessingaFile per Line==24 +== 3. Annotations == 24 24 25 -In s ome cases,youwantreateachuniquepart ofyourinputfile asits messageinsteadofprocessingthe completefileasitsmessage.Inthismicrolearning,wewilllearnhow youcanprocessa (large)fileon aper-linebasis.26 +In this microlearning, we will focus on using annotations on the flow level to clarify our thought process. In the annotation, you either describe a best practice everyone should follow when they change that flow (i.e. within the asynchronous routing) or describe how the (more complex) parts of the flow work. This will help yourself and others every time changes are needed within the flow. 26 26 27 - To make this work ineMagiz youneed tonavigate to the Create phase of eMagiz andopenthe entry flow in which you want to retrieve the file to a certain location. Within the context of thisflow, we need to add functionality that will ensurethat each line is read and processed separately and willbecomeitsunique message. Todosofirst enter "Start Editing" mode on flow level. Afteryou 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.28 +Annotations can be used for: 28 28 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. 30 +* Describing a best practice everyone should follow 31 +* Describing (more complex) parts of the flow 32 +* Describe (parts of) your message definitions 30 30 31 - [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--file-item-reader-directory.png]]34 +To clarify the use cases let us take a look at how annotations can be added within the eMagiz platform. In our first example, we will take a look at asynchronous routing. In many eMagiz projects, a best practice is followed on how to add something to the asynchronous routing (or change something within the asynchronous routing). Because the best practice contains multiple steps it makes sense to use the annotation functionality of eMagiz to define all these steps and register them at the place you need them (i.e. the asynchronous routing). Having done so will result in something like this: 32 32 33 - Secondly, justas whenreadingthefileas a wholensurehatyou useafilter toretrieveonly thecorrectfilesfromthe directory.36 +[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--annotation-best-practice-async-routing.png]] 34 34 35 - ===3.1Item reader Type===38 +The second example is about using annotations on the flow level to describe parts of the flow. In this example, we will use the annotation to describe that we use a filter to determine which messages are picked up from a local directory and how we filter. That way anyway opening the flow has to merely read the annotation to get the context. Having done so will result in something like this: 36 36 37 - Nowit is timeto select ourItemreader Type. Asthe help text of the eMagizcomponent suggest thereare two choices with this component. The first (and most frequently used)option istheFlat file itemreader. With thisoption, you can read each line within theflat file input file andoutput isata separate message. The second optioniscalledtheStax event item reader. With thisoption, youcanread yourinputXML and output messageson a per-record basis.40 +[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--describe-parts-of-flow.png]] 38 38 39 - [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--item-reader-type-options.png]]42 +The third example does not take place on the flow level but the message definition level. Therefore instead of going to Create, we go to Design. In Design when you navigate to the CDM, API Gateway Data model, Event Streaming Data model, message definitions, etc. you have the option to add annotations to the canvas. In this example, we want to make clear to all that make changes that a certain part of our CDM is used by a lot of integrations within eMagiz and therefore everyone should be careful and think twice before adjusting anything related to that part. Having done so will result in something like this: 40 40 41 - Based onyourchoicethexactconfigurationwilldiffer.44 +[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--describe-crucial-part-of-cdm.png]] 42 42 43 - ====3.1.1StaxEventItemReader====46 +Now that we saw some examples let us turn our attention to the how. How can I add an annotation and how can I link it. Adding the annotation is simple. You drag the annotation icon from the left context menu onto the canvas. As a result, an empty annotation will be shown on the canvas. By double-clicking on it you can type whatever you want. Note that you need to be in "Start Editing" mode to change anything, including annotations. 44 44 45 - For the Staxeventitemreader, you need to definethe nameof the elementon which you want tosplit theXML and definewhether you want tohrowan errorincaseno such elementexistsintheinput file (By (de)selecting theoptionStrict). Thedefaultsetting of eMagiz is advisable for this option.48 +[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--annotation-icon-context-menu.png]] 46 46 47 - [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--stax-event-item-reader-config.png]]50 +When you are satisfied with what you have written down you can press the Save button. After you have done so you can rescale the annotation to ensure that the complete text is visible. To link the annotation to a component (on flow level) or an entity (on message definition level) you hover over the annotation until your mouse indicator changes to a + icon, execute a right-click and drag from the annotation to the component in question. 48 48 49 - ====3.1.2FlatFileItemReader====52 +Now you know what annotations are good for and how you can add them within the eMagiz platform. 50 50 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 - 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 - 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 - 60 -For the remainder of this microlearning, we will assume that the option pass through line mapper is chosen. 61 - 62 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--flat-file-item-reader-passthrough.png]] 63 - 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 - 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 - 82 82 == 4. Assignment == 83 83 84 - Configureanentryinwhich you definethecomponentandconfiguration neededto processa fileona per-line basis.56 +Add annotation on the flow level that describes how (a part of) a flow works. 85 85 This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment. 86 86 87 87 == 5. Key takeaways == 88 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 61 +* Annotations can be used for: 62 + * Describing a best practice everyone should follow 63 + * Describing (more complex) parts of the flow 64 + * Describe (parts of) your message definitions 65 +* You can add annotations by dragging and dropping the annotation icon on the canvas. 93 93 94 94 == 6. Suggested Additional Readings == 95 95 ... ... @@ -99,6 +99,6 @@ 99 99 100 100 This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned. 101 101 102 -{{video attachment="novice- file-based-connectivity-processing-a-file-per-line.mp4" reference="Main.Videos.Microlearning.WebHome"/}}75 +{{video attachment="novice-devops-perspectives-annotations.mp4" reference="Main.Videos.Microlearning.WebHome"/}} 103 103 104 104 )))((({{toc/}}))){{/container}}{{/container}}