novice-mendix-connectivity-configure-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.

25

26

To configure an eMagiz Mendix Connector you need the following:

27

28

* Configure the After Startup and Before Shutdown

29

* Configure the Access rights to the eMagiz Mendix Module

30

* Configure the constants

31

* Configure the Keystore/Truststore

== 3. Configure a eMagiz Mendix Connector

36

37

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

38

39

=== 3.1 Configure the After Startup and Before Shutdown

40

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

41

After Startup and Before Shutdown microflow of the project itself.

42

43

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

44

45

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.

46

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

47

48

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

49

50

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

51

52

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

53

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

54

To do this follow these steps:

55

56

* Navigate to **Project Security**

57

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

58

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

59

* Navigate to **User Roles**

60

* Edit the Administrator role

61

* Edit the Module roles

62

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

63

64

The configuration before you press OK should look as follows

65

66

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

67

68

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

69

70

=== 3.3 Configure the constants

71

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.

72

73

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

74

75

==== 3.3.1 eMagizCustomerPassword

76

77

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

78

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.

79

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

80

81

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

82

83

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

84

85

==== 3.3.2 eMagizCustomerUsername

86

87

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

88

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.

89

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

90

91

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

92

93

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

94

95

==== 3.3.3 eMagizRuntimeEnvironment

96

97

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.

98

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

99

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.

100

101

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

102

103

==== 3.3.4 eMagizRuntimeName

104

105

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

106

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.

107

108

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

109

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

110

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

111

112

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

113

114

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

115

116

==== 3.3.5 eMagizWsUrl

117

118

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.

119

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.

120

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

121

122

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

123

124

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

125

126

==== 3.3.6 StartupDelay

127

128

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

129

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

130

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

131

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

132

133

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

134

135

=== 3.4 Configure the keystore/truststore

136

137

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.

138

139

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**

140

141

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

142

143

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

144

145

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

146

147

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

148

149

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**

150

151

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

== 4. Assignment ==

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

158

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.

159

160

== 5. Key takeaways ==

161

162

To configure an eMagiz Mendix Connector you need the following:

163

164

* Configure the After Startup and Before Shutdown

165

* Configure the Access rights to the eMagiz Mendix Module

166

* Configure the constants

167

* Configure the Keystore/Truststore

168

169

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 ==

174

175

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.

176

177

== 7. Silent demonstration video ==

178

179

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

180

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

181

182

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

Wiki source code of novice-mendix-connectivity-configure-emagiz-mendix-connector

Navigation