Skip to Content

Changes for page Command Queue

Last modified by Erik Bakker on 2024/02/22 13:38
From version 7.1
edited by Erik Bakker
on 2022/07/26 09:05
Change comment: There is no comment for this version
To version 16.1
edited by Erik Bakker
on 2022/12/29 14:44
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -expert-create-your-transformations-xpath-expert
1 +Command Queue
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Content
... ... @@ -1,87 +1,48 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -Within the crash course, we already explained XPath conceptually. In that same microlearning, we looked at some more uncomplicated cases of using XPath within your transformation. If you need to brush up on that knowledge, please check out this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-transformation-xpath-basic.WebHome||target="blank"]]. In the intermediate microlearning on this subject, we built upon that knowledge. Please check out this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Create your transformations.intermediate-create-your-transformations-xpath-intermediate.WebHome||target="blank"]] if you need a refresher on that. In the [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Create your transformations.advanced-create-your-transformations-xpath-advanced.WebHome||target="blank"]] that followed, we built upon that knowledge and looked at some concrete, practical examples that could be useful in your project. In this microlearning, we will wrap the concept of XPath by looking at three complex XPath alternatives that are sometimes needed when dealing with messages in eMagiz.
2 +{{error}}
3 +Note that the functionality mentioned in this microlearning will become obsolete when migrating to the 3rd generation runtime.
4 +{{/error}}
3 3  
6 +Within the platform of eMagiz, sometimes you need to send a particular command from the eMagiz portal to retrieve information or execute a specific action. These commands can happen from the Deploy and the Manage phase. The two most noteworthy examples of the triggered command queue are the runtime dashboard functionalities and the message redelivery actions.
7 +
4 4  Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
6 6  == 1. Prerequisites ==
7 7  
8 8  * Expert knowledge of the eMagiz platform
9 -* [[XPath Basic>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-transformation-xpath-basic.WebHome||target="blank"]]
10 -* [[XPath Intermediate>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Create your transformations.intermediate-create-your-transformations-xpath-intermediate.WebHome||target="blank"]]
11 -* [[XPath Advanced>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Create your transformations.advanced-create-your-transformations-xpath-advanced.WebHome||target="blank"]]
12 12  
13 -
14 14  == 2. Key concepts ==
15 15  
16 -This microlearning focuses on very complex XPath operations.
16 +This microlearning focuses on the command queue. The command queue communicates between the eMagiz portal and an eMagiz runtime.
17 17  
18 -With XPath Expert, we mean learning that XPath options are sometimes very complex but could benefit you in specific cases in your daily work.
18 +* Commands towards a runtime, for example, to retrieve runtime information in the runtime dashboard, are sent via the command queue
19 +* You can monitor the command queue the same way as any other queue within your model
20 +* The command queue is prominently used when accessing the [[Runtime Dashboard>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-deploy-runtime-dashboard||target="blank"]] and when using [[Message Redelivery>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Message Redelivery.WebHome||target="blank"]]
19 19  
20 -Some of the very complex XPath options are:
22 +== 3. Command queue ==
21 21  
22 -* matches
23 -* replace
24 -* tokenize
24 +Within the platform of eMagiz, sometimes you need to send a particular command from the eMagiz portal to retrieve information or execute a specific action. These commands can happen from the Deploy and the Manage phase. The two most noteworthy examples of the triggered command queue are the runtime dashboard functionalities and the message redelivery actions.
25 25  
26 -== 3. XPath Expert ==
26 +For example, when you navigate the Runtime Dashboard and click on a runtime, the eMagiz portal will send a command to the runtime via the command queue to retrieve the runtime state. So, for example, the same logic applies when you select a flow and stop it.
27 27  
28 -Within the crash course, we already explained XPath conceptually. In that same microlearning, we looked at some more uncomplicated cases of using XPath within your transformation. If you need to brush up on that knowledge, please check out this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-transformation-xpath-basic.WebHome||target="blank"]]. In the intermediate microlearning on this subject, we built upon that knowledge. Please check out this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Create your transformations.intermediate-create-your-transformations-xpath-intermediate.WebHome||target="blank"]] if you need a refresher on that. In the [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Create your transformations.advanced-create-your-transformations-xpath-advanced.WebHome||target="blank"]] that followed, we built upon that knowledge and looked at some concrete, practical examples that could be useful in your project. In this microlearning, we will wrap the concept of XPath by looking at three complex XPath alternatives that are sometimes needed when dealing with messages in eMagiz.
28 +For Message redelivery, the command queue retrieves all messages in the dead letter queue and resends messages via the command queue.
29 29  
30 -Some of the very complex XPath options are:
30 +{{info}}When all commands sent from the eMagiz portal are not working across models, something is probably broken in the backend of the eMagiz platform. In these cases, please contact us at [[support@emagiz.com>>mailto:support@emagiz.com]]{{/info}}
31 31  
32 -* matches
33 -* replace
34 -* tokenize
35 -
36 -=== 3.1 matches ===
37 -
38 -Sometimes, you want to determine whether a specific value within your payload matches a pattern. In those cases, you can use the XPath function called matches. The function will return true if the supplied string matches a given regular expression. So, for example, if you want to check whether your OrderID contains exactly seven digits and nothing else, the following XPath expression will work for your use case.
39 -
40 -matches(OrderID,'^\d{7}$')
41 -
42 -As a result, you will get a true or false back which you can then use as a filter or within an if-then-else construction.
43 -
44 -=== 3.2 replace ===
45 -
46 -The replace function has many similarities with the matches function. It builds on the premise of the matches function, but instead of returning a true or false, you can state with what you want to replace the matched string. In other words, this function returns a string produced from the input string by replacing any substrings that match a given regular expression with a supplied replacement string.
47 -
48 -When we apply this to our earlier example, we can state that when the OrderID contains any non-digit, we will replace this value with nothing. This will lead to the following XPath expression.
49 -
50 -replace(OrderID,'\D','')
51 -
52 -With a given input string of 12C34A567, the returned result will be 1234567.
53 -
54 -=== 3.3 tokenize ===
55 -
56 -The tokenize function can split a string into multiple entries for you. This is particularly useful when you want to match an input string to a list of possible values that are valid for that string. For example, the function returns a sequence of strings constructed by splitting the input wherever a separator is found; the separator is any substring that matches a given regular expression.
57 -
58 -So, for example, when the input string for AddressID is "street,housenumber,housenumberaddition" and you want to tokenize this with the help of the separator, you could use, in this example, the comma between the values as the separator. This will lead to the following XPath expression.
59 -
60 -tokenize(AddressID,',')
61 -
62 -The given input detailed above will result in the following output: street housenumber housenumberaddition.
63 -
64 64  == 4. Assignment ==
65 65  
66 -Check out which of the XPaths we have discussed today can be found within your project.
67 -This assignment can be completed within the (Academy) project you created/used in the previous assignment.
34 +There is no assignment for this microlearning.
68 68  
69 69  == 5. Key takeaways ==
70 70  
71 -Some of the very complex XPath options are:
38 +* Commands towards a runtime, for example, to retrieve runtime information in the runtime dashboard, are sent via the command queue
39 +* You can monitor the command queue the same way as any other queue within your model
40 +* The command queue is prominently used when accessing the [[Runtime Dashboard>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-deploy-runtime-dashboard.WebHome||target="blank"]] and when using [[Message Redelivery>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Message Redelivery.WebHome||target="blank"]]
72 72  
73 -* matches
74 -* replace
75 -* tokenize
76 -
77 77  == 6. Suggested Additional Readings ==
78 78  
79 -If you are interested in this topic and want more information on it, please read the help text provided by eMagiz and read more information on the following links:
44 +There are no suggested additional readings.
80 80  
81 -* http://www.xsltfunctions.com/xsl/fn_matches.html
82 -* http://www.xsltfunctions.com/xsl/fn_replace.html
83 -* http://www.xsltfunctions.com/xsl/fn_tokenize.html
84 -
85 85  == 7. Silent demonstration video ==
86 86  
87 87  As this is more of theoretical microlearning, there is no video accompanying the microlearning.)))((({{toc/}}))){{/container}}{{/container}}