Skip to Content
Last modified by Erik Bakker on 2025/02/25 16:09
Hide last authors
Erik Bakker 6.1 1 {{container}}
2 {{container layoutStyle="columns"}}(((
Carlijn Kokkeler 17.1 3 In this microlearning, we’ll guide you through the process of updating the eMagiz Mendix Connector for your Mendix application. This connector module, maintained by eMagiz, simplifies the integration between Mendix and eMagiz projects. We’ll cover how to download the latest version, import it into Mendix, and perform the necessary cleanup to ensure a smooth transition to the updated connector. By following these steps, you'll keep your integration running smoothly with the latest features and improvements.
Erik Bakker 1.1 4
5 Should you have any questions, please contact academy@emagiz.com.
6
7 == 1. Prerequisites ==
8 * Basic knowledge of the eMagiz platform
9 * Access to a Mendix application
10 * Access to the Deploy phase of your eMagiz project
11
12 == 2. Key concepts ==
Erik Bakker 4.1 13 This microlearning centers around updating an eMagiz Mendix Connector
Erik Bakker 15.1 14 With eMagiz Mendix 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.
Erik Bakker 1.1 15
Erik Bakker 4.1 16 To update an eMagiz Mendix Connector you need the following:
Erik Bakker 1.1 17
Erik Bakker 2.1 18 * The Mendix Module called the eMagiz Mendix Connector (available in eMagiz under Deploy of your project)
Erik Bakker 4.1 19 * Access to a Mendix project which has an eMagiz Mendix Connector in it at this moment.
Erik Bakker 1.1 20
Erik Bakker 11.1 21 == 3. Update an eMagiz Mendix Connector ==
Erik Bakker 1.1 22
Erik Bakker 11.1 23 === 3.1 Download the eMagiz Mendix connector via eMagiz ===
24 To update the eMagiz Mendix Connector in a Mendix app you first have to download it. You can download it from the eMagiz portal or via the Mendix marketplace.
Erik Bakker 1.1 25
Erik Bakker 11.1 26 ==== 3.1.1 Download the eMagiz Mendix connector ====
27 * To retrieve the eMagiz Mendix connector from the portal execute the following steps.
28 ** Log in at eMagiz and then go to one of the busses you have access to.
29 ** Go to **Deploy -> On Premises -> Runtime Downloads**. Here you can download the eMagiz Mendix connector.
Erik Bakker 1.1 30
Erik Bakker 5.1 31 [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-emagiz-mendix-connector--emc-download-screen.png]]
32
Erik Bakker 11.1 33 {{info}}You must look at the column Mendix version. It must correspond to the Mendix version of the project where you want to use the eMagiz Mendix Connector.
34 If you do not do this then the connector will **not** work.{{/info}}
Erik Bakker 5.1 35
Erik Bakker 4.1 36 Now that we have downloaded the correct eMagiz Mendix connector (the latest version that is available for the Mendix version of our project and newer compared to the current one) we can open Mendix itself.
Erik Bakker 3.1 37
Erik Bakker 2.1 38 If you open your Project in Mendix you can navigate to the left-hand panel called "Project Explorer". In this panel, you see all modules (box icons) that are currently in the project.
39 In Project Explorer, right-click and choose the option "Import module package..."
Erik Bakker 1.1 40
Erik Bakker 4.1 41 [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-update-emagiz-mendix-connector--import-module-package.png]]
Erik Bakker 1.1 42
Erik Bakker 2.1 43 In the pop-up that follows select the correct eMagiz Mendix Connector version and press Open / Openen (depending on the language settings of your PC)
Erik Bakker 1.1 44
Erik Bakker 4.1 45 [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-update-emagiz-mendix-connector--import-module-package-selection.png]]
Erik Bakker 1.1 46
Erik Bakker 11.1 47 ==== 3.1.2 Download the eMagiz Mendix connector via Mendix ====
48 * To retrieve the eMagiz Mendix connector from the Mendix Marketplace execute the following steps.
49 ** Open your Mendix model via Mendix Studio Pro and then select the "Marketplace" option in the right panel
50 ** Search for "eMagiz Mendix" and select the item called "eMagiz Mendix Connector"
Erik Bakker 12.1 51 ** In the screen that follows press the "Download" button.
Erik Bakker 11.1 52
53 [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-emagiz-mendix-connector--mendix-marketplace-download-screen.png]]
54
55 Once downloaded, the following steps need to be performed.
56
57 === 3.2 Importing eMagiz Mendix connector ===
58
Erik Bakker 2.1 59 As a result, Mendix will show you the following pop-up. In this pop-up you press Import and Mendix will import the eMagiz Mendix Connector for you.
60
Erik Bakker 4.1 61 [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-update-emagiz-mendix-connector--import-module-package-replace-existing-module.png]]
Erik Bakker 2.1 62
Erik Bakker 4.1 63 You may be prompted with a warning pop-up the moment you update to a newer version. Make a screenshot and press OK.
Erik Bakker 2.1 64
Erik Bakker 4.1 65 [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-update-emagiz-mendix-connector--import-module-package-java-update-warning.png]]
Erik Bakker 2.1 66
Erik Bakker 11.1 67 === 3.3 Cleaning up the project ===
Erik Bakker 2.1 68
Erik Bakker 4.1 69 After you have updated to a new version of the eMagiz Mendix Connector you must clean the project before you do a new commit.
70 Otherwise, it can happen that the communication between Mendix and eMagiz will take place based on the old instead of the new version.
71
72 ==== 3.3.1 Run the eMagiz Cleanup Tool
73
74 When you navigate to **Project -> Show Project Directory in Explorer -> resources** you will see one Jar file which you can run called the emagiz-cleanup-tool.
75
76 [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-update-emagiz-mendix-connector--emagiz-cleanup-tool.png]]
77
78 Run this cleanup tool by double-clicking on it to make sure that all ties to the old eMagiz Mendix Connector version are cut. In the pop-up that follows select the button Cleanup
79
80 [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-update-emagiz-mendix-connector--emagiz-cleanup-tool-result.png]]
81
82 After you have pressed Cleanup eMagiz will tell you whether or not this has succeeded. Below you see a successful result
83
84 [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-update-emagiz-mendix-connector--emagiz-cleanup-tool-success.png]]
85
Erik Bakker 14.1 86 {{warning}}Note that the eMagiz cleanup tool may not clean up all relevant user libraries, especially when using other Marketplace modules or when the user library is outdated. You can experience this when running the new version for the first time. If this happens, please use the list provided by the Cleanup tool when nothing needs to be removed (according to the cleanup tool).{{/warning}}
Eva Torken 10.1 87
Erik Bakker 4.1 88 ==== 3.3.2 Cleanup Deployment Directory
89
90 As the pop-up states, the next step to finish up the update of your eMagiz Mendix Connector is to clean up your deployment directory.
91 You can simply do this by navigating to **Project -> Clean Deployment Directory** and selecting that option.
92
93 Congratulations, you have successfully updated your eMagiz Mendix Connector to the latest available version.
94
Eva Torken 9.1 95 == 4. Key takeaways ==
Erik Bakker 1.1 96
Erik Bakker 4.1 97 * The crucial part of updating an eMagiz Mendix Connector is to select the correct version that will work with your Mendix project
Erik Bakker 6.1 98 ** To select the correct eMagiz Mendix Connector version look at the Mendix version your app is running in (8.0.0+,7.0.0+, etc.) and look at which of the versions eMagiz has released is the newest version (that is newer compared to the current version).
Erik Bakker 2.1 99 * The actual installation in Mendix is simply importing a module package and selecting the correct one. As easy as can be.
Erik Bakker 1.1 100
Eva Torken 9.1 101 == 5. Suggested Additional Readings ==
Erik Bakker 1.1 102
Carlijn Kokkeler 16.1 103 * [[Novice (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Novice.WebHome||target="blank"]]
104 ** [[Mendix Connectivity (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Mendix Connectivity.WebHome||target="blank"]]
105 *** [[What is an eMagiz Mendix Connector (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Mendix Connectivity.novice-mendix-connectivity-what-is-an-emagiz-mendix-connector.WebHome||target="blank"]]
106 *** [[Install an eMagiz Mendix Connector (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Mendix Connectivity.novice-mendix-connectivity-install-emagiz-mendix-connector.WebHome||target="blank"]]
107 *** [[Configure an eMagiz Mendix Connector (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Mendix Connectivity.novice-mendix-connectivity-configure-emagiz-mendix-connector.WebHome||target="blank"]]
Erik Bakker 18.1 108 * [[Support (Menu)>>doc:Main.eMagiz Support.WebHome||target="blank"]]
109 ** [[Migration Paths (Navigation)>>doc:Main.eMagiz Support.Migration Paths.WebHome||target="blank"]]
110 *** [[eMagiz Mendix Connector 3.0.0 -> 5.0.0 (Explanation)>>doc:Main.eMagiz Support.Migration Paths.migration-path-emagiz-mendix-connector-300-to-500||target="blank"]]
111 *** [[eMagiz Mendix Connector 4.2.0 -> 5.0.0 (Explanation)>>doc:Main.eMagiz Support.Migration Paths.migration-path-emagiz-mendix-connector-420-to-500||target="blank"]]
112 * [[Mendix (Search Result)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=%22mendix%22||target="blank"]]
Erik Bakker 1.1 113
114 )))((({{toc/}}))){{/container}}{{/container}}