Changes for page eMagiz Mendix Connector 3.0.0 -> 5.0.0

Summary

• Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Title

...	...	@@ -1,1 +1,1 @@
1		-migration-path-emagiz-mendix-connector-3.0.0-to-5.0.0
	1	+eMagiz Mendix Connector 3.0.0 -> 5.0.0

Content

...	...	@@ -1,59 +1,73 @@
1	1	{{container}}{{container layoutStyle="columns"}}(((
2	2
3		-Below you will find a document describing the migration path to upgrade your eMagiz Mendix Connector from version 4.2.0 to 5.0.0.
4		-In case you want to implement an eMagiz Mendix Connector in a new Mendix project, ensure that you retrieve the latest version from the Mendix Marketplace as that will guarantee that the latest version is immediately chosen so you can implement it.
	3	+This document describes the difference between the 3.0 version of the eMagiz Mendix Connector and the 4.X and onwards versions of the eMagiz Mendix Connector. On top of that it describes the checks and balances one has to go through while migrating from the 3.0 version to a newer version.
5	5
6		-Should you have any questions, please get in touch with academy@emagiz.com.
	5	+== 1. Positioning of the eMagiz Connector for Mendix 8 package ==
7	7
8		-* Last update: March 1st, 2022
9		-* Required reading time: 4 minutes
	7	+This packages has been created to support clients that are moving towards Mendix 8 in their environment. The latest version of eMagiz has been upgraded to use AMQP queues, which effectively means that direct connections from Mendix to onramp and offramp queues can be made. This has a positive effect as less effort is required in Mendix to interact with eMagiz and there is an easier management of the environment as only the infra flows need to be deployed (no exit and entry flows managed in Mendix).
10	10
11		-== 1. Prerequisites ==
	9	+To take benefit from this, eMagiz has released this version to take the first steps in this direction. Below are some more details and instructions to use this new version. Please read these carefully.
12	12
13		-* Basic knowledge of the eMagiz platform
14		-* Understanding of eMagiz Mendix Connectors
15		-* A need to upgrade from 4.2.0 to 5.0.0
	11	+{{warning}} This version removes the web service layer from the eMagiz Mendix Connector. Mendix now connects to the eMagiz bus directly using Java Actions in microflows. The first upgrade to this new version may take more time for development and testing than previous updates of the eMagiz Mendix Connector. After that, however, it should be easier in use for both Mendix and eMagiz developers. {{/warning}}
16	16
17		-== 2. Key concepts ==
	13	+Please find the package on the usual location: Under Deploy --> On-premise --> Runtime downloads tab
18	18
19		-* The exit connector needs to be configured in eMagiz to make the connection work
20		-* The after startup microflow has been renamed
21		-* The configuration will be downloaded automatically
22		-* The flow overview (XML configuration overview) has returned
	15	+== 2. Comparing eMagiz Mendix connector ==
23	23
24		-== 3. eMagiz Mendix Connector 4.2.0 -> 5.0.0 ==
	17	+| Mendix V6/V7 Connector| Mendix V8 Connector|
	18	+| ------ | ------ |
	19	+| Messages received in XML | Messages received in XML, JSON or Data Model|
	20	+| Web service required to receive messages. For sending messages, a Request Handler in the Mendix model is required | Direct connection to the eMagiz queue (onramp/offramp) made via Java Action|
	21	+| Each flow (exit, entry and infra) needs to be deployed | Only infra flow needs to be deployed once, microflows connected to the queues directly|
	22	+|Incoming webservice|Microflow - Java action details |
25	25
26		-Below you will find a document describing the migration path to upgrade your eMagiz Mendix Connector from version 4.2.0 to 5.0.0.
27		-In case you want to implement an eMagiz Mendix Connector in a new Mendix project, ensure that you retrieve the latest version from the Mendix Marketplace as that will guarantee that the latest version is immediately chosen so you can implement it.
	24	+== 3. General steps to move from previous eMagiz Connector versions to this version ==
28	28
29		-Below we have written down the steps to migrate from the 4.2.0 to the 5.0.0 version of the eMagiz Mendix Connector. Follow these steps carefully to acquire the desired result.
	26	+1. Download the package and update the eMagiz Mendix Connector. If you are unsure how, please check out this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Novice.Mendix Connectivity.novice-mendix-connectivity-update-emagiz-mendix-connector.WebHome||target="blank"]]
	27	+2. Locate the name of the queue that interacts with Mendix web service currently in place
	28	+2. Remove the Web service components in the Mendix model
	29	+3. At the point where this web service component was called, replace it with the appropriate Java action from the Connector module. Use the queue name located in step 1
	30	+4. Use the configuration items of the Java action as described in the approriate [[microlearnings>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Mendix Connectivity.WebHome||target="blank"]]
	31	+6. Test if the messages are properly working
30	30
31		-=== 3.1 Retrieve latest eMagiz Mendix Connector ===
	33	+**Key considerations**
	34	+- Check if [%CurrentUser%] is not used in the microflow when processing incoming messages. Mendix loses this value when using a Java action microflow. An error message is generated and the message is not processed.
	35	+- Understand the impact of the user that is updating/creating the domain model object. The web service user is no longer used to update/create the domain model object
	36	+- A best practice can be to store the XSDs of the various integrations into the resources folder of the mendix project so that the entire team has access to the latest
	37	+- During restart of the Mendix application, there is no consumer on the synchronous response queues. Once the first message is processed, the consumer will become active. eMagiz alerting will trigger on this scenario which can be considered a false positive.
	38	+
32	32
33		-The first step would be to download the latest version of the eMagiz Mendix Connector. You can do this via the marketplace of Mendix, or you can navigate within your eMagiz model to Deploy -> On-premises and open the tab Runtime Downloads to download the latest version that works for the Mendix version your project is running in.
	40	+== 4. Key notes in using this package ==
34	34
35		-[[image:Main.Images.Microlearning.WebHome@novice-mendix-connectivity-update-emagiz-mendix-connector--emc-download-screen.png]]
	42	+Please take care of the following items when you start to use this version of the Connector to ensure you can use it properly
	43	+- Use supplied Java actions in the eMagiz Mendix connector to set up the connections
	44	+- These 2 libraries could cause issues with the current version of the Connector - please evaluate the necessity of these before deleting them
	45	+ - xerces.xercesImpl.2.8.1.jar
	46	+ - xmlbeans-3.0.1.jar.ExcelImporter.jar
	47	+- Make sure that you configure the exits in eMagiz correctly when using the latest version of the eMagiz Mendix Connector.
36	36
37		-=== 3.2 Update the eMagiz Mendix Connector ===
	49	+== 5. Addendum eMagiz Mendix Connector 5.1.0 ==
38	38
39		-Please read the following [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Novice.Mendix Connectivity.novice-mendix-connectivity-update-emagiz-mendix-connector.WebHome||target="blank"]] as this microlearning details how you should update your eMagiz Mendix Connector.
	51	+With the release of the newewst version of the eMagiz Mendix Connector a couple of things have changed.
