Changes for page Volume Mapping (On-premise)
Last modified by Erik Bakker on 2024/08/26 12:37
From version 33.1
edited by Erik Bakker
on 2022/06/10 13:46
on 2022/06/10 13:46
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 -A rchiving1 +Annotations - Content
-
... ... @@ -1,10 +1,10 @@ 1 1 {{container}}{{container layoutStyle="columns"}}((( 2 -In mostcases, the customerwants some kind of insurance policy to determinewhethera filehasenteredor left eMagiz. Oneway of supplyingsuch functionality for file-baseddataexchangeisthroughheuse of archivingfunctionality.Withthehelpofthis functionalitycanyou easily write thefileasreceived(orabouttobeent)to a separate location.Byensuringthatthedata staysin that locationforaertainamountoftime andbygivingthe customerand yourselfaccess youhaveasortofaudit trailthatdetailsthemessagesthat havebeenexchanged. This archive could alsobeusedtoanalyzeproblemsin casethingsowrong.In thismicrolearning,we willlearnhowyoucansetup that archiving andlearnhow to cleanupthearchivingtoensurethat data is only kept for a limitedperiod.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: 6minutes6 +* Last update: May 9th, 2021 7 +* Required reading time: 5 minutes 8 8 9 9 == 1. Prerequisites == 10 10 ... ... @@ -12,81 +12,66 @@ 12 12 13 13 == 2. Key concepts == 14 14 15 -This microlearning centers around learning how to archive correctly. 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 archiving, we mean: Temporarily storing data for audit purposesandpossibleretryscenarios.18 +Annotations can be used for: 18 18 19 -* Archivingisusedforuditpurposes20 -* Archivingis used forretryscenarios21 -* Ensurethatdataiscleanedafter a retentionperiodto keepin control of the data20 +* 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. A rchiving==24 +== 3. Annotations == 24 24 25 -In mostcases, the customerwants some kind of insurance policy to determinewhethera filehasenteredor left eMagiz. Oneway of supplyingsuch functionalityforfile-baseddataexchangeisthroughheuse of archivingfunctionality.Withthehelpofthis functionalitycanyou easily write thefileasreceived(orabouttobeent)to a separate location.Byensuring that thedatastays in that locationfor a certain amountof timeandby givingthe customerand yourselfaccess youhave a sortofaudittrailthat detailsthemessagesthat have beenexchanged. Thisarchive couldalsobeusedtoanalyzeproblemsin casethingsgo wrong.In thismicrolearning,we willlearnhowyoucansetup that archiving andlearnhow to cleanupthearchivingtoensurethatdatais onlykept for alimited period.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 - === 3.1Archivingitself===28 +Annotations can be used for: 28 28 29 -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 archive the files. Within the context of this flow, we need to add functionality that will ensure that each input file is archived and cleaned up when older than three days. To do so first enter "Start Editing" mode on flow level. The first decision we have to take is how we are going to name the files within the archiving. The best practice, in this case, is the original filename + the current time as a suffix. You can define this by dragging a format file name generator (support object) to the canvas. 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-archiving--file-name-generator.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 - After we have done this pleasedd a file outbound channel adaptertothe flow includingannputchannel. Ensurethat you use aproperty for the directorythatreferencesher directory comparedto theinput directory topreventreatingan infinite loop.36 +[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--annotation-best-practice-async-routing.png]] 34 34 35 - [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-archiving--archiving-config-file-outbound-basic.png]]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 - Now that wehave configured the basics let us turnour attention to theadvanced configuration.In theadvanced tabf this component, we need toselect thefile name generator to ensure that the files are namedcorrectly. In case youprocesseach lineseparately you have tochoose whether to savethem asseparate files inhearchiveor by appending them again. Thisan be achievedby selecting the correctMode. In most cases, however, the default Mode ofReplacewill suffice.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-archiving--archiving-config-file-outbound-advanced.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 - Themoment youaresatisfied press Save.Now that we have configured thist becomes time to determine how we get the needed input to write to our archive. In the exampleweare usingherewe want toarchive ourinput file so we need to ensure that the data we receivedis written to the archive as soon aspossible. To do soplacea wiretapon thefirstchannel after retrieving thefile. Thiswill make surethatthe messageisarchivedbefore processed further. The result should be somethingas shown below. Note thatthis same pieceoflogiccouldbe applied inother flows within the eMagiz platform in a similar manner.44 +[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--describe-crucial-part-of-cdm.png]] 42 42 43 - [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-archiving--archiving-result.png]]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 - === 3.2 CleanuptheArchive===48 +[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--annotation-icon-context-menu.png]] 46 46 47 - Toensurethat thedatais notkeptindefinitelyweneedto cleanup the archive.We do sotopreventproblemswithdiskspacebutlsotopreventdataleaksofolddata thatcould impactthe privacyofothers.Beforewe cansetupthelogic in eMagiz weneedtalktothecustomer to seewhatacceptabletermiswithinwhichthedata iskept.In most cases,thisisaweek ortwoweeks.Inhisexample,wehave chosenhreedays.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 -Now thatweknowthe limititistime toconfigure the components.We startwith a compositefile filter (supportobject). Within this filter, weat least definehow old a file mustbe before itcanbedeleted(in milliseconds). If weturn threedaysinto millisecondswe get259200000. Furthermore,wetleastdefine that weonly want to deleteregular files.52 +Now you know what annotations are good for and how you can add them within the eMagiz platform. 50 50 51 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-archiving--file-list-filter-for-archive-cleanup.png]] 52 - 53 -Having done so we can add a file inbound channel adapter to the canvas including an output channel. Ensure that the property reference for the directory matches the one you have used before in the outbound channel adapter. Furthermore link the filter to the component and define the poller according to the best practice. 54 - 55 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-archiving--file-inbound-archive-cleanup.png]] 56 - 57 -One thing we should not forget within this configuration is to set the Max messages per poll on the Advanced tab of the poller-configuration to a sufficiently high number (i.e. 50). If you forget to do so and you only check once a day it will mean that only one message will be deleted that day. 58 - 59 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-archiving--file-inbound-archive-cleanup-max-messages-per-poll.png]] 60 - 61 -Now eMagiz will check on a set time interval whether there are files that are older than three days that are ready for deletion. One last step to go. This last step will ensure that all files that fit the bill will be deleted from the archive. Simply add a standard service activator to the canvas and define the following SPeL expression within the component: payload.delete(). 62 - 63 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-archiving--archive-cleanup-deletion.png]] 64 - 65 -This will ensure that each file that is retrieved will indeed be deleted from the archive. 66 - 67 67 == 4. Assignment == 68 68 69 - Configureanentryinwhichyoubuildthearchivingandtheleanup ofthearchiving.56 +Add annotation on the flow level that describes how (a part of) a flow works. 70 70 This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment. 71 71 72 72 == 5. Key takeaways == 73 73 74 -* Archiving is used for audit purposes 75 -* Archiving is used for retry scenarios 76 -* Ensure that data is cleaned after a retention period to keep in control of the data 77 -* Don't forget the max messages per poll 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. 78 78 79 79 == 6. Suggested Additional Readings == 80 80 81 - Ifyouareinterestedin this topicandwant moreinformationon it pleasereadthe help text provided by eMagizandcheck outthe followingstorecontent:69 +There are no suggested additional readings on this topic 82 82 83 -* [[microlearning>>doc:Main.eMagiz Store.Accelerators.File Archiving.WebHome||target="blank"]] 84 -* [[microlearning>>doc:Main.eMagiz Store.Accelerators.Delete Folder's.WebHome||target="blank"]] 85 - 86 86 == 7. Silent demonstration video == 87 87 88 88 This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned. 89 89 90 -{{video attachment="novice- file-based-connectivity-characterset.mp4" reference="Main.Videos.Microlearning.WebHome"/}}75 +{{video attachment="novice-devops-perspectives-annotations.mp4" reference="Main.Videos.Microlearning.WebHome"/}} 91 91 92 92 )))((({{toc/}}))){{/container}}{{/container}}