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 6.1
edited by Erik Bakker
on 2022/06/12 10:03
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -What is an eMagiz Mendix Connector
1 +novice-mendix-connectivity-configure-emagiz-mendix-connector
Content
... ... @@ -1,62 +1,175 @@
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}}{{container layoutStyle="columns"}}(((
4 4  
3 +
4 +
5 +# Configure an eMagiz Mendix Connector
6 +
7 +In this microlearning, we will focus on configuring an eMagiz Mendix Connector.
8 +With the help of this Mendix module created by the eMagiz team, you can easily connect between Mendix and eMagiz for data integration.
9 +
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
12 +* Last update: January 27th, 2021
13 +* Required reading time: 10 minutes
9 9  
10 10  == 1. Prerequisites ==
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
19 +* A connection between Mendix and eMagiz Designed and Created
20 +* Using eMagiz Mendix version 4.2.0 or higher. For legacy configuration please see the user guide **Install guide eMagiz Connector for Mendix**
14 14  
15 15  == 2. Key concepts ==
16 -This microlearning centers around learning what an eMagiz Mendix Connector is
23 +This microlearning centers around configuring 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:
26 +To configure 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)
28 +* Configure the After Startup and Before Shutdown
29 +* Configure the Access rights to the eMagiz Mendix Module
30 +* Configure the constants
31 +* Configure the Keystore/Truststore
25 25  
26 26  
27 27  
28 -== 3. What is an eMagiz Mendix Connector
35 +== 3. Configure a 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.
37 +To configure 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:
39 +=== 3.1 Configure the After Startup and Before Shutdown
40 +The first step of configuring your eMagiz Mendix Connector is to connect the After Startup and the Before Shutdown microflow that eMagiz provides you as part of the Use Me folder to the existing
41 +After Startup and Before Shutdown microflow of the project itself.
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)
43 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--after-startup-before-shutdown-emagiz.png]]
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.
45 +After you have linked them to the project after startup and the project before shutdown ensure that these microflows are indeed triggered on the Project level.
46 +You can verify this by navigating to **Project Settings -> Runtime**
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.
48 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--after-startup-before-shutdown-project.png]]
42 42  
50 +This configuration only needs to happen **once**.
51 +
52 +=== 3.2 Configure the Access rights to the eMagiz Mendix Module
53 +It is recommended that only the administrator user role has access to the eMagiz Mendix Connector module.
54 +To do this follow these steps:
43 43  
56 +* Navigate to **Project Security**
57 +* Validate that the security of your project is set to Production. If not please select the Production option
58 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--security-settings.png]]
59 +* Navigate to **User Roles**
60 +* Edit the Administrator role
61 +* Edit the Module roles
62 +* Check the box of the eMagiz Mendix Connector module and press OK
44 44  
64 +The configuration before you press OK should look as follows
65 +
66 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--security-admin-result.png]]
67 +
68 +This configuration only needs to happen **once**.
69 +
70 +=== 3.3 Configure the constants
71 +The eMagiz Mendix Connector comes with six constants that need to be configured correctly to make sure that a successful and stable connection can be established between the Mendix application and eMagiz.
72 +
73 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--emagiz-mendix-constants.png]]
74 +
75 +==== 3.3.1 eMagizCustomerPassword
76 +
77 +The first constant you need to configure is the password that connects the eMagiz Mendix Connector to the accompanying eMagiz Project.
78 +The correct password can be retrieved from eMagiz. Simply navigate to **Deploy -> On-premises -> Runtime connection settings** and copy-paste the value for the Customer Password.
79 +This is the value that you need to fill in for the eMagizCustomerPassword. The password in the below picture is removed for security reasons.
80 +
81 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--emagiz-mendix-runtime-connection-settings.png]]
82 +
83 +This configuration only needs to happen **once**.
84 +
85 +==== 3.3.2 eMagizCustomerUsername
86 +
87 +The second constant you need to configure is the username that connects the eMagiz Mendix Connector to the accompanying eMagiz Project.
88 +The correct username can be retrieved from eMagiz. Simply navigate to **Deploy -> On-premises -> Runtime connection settings** and copy-paste the value for the Customer Username.
89 +This is the value that you need to fill in for the eMagizCustomerUsername. The username in the below picture is removed for security reasons.
90 +
91 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--emagiz-mendix-runtime-connection-settings.png]]
92 +
93 +This configuration only needs to happen **once**.
94 +
95 +==== 3.3.3 eMagizRuntimeEnvironment
96 +
97 +The third constant you need to configure is a dynamic configuration that depends on the environment (Test, Acceptance, or Production) of your eMagiz project you want to connect your Mendix project.
98 +When running the project locally it stands to reason that the Test environment (if available) would be the most logical choice.
99 +When you deploy your Mendix application to Acceptance or Production make sure to change the value of this constant via the option Mendix offers you for it.
100 +
101 +The correct value can either be prod, accp or test.
102 +
103 +==== 3.3.4 eMagizRuntimeName
104 +
105 +The fourth constant defines which runtime in eMagiz relates to the Mendix application.
106 +To correctly connect your Mendix application to your eMagiz project you need to fill in the technical name of the runtime that you have set up in eMagiz.
107 +
108 +To find out the technical name of this runtime simply navigate to **Deploy -> Containers**.
109 +Here you can see the technical name of all of your runtimes including the one that connects to your Mendix application.
110 +The technical name is build up as follows: <busname>.connector.<technical_name of the Mendix system in eMagiz>
111 +
112 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--emagiz-container-overview.png]]
113 +
114 +If you have found your runtime name you can fill it in for the constant eMagizRuntimeName. This configuration only needs to happen **once**.
115 +
116 +==== 3.3.5 eMagizWsUrl
117 +
118 +The fifth constant you need to configure is the URL from which you can retrieve the property configuration made in eMagiz that you need to successfully connect to eMagiz and exchange data with eMagiz.
119 +The correct URL can be retrieved from eMagiz. Simply navigate to **Deploy -> On-premises -> Runtime connection settings** and copy-paste the value for the eMagiz WS URL.
120 +This is the value that you need to fill in for the eMagizWsUrl. You can find the URL in the picture below.
121 +
122 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--emagiz-mendix-runtime-connection-settings.png]]
123 +
124 +This configuration only needs to happen **once**.
125 +
126 +==== 3.3.6 StartupDelay
127 +
128 +The sixth and last constant that needs to be filled in is the startup delay.
129 +This constant indicates how many milliseconds the process will wait before starting up the infra flow and registering the exit queues.
130 +In case Mendix has not fully started up yet but the flows have already started up could lead to unexpected behavior and data loss.
131 +Therefore we advise a setting of 30000ms for this constant.
132 +
133 +This configuration only needs to happen **once**.
134 +
135 +=== 3.4 Configure the keystore/truststore
136 +
137 +To ensure a proper SSL connection between runtime and eMagiz JMS each runtime needs to have a Keystore and Truststore that hold the relevant certificates.
138 +
139 +For a Mendix application specifically, this has to be done by hand. You can find the correct Keystore and Truststore if you open the infra flow of the Mendix runtime in **Create**
140 +
141 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--open-connector-infra.png]]
142 +
143 +Under the Resources tab, you will find the key and Truststore. Download these and place them in the resources folder of your Mendix project.
144 +
145 +You can access this resources folder in the following manner: **Project -> Show Project Directory in Explorer -> Open the resources folder**
146 +
147 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--show-project-directory.png]]
148 +
149 +Simply make sure that the Keystore and Truststore that you have downloaded from eMagiz are placed in this folder **including the unique number prefix eMagiz has given the key* and Truststore**
150 +
151 +This configuration only needs to happen **once**.
152 +
153 +
154 +
45 45  == 4. Assignment ==
46 46  
47 -As this is a theoretical microlearning there is no assignment that you need to complete
157 +The assignment is simple this time. Configure your eMagiz Mendix Connector.
158 +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:
162 +To configure an eMagiz Mendix Connector you need the following:
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)
164 +* Configure the After Startup and Before Shutdown
165 +* Configure the Access rights to the eMagiz Mendix Module
166 +* Configure the constants
167 +* Configure the Keystore/Truststore
57 57  
169 +To make a connection in terms of allowing data to travel between A and B you need to fill in the correct constants and setup your Keystore and Truststore correctly.
58 58  
59 59  
172 +
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,7 @@
63 63  
64 64  == 7. Silent demonstration video ==
65 65  
66 -As this is a theoretical microlearning there is no video
179 +As most of this configuration takes place in Mendix and not in eMagiz we have chosen not to make a video on this topic.
180 +The pictures and text provided above should give you enough guidance to configure the connection between Mendix and eMagiz.
67 67  
68 -)))((({{toc/}}))){{/container}}{{/container}}
182 +)))((({{toc/}}))){{container}}{{/container}}