Changes for page SOAP Headers
Last modified by Erik Bakker on 2024/08/26 12:48
From version 27.2
edited by Erik Bakker
on 2022/06/10 13:08
on 2022/06/10 13:08
Change comment:
Update document after refactoring.
To version 44.1
edited by Eva Torken
on 2023/06/27 12:13
on 2023/06/27 12:13
Change comment:
There is no comment for this version
Summary
-
Page properties (4 modified, 0 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 - novice-file-based-connectivity-header-line1 +SOAP Headers - Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki.e bakker1 +XWiki.etorken - Default language
-
... ... @@ -1,0 +1,1 @@ 1 +en - Content
-
... ... @@ -1,77 +1,57 @@ 1 1 {{container}}{{container layoutStyle="columns"}}((( 2 - Inthismicrolearning,we willfocusonusingannotations toclarifyyour thoughtprocess. In theannotation,youeitherdescribeabest practice everyoneshouldfollow when theychangethatflow(i.e.within the asynchronousrouting),describehowthe(moreomplex)partsoftheflow work ordescribe(partsof) of yourmessagedefinitions(i.e.CDM,APIGatewayDatamodel,systemmessage,etc.).This will help yourselfand others everytimechangesareneeded.2 +When communicating via SOAP web service calls it can happen that an exchange of data needs to happen between the message headers on your message and the SOAP headers. In this microlearning, we will learn about this exchange in both directions. SOAP Headers are headers within a SOAP Envelope that can be used to communicate metadata or authentication information between parties. 3 3 4 -Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].4 +Should you have any questions, please contact academy@emagiz.com. 5 5 6 -* Last update: May 9th, 2021 7 -* Required reading time: 5 minutes 8 - 9 9 == 1. Prerequisites == 10 - 11 11 * Basic knowledge of the eMagiz platform 12 12 13 13 == 2. Key concepts == 10 +This microlearning centers around SOAP Headers. 14 14 15 -This microlearning centers around using annotations. 16 -With annotations, we mean: A piece of text to explain something to yourself and others 12 +By SOAP Headers, we mean: headers within a SOAP Envelope that can be used to communicate metadata or authentication information between parties 17 17 18 -Annotations can be used for: 14 +You can exchange data from: 15 +* SOAP Header to Message Header 16 +* Message Header to SOAP Header 19 19 20 -* Describing a best practice everyone should follow 21 -* Describing (more complex) parts of the flow 22 -* Describe (parts of) your message definitions 18 +In both cases ensure that the correct information is exchanged. 23 23 24 -== 3. A nnotations ==20 +== 3. SOAP Headers == 25 25 26 - Inthismicrolearning,wewillfocuson usingannotationsontheflowleveltoclarifyourthoughtprocess.In thennotation,youeitherdescribe abestpractice everyoneshouldfollow when theychangethat flow(i.e.withinthesynchronousrouting)ordescribe howthe(morecomplex) partsoftheflowwork. Thiswillhelpyourself and otherseverytimehangesareneeded within theflow.22 +When communicating via SOAP web service calls it can happen that an exchange of data needs to happen between the message headers on your message and the SOAP headers. In this microlearning, we will learn about this exchange in both directions. SOAP Headers are headers within a SOAP Envelope that can be used to communicate metadata or authentication information between parties. 27 27 28 -Annotations can be used for: 24 +You can exchange data from: 25 +* SOAP Header to Message Header 26 +* Message Header to SOAP Header 29 29 30 -* Describing a best practice everyone should follow 31 -* Describing (more complex) parts of the flow 32 -* Describe (parts of) your message definitions 28 +In both cases ensure that the correct information is exchanged. 33 33 34 - Toclarifytheecasesletustakea lookathowannotationscanbeaddedwithin theeMagiz platform.Inourfirst example, we willtake a look at asynchronousrouting.In manyeMagizprojects,abest practice is followed on how toadd somethingtotheasynchronous routing (orchangesomething within the asynchronous routing). Becausethebest practiceainsmultipletepsitmakessense tousethe annotationfunctionalityofeMagiztodefine all thesestepsandregisterthemattheplaceyouneedthem(i.e.theasynchronousrouting).Havingdonesowillresultin something like this:30 +In a previous microlearning, we already discussed one aspect of this. As you probably recall from our microlearning on [[Securing your SOAP Webservice>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-securing-your-soap-webservice||target="blank"]] we needed to exchange data between the SOAP header that our client was sending and a message header on the message so we could check whether or not the client was authorized to call the operation. 35 35 36 - [[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--annotation-best-practice-async-routing.png]]32 +In that microlearning, we also discussed the component that we need for this. The 'complex SOAP header mapper'. 37 37 38 - The second exampleisabout usingnnotations on theflow level to describe partsof the flow. In thisexample, we will use the annotationto describe that we use a filter todeterminewhich messagesarepicked up from a local directory and how wefilter. That wayanywayopening theflow hastoerely read the annotation to get thecontext. Havingdoneso willresult in somethinglike this:34 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-soap-headers--complex-soap-header-mapper.png]] 39 39 40 - [[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--describe-parts-of-flow.png]]36 +As you can see you can map from and to message headers with regards to the SOAP Headers. As we already discussed the first scenario in an earlier microlearning I will for now continue with the other scenario. This scenario is mainly needed when eMagiz calls a SOAP web service that is hosted by an external party. Since we would normally do this in an exit (gate/flow) let us open such an exit in eMagiz and enter "Start Editing" mode. 41 41 42 -The thirdexampledoesnot takeplaceon the flowlevelbut themessagedefinitionlevel.Therefore insteadofgoingtoCreate,wego toDesign.InDesignwhenyounavigateto theCDM,API GatewayDatamodel,EventStreamingDatamodel, message definitions, etc.you havetheoption to addannotationsto the canvas.Inthisexample,we wantto makeclear to allthatmakechangesthatacertain part of ourCDMissedbya lotofintegrations withineMagizandthereforeryoneshouldbecareful and think twicebefore adjustinganythingrelatedtothatpart.Havingdone sowillresultinsomethinglikethis:38 +The first step we need to take is to ensure that the information that we need to send to the SOAP web service in question (in this a unique reference number) is available in a message header. This can be done by verifying in all steps that preceded before the message entered the exit whether or not this piece of information was already added to a message header. In this case, we assume that this is the case since we want to focus on the 'complex SOAP header mapper' component and its relation to the web services outbound gateway. To correctly exchange data from a message header to a SOAP header we need to define a valid SpEL expression. See the help text of the component for a suggestion of what a valid SpEL expression is. The key part in this is knowing how the external party wants to receive the header(s) and how you (or one of your colleagues) has named the message header. When you have those two information elements you can write the correct expression. The result should be something as follows: 43 43 44 -[[image:Main.Images.Microlearning.WebHome@novice- devops-perspectives-annotations--describe-crucial-part-of-cdm.png]]40 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-soap-headers--mapping-from-message-header.png]] 45 45 46 - Now that wesaw someexampleslet usturn ourattention to thehow.HowcanIaddanannotation andhow can Ilinkit. Adding theannotation issimple. You dragtheannotation icon from theleftcontextmenu onto thecanvas. As a result, an empty annotationwill be shown on thecanvas. By double-clicking on it you can typewhatever youwant. Note that youeedto be in "StartEditing" modeto change anything, including annotations.42 +Once you are satisfied you can press Save and link the support object to the web service outbound gateway. 47 47 48 - [[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--annotation-icon-context-menu.png]]44 +With this information, you can place SOAP Headers on message headers and vice versa every time you need it. 49 49 50 - Whenyou are satisfied with what you have written down you can press the Save button.Afteryouhave done so you can rescaletheannotation to ensure that the complete text is visible. To linkthennotation to a component (on flowlevel) oran entity(on messagedefinition 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.46 +== 4. Key takeaways == 51 51 52 -Now you know what annotations are good for and how you can add them within the eMagiz platform. 48 +* You can exchange data from: 49 + ** SOAP Header to Message Header 50 + ** Message Header to SOAP Header 51 +* You need the SOAP structure and the message header name to make it work 53 53 54 -== 4.Assignment==53 +== 5. Suggested Additional Readings == 55 55 56 -Add annotation on the flow level that describes how (a part of) a flow works. 57 -This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment. 55 +If you are interested in this topic and want more information on it please read the help text provided by eMagiz. 58 58 59 -== 5. Key takeaways == 60 - 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. 66 - 67 -== 6. Suggested Additional Readings == 68 - 69 -There are no suggested additional readings on this topic 70 - 71 -== 7. Silent demonstration video == 72 - 73 -This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned. 74 - 75 -{{video attachment="novice-devops-perspectives-annotations.mp4" reference="Main.Videos.Microlearning.WebHome"/}} 76 - 77 77 )))((({{toc/}}))){{/container}}{{/container}}