Changes for page Endpoint Check
Last modified by Danniar Firdausy on 2024/09/04 10:26
From version 35.2
edited by Erik Bakker
on 2022/06/12 09:35
on 2022/06/12 09:35
Change comment:
Update document after refactoring.
To version 34.2
edited by Erik Bakker
on 2022/06/12 09:34
on 2022/06/12 09:34
Change comment:
Update document after refactoring.
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 -novice-soap-webservice-connectivity- validate-incoming-messages1 +novice-soap-webservice-connectivity-calling-a-soap-webservice - Content
-
... ... @@ -1,100 +1,92 @@ 1 -{{container}}{{container layoutStyle="columns"}}((( 2 -When t alkingtoexternalpartiesvia aSOAPwebservice youneedtodefinein eMagizthat youwantto callaSOAPwebsoeMagizwill formacorrectSOAPmessage.Ontopofthecallthereisa supportobjectin eMagizthatwillhelpyou withthe analysis ofyourproblems whencallingtheSOAP web service.In thismicrolearning,wewill learnhowto calla SOAP web servicefrom eMagiz.1 +{{container}}{{container layoutStyle="columns"}}((( 2 +When setting up a point at which your customers can talk to you eMagiz offers various methods of creating such a point. One of those options is by hosting a SOAP Webservice in eMagiz that handles XML messages asynchronously or synchronously. In this microlearning, we will learn the basics of this configuration in the various phases of the platform so you can easily set up your SOAP web service. 3 3 4 4 Should you have any questions, please contact academy@emagiz.com. 5 5 6 -* Last update: April1st, 20227 -* Required reading time: 5minutes6 +* Last update: June 10th, 2021 7 +* Required reading time: 7 minutes 8 8 9 9 == 1. Prerequisites == 10 10 * Basic knowledge of the eMagiz platform 11 11 12 12 == 2. Key concepts == 13 -This microlearning centers around c allingaSOAPWebservice.13 +This microlearning centers around configuring your SOAP web service. 14 14 15 - WithSOAP, we mean:A messagingprotocol specificationforexchanging structured informationimplementationof web services in computer networks.15 +By configuring, we mean: Designing and determining the characteristics of the SOAP web service 16 16 17 - * TocallaRESTWebserviceyouneed either:18 - *A Web Service OutboundGateway19 -* Criticalinformation when configuring thiscomponent:20 - *URL21 - *Retry Advice22 - ** Error Handling23 - ** Authentication17 +Crucial parts in the configuration are: 18 +* Operation Name 19 +* SOAP Webservice Namespace 20 +* Validation 21 +* Authentication 22 + 23 +Of these four points, the last two will be discussed in separate microlearnings. 24 24 25 -== 3. C allingaSOAP Webservice ==25 +== 3. Configure your SOAP Webservice == 26 26 27 -When t alkingtoexternalpartiesvia aSOAPwebservice youneedtodefinein eMagizthat youwantto callaSOAPwebsoeMagizwill formacorrectSOAPmessage.Ontopofthecallthereisa supportobjectin eMagizthatwillhelpyou withthe analysis ofyourproblems whencallingtheSOAP web service.In thismicrolearning,wewill learnhowto calla SOAP web servicefrom eMagiz.27 +When setting up a point at which your customers can talk to you eMagiz offers various methods of creating such a point. One of those options is by hosting a SOAP Webservice in eMagiz that handles XML messages asynchronously or synchronously. In this microlearning, we will learn the basics of this configuration in the various phases of the platform so you can easily set up your SOAP web service. 28 28 29 -Calling a SOAP Webservice within eMagiz can be done with the help of a Web Service Outbound Gateway. To correctly configure this component you need to consider the following elements: 30 - 31 -* URL 32 -* Retry Advice 33 -* Error Handling 29 +Crucial parts in the configuration are: 30 +* Operation Name 31 +* SOAP Webservice Namespace 32 +* Validation 34 34 * Authentication 35 35 36 - We will discuss thefirstthree itemsin thislistinthis microlearning.Inthemicrolearningsthat willfollow thismicrolearning,we willdelvedeeper intovarious authenticationpossibilities.35 +Of these four points, the last two will be discussed in separate microlearnings. In this microlearning, we will focus on the first two aspects of the configuration. As you might have noticed I did not mention the fact whether the integration is synchronous or asynchronous as a crucial part of the configuration. The reason being that when configuring a (SOAP) web service you always need to send an acknowledgment back to the client calling the web service to let them know what the status of the message is. In case you want to set up the rest of your integration asynchronously you can send an empty message back as acknowledgment. In case you want to set up the rest of your integration synchronously you need to send the response you have received from the backend operation back to the client. More on the choice between asynchronous and synchronous in a later stage. 37 37 38 - Beforewedelve into the configuration of the component let us first move to Create and open an exit flow inwhich we want to call theSOAP Webservice. When you open the exit flow it will look similar to this:37 +=== 3.1 Operation Name === 39 39 40 - [[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--exit-flow-starting-point.png]]39 +Let us first zoom in on the parts of the configuration before we learn how you can implement it in eMagiz. Starting with the operation name. When you have dealt with the API Gateway offering of eMagiz in the past or have some knowledge of how APIs work the notion of an operation name should not be unfamiliar. In essence, it is a unique name that defines a certain operation. In eMagiz the best practice for naming the operation is as follows: 41 41 42 - Nowthat wehave openedheflow and arein "Start Editing"modewe need toaddtheweb service outbound gateway to start with.41 +* Send{technicalnameoftheoperation} 43 43 44 - [[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component.png]]43 +When you are in Create you will notice that eMagiz uses the default suffix of Request and Response is added to the operation name. Therefore the full operation name a client needs to call to get the desired result if you adhere to the best practice is: 45 45 46 - ===3.1 URL ===45 +* Send{technicalnameoftheoperation}Request 47 47 48 - Nowthat we have added the correct component to the canvas it has become time to configure the component correctly.The first thing to configure when calling aSOAP Webserviceis determiningand registering the endpoint (URL) eMagiz should call to deliver themessage too. As always in scenarios where an information element can change between environments, you should use aproperty referenceand determine thecorrectvalue on a per-environment basis.47 +=== 3.2 SOAP Webservice Namespace === 49 49 50 - [[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-url.png]]49 +The second part of the configuration is the SOAP Webservice Namespace. When hosting a SOAP Webservice via the standard eMagiz tooling you need to define a namespace. To smoothen this process eMagiz automatically generates a namespace based on the configuration settings you choose in the Design phase of eMagiz. 51 51 52 -=== 3. 2RetryAdvice ===51 +=== 3.3 Configuration in eMagiz === 53 53 54 - The secondsettingwe needtoconfigureisthe retry advice. Withretry advice,youcanguardyoursolutionagainsttemporary connectionlossesbetween eMagizandtheexternalparty. As this can happenfromtimetotime thebestpracticeis to configuresuchaRetryAdviceonveryWeb ServiceOutboundcomponent.ToaddtheRetry AdvicemovetotheAdvancedtabandmovedownto theRequesthandleradvice chainsegment.Within this segment, youwillsee abuttoncalledRetryAdvice.53 +Now that we know what configurations are required, we can see how we can implement this in eMagiz. In the Capture phase, nothing changes. You simply draw a system on the canvas including at least one line that goes from the system towards eMagiz. When you are done you move to the Design phase in eMagiz. In this phase, you need to correctly set up the operation name(s) and the SOAP Webservice Namespace. 55 55 56 - [[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-retry-advice-button.png]]55 +The configuration in Design starts at the system level. At the system level, you need to define the technical name (or let eMagiz automatically fill it in for you) and select the checkbox called Combined Entry Connector. By selecting this checkbox you tell eMagiz that you want to host an endpoint for others to call. 57 57 58 - Whenyou clickon theRetry Adviceuttonyou will beprompted withaop-up. In hereyouneedtoconfigurethexact settings57 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice--combined-entry-check.png]] 59 59 60 - [[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-retry-advice-pop-up-empty.png]]59 +As you can see, selecting this option opens up a new choice to make. In this case between SOAP Webservice and Custom. 61 61 62 -The best practice for this configuration is as follows for asynchronous solutions: 63 -* Select the option called Simple Retry Policy 64 -* Set the max attempts at 6 65 -* Select the Fixed back off policy 66 -* Set the backoff period at 5000 (ms) 61 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice--combined-entry-choice.png]] 67 67 68 - Whenyou have done sotheconfigurationshouldlookas follows.Theonlything leftisto press Saveto saveyourRetry Adviceconfiguration63 +In this case, we opt for the SOAP web service. After you have done so eMagiz will automatically define the SOAP Webservice Name and SOAP Webservice Namespace. 69 69 70 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-c alling-a-soap-webservice--web-service-outbound-component-retry-advice-pop-up-filled-in.png]]65 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice--combined-entry-soap-ws-namespace.png]] 71 71 72 - ===3.3ErrorHandling===67 +With this, you are done with your configuration on the system level. Don't forget to update the status of your task. Now that we have configured the system it is time to configure the integration that is drawn from the system to eMagiz. We can do so by double-clicking on it (or by accessing the context menu and selecting the edit option). When you open the Edit page on the integration level you will notice that a new segment is added (compared to other integrations). This segment defines the settings on the system level we have just specified and defines the operation name. 73 73 74 - When callingaSOAP Webservice with the configuration wehave defined up till here you could suffer from crypticrror response you get backwhen the SOAP weball fails. Toimprovehe error handlingto makeyour life easier when analyzingthe problemyouneed to add a support object to the canvasand link it totheweboutbound gateway. This supportobjectisnamed "Detailed SOAP FaultMessage Resolver".69 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice--edit-integration.png]] 75 75 76 - Tolinkthesupport objecttoyourwebservice outboundgatewayyouopen thewebserviceoutbound gateway,navigatetotheAdvancedtab,and selecttheFaultmessageresolver. AfterwardpressSaveto save thelinkbetween thecomponents.71 +As you can see eMagiz has already prefilled the operation name for you based on the best practice at eMagiz. If you want to change you have the option to do so. Do note that for the sake of consistency it would be smart to use the same naming convention within a single project to avoid confusion. 77 77 78 - [[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-fault-message-resolver.png]]73 +=== 3.4 Add integration to Create === 79 79 80 -Now that we have configure dtheHTTPOutboundcomponenttoourlikingwe can pressSave on thecomponentleveltostore ourchanges.Asaresult theflowwill lookas follows:75 +Now that we have finished the configuration in Design the last step of this microlearning is to add the integration to Create. You can simply do so by navigating to Create -> Add integrations and selecting the integration to move it to Create. After you have selected it press Save to add the integration to Create. 81 81 82 -[[image:Main.Images.Microlearning.WebHome@microlearning/novice-soap-webservice-connectivity-calling-a-soap-webservice--flow-result.png]] 83 - 84 84 == 4. Assignment == 85 85 86 - Buildaflowwithinyour projectinwhichyoudoacalltoanxternalparty thathostsaSOAPwebservice.79 +Configure a SOAP web service that consists of at least one operation and add it to Create. 87 87 This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment. 88 88 89 89 == 5. Key takeaways == 90 90 91 -* eMagiz will create a valid SOAP message when using this component 92 -* eMagiz provides a support object for better error handling of SOAP faults 93 -* There are four key configuration elements: 94 - ** URL 95 - ** Retry Advice 96 - ** Error Handling 84 +* Crucial parts in the configuration are: 85 + ** Operation Name 86 + ** SOAP Webservice Namespace 87 + ** Validation 97 97 ** Authentication 89 +* For ease, you can use the default naming convention of eMagiz 98 98 99 99 == 6. Suggested Additional Readings == 100 100 ... ... @@ -102,6 +102,6 @@ 102 102 103 103 == 7. Silent demonstration video == 104 104 105 -{{video attachment="novice-soap-webservice-connectivity-c alling-a-soap-webservice.mp4" reference="Main.Videos.Microlearning.WebHome"/}}97 +{{video attachment="novice-soap-webservice-connectivity-configure-your-soap-webservice.mp4" reference="Main.Videos.Microlearning.WebHome"/}} 106 106 107 107 )))((({{toc/}}))){{/container}}{{/container}}