Configure an eMagiz Mendix Connector

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

21

To configure an eMagiz Mendix Connector you need the following:

22

23

* Configure the After Startup and Before Shutdown

24

* Configure the Access rights to the eMagiz Mendix Module

25

* Configure the constants

26

* Configure the Keystore/Truststore

== 3. Configure a eMagiz Mendix Connector

31

32

To configure the eMagiz Mendix Connector in a Mendix app, the following steps need to be performed.

33

34

=== 3.1 Configure the After Startup and Before Shutdown

35

36

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

37

After Startup and Before Shutdown microflow of the project itself.

38

39

[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--after-startup-before-shutdown-emagiz.png]]

40

41

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.

42

You can verify this by navigating to **Project Settings -> Runtime**

43

44

[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--after-startup-before-shutdown-project.png]]

45

46

This configuration only needs to happen **once**.

47

48

=== 3.2 Configure the Access rights to the eMagiz Mendix Module

49

50

It is recommended that only the administrator user role has access to the eMagiz Mendix Connector module.

51

To do this follow these steps:

52

53

* Navigate to **Project Security**

54

* Validate that the security of your project is set to Production. If not please select the Production option

55

[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--security-settings.png]]

56

* Navigate to **User Roles**

57

* Edit the Administrator role

58

* Edit the Module roles

59

* Check the box of the eMagiz Mendix Connector module and press OK

60

61

The configuration before you press OK should look as follows

62

63

[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--security-admin-result.png]]

64

65

This configuration only needs to happen **once**.

66

67

=== 3.3 Configure the constants

68

69

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.

70

71

[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--emagiz-mendix-constants.png]]

72

73

==== 3.3.1 eMagizCustomerPassword

74

75

The first constant you need to configure is the password that connects the eMagiz Mendix Connector to the accompanying eMagiz Project.

76

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.

77

This is the value that you need to fill in for the eMagizCustomerPassword. The password in the below picture is removed for security reasons.

78

79

[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--emagiz-mendix-runtime-connection-settings.png]]

80

81

This configuration only needs to happen **once**.

82

83

==== 3.3.2 eMagizCustomerUsername

84

85

The second constant you need to configure is the username that connects the eMagiz Mendix Connector to the accompanying eMagiz Project.

86

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.

87

This is the value that you need to fill in for the eMagizCustomerUsername. The username in the below picture is removed for security reasons.

88

89

[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--emagiz-mendix-runtime-connection-settings.png]]

90

91

This configuration only needs to happen **once**.

92

93

==== 3.3.3 eMagizRuntimeEnvironment

94

95

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.

96

When running the project locally it stands to reason that the Test environment (if available) would be the most logical choice.

97

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.

98

99

The correct value can either be prod, accp or test.

100

101

==== 3.3.4 eMagizRuntimeName

102

103

The fourth constant defines which runtime in eMagiz relates to the Mendix application.

104

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

106

To find out the technical name of this runtime simply navigate to **Deploy -> Containers**.

107

Here you can see the technical name of all of your runtimes including the one that connects to your Mendix application.

108

The technical name is build up as follows: <busname>.connector.<technical_name of the Mendix system in eMagiz>

109

110

[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--emagiz-container-overview.png]]

111

112

If you have found your runtime name you can fill it in for the constant eMagizRuntimeName. This configuration only needs to happen **once**.

113

114

==== 3.3.5 eMagizWsUrl

115

116

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.

117

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.

118

This is the value that you need to fill in for the eMagizWsUrl. You can find the URL in the picture below.

119

120

[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--emagiz-mendix-runtime-connection-settings.png]]

121

122

This configuration only needs to happen **once**.

123

124

==== 3.3.6 StartupDelay

125

126

The sixth and last constant that needs to be filled in is the startup delay.

127

This constant indicates how many milliseconds the process will wait before starting up the infra flow and registering the exit queues.

128

In case Mendix has not fully started up yet but the flows have already started up could lead to unexpected behavior and data loss.

129

Therefore we advise a setting of 30000ms for this constant.

130

131

This configuration only needs to happen **once**.

132

133

=== 3.4 Configure the keystore/truststore

134

135

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.

136

137

For a Mendix application specifically, this has to be done by hand. You can find the correct Keystore and Truststore if you open the infra flow of the Mendix runtime in **Create**

138

139

[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--open-connector-infra.png]]

140

141

Under the Resources tab, you will find the key and Truststore. Download these and place them in the resources folder of your Mendix project.

142

143

You can access this resources folder in the following manner: **Project -> Show Project Directory in Explorer -> Open the resources folder**

144

145

[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-configure-emagiz-mendix-connector--show-project-directory.png]]

146

147

Simply make sure that the Keystore and Truststore that you have downloaded from eMagiz are placed in this folder **including the unique number prefix eMagiz has given the key* and Truststore**

148

149

This configuration only needs to happen **once**.

== 4. Assignment ==

The assignment is simple this time. Configure your eMagiz Mendix Connector.

156

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.

157

158

== 5. Key takeaways ==

159

160

To configure an eMagiz Mendix Connector you need the following:

161

162

* Configure the After Startup and Before Shutdown

163

* Configure the Access rights to the eMagiz Mendix Module

164

* Configure the constants

165

* Configure the Keystore/Truststore

166

167

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.

== 6. Suggested Additional Readings ==

172

173

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.

174

175

== 7. Silent demonstration video ==

176

177

As most of this configuration takes place in Mendix and not in eMagiz we have chosen not to make a video on this topic.

178

The pictures and text provided above should give you enough guidance to configure the connection between Mendix and eMagiz.

179

180

)))((({{toc/}}))){{/container}}{{/container}}

Wiki source code of Configure an eMagiz Mendix Connector

Navigation