Changes for page Configure your SOAP web service
Last modified by Erik Bakker on 2024/08/26 12:38
From 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.
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 -no vice-soap-webservice-connectivity-configure-your-soap-webservice1 +Annotations - Content
-
... ... @@ -1,10 +1,10 @@ 1 1 {{container}}{{container layoutStyle="columns"}}((( 2 -n s omecases,the inputyoureceiveor theoutputthat youneedtosendtoanexternalpartycannothandleallcharactersortheinputor outputiswrittenwith thehelp ofaaracter set. Inthismicrolearning,wewill learnhowyoucandefinethecharacter set forfile-basedconnectivity toensurethatoucanprocess anddeliverfilesaccordingtopecifications.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,56 +12,66 @@ 12 12 13 13 == 2. Key concepts == 14 14 15 -This microlearning centers around learning how to define the character set to ensure that eMagiz processes the information 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 character set, we mean: The compositenumberof differentcharacters that are being used and supported by computer software and hardware. It consistsofcodes, bit patterns,or natural numbersusedin defining some particular character.18 +Annotations can be used for: 18 18 19 -* Someexternalsystem talkin adifferentcharacter set20 -* e Magiz talksin default UTF-8 as acharacter set andassumes everyoneelse alsodoesthis21 -* In casesof mismatch correctisatthe pointwhereyoutalk with the other system(i.e. entry or exit)20 +* 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. Characterset==24 +== 3. Annotations == 24 24 25 -In s omecases,the inputyoureceiveortheoutput thatyouneedtosendtoanexternalpartycannothandle all charactersortheinputroutputis written withthehelpofacharacter set.In thismicrolearning,we willlearnw youcan definethecharacterset forfile-basedconnectivitytoensurethatyoucanprocessand deliverfiles accordingto thespecifications.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 - Sometimes external systems only talk in a specific character set. Toensurethatall the datais properly communicated between eMagiz and the othersystemwe need to make sure that we define which character set that is so we cantellit to eMagiz via a component. That way eMagiz will deviate from its default (i.e. UTF-8) and will process thefile accordingto 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:28 +Annotations can be used for: 28 28 29 - -Filetostring transformer30 - -Flat file toXMLtransformer31 - -Fileoutboundchanneladapter30 +* Describing a best practice everyone should follow 31 +* Describing (more complex) parts of the flow 32 +* Describe (parts of) your message definitions 32 32 33 - Inallthese componentsyouhave theoptiontodefine the character setwithin theAdvancedtabofthecomponent. In thismicrolearning,wewilluse theFile to stringtransformerto illustrate howthat will look.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: 34 34 35 -[[image:Main.Images.Microlearning.WebHome@novice- file-based-connectivity-characterset--characterset-configuration.png]]36 +[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--annotation-best-practice-async-routing.png]] 36 36 37 - In this field,youcanefinethecharactersetof yourchoice.Tomakethiswork in eMagizyouneed to navigate totheCreatephaseofeMagiz and opentheentryflowinwhichyou want to retrievethefile toacertainlocation.Withintheontextofthisflow, weneedtoaddfunctionality that willensurethatthecorrectcharactersetis used.Todosofirstenter"Start Editing" modeon flowlevel.Afterthat open,theFile to stringtransformer, navigateto theAdvanced tab,and fill inthe correctcharacter set. After you have definedthe correctcharacter set the onlything leftto do is to Savethe component.See thesuggestedadditional readingssection on the completelist of charactersets that aresupported by Java 8.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: 38 38 39 - Congratulations you haveuccessfully learned how toifythecharacterset.40 +[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--describe-parts-of-flow.png]] 40 40 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: 43 + 44 +[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--describe-crucial-part-of-cdm.png]] 45 + 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. 47 + 48 +[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--annotation-icon-context-menu.png]] 49 + 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. 51 + 52 +Now you know what annotations are good for and how you can add them within the eMagiz platform. 53 + 41 41 == 4. Assignment == 42 42 43 - 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. 44 44 This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment. 45 45 46 46 == 5. Key takeaways == 47 47 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 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. 52 52 53 53 == 6. Suggested Additional Readings == 54 54 55 - Ifyouareinterestedin this topicandwant moreinformationon it pleasereadthe help text provided by eMagizandreadthefollowing links:69 +There are no suggested additional readings on this topic 56 56 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 - 61 61 == 7. Silent demonstration video == 62 62 63 63 This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned. 64 64 65 -{{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"/}} 66 66 67 67 )))((({{toc/}}))){{/container}}{{/container}}