Last modified by Erik Bakker on 2023/07/18 08:44
Show last authors
1 {{container}}{{container layoutStyle="columns"}}(((
2 In this microlearning, we will focus on configuring 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
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 * A connection between Mendix and eMagiz Designed and Created
12 * Using eMagiz Mendix version 4.2.0 or higher.
13
14 == 2. Key concepts ==
15 This microlearning centers around configuring an eMagiz Mendix Connector
16 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.
17
18 To configure an eMagiz Mendix Connector you need the following:
19
20 * Configure the After Startup and Before Shutdown
21 * Configure the Access rights to the eMagiz Mendix Module
22 * Configure the constants
23 * Configure the Keystore/Truststore
24
25 == 3. Configure a eMagiz Mendix Connector
26
27 To configure the eMagiz Mendix Connector in a Mendix app, the following steps need to be performed.
28
29 === 3.1 Configure the After Startup and Before Shutdown
30
31 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
32 After Startup and Before Shutdown microflow of the project itself.
33
34 [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--after-startup-before-shutdown-emagiz.png]]
35
36 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.
37 You can verify this by navigating to **Project Settings -> Runtime**
38
39 [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--after-startup-before-shutdown-project.png]]
40
41 This configuration only needs to happen **once**.
42
43 === 3.2 Configure the Access rights to the eMagiz Mendix Module
44
45 It is recommended that only the administrator user role has access to the eMagiz Mendix Connector module.
46 To do this follow these steps:
47
48 * Navigate to **Project Security**
49 * Validate that the security of your project is set to Production. If not please select the Production option
50 [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--security-settings.png]]
51 * Navigate to **User Roles**
52 * Edit the Administrator role
53 * Edit the Module roles
54 * Check the box of the eMagiz Mendix Connector module and press OK
55
56 The configuration before you press OK should look as follows
57
58 [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--security-admin-result.png]]
59
60 This configuration only needs to happen **once**.
61
62 === 3.3 Configure the constants
63
64 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.
65
66 [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--emagiz-mendix-constants.png]]
67
68 ==== 3.3.1 eMagizCustomerPassword
69
70 The first constant you need to configure is the password that connects the eMagiz Mendix Connector to the accompanying eMagiz Project.
71 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.
72 This is the value that you need to fill in for the eMagizCustomerPassword. The password in the below picture is removed for security reasons.
73
74 [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--emagiz-mendix-runtime-connection-settings.png]]
75
76 This configuration only needs to happen **once**.
77
78 ==== 3.3.2 eMagizCustomerUsername
79
80 The second constant you need to configure is the username that connects the eMagiz Mendix Connector to the accompanying eMagiz Project.
81 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.
82 This is the value that you need to fill in for the eMagizCustomerUsername. The username in the below picture is removed for security reasons.
83
84 [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--emagiz-mendix-runtime-connection-settings.png]]
85
86 This configuration only needs to happen **once**.
87
88 ==== 3.3.3 eMagizRuntimeEnvironment
89
90 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.
91 When running the project locally it stands to reason that the Test environment (if available) would be the most logical choice.
92 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.
93
94 The correct value can either be prod, accp or test.
95
96 ==== 3.3.4 eMagizRuntimeName
97
98 The fourth constant defines which runtime in eMagiz relates to the Mendix application.
99 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.
100
101 To find out the technical name of this runtime simply navigate to **Deploy -> Containers**.
102 Here you can see the technical name of all of your runtimes including the one that connects to your Mendix application.
103 The technical name is build up as follows: <busname>.connector.<technical_name of the Mendix system in eMagiz>
104
105 [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--emagiz-container-overview.png]]
106
107 If you have found your runtime name you can fill it in for the constant eMagizRuntimeName. This configuration only needs to happen **once**.
108
109 ==== 3.3.5 eMagizWsUrl
110
111 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.
112 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.
113 This is the value that you need to fill in for the eMagizWsUrl. You can find the URL in the picture below.
114
115 [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--emagiz-mendix-runtime-connection-settings.png]]
116
117 This configuration only needs to happen **once**.
118
119 ==== 3.3.6 StartupDelay
120
121 The sixth and last constant that needs to be filled in is the startup delay.
122 This constant indicates how many milliseconds the process will wait before starting up the infra flow and registering the exit queues.
123 In case Mendix has not fully started up yet but the flows have already started up could lead to unexpected behavior and data loss.
124 Therefore we advise a setting of 30000ms for this constant.
125
126 This configuration only needs to happen **once**.
127
128 === 3.4 Configure the keystore/truststore
129
130 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.
131
132 For a Mendix application specifically, this has to be done by hand. You can find the correct Keystore and Truststore if you navigate to **Create -> Resources**. In here you can search for "{technicalnamemodel}-client" in the field "Name".
133
134 [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--find-resources.png]]
135
136 In this overview, you will find the key and Truststore. Download these and place them in the resources folder of your Mendix project.
137
138 You can access this resources folder in the following manner for Mendix Projects running below version 9.18.0: **Project -> Show Project Directory in Explorer -> Open the resources folder**
139
140 [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--show-project-directory.png]]
141
142 For Mendix projects running version 9.18.0 or higher please go to: **App -> Show App Directory In Explorer**.
143
144 [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--show-app-directory.png]]
145
146 Simply make sure that the Keystore and Truststore that you have downloaded from eMagiz are placed in this folder.
147
148 {{warning}}Don't forget to include the unique number prefix eMagiz has given the key- and truststore. Otherwise the connection cannot be established.{{/warning}}
149
150 This configuration only needs to happen **once**.
151
152 == 4. Key takeaways ==
153
154 To configure an eMagiz Mendix Connector you need the following:
155
156 * Configure the After Startup and Before Shutdown
157 * Configure the Access rights to the eMagiz Mendix Module
158 * Configure the constants
159 * Configure the Keystore/Truststore
160
161 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.
162
163 == 5. Suggested Additional Readings ==
164
165 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.
166
167 If you are interested in migrating towards the latest version of the eMagiz Mendix Connector please check out our [[migration paths>>doc:Main.eMagiz Support.Migration Paths.WebHome||target="blank"]].
168
169 )))((({{toc/}}))){{/container}}{{/container}}