Skip to Content
Last modified by Erik Bakker on 2025/02/25 16:09
From version 1.1
edited by Erik Bakker
on 2022/06/12 09:59
Change comment: There is no comment for this version
To version 9.1
edited by Erik Bakker
on 2025/02/25 16:09
Change comment: Renamed back-links.

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -What is an eMagiz Mendix Connector
1 +novice-mendix-connectivity-install-emagiz-mendix-connector
Parent
... ... @@ -1,1 +1,1 @@
1 -Main.eMagiz Academy.Microlearnings.Novice.Mendix Connectivity.WebHome
1 +Main.eMagiz Academy.Microlearnings.Legacy Functionality.WebHome
Content
... ... @@ -1,68 +1,77 @@
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 +(((
4 +In this microlearning, we'll guide you through the process of installing the eMagiz Mendix Connector. This module, developed by eMagiz, helps seamlessly integrate a Mendix application with eMagiz for efficient data exchange. We’ll cover how to download the correct version of the connector from eMagiz, and then import it into your Mendix project. With these steps, you'll be set up and ready to start configuring and using the eMagiz Mendix Connector.
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 ==
9 +
11 11  * Basic knowledge of the eMagiz platform
12 12  * Access to a Mendix application
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
15 +
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  
24 +== 3. Install an eMagiz Mendix Connector ==
26 26  
26 +To install the eMagiz Mendix Connector in a Mendix app, the following steps need to be performed.
27 27  
28 -== 3. What is an eMagiz Mendix Connector
28 +=== 3.1 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.
30 +* The eMagiz Mendix connector can be downloaded via eMagiz. Log in and then go to one of the busses you have access to.
31 +* Go to **Deploy -> On Premises -> Runtime Downloads** the eMagiz Mendix connector can be downloaded.
32 +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.
33 +If you do not do this then the connector will **not** work.
31 31  
32 -Key aspects of the eMagiz Mendix Connector:
35 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-install-emagiz-mendix-connector--emc-download-screen.png]]
36 +
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)
38 +=== 3.2 Importing eMagiz Mendix connector ===
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.
40 +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.
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 +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.
43 +In Project Explorer, right-click and choose the option "Import module package..."
42 42  
45 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-install-emagiz-mendix-connector--import-module-package.png]]
43 43  
47 +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 44  
45 -== 4. Assignment ==
49 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-install-emagiz-mendix-connector--import-module-package-selection.png]]
46 46  
47 -As this is a theoretical microlearning there is no assignment that you need to complete
51 +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.
48 48  
49 -== 5. Key takeaways ==
53 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-install-emagiz-mendix-connector--import-module-package-add-as-new-module.png]]
50 50  
51 -Key aspects of the eMagiz Mendix Connector:
55 +In the following microlearnings, we will focus on configuring the eMagiz Mendix Connector and updating the eMagiz Mendix Connector.
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 +== 4. Key takeaways ==
57 57  
59 +* The crucial part of installing an eMagiz Mendix Connector is to select the correct version that will work with your Mendix project
60 +** 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.
61 +* The actual installation in Mendix is simply importing a module package and selecting the correct one. As easy as can be.
58 58  
63 +== 5. Suggested Additional Readings ==
59 59  
60 -== 6. Suggested Additional Readings ==
65 +* [[Novice (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Novice.WebHome||target="blank"]]
66 +** [[Mendix Connectivity (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Mendix Connectivity.WebHome||target="blank"]]
67 +*** [[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"]]
68 +*** [[Configure an eMagiz Mendix Connector (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Mendix Connectivity.novice-mendix-connectivity-configure-emagiz-mendix-connector.WebHome||target="blank"]]
69 +*** [[Update an eMagiz Mendix Connector (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Legacy Functionality.novice-mendix-connectivity-update-emagiz-mendix-connector.WebHome||target="blank"]]
70 +* [[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"]]
71 +)))
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.
63 -
64 -== 7. Silent demonstration video ==
65 -
66 -As this is a theoretical microlearning there is no video
67 -
68 -)))((({{toc/}}))){{/container}}{{/container}}
73 +(((
74 +{{toc/}}
75 +)))
76 +{{/container}}
77 +{{/container}}