Changes for page Asynchronous Routing

Summary

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

Details

Page properties

Title

...	...	@@ -1,1 +1,0 @@
1		-Asynchronous Routing

Parent

...	...	@@ -1,1 +1,0 @@
1		-WebHome

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.ebakker
	1	+XWiki.marijn

Default language

...	...	@@ -1,1 +1,0 @@
1		-en

Content

...	...	@@ -1,8 +1,20 @@
1		-{{container}}{{container layoutStyle="columns"}}(((
	1	+{{html wiki="true"}}
	2	+<div class="ez-academy">
	3	+ <div class="ez-academy_body">
	4	+
	5	+<div class="doc">
	6	+
	7	+
	8	+
	9	+= Asynchronous Routing =
	10	+
2	2	In this microlearning, we will explain the basics of asynchronous routing that plays a vital role in the distribution of messages within the five-layer model of messaging.
3	3
4		-Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
	13	+Should you have any questions, please contact academy@emagiz.com.
5	5
	15	+* Last update: February 25th, 2021
	16	+* Required reading time: 7 minutes
	17	+
6	6	== 1. Prerequisites ==
7	7
8	8	* Basic knowledge of the eMagiz platform
...	...	@@ -18,6 +18,8 @@
18	18	* Based on a decision made within the routing the message is routed to one or more offramp queues
19	19	* Each offramp queue will receive data based on the decision unless you add another filter before the messages are sent to the offramp queue
20	20
	33	+
	34	+
21	21	== 3. Asynchronous routing ==
22	22
23	23	Asynchronous routing plays a crucial role in the distribution of messages it receives to one or more offramps.
...	...	@@ -39,19 +39,19 @@
39	39
40	40	This SpEL expression does the following things:
41	41
42		-* It looks for the header called {technicalnameofproject}\_targetSystem and will split each entry based on the separator (a comma)
43		-* It will trim the result of this split and combine it the value in the header called {technicalnameofproject}\_messageType
44		-* For every unique combination it will search to a pre-configured list to see to which channel the message should be sent
	56	+1. It looks for the header called {technicalnameofproject}\_targetSystem and will split each entry based on the separator (a comma)
	57	+2. It will trim the result of this split and combine it the value in the header called {technicalnameofproject}\_messageType
	58	+3. For every unique combination it will search to a pre-configured list to see to which channel the message should be sent
45	45
46	46	In the standard router component this will look as follows:
47	47
48		-[[image:Main.Images.Microlearning.WebHome@crashcourse-messaging-asynchronous-routing--routing-decision.png]]
	62	+<p align="center">[[image:crashcourse-messaging-asynchronous-routing--routing-decision.png||]]</p>
49	49
50	50	In this simple case, we only have one channel as a result because all routings start simple.
51	51	The moment you add new offramps to your project you need to add the new entry(s) to this list.
52	52	Doing so is easy when you are in Start Editing Mode. Simply open the router component and select the button New Mapping
53	53
54		-[[image:Main.Images.Microlearning.WebHome@crashcourse-messaging-asynchronous-routing--new-value-mapping.png]]
	68	+<p align="center">[[image:crashcourse-messaging-asynchronous-routing--new-value-mapping.png||]]</p>
55	55
56	56	In here you fill in the correct unique combination of a target system and the message type and select the channel you want to route the message to.
57	57	When you are satisfied you can press Save and the new entry will be registered in eMagiz.
...	...	@@ -60,20 +60,26 @@
60	60
61	61	=== 3.2 Control output ===
62	62
63		-As the asynchronous plays a role in routing messages between all asynchronous flows in the messaging solution you can imagine that making changes does not need to happen lightly. The other aspect is that when multiple projects are being built at the same time the asynchronous routing will house a multitude of changes that need to go to Acceptance or Production at the same time.
	77	+As the asynchronous plays a role in routing messages between all asynchronous flows in a
	78	+the messaging solution you can imagine that making changes does not need to happen lightly.
	79	+The other aspect is that when multiple projects are being built at the same time the asynchronous routing
	80	+will house a multitude of changes that need to go to Acceptance or Production at the same time.
64	64
65		-One control mechanism we consider a best practice to guard yourself against those risks is to add a filter before data is placed on the offramp queue.
66		-By doing this consistently you can control when a specific offramp can receive data on any environment. In other words, when a certain system is not ready yet to receive data on Acceptance or Production but is ready on Test you can control this behavior with this solution.
	82	+One control mechanism we consider a best practice to guard yourself against those risks is to add a filter
	83	+before data is placed on the offramp queue.
	84	+By doing this consistently you can control when a specific offramp can receive data on any environment.
	85	+In other words, when a certain system is not ready yet to receive data on Acceptance or Production but is ready on Test
	86	+you can control this behavior with this solution.
67	67
68	68	Below you see how this will look on flow level.
69	69
70		-[[image:Main.Images.Microlearning.WebHome@crashcourse-messaging-asynchronous-routing--filter-construction.png]]
	90	+<p align="center">[[image:crashcourse-messaging-asynchronous-routing--filter-construction.png||]]</p>
71	71
72	72	When we zoom in on the filter component we see a simple SpEL expression that checks the value of a certain property.
73	73	When the value of the property is true the message can pass. If the value of the property is any other value the message will be halted.
74	74	The best practice would be to work with false to get clarity on what the intended use of the property value is.
75	75
76		-[[image:Main.Images.Microlearning.WebHome@crashcourse-messaging-asynchronous-routing--filter-configuration.png]]
	96	+<p align="center">[[image:crashcourse-messaging-asynchronous-routing--filter-configuration.png||]]</p>
77	77
78	78	=== 3.4 Step by step guide ===
79	79
...	...	@@ -82,17 +82,19 @@
82	82
83	83	Steps to follow when adding an integration to the routing Part I:
84	84
85		-* Add a header in the onramp named {technicalnameofproject}\_targetSystem (if this is not done yet)
86		-* Fill this header with a value that should be defined as a property (naming convention = systemname.messagetype.targetsystems)
87		-* This property should be created in Test, Accp, and Prod and filled with all target systems for a certain message type (notation = systemname1,systemname2,systemname3)
88		-* In the routing a standard router should be used as the first building block after receiving the input.
	105	+1. Add a header in the onramp named {technicalnameofproject}\_targetSystem (if this is not done yet)
	106	+2. Fill this header with a value that should be defined as a property (naming convention = systemname.messagetype.targetsystems)
	107	+3. This property should be created in Test, Accp, and Prod and filled with all target systems for a certain message type (notation = systemname1,systemname2,systemname3)
	108	+4. In the routing a standard router should be used as the first building block after receiving the input.
89	89
90	90	Part II
91	91
92		-* In this standard router a SpelExpression has to be defined **once** that concatenates the following headers: {technicalnameofproject}\_targetSystem and {technicalnameofproject}\_messageType.
93		-* For every unique combination there is a value that should be specified alongside the channel on which to put the message (this should be a channel that ultimately leads to the correct offramp queue)
94		-* For every channel that leads to a JMS outbound channel adapter a filter needs to be added to make sure that each output option can be turned on or off easily. This to prevent that messages are sent to a system that does not expect them then
95		-* This filter should look like this: '${routing.monitor.detorem.enabled}' == 'true'. The naming convention of said property is routing.targetsystem.messagetype.enabled.
	112	+5. In this standard router a SpelExpression has to be defined **once** that concatenates the following headers: {technicalnameofproject}\_targetSystem and {technicalnameofproject}\_messageType.
	113	+6. For every unique combination there is a value that should be specified alongside the channel on which to put the message (this should be a channel that ultimately leads to the correct offramp queue)
	114	+7. For every channel that leads to a JMS outbound channel adapter a filter needs to be added to make sure that each output option can be turned on or off easily.
	115	+ This to prevent that messages are sent to a system that does not expect them then
	116	+ 8 This filter should look like this: '${routing.monitor.detorem.enabled}' == 'true'.
	117	+ The naming convention of said property is routing.targetsystem.messagetype.enabled.
96	96
97	97	=== 3.5 The result ===
98	98
...	...	@@ -99,8 +99,9 @@
99	99	The result of setting up your asynchronous routing in this manner
100	100	is that you have one single point of entry, one single piece of decision logic, and a way to control the output per specific output channel.
101	101
102		-[[image:Main.Images.Microlearning.WebHome@crashcourse-messaging-asynchronous-routing--simple-asynchronous-routing-example.png]]
	124	+<p align="center">[[image:crashcourse-messaging-asynchronous-routing--simple-asynchronous-routing-example.png||]]</p>
103	103
	126	+===== Practice =====
104	104
105	105	== 4. Assignment ==
106	106
...	...	@@ -113,6 +113,8 @@
113	113	* Control the output with a filter to prevent data to be sent to a queue too early
114	114	* Use the annotations to write down the step by step guide within your asynchronous routing
115	115
	139	+
	140	+
116	116	== 6. Suggested Additional Readings ==
117	117
118	118	If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
...	...	@@ -121,6 +121,10 @@
121	121
122	122	This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
123	123
124		-{{video attachment="crashcourse-messaging-asynchronous-routing.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
	149	+<iframe width="1280" height="720" src="../../vid/microlearning/crashcourse-messaging-asynchronous-routing.mp4" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
125	125
126		-)))((({{toc/}}))){{/container}}{{/container}}
	151	+</div>
	152	+</div>
	153	+</div>
	154	+
	155	+{{/html}}