Skip to Content
Last modified by Erik Bakker on 2025/02/25 16:09
From version 18.2
edited by Erik Bakker
on 2025/02/18 16:11
Change comment: Update document after refactoring.
To version 19.1
edited by Erik Bakker
on 2025/02/25 16:09
Change comment: Renamed back-links.

Summary

Details

Page properties
Content
... ... @@ -1,9 +1,12 @@
1 -{{container}}{{container layoutStyle="columns"}}(((
1 +{{container}}
2 +{{container layoutStyle="columns"}}
3 +(((
2 2  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.
3 3  
4 4  Should you have any questions, please contact academy@emagiz.com.
5 5  
6 6  == 1. Prerequisites ==
9 +
7 7  * Basic knowledge of the eMagiz platform
8 8  * Access to a Mendix application
9 9  * Access to the Deploy phase of your eMagiz project
... ... @@ -11,6 +11,7 @@
11 11  * Using eMagiz Mendix version 4.2.0 or higher.
12 12  
13 13  == 2. Key concepts ==
17 +
14 14  This microlearning centers around configuring an eMagiz Mendix Connector
15 15  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.
16 16  
... ... @@ -21,11 +21,11 @@
21 21  * Configure the constants
22 22  * Configure the Keystore/Truststore
23 23  
24 -== 3. Configure a eMagiz Mendix Connector
28 +== 3. Configure a eMagiz Mendix Connector ==
25 25  
26 26  To configure the eMagiz Mendix Connector in a Mendix app, the following steps need to be performed.
27 27  
28 -=== 3.1 Configure the After Startup and Before Shutdown
32 +=== 3.1 Configure the After Startup and Before Shutdown ===
29 29  
30 30  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
31 31  After Startup and Before Shutdown microflow of the project itself.
... ... @@ -39,7 +39,7 @@
39 39  
40 40  This configuration only needs to happen **once**.
41 41  
42 -=== 3.2 Configure the Access rights to the eMagiz Mendix Module
46 +=== 3.2 Configure the Access rights to the eMagiz Mendix Module ===
43 43  
44 44  It is recommended that only the administrator user role has access to the eMagiz Mendix Connector module.
45 45  To do this follow these steps:
... ... @@ -58,13 +58,13 @@
58 58  
59 59  This configuration only needs to happen **once**.
60 60  
61 -=== 3.3 Configure the constants
65 +=== 3.3 Configure the constants ===
62 62  
63 63  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.
64 64  
65 65  [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--emagiz-mendix-constants.png]]
66 66  
67 -==== 3.3.1 eMagizCustomerPassword
71 +==== 3.3.1 eMagizCustomerPassword ====
68 68  
69 69  The first constant you need to configure is the password that connects the eMagiz Mendix Connector to the accompanying eMagiz Project.
70 70  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.
... ... @@ -74,7 +74,7 @@
74 74  
75 75  This configuration only needs to happen **once**.
76 76  
77 -==== 3.3.2 eMagizCustomerUsername
81 +==== 3.3.2 eMagizCustomerUsername ====
78 78  
79 79  The second constant you need to configure is the username that connects the eMagiz Mendix Connector to the accompanying eMagiz Project.
80 80  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.
... ... @@ -84,7 +84,7 @@
84 84  
85 85  This configuration only needs to happen **once**.
86 86  
87 -==== 3.3.3 eMagizRuntimeEnvironment
91 +==== 3.3.3 eMagizRuntimeEnvironment ====
88 88  
89 89  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.
90 90  When running the project locally it stands to reason that the Test environment (if available) would be the most logical choice.
... ... @@ -92,7 +92,7 @@
92 92  
93 93  The correct value can either be prod, accp or test.
94 94  
95 -==== 3.3.4 eMagizRuntimeName
99 +==== 3.3.4 eMagizRuntimeName ====
96 96  
97 97  The fourth constant defines which runtime in eMagiz relates to the Mendix application.
98 98  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.
... ... @@ -105,7 +105,7 @@
105 105  
106 106  If you have found your runtime name you can fill it in for the constant eMagizRuntimeName. This configuration only needs to happen **once**.
107 107  
108 -==== 3.3.5 eMagizWsUrl
112 +==== 3.3.5 eMagizWsUrl ====
109 109  
110 110  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.
111 111  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.
... ... @@ -115,7 +115,7 @@
115 115  
116 116  This configuration only needs to happen **once**.
117 117  
118 -==== 3.3.6 StartupDelay
122 +==== 3.3.6 StartupDelay ====
119 119  
120 120  The sixth and last constant that needs to be filled in is the startup delay.
121 121  This constant indicates how many milliseconds the process will wait before starting up the infra flow and registering the exit queues.
... ... @@ -124,7 +124,7 @@
124 124  
125 125  This configuration only needs to happen **once**.
126 126  
127 -=== 3.4 Configure the keystore/truststore
131 +=== 3.4 Configure the keystore/truststore ===
128 128  
129 129  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.
130 130  
... ... @@ -144,7 +144,9 @@
144 144  
145 145  Simply make sure that the Keystore and Truststore that you have downloaded from eMagiz are placed in this folder.
146 146  
147 -{{warning}}Don't forget to include the unique number prefix eMagiz has given the key- and truststore. Otherwise the connection cannot be established.{{/warning}}
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}}
148 148  
149 149  This configuration only needs to happen **once**.
150 150  
... ... @@ -165,11 +165,16 @@
165 165  ** [[Mendix Connectivity (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Mendix Connectivity.WebHome||target="blank"]]
166 166  *** [[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"]]
167 167  *** [[Install an eMagiz Mendix Connector (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Mendix Connectivity.novice-mendix-connectivity-install-emagiz-mendix-connector.WebHome||target="blank"]]
168 -*** [[Update an eMagiz Mendix Connector (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Mendix Connectivity.novice-mendix-connectivity-update-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"]]
169 169  * [[Support (Menu)>>doc:Main.eMagiz Support.WebHome||target="blank"]]
170 170  ** [[Migration Paths (Navigation)>>doc:Main.eMagiz Support.Migration Paths.WebHome||target="blank"]]
171 -*** [[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"]]
172 -*** [[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"]]
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"]]
173 173  * [[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 +)))
174 174  
175 -)))((({{toc/}}))){{/container}}{{/container}}
182 +(((
183 +{{toc/}}
184 +)))
185 +{{/container}}
186 +{{/container}}