Skip to Content
Last modified by Erik Bakker on 2025/02/25 16:09
From version 8.1
edited by Erik Bakker
on 2022/06/12 10:04
Change comment: There is no comment for this version
To version 19.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 -Configure an eMagiz Mendix Connector
1 +novice-mendix-connectivity-configure-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,20 +1,20 @@
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.
1 +{{container}}
2 +{{container layoutStyle="columns"}}
3 +(((
4 +In this microlearning, we'll cover how to configure the eMagiz Mendix Connector for your Mendix application. The eMagiz Mendix Connector is a module that facilitates seamless integration between Mendix and eMagiz projects. We’ll walk you through the essential configuration steps, including setting up startup and shutdown processes, configuring access rights, defining key constants, and properly setting up the Keystore and Truststore. By the end, you'll be ready to ensure a stable and secure connection between your Mendix application and eMagiz.
4 4  
5 5  Should you have any questions, please contact academy@emagiz.com.
6 6  
7 -* Last update: January 27th, 2021
8 -* Required reading time: 10 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  * A connection between Mendix and eMagiz Designed and Created
15 -* Using eMagiz Mendix version 4.2.0 or higher. For legacy configuration please see the user guide **Install guide eMagiz Connector for Mendix**
14 +* Using eMagiz Mendix version 4.2.0 or higher.
16 16  
17 17  == 2. Key concepts ==
17 +
18 18  This microlearning centers around configuring an eMagiz Mendix Connector
19 19  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.
20 20  
... ... @@ -25,13 +25,11 @@
25 25  * Configure the constants
26 26  * Configure the Keystore/Truststore
27 27  
28 +== 3. Configure a eMagiz Mendix Connector ==
28 28  
29 -
30 -== 3. Configure a eMagiz Mendix Connector
31 -
32 32  To configure the eMagiz Mendix Connector in a Mendix app, the following steps need to be performed.
33 33  
34 -=== 3.1 Configure the After Startup and Before Shutdown
32 +=== 3.1 Configure the After Startup and Before Shutdown ===
35 35  
36 36  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
37 37  After Startup and Before Shutdown microflow of the project itself.
... ... @@ -45,7 +45,7 @@
45 45  
46 46  This configuration only needs to happen **once**.
47 47  
48 -=== 3.2 Configure the Access rights to the eMagiz Mendix Module
46 +=== 3.2 Configure the Access rights to the eMagiz Mendix Module ===
49 49  
50 50  It is recommended that only the administrator user role has access to the eMagiz Mendix Connector module.
51 51  To do this follow these steps:
... ... @@ -64,13 +64,13 @@
64 64  
65 65  This configuration only needs to happen **once**.
66 66  
67 -=== 3.3 Configure the constants
65 +=== 3.3 Configure the constants ===
68 68  
69 69  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.
70 70  
71 71  [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--emagiz-mendix-constants.png]]
72 72  
73 -==== 3.3.1 eMagizCustomerPassword
71 +==== 3.3.1 eMagizCustomerPassword ====
74 74  
75 75  The first constant you need to configure is the password that connects the eMagiz Mendix Connector to the accompanying eMagiz Project.
76 76  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.
... ... @@ -80,7 +80,7 @@
80 80  
81 81  This configuration only needs to happen **once**.
82 82  
83 -==== 3.3.2 eMagizCustomerUsername
81 +==== 3.3.2 eMagizCustomerUsername ====
84 84  
85 85  The second constant you need to configure is the username that connects the eMagiz Mendix Connector to the accompanying eMagiz Project.
86 86  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.
... ... @@ -90,7 +90,7 @@
90 90  
91 91  This configuration only needs to happen **once**.
92 92  
93 -==== 3.3.3 eMagizRuntimeEnvironment
91 +==== 3.3.3 eMagizRuntimeEnvironment ====
94 94  
95 95  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.
96 96  When running the project locally it stands to reason that the Test environment (if available) would be the most logical choice.
... ... @@ -98,7 +98,7 @@
98 98  
99 99  The correct value can either be prod, accp or test.
100 100  
101 -==== 3.3.4 eMagizRuntimeName
99 +==== 3.3.4 eMagizRuntimeName ====
102 102  
103 103  The fourth constant defines which runtime in eMagiz relates to the Mendix application.
104 104  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.
... ... @@ -111,7 +111,7 @@
111 111  
112 112  If you have found your runtime name you can fill it in for the constant eMagizRuntimeName. This configuration only needs to happen **once**.
113 113  
114 -==== 3.3.5 eMagizWsUrl
112 +==== 3.3.5 eMagizWsUrl ====
115 115  
116 116  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.
117 117  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.
... ... @@ -121,7 +121,7 @@
121 121  
122 122  This configuration only needs to happen **once**.
123 123  
124 -==== 3.3.6 StartupDelay
122 +==== 3.3.6 StartupDelay ====
125 125  
126 126  The sixth and last constant that needs to be filled in is the startup delay.
127 127  This constant indicates how many milliseconds the process will wait before starting up the infra flow and registering the exit queues.
... ... @@ -130,33 +130,34 @@
130 130  
131 131  This configuration only needs to happen **once**.
132 132  
133 -=== 3.4 Configure the keystore/truststore
131 +=== 3.4 Configure the keystore/truststore ===
134 134  
135 135  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.
136 136  
137 -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**
135 +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".
138 138  
139 -[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--open-connector-infra.png]]
137 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--find-resources.png]]
140 140  
141 -Under the Resources tab, you will find the key and Truststore. Download these and place them in the resources folder of your Mendix project.
139 +In this overview, you will find the key and Truststore. Download these and place them in the resources folder of your Mendix project.
142 142  
143 -You can access this resources folder in the following manner: **Project -> Show Project Directory in Explorer -> Open the resources folder**
141 +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**
144 144  
145 145  [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--show-project-directory.png]]
146 146  
147 -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**
145 +For Mendix projects running version 9.18.0 or higher please go to: **App -> Show App Directory In Explorer**.
148 148  
149 -This configuration only needs to happen **once**.
147 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--show-app-directory.png]]
150 150  
149 +Simply make sure that the Keystore and Truststore that you have downloaded from eMagiz are placed in this folder.
151 151  
151 +{{warning}}
152 +Don't forget to include the unique number prefix eMagiz has given the key- and truststore. Otherwise the connection cannot be established.
153 +{{/warning}}
152 152  
153 -== 4. Assignment ==
155 +This configuration only needs to happen **once**.
154 154  
155 -The assignment is simple this time. Configure your eMagiz Mendix Connector.
156 -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.
157 +== 4. Key takeaways ==
157 157  
158 -== 5. Key takeaways ==
159 -
160 160  To configure an eMagiz Mendix Connector you need the following:
161 161  
162 162  * Configure the After Startup and Before Shutdown
... ... @@ -166,15 +166,22 @@
166 166  
167 167  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.
168 168  
168 +== 5. Suggested Additional Readings ==
169 169  
170 +* [[Novice (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Novice.WebHome||target="blank"]]
171 +** [[Mendix Connectivity (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Mendix Connectivity.WebHome||target="blank"]]
172 +*** [[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"]]
173 +*** [[Install an eMagiz Mendix Connector (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Mendix Connectivity.novice-mendix-connectivity-install-emagiz-mendix-connector.WebHome||target="blank"]]
174 +*** [[Update an eMagiz Mendix Connector (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Legacy Functionality.novice-mendix-connectivity-update-emagiz-mendix-connector.WebHome||target="blank"]]
175 +* [[Support (Menu)>>doc:Main.eMagiz Support.WebHome||target="blank"]]
176 +** [[Migration Paths (Navigation)>>doc:Main.eMagiz Support.Migration Paths.WebHome||target="blank"]]
177 +*** [[eMagiz Mendix Connector 3.0.0 -~> 5.0.0 (Explanation)>>doc:Main.eMagiz Support.Migration Paths.migration-path-emagiz-mendix-connector-300-to-500||target="blank"]]
178 +*** [[eMagiz Mendix Connector 4.2.0 -~> 5.0.0 (Explanation)>>doc:Main.eMagiz Support.Migration Paths.migration-path-emagiz-mendix-connector-420-to-500||target="blank"]]
179 +* [[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"]]
180 +)))
170 170  
171 -== 6. Suggested Additional Readings ==
172 -
173 -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.
174 -
175 -== 7. Silent demonstration video ==
176 -
177 -As most of this configuration takes place in Mendix and not in eMagiz we have chosen not to make a video on this topic.
178 -The pictures and text provided above should give you enough guidance to configure the connection between Mendix and eMagiz.
179 -
180 -)))((({{toc/}}))){{/container}}{{/container}}
182 +(((
183 +{{toc/}}
184 +)))
185 +{{/container}}
186 +{{/container}}