Wiki source code of Calling an Asynchronous Queue in Mendix
Last modified by Erik Bakker on 2025/02/28 09:50
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
20.1 | 1 | {{container}}{{container layoutStyle="columns"}}((( |
| |
31.1 | 2 | In this microlearning, we will integrate Mendix with eMagiz using the eMagiz Mendix module. Here, we will guide you through calling an asynchronous queue in Mendix, essential for efficient data exchange between your systems. |
| |
1.1 | 3 | |
| |
20.1 | 4 | Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]]. |
| |
1.1 | 5 | |
| 6 | == 1. Prerequisites == | ||
| 7 | |||
| 8 | * Intermediate knowledge of the eMagiz platform | ||
| |
30.1 | 9 | * Access to a Mendix application (potentially via an external party) |
| |
1.1 | 10 | * Access to the Deploy phase of your eMagiz project |
| |
30.1 | 11 | * A connection between Mendix and eMagiz Designed, Created, and in the active release |
| 12 | * Using the "eMagiz Connector" in the Mendix Marketplace. | ||
| |
32.1 | 13 | * Initial [[installation>>doc:Main.eMagiz Academy.Microlearnings.Novice.Mendix Connectivity.novice-mendix-connectivity-install-emagiz-mendix-connector.WebHome||target="blank"]] done. |
| 14 | * Initial [[configuration>>doc:Main.eMagiz Academy.Microlearnings.Novice.Mendix Connectivity.novice-mendix-connectivity-configure-emagiz-mendix-connector.WebHome||target="blank"]] done. | ||
| |
1.1 | 15 | |
| 16 | == 2. Key concepts == | ||
| 17 | |||
| |
31.1 | 18 | This microlearning centers around calling an asynchronous queue in Mendix. |
| 19 | * 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. | ||
| |
1.1 | 20 | |
| |
31.1 | 21 | To call an asynchronous queue in Mendix, you need the following: |
| |
1.1 | 22 | |
| |
30.1 | 23 | * The destination (i.e., the queue from which you want to retrieve the information) |
| |
1.1 | 24 | * Execute microflow (the microflow that will process the incoming data) |
| |
30.1 | 25 | * Optionally, you can define an import mapping and subsequent options. |
| |
1.1 | 26 | |
| |
30.1 | 27 | {{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}} |
| |
1.1 | 28 | |
| |
31.1 | 29 | == 3. Calling an asynchronous queue in Mendix == |
| |
1.1 | 30 | |
| |
31.1 | 31 | 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 an asynchronous queue in Mendix. For sending data to Mendix, we offer three options to send data: |
| |
1.1 | 32 | |
| |
31.1 | 33 | * Using the import mapping to send data to Mendix. |
| 34 | * Sending a string to Mendix without using the import mapping. | ||
| |
30.1 | 35 | * Any combination of the two above. |
| |
1.1 | 36 | |
| |
31.1 | 37 | Below, we will detail how to configure each option for sending data asynchronously to Mendix. |
| |
1.1 | 38 | |
| |
31.1 | 39 | === 3.1 Sending asynchronous messages with import and export mapping === |
| |
1.1 | 40 | |
| |
31.1 | 41 | 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 mapping in Mendix. In the subsequent paragraph, we will look at configuring the exit if you do **not** want to use the import mapping. |
| |
1.1 | 42 | |
| |
30.1 | 43 | 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. |
| |
1.1 | 44 | |
| |
30.1 | 45 | {{info}}The exit version must be altered when you change your system messages in Design.{{/info}} |
| |
1.1 | 46 | |
| |
31.1 | 47 | In parallel, earlier or later, the Mendix application needs to be developed to handle the message's consumption. This is done by adding the following configuration to the existing "After Startup" microflow. |
| |
1.1 | 48 | |
| |
30.1 | 49 | ==== 3.1.1 Startup action ==== |
| |
31.1 | 50 | In Mendix, you must add the "StartMessageConsumer" Java Action to the after startup flow. The most important configuration items here are the following. |
| |
1.1 | 51 | |
| |
31.1 | 52 | [[image:Main.Images.Microlearning.WebHome@intermediate-mendix-connectivity-calling-an-asynchronous-webservice-in-mendix-start-consumer.png]] |
| |
30.1 | 53 | |
| |
31.1 | 54 | * The destination (i.e., the queue from which you want to consume the 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. |
| 55 | * The 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). | ||
| 56 | * The microflow that handles the incoming message. | ||
| |
1.1 | 57 | |
| |
31.1 | 58 | [[image:Main.Images.Microlearning.WebHome@intermediate-mendix-connectivity-calling-an-asynchronous-webservice-in-mendix-on-receive-microflow-config.png]] |
| |
1.1 | 59 | |
| |
31.1 | 60 | === 3.2 Sending asynchronous messages without import and export mapping === |
| |
1.1 | 61 | |
| |
31.1 | 62 | We just saw the example when working with the import mapping. Now we turn our attention to an instance without that 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. |
| |
1.1 | 63 | |
| |
30.1 | 64 | 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. |
| |
1.1 | 65 | |
| |
30.1 | 66 | {{info}}The version of your exit needs to be altered when you make changes to your system messages in Design.{{/info}} |
| |
1.1 | 67 | |
| |
30.1 | 68 | 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. |
| |
1.1 | 69 | |
| |
30.1 | 70 | ==== 3.1.1 Startup action ==== |
| |
31.1 | 71 | In Mendix, you must add the "StartStringConsumer" Java Action to the after startup flow. The most important configuration items here are the following. |
| |
30.1 | 72 | |
| |
31.1 | 73 | [[image:Main.Images.Microlearning.WebHome@intermediate-mendix-connectivity-calling-an-asynchronous-webservice-in-mendix-start-consumer-string.png]] |
| |
30.1 | 74 | |
| 75 | * 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. | ||
| 76 | * The microflow that handles the incoming message and returns a result. | ||
| 77 | |||
| |
31.1 | 78 | [[image:Main.Images.Microlearning.WebHome@intermediate-mendix-connectivity-calling-an-asynchronous-webservice-in-mendix-on-receive-microflow-config-string.png]] |
| |
30.1 | 79 | |
| |
25.1 | 80 | == 4. Key takeaways == |
| |
1.1 | 81 | |
| |
31.1 | 82 | To call an asynchronous queue in Mendix, you need the following: |
| |
1.1 | 83 | |
| |
30.1 | 84 | * The destination (i.e., the queue from which you want to retrieve the information) |
| |
1.1 | 85 | * Execute microflow (the microflow that will process the incoming data) |
| |
30.1 | 86 | * Optionally, you can define an import mapping and subsequent options. |
| |
1.1 | 87 | |
| |
32.1 | 88 | {{warning}} To make a connection in allowing data to travel between A and B, you need to [[install>>doc:Main.eMagiz Academy.Microlearnings.Novice.Mendix Connectivity.novice-mendix-connectivity-install-emagiz-mendix-connector.WebHome||target="blank"]] and do a basic [[configuration>>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}} |
| |
1.1 | 89 | |
| |
25.1 | 90 | == 5. Suggested Additional Readings == |
| |
1.1 | 91 | |
| |
28.2 | 92 | 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: |
| |
1.1 | 93 | |
| |
28.2 | 94 | * [[Novice Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Novice.WebHome||target="blank"]] |
| 95 | ** [[Mendix Connectivity (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Mendix Connectivity.WebHome||target="blank"]] | ||
| 96 | * [[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"]] | ||
| |
1.1 | 97 | |
| |
20.1 | 98 | )))((({{toc/}}))){{/container}}{{/container}} |