Skip to Content
Last modified by Erik Bakker on 2025/02/25 16:09
From version 19.1
edited by Erik Bakker
on 2025/02/25 16:09
Change comment: Renamed back-links.
To version 17.1
edited by Erik Bakker
on 2024/08/26 13:03
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -novice-mendix-connectivity-configure-emagiz-mendix-connector
1 +Configure an eMagiz Mendix Connector
Parent
... ... @@ -1,1 +1,1 @@
1 -Main.eMagiz Academy.Microlearnings.Legacy Functionality.WebHome
1 +Main.eMagiz Academy.Microlearnings.Novice.Mendix Connectivity.WebHome
Content
... ... @@ -1,12 +1,9 @@
1 -{{container}}
2 -{{container layoutStyle="columns"}}
3 -(((
1 +{{container}}{{container layoutStyle="columns"}}(((
4 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.
5 5  
6 6  Should you have any questions, please contact academy@emagiz.com.
7 7  
8 8  == 1. Prerequisites ==
9 -
10 10  * Basic knowledge of the eMagiz platform
11 11  * Access to a Mendix application
12 12  * Access to the Deploy phase of your eMagiz project
... ... @@ -14,7 +14,6 @@
14 14  * Using eMagiz Mendix version 4.2.0 or higher.
15 15  
16 16  == 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,11 +25,11 @@
25 25  * Configure the constants
26 26  * Configure the Keystore/Truststore
27 27  
28 -== 3. Configure a eMagiz Mendix Connector ==
24 +== 3. Configure a eMagiz Mendix Connector
29 29  
30 30  To configure the eMagiz Mendix Connector in a Mendix app, the following steps need to be performed.
31 31  
32 -=== 3.1 Configure the After Startup and Before Shutdown ===
28 +=== 3.1 Configure the After Startup and Before Shutdown
33 33  
34 34  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
35 35  After Startup and Before Shutdown microflow of the project itself.
... ... @@ -43,7 +43,7 @@
43 43  
44 44  This configuration only needs to happen **once**.
45 45  
46 -=== 3.2 Configure the Access rights to the eMagiz Mendix Module ===
42 +=== 3.2 Configure the Access rights to the eMagiz Mendix Module
47 47  
48 48  It is recommended that only the administrator user role has access to the eMagiz Mendix Connector module.
49 49  To do this follow these steps:
... ... @@ -62,13 +62,13 @@
62 62  
63 63  This configuration only needs to happen **once**.
64 64  
65 -=== 3.3 Configure the constants ===
61 +=== 3.3 Configure the constants
66 66  
67 67  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.
68 68  
69 69  [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--emagiz-mendix-constants.png]]
70 70  
71 -==== 3.3.1 eMagizCustomerPassword ====
67 +==== 3.3.1 eMagizCustomerPassword
72 72  
73 73  The first constant you need to configure is the password that connects the eMagiz Mendix Connector to the accompanying eMagiz Project.
74 74  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.
... ... @@ -78,7 +78,7 @@
78 78  
79 79  This configuration only needs to happen **once**.
80 80  
81 -==== 3.3.2 eMagizCustomerUsername ====
77 +==== 3.3.2 eMagizCustomerUsername
82 82  
83 83  The second constant you need to configure is the username that connects the eMagiz Mendix Connector to the accompanying eMagiz Project.
84 84  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.
... ... @@ -88,7 +88,7 @@
88 88  
89 89  This configuration only needs to happen **once**.
90 90  
91 -==== 3.3.3 eMagizRuntimeEnvironment ====
87 +==== 3.3.3 eMagizRuntimeEnvironment
92 92  
93 93  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.
94 94  When running the project locally it stands to reason that the Test environment (if available) would be the most logical choice.
... ... @@ -96,7 +96,7 @@
96 96  
97 97  The correct value can either be prod, accp or test.
98 98  
99 -==== 3.3.4 eMagizRuntimeName ====
95 +==== 3.3.4 eMagizRuntimeName
100 100  
101 101  The fourth constant defines which runtime in eMagiz relates to the Mendix application.
102 102  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.
... ... @@ -109,7 +109,7 @@
109 109  
110 110  If you have found your runtime name you can fill it in for the constant eMagizRuntimeName. This configuration only needs to happen **once**.
111 111  
112 -==== 3.3.5 eMagizWsUrl ====
108 +==== 3.3.5 eMagizWsUrl
113 113  
114 114  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.
115 115  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.
... ... @@ -119,7 +119,7 @@
119 119  
120 120  This configuration only needs to happen **once**.
121 121  
122 -==== 3.3.6 StartupDelay ====
118 +==== 3.3.6 StartupDelay
123 123  
124 124  The sixth and last constant that needs to be filled in is the startup delay.
125 125  This constant indicates how many milliseconds the process will wait before starting up the infra flow and registering the exit queues.
... ... @@ -128,7 +128,7 @@
128 128  
129 129  This configuration only needs to happen **once**.
130 130  
131 -=== 3.4 Configure the keystore/truststore ===
127 +=== 3.4 Configure the keystore/truststore
132 132  
133 133  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.
134 134  
... ... @@ -148,9 +148,7 @@
148 148  
149 149  Simply make sure that the Keystore and Truststore that you have downloaded from eMagiz are placed in this folder.
150 150  
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}}
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}}
154 154  
155 155  This configuration only needs to happen **once**.
156 156  
... ... @@ -171,16 +171,11 @@
171 171  ** [[Mendix Connectivity (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Mendix Connectivity.WebHome||target="blank"]]
172 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 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"]]
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"]]
175 175  * [[Support (Menu)>>doc:Main.eMagiz Support.WebHome||target="blank"]]
176 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"]]
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"]]
179 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 -)))
181 181  
182 -(((
183 -{{toc/}}
184 -)))
185 -{{/container}}
186 -{{/container}}
175 +)))((({{toc/}}))){{/container}}{{/container}}