Skip to Content
Last modified by Erik Bakker on 2025/02/25 16:09
From version 12.1
edited by Erik Bakker
on 2023/07/18 08:44
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,10 +1,12 @@
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 7  == 1. Prerequisites ==
9 +
8 8  * Basic knowledge of the eMagiz platform
9 9  * Access to a Mendix application
10 10  * Access to the Deploy phase of your eMagiz project
... ... @@ -12,6 +12,7 @@
12 12  * Using eMagiz Mendix version 4.2.0 or higher.
13 13  
14 14  == 2. Key concepts ==
17 +
15 15  This microlearning centers around configuring an eMagiz Mendix Connector
16 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 17  
... ... @@ -22,11 +22,11 @@
22 22  * Configure the constants
23 23  * Configure the Keystore/Truststore
24 24  
25 -== 3. Configure a eMagiz Mendix Connector
28 +== 3. Configure a eMagiz Mendix Connector ==
26 26  
27 27  To configure the eMagiz Mendix Connector in a Mendix app, the following steps need to be performed.
28 28  
29 -=== 3.1 Configure the After Startup and Before Shutdown
32 +=== 3.1 Configure the After Startup and Before Shutdown ===
30 30  
31 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 32  After Startup and Before Shutdown microflow of the project itself.
... ... @@ -40,7 +40,7 @@
40 40  
41 41  This configuration only needs to happen **once**.
42 42  
43 -=== 3.2 Configure the Access rights to the eMagiz Mendix Module
46 +=== 3.2 Configure the Access rights to the eMagiz Mendix Module ===
44 44  
45 45  It is recommended that only the administrator user role has access to the eMagiz Mendix Connector module.
46 46  To do this follow these steps:
... ... @@ -59,13 +59,13 @@
59 59  
60 60  This configuration only needs to happen **once**.
61 61  
62 -=== 3.3 Configure the constants
65 +=== 3.3 Configure the constants ===
63 63  
64 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 65  
66 66  [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--emagiz-mendix-constants.png]]
67 67  
68 -==== 3.3.1 eMagizCustomerPassword
71 +==== 3.3.1 eMagizCustomerPassword ====
69 69  
70 70  The first constant you need to configure is the password that connects the eMagiz Mendix Connector to the accompanying eMagiz Project.
71 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.
... ... @@ -75,7 +75,7 @@
75 75  
76 76  This configuration only needs to happen **once**.
77 77  
78 -==== 3.3.2 eMagizCustomerUsername
81 +==== 3.3.2 eMagizCustomerUsername ====
79 79  
80 80  The second constant you need to configure is the username that connects the eMagiz Mendix Connector to the accompanying eMagiz Project.
81 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.
... ... @@ -85,7 +85,7 @@
85 85  
86 86  This configuration only needs to happen **once**.
87 87  
88 -==== 3.3.3 eMagizRuntimeEnvironment
91 +==== 3.3.3 eMagizRuntimeEnvironment ====
89 89  
90 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 91  When running the project locally it stands to reason that the Test environment (if available) would be the most logical choice.
... ... @@ -93,7 +93,7 @@
93 93  
94 94  The correct value can either be prod, accp or test.
95 95  
96 -==== 3.3.4 eMagizRuntimeName
99 +==== 3.3.4 eMagizRuntimeName ====
97 97  
98 98  The fourth constant defines which runtime in eMagiz relates to the Mendix application.
99 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.
... ... @@ -106,7 +106,7 @@
106 106  
107 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 108  
109 -==== 3.3.5 eMagizWsUrl
112 +==== 3.3.5 eMagizWsUrl ====
110 110  
111 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 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.
... ... @@ -116,7 +116,7 @@
116 116  
117 117  This configuration only needs to happen **once**.
118 118  
119 -==== 3.3.6 StartupDelay
122 +==== 3.3.6 StartupDelay ====
120 120  
121 121  The sixth and last constant that needs to be filled in is the startup delay.
122 122  This constant indicates how many milliseconds the process will wait before starting up the infra flow and registering the exit queues.
... ... @@ -125,7 +125,7 @@
125 125  
126 126  This configuration only needs to happen **once**.
127 127  
128 -=== 3.4 Configure the keystore/truststore
131 +=== 3.4 Configure the keystore/truststore ===
129 129  
130 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 131  
... ... @@ -145,7 +145,9 @@
145 145  
146 146  Simply make sure that the Keystore and Truststore that you have downloaded from eMagiz are placed in this folder.
147 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}}
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}}
149 149  
150 150  This configuration only needs to happen **once**.
151 151  
... ... @@ -162,8 +162,20 @@
162 162  
163 163  == 5. Suggested Additional Readings ==
164 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.
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 +)))
166 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}}
182 +(((
183 +{{toc/}}
184 +)))
185 +{{/container}}
186 +{{/container}}