Skip to Content
Last modified by Erik Bakker on 2025/02/25 16:09
From version 16.1
edited by Erik Bakker
on 2024/08/26 13:03
Change comment: There is no comment for this version
To version 5.2
edited by Erik Bakker
on 2022/06/12 10:02
Change comment: Update document after refactoring.

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Configure an eMagiz Mendix Connector
1 +novice-mendix-connectivity-configure-emagiz-mendix-connector
Content
... ... @@ -1,175 +1,110 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
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.
2 +In this microlearning, we will focus on updating 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.
3 3  
4 4  Should you have any questions, please contact academy@emagiz.com.
5 5  
7 +* Last update: January 27th, 2021
8 +* Required reading time: 7 minutes
9 +
6 6  == 1. Prerequisites ==
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
10 -* A connection between Mendix and eMagiz Designed and Created
11 -* Using eMagiz Mendix version 4.2.0 or higher.
12 12  
13 13  == 2. Key concepts ==
14 -This microlearning centers around configuring an eMagiz Mendix Connector
16 +This microlearning centers around updating 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  
17 -To configure an eMagiz Mendix Connector you need the following:
19 +To update an eMagiz Mendix Connector you need the following:
18 18  
19 -* Configure the After Startup and Before Shutdown
20 -* Configure the Access rights to the eMagiz Mendix Module
21 -* Configure the constants
22 -* Configure the Keystore/Truststore
21 +* The Mendix Module called the eMagiz Mendix Connector (available in eMagiz under Deploy of your project)
22 +* Access to a Mendix project which has an eMagiz Mendix Connector in it at this moment.
23 23  
24 -== 3. Configure a eMagiz Mendix Connector
25 25  
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
26 +== 3. Update an eMagiz Mendix Connector
29 29  
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 -After Startup and Before Shutdown microflow of the project itself.
28 +To update the eMagiz Mendix Connector in a Mendix app, the following steps need to be performed.
32 32  
33 -[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--after-startup-before-shutdown-emagiz.png]]
30 +=== 3.1 Download the eMagiz Mendix connector
31 +* The eMagiz Mendix connector can be downloaded via eMagiz. Log in and then go to one of the busses you have access to.
32 +* Go to **Deploy -> On Premises -> Runtime Downloads** the eMagiz Mendix connector can be downloaded.
33 +You must look at the column Mendix version. It must correspond to the Mendix version of the project where you want to use the eMagiz Mendix Connector.
34 +If you do not do this then the connector will **not** work.
34 34  
35 -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.
36 -You can verify this by navigating to **Project Settings -> Runtime**
36 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-emagiz-mendix-connector--emc-download-screen.png]]
37 37  
38 -[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--after-startup-before-shutdown-project.png]]
38 +=== 3.2 Importing eMagiz Mendix connector
39 39  
40 -This configuration only needs to happen **once**.
40 +Now that we have downloaded the correct eMagiz Mendix connector (the latest version that is available for the Mendix version of our project and newer compared to the current one) we can open Mendix itself.
41 41  
42 -=== 3.2 Configure the Access rights to the eMagiz Mendix Module
42 +If you open your Project in Mendix you can navigate to the left-hand panel called "Project Explorer". In this panel, you see all modules (box icons) that are currently in the project.
43 +In Project Explorer, right-click and choose the option "Import module package..."
43 43  
44 -It is recommended that only the administrator user role has access to the eMagiz Mendix Connector module.
45 -To do this follow these steps:
45 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-update-emagiz-mendix-connector--import-module-package.png]]
46 46  
47 -* Navigate to **Project Security**
48 -* Validate that the security of your project is set to Production. If not please select the Production option
49 -[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--security-settings.png]]
50 -* Navigate to **User Roles**
51 -* Edit the Administrator role
52 -* Edit the Module roles
53 -* Check the box of the eMagiz Mendix Connector module and press OK
47 +In the pop-up that follows select the correct eMagiz Mendix Connector version and press Open / Openen (depending on the language settings of your PC)
54 54  
55 -The configuration before you press OK should look as follows
49 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-update-emagiz-mendix-connector--import-module-package-selection.png]]
56 56  
57 -[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--security-admin-result.png]]
51 +As a result, Mendix will show you the following pop-up. In this pop-up you press Import and Mendix will import the eMagiz Mendix Connector for you.
58 58  
59 -This configuration only needs to happen **once**.
53 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-update-emagiz-mendix-connector--import-module-package-replace-existing-module.png]]
60 60  
61 -=== 3.3 Configure the constants
55 +You may be prompted with a warning pop-up the moment you update to a newer version. Make a screenshot and press OK.
62 62  
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.
57 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-update-emagiz-mendix-connector--import-module-package-java-update-warning.png]]
64 64  
65 -[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--emagiz-mendix-constants.png]]
59 +=== 3.3 Cleaning up the project
66 66  
67 -==== 3.3.1 eMagizCustomerPassword
61 +After you have updated to a new version of the eMagiz Mendix Connector you must clean the project before you do a new commit.
62 +Otherwise, it can happen that the communication between Mendix and eMagiz will take place based on the old instead of the new version.
68 68  
69 -The first constant you need to configure is the password that connects the eMagiz Mendix Connector to the accompanying eMagiz Project.
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.
71 -This is the value that you need to fill in for the eMagizCustomerPassword. The password in the below picture is removed for security reasons.
64 +==== 3.3.1 Run the eMagiz Cleanup Tool
72 72  
73 -[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--emagiz-mendix-runtime-connection-settings.png]]
66 +When you navigate to **Project -> Show Project Directory in Explorer -> resources** you will see one Jar file which you can run called the emagiz-cleanup-tool.
74 74  
75 -This configuration only needs to happen **once**.
68 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-update-emagiz-mendix-connector--emagiz-cleanup-tool.png]]
76 76  
77 -==== 3.3.2 eMagizCustomerUsername
70 +Run this cleanup tool by double-clicking on it to make sure that all ties to the old eMagiz Mendix Connector version are cut. In the pop-up that follows select the button Cleanup
78 78  
79 -The second constant you need to configure is the username that connects the eMagiz Mendix Connector to the accompanying eMagiz Project.
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.
81 -This is the value that you need to fill in for the eMagizCustomerUsername. The username in the below picture is removed for security reasons.
72 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-update-emagiz-mendix-connector--emagiz-cleanup-tool-result.png]]
82 82  
83 -[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--emagiz-mendix-runtime-connection-settings.png]]
74 +After you have pressed Cleanup eMagiz will tell you whether or not this has succeeded. Below you see a successful result
84 84  
85 -This configuration only needs to happen **once**.
76 +[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-update-emagiz-mendix-connector--emagiz-cleanup-tool-success.png]]
86 86  
87 -==== 3.3.3 eMagizRuntimeEnvironment
78 +==== 3.3.2 Cleanup Deployment Directory
88 88  
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 -When running the project locally it stands to reason that the Test environment (if available) would be the most logical choice.
91 -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.
80 +As the pop-up states, the next step to finish up the update of your eMagiz Mendix Connector is to clean up your deployment directory.
81 +You can simply do this by navigating to **Project -> Clean Deployment Directory** and selecting that option.
92 92  
93 -The correct value can either be prod, accp or test.
83 +Congratulations, you have successfully updated your eMagiz Mendix Connector to the latest available version.
94 94  
95 -==== 3.3.4 eMagizRuntimeName
96 96  
97 -The fourth constant defines which runtime in eMagiz relates to the Mendix application.
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.
99 99  
100 -To find out the technical name of this runtime simply navigate to **Deploy -> Containers**.
101 -Here you can see the technical name of all of your runtimes including the one that connects to your Mendix application.
102 -The technical name is build up as follows: <busname>.connector.<technical_name of the Mendix system in eMagiz>
87 +== 4. Assignment ==
103 103  
104 -[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--emagiz-container-overview.png]]
89 +The assignment is simple this time. Just update an eMagiz Mendix Connector.
90 +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.
105 105  
106 -If you have found your runtime name you can fill it in for the constant eMagizRuntimeName. This configuration only needs to happen **once**.
92 +== 5. Key takeaways ==
107 107  
108 -==== 3.3.5 eMagizWsUrl
94 +* The crucial part of updating an eMagiz Mendix Connector is to select the correct version that will work with your Mendix project
95 + ** To select the correct eMagiz Mendix Connector version look at the Mendix version your app is running in (8.0.0+,7.0.0+, etc.) and look at which of the versions eMagiz has released is the newest version (that is newer compared to the current version).
96 +* The actual installation in Mendix is simply importing a module package and selecting the correct one. As easy as can be.
109 109  
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 -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.
112 -This is the value that you need to fill in for the eMagizWsUrl. You can find the URL in the picture below.
113 113  
114 -[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--emagiz-mendix-runtime-connection-settings.png]]
115 115  
116 -This configuration only needs to happen **once**.
100 +== 6. Suggested Additional Readings ==
117 117  
118 -==== 3.3.6 StartupDelay
102 +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.
119 119  
120 -The sixth and last constant that needs to be filled in is the startup delay.
121 -This constant indicates how many milliseconds the process will wait before starting up the infra flow and registering the exit queues.
122 -In case Mendix has not fully started up yet but the flows have already started up could lead to unexpected behavior and data loss.
123 -Therefore we advise a setting of 30000ms for this constant.
104 +== 7. Silent demonstration video ==
124 124  
125 -This configuration only needs to happen **once**.
106 +This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned. Disclaimer, you only see the eMagiz part but if you follow the above steps you are good to go!
126 126  
127 -=== 3.4 Configure the keystore/truststore
108 +{{video attachment="novice-mendix-connectivity-update-update-emagiz-mendix-connector.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
128 128  
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 -
131 -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".
132 -
133 -[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--find-resources.png]]
134 -
135 -In this overview, you will find the key and Truststore. Download these and place them in the resources folder of your Mendix project.
136 -
137 -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**
138 -
139 -[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--show-project-directory.png]]
140 -
141 -For Mendix projects running version 9.18.0 or higher please go to: **App -> Show App Directory In Explorer**.
142 -
143 -[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--show-app-directory.png]]
144 -
145 -Simply make sure that the Keystore and Truststore that you have downloaded from eMagiz are placed in this folder.
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}}
148 -
149 -This configuration only needs to happen **once**.
150 -
151 -== 4. Key takeaways ==
152 -
153 -To configure an eMagiz Mendix Connector you need the following:
154 -
155 -* Configure the After Startup and Before Shutdown
156 -* Configure the Access rights to the eMagiz Mendix Module
157 -* Configure the constants
158 -* Configure the Keystore/Truststore
159 -
160 -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.
161 -
162 -== 5. Suggested Additional Readings ==
163 -
164 -* [[Novice (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Novice.WebHome||target="blank"]]
165 -** [[Mendix Connectivity (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Mendix Connectivity.WebHome||target="blank"]]
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 -*** [[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"]]
169 -* [[Support (Menu)>>doc:Main.eMagiz Support.WebHome||target="blank"]]
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.WebHome||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.WebHome||target="blank"]]
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"]]
174 -
175 175  )))((({{toc/}}))){{/container}}{{/container}}