40	40
41		-=== 3.3 Specific configuration ===
	53	+- On project startup the connector-infra configuration is downloaded, installed, and started automatically.
	54	+ - When it is not possible to retrieve the active release, the previous connector-infra will be used.
	55	+ - The Configuration Overview snippet is back so you can download the release if needed.
	56	+- Improved exception handling for synchronous entry integrations.
	57	+ - Standard eMagiz bus exceptions are recognized and converted into Mendix exceptions.
	58	+- Improved way of working with synchronous exits and entries in combination with the import and export mapping (or the absence of them)
42	42
43		-The following points warrant additional actions on your part as they are needed to make the solution work within version 5.0.0
	60	+{{info}} Note that this is a brief description of how to migrate from 3.0.0 to a higher version of the eMagiz Mendix Connector. For a full migration path from 4.2.0 towards 5.X.0 please see this [[migration path>>doc:Main.eMagiz Support.Migration Paths.migration-path-emagiz-mendix-connector-4.2.0-to-5.0.0.WebHome||target="blank"]] {{/info}}
44	44
45		-* The after startup microflow within the module has been renamed. Ensure that you refer to the new and correct after startup microflow within your own after startup microflow or directly from the Project settings. Note that the after startup microflow is now called AfterStartup
46		-* The register microflow is not needed anymore in version 5.0.0. To make the solution work in 5.0.0, you need to change the exit flows in the portal to define the correct information.
47		- ** For asynchronous exits you can check out this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Mendix connectivity.intermediate-mendix-connectivity-calling-an-asynchronous-webservice-in-mendix.WebHome||target="blank"]] on how to exactly configure the exit flow correctly
48		- ** For synchronous exits you can check out this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Mendix connectivity.intermediate-mendix-connectivity-calling-a-synchronous-webservice-in-mendix.WebHome||target="blank"]] on how to exactly configure the exit flow correctly
49		-* The XML Configuration overview has returned (XmlConfiguration_Overview). So make sure that the relevant role(s) can view this overview in case a migration needs to be performed or a manual download is needed.
	62	+=== 5.1 Infra download, installation and starting ===
50	50
51		-== 4. Key takeaways ==
	64	+In older versions of the eMagiz Mendix Connector (3.0.0 and lower) you always needed to download the .emc package, manually upload it in Mendix and start the Infra flow by hand.
	65	+With the introduction of this release we have made a change that automatically downloads, installs and starts the Infra flow belonging to this specific Mendix application.
52	52
53		-* The exit connector needs to be configured in eMagiz to make the connection work
54		-* The after startup microflow has been renamed
55		-* The configuration will be downloaded automatically
56		-* The flow overview (XML configuration overview) has returned
57		-* Migration from 4.2.0 to 5.0.0 requires changes on both sides
	67	+[[image:Main.Images.Migrationpath.WebHome@emc8-after-startup-retrieve-infra.png]]
58	58
	69	+This way you never have to execute those steps and eMagiz ensures that the Infra flow is the first to start up before any exits are registered.
	70	+To make this possible we have added logic to the AfterStartup microflow of eMagiz to retrieve the properties from eMagiz, download the infra and start the infra.
	71	+
	72	+In case there is a problem with internet connectivity or you simply cannot reach eMagiz, the microflow ensures that the latest known infra will be started up.
59	59	)))((({{toc/}}))){{/container}}{{/container}}