Skip to Content
Last modified by Erik Bakker on 2025/02/25 16:09
From version 1.2
edited by Erik Bakker
on 2022/06/12 09:59
Change comment: Update document after refactoring.
To version 13.1
edited by Erik Bakker
on 2024/06/06 09:16
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -novice-mendix-connectivity-install-emagiz-mendix-connector
1 +Update an eMagiz Mendix Connector
Content
... ... @@ -1,12 +1,10 @@
1 -{{container}}{{container layoutStyle="columns"}}(((
2 -In this microlearning, we will focus on determining what an eMagiz Mendix Connector is.
3 -This insight will help you the moment you will start using the eMagiz Mendix Connector.
1 +{{container}}
2 +{{container layoutStyle="columns"}}(((
3 +In this microlearning, we will focus on updating an eMagiz Mendix Connector.
4 +With the help of this Mendix module created by the eMagiz team, you can easily connect between Mendix and eMagiz for data integration.
4 4  
5 5  Should you have any questions, please contact academy@emagiz.com.
6 6  
7 -* Last update: March 25th, 2021
8 -* Required reading time: 4 minutes
9 -
10 10  == 1. Prerequisites ==
11 11  * Basic knowledge of the eMagiz platform
12 12  * Access to a Mendix application
... ... @@ -13,56 +13,96 @@
13 13  * Access to the Deploy phase of your eMagiz project
14 14  
15 15  == 2. Key concepts ==
16 -This microlearning centers around learning what an eMagiz Mendix Connector is
14 +This microlearning centers around updating an eMagiz Mendix Connector
17 17  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.
18 18  
19 -Key aspects of the eMagiz Mendix Connector:
17 +To update an eMagiz Mendix Connector you need the following:
20 20  
21 -* The goal of the module is to simplify the connection between Mendix and eMagiz and therefore enhance the speed of development and reduce the risks of problems
22 -* The Mendix module is developed and maintained by eMagiz
23 -* As of Mendix 8 the inner workings of the module have changed
24 -* No manual actions in Mendix via a Mendix screen are necessary to control the eMagiz parts (as of version 4.2.0)
19 +* The Mendix Module called the eMagiz Mendix Connector (available in eMagiz under Deploy of your project)
20 +* Access to a Mendix project which has an eMagiz Mendix Connector in it at this moment.
25 25  
22 +== 3. Update an eMagiz Mendix Connector ==
26 26  
24 +=== 3.1 Download the eMagiz Mendix connector via eMagiz ===
25 +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.
27 27  
28 -== 3. What is an eMagiz Mendix Connector
27 +==== 3.1.1 Download the eMagiz Mendix connector ====
28 + * To retrieve the eMagiz Mendix connector from the portal execute the following steps.
29 + ** Log in at eMagiz and then go to one of the busses you have access to.
30 + ** Go to **Deploy -> On Premises -> Runtime Downloads**. Here you can download the eMagiz Mendix connector.
29 29  
30 -The eMagiz Mendix Connector is a Mendix module that is developed and maintained by eMagiz that simplifies connecting a Mendix application to an eMagiz project for data traffic between both systems.
32 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-emagiz-mendix-connector--emc-download-screen.png]]
31 31  
32 -Key aspects of the eMagiz Mendix Connector:
34 +{{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.
35 +If you do not do this then the connector will **not** work.{{/info}}
33 33  
34 -* The goal of the module is to simplify the connection between Mendix and eMagiz and therefore enhance the speed of development and reduce the risks of problems
35 -* The Mendix module is developed and maintained by eMagiz
36 -* As of Mendix 8 the inner workings of the module have changed
37 -* No manual actions in Mendix via a Mendix screen are necessary to control the eMagiz parts (as of version 4.2.0)
37 +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.
38 38  
39 -The eMagiz Mendix Connector makes use of Java Actions (Mendix 8 and up) or a web service layer (Mendix 7 and down) to connect Mendix to eMagiz and vice versa. We have changed the connection method to create a process that is better maintainable and easier to realize.
39 +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.
40 +In Project Explorer, right-click and choose the option "Import module package..."
40 40  
41 -In the remainder of the microlearnings within this module, we will learn how you can install, configure and update your eMagiz Mendix Connector. So stay tuned.
42 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-update-emagiz-mendix-connector--import-module-package.png]]
42 42  
44 +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)
43 43  
46 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-update-emagiz-mendix-connector--import-module-package-selection.png]]
44 44  
45 -== 4. Assignment ==
48 +==== 3.1.2 Download the eMagiz Mendix connector via Mendix ====
49 + * To retrieve the eMagiz Mendix connector from the Mendix Marketplace execute the following steps.
50 + ** Open your Mendix model via Mendix Studio Pro and then select the "Marketplace" option in the right panel
51 + ** Search for "eMagiz Mendix" and select the item called "eMagiz Mendix Connector"
52 + ** In the screen that follows press the "Download" button.
46 46  
47 -As this is a theoretical microlearning there is no assignment that you need to complete
54 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-emagiz-mendix-connector--mendix-marketplace-download-screen.png]]
55 +
56 +Once downloaded, the following steps need to be performed.
48 48  
49 -== 5. Key takeaways ==
58 +=== 3.2 Importing eMagiz Mendix connector ===
50 50  
51 -Key aspects of the eMagiz Mendix Connector:
60 +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.
52 52  
53 -* The goal of the module is to simplify the connection between Mendix and eMagiz and therefore enhance the speed of development and reduce the risks of problems
54 -* The Mendix module is developed and maintained by eMagiz
55 -* As of Mendix 8 the inner workings of the module have changed
56 -* No manual actions in Mendix via a Mendix screen are necessary to control the eMagiz parts (as of version 4.2.0)
62 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-update-emagiz-mendix-connector--import-module-package-replace-existing-module.png]]
57 57  
64 +You may be prompted with a warning pop-up the moment you update to a newer version. Make a screenshot and press OK.
58 58  
66 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-update-emagiz-mendix-connector--import-module-package-java-update-warning.png]]
59 59  
60 -== 6. Suggested Additional Readings ==
68 +=== 3.3 Cleaning up the project ===
61 61  
62 -If you are interested in this topic and want more information on it please read the release notes provided by eMagiz that accompany the eMagiz Mendix Connector version you have selected.
70 +After you have updated to a new version of the eMagiz Mendix Connector you must clean the project before you do a new commit.
71 +Otherwise, it can happen that the communication between Mendix and eMagiz will take place based on the old instead of the new version.
63 63  
64 -== 7. Silent demonstration video ==
73 +==== 3.3.1 Run the eMagiz Cleanup Tool
65 65  
66 -As this is a theoretical microlearning there is no video
75 +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.
67 67  
77 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-update-emagiz-mendix-connector--emagiz-cleanup-tool.png]]
78 +
79 +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
80 +
81 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-update-emagiz-mendix-connector--emagiz-cleanup-tool-result.png]]
82 +
83 +After you have pressed Cleanup eMagiz will tell you whether or not this has succeeded. Below you see a successful result
84 +
85 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-update-emagiz-mendix-connector--emagiz-cleanup-tool-success.png]]
86 +
87 +{{warning}}Note that it can happen, especially when using other Marketplace modules or when the user library is outdated, that not all relevant user libraries are cleaned up by the eMagiz cleanup tool. 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}}
88 +
89 +==== 3.3.2 Cleanup Deployment Directory
90 +
91 +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.
92 +You can simply do this by navigating to **Project -> Clean Deployment Directory** and selecting that option.
93 +
94 +Congratulations, you have successfully updated your eMagiz Mendix Connector to the latest available version.
95 +
96 +== 4. Key takeaways ==
97 +
98 +* The crucial part of updating an eMagiz Mendix Connector is to select the correct version that will work with your Mendix project
99 + ** 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).
100 +* The actual installation in Mendix is simply importing a module package and selecting the correct one. As easy as can be.
101 +
102 +== 5. Suggested Additional Readings ==
103 +
104 +If you are interested in this topic and want more information on it please read the release notes provided by eMagiz that accompany the eMagiz Mendix Connector version you have selected.
105 +
68 68  )))((({{toc/}}))){{/container}}{{/container}}