Wiki source code of Configure an eMagiz Mendix Connector
Version 14.1 by Carlijn Kokkeler on 2024/08/23 14:25
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
7.1 | 1 | {{container}}{{container layoutStyle="columns"}}((( |
| |
14.1 | 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. |
| |
1.1 | 3 | |
| 4 | Should you have any questions, please contact academy@emagiz.com. | ||
| 5 | |||
| 6 | == 1. Prerequisites == | ||
| 7 | * Basic knowledge of the eMagiz platform | ||
| 8 | * Access to a Mendix application | ||
| 9 | * Access to the Deploy phase of your eMagiz project | ||
| |
6.1 | 10 | * A connection between Mendix and eMagiz Designed and Created |
| |
9.1 | 11 | * Using eMagiz Mendix version 4.2.0 or higher. |
| |
1.1 | 12 | |
| 13 | == 2. Key concepts == | ||
| |
6.1 | 14 | This microlearning centers around configuring an eMagiz Mendix Connector |
| |
1.1 | 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 | |||
| |
6.1 | 17 | To configure an eMagiz Mendix Connector you need the following: |
| |
1.1 | 18 | |
| |
6.1 | 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 | ||
| |
1.1 | 23 | |
| |
6.1 | 24 | == 3. Configure a eMagiz Mendix Connector |
| |
1.1 | 25 | |
| |
6.1 | 26 | To configure the eMagiz Mendix Connector in a Mendix app, the following steps need to be performed. |
| |
1.1 | 27 | |
| |
6.1 | 28 | === 3.1 Configure the After Startup and Before Shutdown |
| |
8.1 | 29 | |
| |
6.1 | 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. | ||
| |
1.1 | 32 | |
| |
6.1 | 33 | [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--after-startup-before-shutdown-emagiz.png]] |
| |
5.1 | 34 | |
| |
6.1 | 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** | ||
| |
5.1 | 37 | |
| |
6.1 | 38 | [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--after-startup-before-shutdown-project.png]] |
| |
3.1 | 39 | |
| |
6.1 | 40 | This configuration only needs to happen **once**. |
| |
8.1 | 41 | |
| |
6.1 | 42 | === 3.2 Configure the Access rights to the eMagiz Mendix Module |
| |
8.1 | 43 | |
| |
6.1 | 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: | ||
| |
1.1 | 46 | |
| |
6.1 | 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 | ||
| |
1.1 | 54 | |
| |
6.1 | 55 | The configuration before you press OK should look as follows |
| |
1.1 | 56 | |
| |
6.1 | 57 | [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--security-admin-result.png]] |
| |
1.1 | 58 | |
| |
6.1 | 59 | This configuration only needs to happen **once**. |
| |
2.1 | 60 | |
| |
6.1 | 61 | === 3.3 Configure the constants |
| |
8.1 | 62 | |
| |
6.1 | 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. |
| |
2.1 | 64 | |
| |
6.1 | 65 | [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--emagiz-mendix-constants.png]] |
| |
2.1 | 66 | |
| |
6.1 | 67 | ==== 3.3.1 eMagizCustomerPassword |
| |
2.1 | 68 | |
| |
6.1 | 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. | ||
| |
2.1 | 72 | |
| |
6.1 | 73 | [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--emagiz-mendix-runtime-connection-settings.png]] |
| |
4.1 | 74 | |
| |
6.1 | 75 | This configuration only needs to happen **once**. |
| |
4.1 | 76 | |
| |
6.1 | 77 | ==== 3.3.2 eMagizCustomerUsername |
| |
4.1 | 78 | |
| |
6.1 | 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. | ||
| |
4.1 | 82 | |
| |
6.1 | 83 | [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--emagiz-mendix-runtime-connection-settings.png]] |
| |
4.1 | 84 | |
| |
6.1 | 85 | This configuration only needs to happen **once**. |
| |
4.1 | 86 | |
| |
6.1 | 87 | ==== 3.3.3 eMagizRuntimeEnvironment |
| |
4.1 | 88 | |
| |
6.1 | 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. | ||
| |
4.1 | 92 | |
| |
6.1 | 93 | The correct value can either be prod, accp or test. |
| |
4.1 | 94 | |
| |
6.1 | 95 | ==== 3.3.4 eMagizRuntimeName |
| |
4.1 | 96 | |
| |
6.1 | 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. | ||
| |
4.1 | 99 | |
| |
6.1 | 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> | ||
| |
4.1 | 103 | |
| |
6.1 | 104 | [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--emagiz-container-overview.png]] |
| |
4.1 | 105 | |
| |
6.1 | 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 | |||
| 108 | ==== 3.3.5 eMagizWsUrl | ||
| 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 | |||
| 114 | [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--emagiz-mendix-runtime-connection-settings.png]] | ||
| 115 | |||
| 116 | This configuration only needs to happen **once**. | ||
| 117 | |||
| 118 | ==== 3.3.6 StartupDelay | ||
| 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. | ||
| 124 | |||
| 125 | This configuration only needs to happen **once**. | ||
| 126 | |||
| 127 | === 3.4 Configure the keystore/truststore | ||
| 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 | |||
| |
12.1 | 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". |
| |
6.1 | 132 | |
| |
12.1 | 133 | [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--find-resources.png]] |
| |
6.1 | 134 | |
| |
12.1 | 135 | In this overview, you will find the key and Truststore. Download these and place them in the resources folder of your Mendix project. |
| |
6.1 | 136 | |
| |
12.1 | 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** |
| |
6.1 | 138 | |
| 139 | [[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--show-project-directory.png]] | ||
| 140 | |||
| |
12.1 | 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 | |||
| |
10.1 | 145 | Simply make sure that the Keystore and Truststore that you have downloaded from eMagiz are placed in this folder. |
| |
6.1 | 146 | |
| |
10.1 | 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 | |||
| |
6.1 | 149 | This configuration only needs to happen **once**. |
| 150 | |||
| |
11.1 | 151 | == 4. Key takeaways == |
| |
1.1 | 152 | |
| |
6.1 | 153 | To configure an eMagiz Mendix Connector you need the following: |
| |
1.1 | 154 | |
| |
6.1 | 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 | ||
| |
1.1 | 159 | |
| |
6.1 | 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. |
| |
1.1 | 161 | |
| |
11.1 | 162 | == 5. Suggested Additional Readings == |
| |
1.1 | 163 | |
| |
13.1 | 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"]] | ||
| |
1.1 | 169 | |
| |
9.1 | 170 | 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"]]. |
| 171 | |||
| |
7.1 | 172 | )))((({{toc/}}))){{/container}}{{/container}} |