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 2.1
edited by Erik Bakker
on 2022/06/12 10:00
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 +Install an eMagiz Mendix Connector
Content
... ... @@ -1,11 +1,11 @@
1 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.
2 +In this microlearning, we will focus on installing an eMagiz Mendix Connector.
3 +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
7 +* Last update: January 27th, 2021
8 +* Required reading time: 5 minutes
9 9  
10 10  == 1. Prerequisites ==
11 11  * Basic knowledge of the eMagiz platform
... ... @@ -13,50 +13,61 @@
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
16 +This microlearning centers around installing 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:
19 +To install 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)
21 +* The Mendix Module called the eMagiz Mendix Connector (available in eMagiz under Deploy of your project)
22 +* Access to a Mendix project which has no eMagiz Mendix Connector in it at this moment.
25 25  
26 26  
27 27  
28 -== 3. What is an eMagiz Mendix Connector
26 +== 3. Install an 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.
28 +To install the eMagiz Mendix Connector in a Mendix app, the following steps need to be performed.
31 31  
32 -Key aspects of the eMagiz Mendix Connector:
30 +=== 3.1 Download the eMagiz Mendix connector
31 +* The eMagiz Mendix connector can be downloaded via eMagiz. Log in and then go to one of the busses you have access to.
32 +* Go to **Deploy -> On Premises -> Runtime Downloads** the eMagiz Mendix connector can be downloaded.
33 +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.
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)
36 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-install-emagiz-mendix-connector--emc-download-screen.png]]
37 +
38 +=== 3.2 Importing eMagiz Mendix connector
39 +Now that we have downloaded the correct eMagiz Mendix connector (the latest version that is available for the Mendix version of our project) 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.
41 +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.
42 +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.
44 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-install-emagiz-mendix-connector--import-module-package.png]]
42 42  
46 +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  
48 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-install-emagiz-mendix-connector--import-module-package-selection.png]]
44 44  
50 +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.
51 +
52 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-install-emagiz-mendix-connector--import-module-package-add-as-new-module.png]]
53 +
54 +In the following microlearnings, we will focus on configuring the eMagiz Mendix Connector and updating the eMagiz Mendix Connector.
55 +
56 +
57 +
45 45  == 4. Assignment ==
46 46  
47 -As this is a theoretical microlearning there is no assignment that you need to complete
60 +The assignment is simple this time. Just install an eMagiz Mendix Connector.
61 +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.
48 48  
49 49  == 5. Key takeaways ==
50 50  
51 -Key aspects of the eMagiz Mendix Connector:
65 +* The crucial part of installing an eMagiz Mendix Connector is to select the correct version that will work with your Mendix project
66 + ** 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.
67 +* The actual installation in Mendix is simply importing a module package and selecting the correct one. As easy as can be.
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)
57 57  
58 58  
59 -
60 60  == 6. Suggested Additional Readings ==
61 61  
62 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.
... ... @@ -63,6 +63,8 @@
63 63  
64 64  == 7. Silent demonstration video ==
65 65  
66 -As this is a theoretical microlearning there is no video
77 +This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned. Disclaimer, you don't see the pop-up appearing in Mendix but if you follow the above steps you are good to go!
67 67  
79 +{{video attachment="novice-mendix-connectivity-install-emagiz-mendix-connector.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
80 +
68 68  )))((({{toc/}}))){{/container}}{{/container}}