Changes for page Calling an Asynchronous Queue in Mendix

Last modified by Erik Bakker on 2025/02/28 09:50

From 21.1 to 21.2 From 30.1 to 31.1

From version 21.2

edited by Erik Bakker
on 2022/06/10 12:14

Change comment: Update document after refactoring.

To version 30.1

edited by Erik Bakker
on 2025/02/28 09:37

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (3 modified, 0 added, 0 removed)

Details

Page properties

Title

@@ -1,1 +1,1 @@
--intermediate-mendix-connectivity-calling-an-asynchronous-webservice-in-mendix
++Calling an Asynchronous Queue in Mendix

Default language

...	...	@@ -1,0 +1,1 @@
	1	+en

Content

@@ -1,96 +1,98 @@
  {{container}}{{container layoutStyle="columns"}}(((
--= Calling an asynchronous web service in Mendix =
++In this microlearning, we will integrate Mendix with eMagiz using the eMagiz Mendix module. Here, we will guide you through calling a synchronous queue in Mendix, essential for efficient data exchange between your systems.
--With the help of the eMagiz Mendix module created by the eMagiz team, you can easily connect between Mendix and eMagiz for data integration. In this microlearning, we will focus on calling an asynchronous web service in Mendix.
--
  Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]].
--* Last update: October 29th, 2021
--* Required reading time: 6 minutes
--
  == 1. Prerequisites ==
  * Intermediate knowledge of the eMagiz platform
--* Access to a Mendix application
++* Access to a Mendix application (potentially via an external party)
  * Access to the Deploy phase of your eMagiz project
--* A connection between Mendix and eMagiz Designed and Created
--* Using eMagiz Mendix version 5.0.0 or higher.
++* A connection between Mendix and eMagiz Designed, Created, and in the active release
++* Using the "eMagiz Connector" in the Mendix Marketplace.
++* Initial [[installation (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Mendix Connectivity.novice-mendix-connectivity-install-emagiz-mendix-connector.WebHome||target="blank"]] done.
++* Initial [[configuration (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Mendix Connectivity.novice-mendix-connectivity-configure-emagiz-mendix-connector.WebHome||target="blank"]] done.
  == 2. Key concepts ==
--This microlearning centers around calling an asynchronous web service in Mendix
--With eMagiz Mendix Connector, we mean: A Mendix module developed and maintained by eMagiz that simplifies connect a Mendix application to an eMagiz project for data traffic between both systems.
++This microlearning centers around calling a synchronous queue in Mendix.
++* With eMagiz Connector, we mean A Mendix module developed and maintained by eMagiz that simplifies connecting a Mendix application to an eMagiz project for data traffic between both systems.
--To call an asynchronous web service in Mendix, you need the following:
++To call a synchronous queue in Mendix, you need the following:
++* The destination (i.e., the queue from which you want to retrieve the information)
  * Execute microflow (the microflow that will process the incoming data)
--* Optionally, you can define an import mapping and subsequent option
++* Optionally, you can define an import mapping and subsequent options.
++{{warning}}All changes in eMagiz need to be activated by adding the changes to the eMagiz release and activating said release. When setting up the initial connection, the Mendix system must be **in** the eMagiz release before connecting from Mendix to eMagiz with an **activation key**.{{/warning}}
++== 3. Calling a synchronous queue in Mendix ==
--== 3. Calling an asynchronous web service in Mendix ==
++With the help of the Mendix module (called eMagiz Connector) created by the eMagiz team, you can easily connect between Mendix and eMagiz for data integration. This microlearning will focus on calling a synchronous queue in Mendix. For sending data to Mendix, we offer three options to send data:
--With the help of the eMagiz Mendix module created by the eMagiz team, you can easily connect between Mendix and eMagiz for data integration. In this microlearning, we will focus on calling an asynchronous web service in Mendix. For sending data to Mendix, we offer two options to send data:
++* Using the import and export mapping to send data to Mendix.
++* Sending a string to and from Mendix without using the import and export mapping.
++* Any combination of the two above.
--* Using the import mapping to send data to Mendix
--* Sending a string message directly to Mendix
++Below, we will detail how to configure each option for sending data synchronously to Mendix.
--Alternatively, you could use the eMagiz Kafka connector to connect to the event broker that eMagiz offers. For more information on that, please check out this [microlearning](intermediate-event-streaming-connectors-using-kafka-module-mendix.md).
++=== 3.1 Sending synchronous messages with import and export mapping ===
--Below, we will detail how to configure each option for sending data asynchronously to Mendix.
++To send data to Mendix, you must define several configuration options in the Mendix project. In this example, we will look at the configuration using the import and export mapping in Mendix. In the subsequent paragraph, we will look at configuring the exit if you do **not** want to use the import and export mapping.
--=== 3.1 Sending asynchronous messages with import mapping ===
++In eMagiz, you will see a flow in Create that you cannot edit, as the autogenerated functionality provided by eMagiz is all you need. Once done, make sure the flow is transported to Deploy and ready to be used in a Mendix application by adding it to a release.
--To send data to Mendix, you need to define several configuration options in the exit flow within the eMagiz portal. You want to connect your eMagiz solution to Mendix. In this example, we will look at the configuration for when you want to use the import mapping in Mendix. In the subsequent paragraph, we will take a closer look at how to configure the exit in case you do **not** want to use the import mapping.
++{{info}}The exit version must be altered when you change your system messages in Design.{{/info}}
--You will see the following overview within the exit flow, which you can configure (if in "Start Editing" mode). Here, you need to define the import mapping (complete name in Mendix including module name) and the execute microflow (complete name in Mendix including module name).
++In parallel, earlier or later, the Mendix application needs to be developed to handle the message's consumption and respond to the request with a response mapping. This is done by adding the following configuration to the existing "After Startup" microflow.
--[[image:Main.Images.Microlearning.WebHome@intermediate-mendix-connectivity-calling-an-asynchronous-webservice-in-exit-flow-config.png]]
++==== 3.1.1 Startup action ====
++In Mendix, you must add the "StartSyncMessageConsumer" Java Action to the after startup flow. The most important configuration items here are the following.
--When selecting the import mapping, several additional options need to be chosen within the exit. What each specific option does is detailed in the accompanying help text. Below you will see an example of how you could configure this.
++[[image:Main.Images.Microlearning.WebHome@intermediate-mendix-connectivity-calling-a-synchronous-webservice-in-mendix-start-consumer.png]]
++
++* The destination (i.e., the queue from which you want to consume the **request** messages). This can be supplied by the eMagiz developer or found under Deploy -> Mendix Connectors should you have access to the eMagiz model in question.
++* The export and import mapping (based on the system message definitions). These definitions can be determined by the eMagiz developer (and then shared with the Mendix developer) or determined by the Mendix developer (and then shared with the eMagiz developer).
++* The microflow that handles the incoming message and returns a result.
--[[image:Main.Images.Microlearning.WebHome@intermediate-mendix-connectivity-calling-an-asynchronous-webservice-in-exit-flow-config-import-mapping-specific.png]]
++[[image:Main.Images.Microlearning.WebHome@intermediate-mendix-connectivity-calling-a-synchronous-webservice-in-mendix-on-receive-microflow-config.png]]
--Note that the Range is a critical piece of the configuration as it defines whether the root of the result of the import mapping is a list (All), a single object (First), or a limited list (Custom). Note that the parameter of your import microflow should match this to prevent errors. So, for example, when your parameter upon the import microflow is an Object, you should select the option First. If the parameter on your import microflow is a List, you should select the option All. In cases where you want to reduce the number of entries in the List, you can use the Custom option to reduce the amount to a predefined limit.
++=== 3.2 Sending synchronous messages without import and export mapping ===
--When satisfied with this setup, please create a new version of the flow and include it in your latest release. That will allow Mendix to retrieve the newest version upon the next restart of Mendix (or by manually downloading the release in Mendix).
++We just saw the example when working with the import and export mapping. Now we turn our attention to an instance without those mappings. In these cases, the string is just passed to the execute microflow, and you can determine in Mendix yourself what to do with it. The same applies to the export part of the logic.
--=== 3.2 Sending asynchronous messages without import mapping ===
++In eMagiz, you will see a flow in Create that you cannot edit, as the autogenerated functionality provided by eMagiz is all you need. Once done, make sure the flow is transported to Deploy and ready to be used in a Mendix application by adding it to a release.
--We just saw the example when working with the import mapping. Now we turn our attention to an instance without import mapping. In these cases, the string is just passed to the execute microflow, and you can determine in Mendix yourself what to do with it.
++{{info}}The version of your exit needs to be altered when you make changes to your system messages in Design.{{/info}}
--You will see the following overview within the exit flow, which you can configure (if in "Start Editing" mode). Here you need to define the execute microflow (complete name in Mendix including module name).
++In parallel, earlier or later, the Mendix application needs to be developed to handle the consumption of the message and respond to the request with a response mapping. This is done by adding the following configuration to the existing "After Startup" microflow.
--[[image:Main.Images.Microlearning.WebHome@intermediate-mendix-connectivity-calling-an-asynchronous-webservice-in-exit-flow-config-string.png]]
++==== 3.1.1 Startup action ====
++In Mendix, you must add the "StartSyncStringConsumer" Java Action to the after startup flow. The most important configuration items here are the following.
--When satisfied with this setup, please create a new version of the flow and include it in your latest release. That will allow Mendix to retrieve the newest version upon the next restart of Mendix (or by manually downloading the release in Mendix).
++[[image:Main.Images.Microlearning.WebHome@intermediate-mendix-connectivity-calling-a-synchronous-webservice-in-mendix-start-consumer-string.png]]
++
++* The destination (i.e., the queue from which you want to consume the **request** messages). This can be supplied by the eMagiz developer or found under Deploy -> Mendix Connectors should you have access to the eMagiz model in question.
++* The microflow that handles the incoming message and returns a result.
++[[image:Main.Images.Microlearning.WebHome@intermediate-mendix-connectivity-calling-a-synchronous-webservice-in-mendix-on-receive-microflow-config-string.png]]
++== 4. Key takeaways ==
--== 4. Assignment ==
++To call a synchronous queue in Mendix, you need the following:
--The assignment is simple this time. Configure the exit flow to send data to Mendix correctly. Ideally, work on both options.
--This assignment can be completed with the help of an associated Mendix project linked to the (Academy) project that you have created/used in the previous assignment.
--
--== 5. Key takeaways ==
--
--To call an asynchronous web service in Mendix, you need the following:
--
++* The destination (i.e., the queue from which you want to retrieve the information)
  * Execute microflow (the microflow that will process the incoming data)
--* Optionally, you can define an import mapping and subsequent option
--* Setting the Range option correctly is critical to prevent 'unexpected' errors
++* Optionally, you can define an import mapping and subsequent options.
--Note: To make a connection in allowing data to travel between A and B, you need to fill in the correct constants and set up your Keystore and Truststore correctly. For more information check out this [course](novice-mendix-connectivity-index.md)
++{{warning}} To make a connection in allowing data to travel between A and B, you need to [[install (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Mendix Connectivity.novice-mendix-connectivity-install-emagiz-mendix-connector.WebHome||target="blank"]] and do a basic [[configuration (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Mendix Connectivity.novice-mendix-connectivity-configure-emagiz-mendix-connector.WebHome||target="blank"]] before you can set up this specific communication.{{/warning}}
++== 5. Suggested Additional Readings ==
++If you are interested in this topic and want more information, please read the release notes provided by eMagiz that accompany the eMagiz Mendix Connector version you have selected. Furthermore, check out these links:
--== 6. Suggested Additional Readings ==
++* [[Novice Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Novice.WebHome||target="blank"]]
++** [[Mendix Connectivity (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Mendix Connectivity.WebHome||target="blank"]]
++* [[Mendix Connectivity (Search Results)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&l_space_facet=10&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=%22mendix+connectivity%22||target="blank"]]
--If you are interested in this topic and want more information, please read the release notes provided by eMagiz that accompany the eMagiz Mendix Connector version you have selected.
--
--== 7. Silent demonstration video ==
--
--We have opted not to make a video on this for now.
--The pictures and text provided above should give you enough guidance to configure the connection between Mendix and eMagiz.
--
  )))((({{toc/}}))){{/container}}{{/container}}