Last modified by Erik Bakker on 2024/08/26 12:38
From version 30.2
edited by Erik Bakker
on 2022/06/10 13:23
Change comment: Update document after refactoring.
To version 7.1
edited by eMagiz
on 2022/05/22 21:29
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,0 @@
1 -novice-file-based-connectivity-characterset
Parent
... ... @@ -1,1 +1,0 @@
1 -WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ebakker
1 +XWiki.marijn
Content
... ... @@ -1,96 +1,84 @@
1 -{{container}}{{container layoutStyle="columns"}}(((
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.
1 +{{html wiki="true"}}
2 +<div class="ez-academy">
3 + <div class="ez-academy_body">
3 3  
4 -Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 +<div class="doc">
5 5  
6 -* Last update: May 31th, 2021
7 -* Required reading time: 7 minutes
8 8  
9 -== 1. Prerequisites ==
10 10  
11 -* Basic knowledge of the eMagiz platform
9 += Annotations =
12 12  
13 -== 2. Key concepts ==
11 +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.
14 14  
15 -This microlearning centers around learning how to process an incoming file per line.
13 +Should you have any questions, please contact academy@emagiz.com.
16 16  
17 -By processing per line, we mean: Splitting up the input into discernable pieces that each will become a unique message
15 +* Last update: May 9th, 2021
16 +* Required reading time: 5 minutes
18 18  
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
18 +== 1. Prerequisites ==
22 22  
23 -== 3. Processing a File per Line ==
20 +* Basic knowledge of the eMagiz platform
24 24  
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.
22 +== 2. Key concepts ==
26 26  
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.
24 +This microlearning centers around using annotations.
25 +With annotations, we mean: A piece of text to explain something to yourself and others
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.
27 +Annotations can be used for:
30 30  
31 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--file-item-reader-directory.png]]
29 +* Describing a best practice everyone should follow
30 +* Describing (more complex) parts of the flow
31 +* Describe (parts of) your message definitions
32 32  
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.
34 34  
35 -=== 3.1 Item reader Type ===
36 36  
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.
35 +== 3. Annotations ==
38 38  
39 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--item-reader-type-options.png]]
37 +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.
40 40  
41 -Based on your choice the exact configuration will differ.
39 +Annotations can be used for:
42 42  
43 -==== 3.1.1 Stax Event Item Reader ====
41 +* Describing a best practice everyone should follow
42 +* Describing (more complex) parts of the flow
43 +* Describe (parts of) your message definitions
44 44  
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.
45 +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:
46 46  
47 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--stax-event-item-reader-config.png]]
47 +<p align="center">[[image:novice-devops-perspectives-annotations--annotation-best-practice-async-routing.png||]]</p>
48 48  
49 -==== 3.1.2 Flat File Item Reader ====
49 +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:
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
51 +<p align="center">[[image:novice-devops-perspectives-annotations--describe-parts-of-flow.png||]]</p>
55 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).
53 +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:
57 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.
55 +<p align="center">[[image:novice-devops-perspectives-annotations--describe-crucial-part-of-cdm.png||]]</p>
59 59  
60 -For the remainder of this microlearning, we will assume that the option pass through line mapper is chosen.
57 +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.
61 61  
62 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--flat-file-item-reader-passthrough.png]]
59 +<p align="center">[[image:novice-devops-perspectives-annotations--annotation-icon-context-menu.png||]]</p>
63 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.
61 +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.
65 65  
66 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--flat-file-item-reader-passthrough-advanced.png]]
63 +Now you know what annotations are good for and how you can add them within the eMagiz platform.
67 67  
68 -=== 3.2 Poller ===
65 +===== Practice =====
69 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 -Configure an entry in which you define the component and configuration needed to process a file on a per-line basis.
69 +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
74 +* Annotations can be used for:
75 + * Describing a best practice everyone should follow
76 + * Describing (more complex) parts of the flow
77 + * Describe (parts of) your message definitions
78 +* You can add annotations by dragging and dropping the annotation icon on the canvas.
93 93  
80 +
81 +
94 94  == 6. Suggested Additional Readings ==
95 95  
96 96  There are no suggested additional readings on this topic
... ... @@ -99,6 +99,11 @@
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"/}}
90 +<iframe width="1280" height="720" src="../../vid/microlearning/novice-devops-perspectives-annotations.mp4" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
103 103  
104 -)))((({{toc/}}))){{/container}}{{/container}}
92 +</div>
93 +
94 +</div>
95 +</div>
96 +
97 +{{/html}}
novice-devops-perspectives-annotations--annotation-best-practice-async-routing.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.marijn
Size
... ... @@ -1,0 +1,1 @@
1 +25.7 KB
Content
novice-devops-perspectives-annotations--annotation-icon-context-menu.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.marijn
Size
... ... @@ -1,0 +1,1 @@
1 +774 bytes
Content
novice-devops-perspectives-annotations--describe-crucial-part-of-cdm.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.marijn
Size
... ... @@ -1,0 +1,1 @@
1 +15.5 KB
Content
novice-devops-perspectives-annotations--describe-parts-of-flow.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.marijn
Size
... ... @@ -1,0 +1,1 @@
1 +18.9 KB
Content