Skip to Content
Last modified by Erik Bakker on 2025/02/25 16:09
Show last authors
1 {{container}}
2 {{container layoutStyle="columns"}}(((
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.
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 ==
13 This microlearning centers around updating an eMagiz Mendix Connector
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.
15
16 To update an eMagiz Mendix Connector you need the following:
17
18 * The Mendix Module called the eMagiz Mendix Connector (available in eMagiz under Deploy of your project)
19 * Access to a Mendix project which has an eMagiz Mendix Connector in it at this moment.
20
21 == 3. Update an eMagiz Mendix Connector ==
22
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.
25
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.
30
31 [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-emagiz-mendix-connector--emc-download-screen.png]]
32
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}}
35
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.
37
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..."
40
41 [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-update-emagiz-mendix-connector--import-module-package.png]]
42
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)
44
45 [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-update-emagiz-mendix-connector--import-module-package-selection.png]]
46
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"
51 ** In the screen that follows press the "Download" button.
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
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
61 [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-update-emagiz-mendix-connector--import-module-package-replace-existing-module.png]]
62
63 You may be prompted with a warning pop-up the moment you update to a newer version. Make a screenshot and press OK.
64
65 [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-update-emagiz-mendix-connector--import-module-package-java-update-warning.png]]
66
67 === 3.3 Cleaning up the project ===
68
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
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}}
87
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
95 == 4. Key takeaways ==
96
97 * The crucial part of updating an eMagiz Mendix Connector is to select the correct version that will work with your Mendix project
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).
99 * The actual installation in Mendix is simply importing a module package and selecting the correct one. As easy as can be.
100
101 == 5. Suggested Additional Readings ==
102
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"]]
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"]]
113
114 )))((({{toc/}}))){{/container}}{{/container}}