Skip to Content

Wiki source code of Manage Message Redelivery

Version 12.1 by Erik Bakker on 2023/01/26 11:13
Show last authors
1 {{container}}
2 {{container layoutStyle="columns"}}
3 (((
4 {{warning}}
5 Please note that this microlearning is for the new monitoring stack only.
6 {{/warning}}
7
8 In this microlearning, we will learn how you can view the messages that are currently waiting for message redelivery. On top of that, we will learn how you can perform actions on these messages. The primary step we will be focusing on is the redelivery of the message itself.
9
10 Should you have any questions, please get in touch with academy@emagiz.com.
11
12 == 1. Prerequisites==
13 * Basic knowledge of the eMagiz platform
14
15 == 2. Key concepts==
16 This microlearning is about redelivering messages from the message redelivery overview in Manage.
17
18 * The message redelivery overview shows the following:
19 ** The queue on which the error occurred.
20 ** The payload of the message as it arrived on this queue
21 ** The header information of the message as it arrived on this queue
22 ** Metadata about the message
23 * Via the "Show error message" button you can see the accompanying error for a period of four weeks
24 * With the help of the "Retry" button you can redeliver a specific message
25 * With the help of the "Delete message" button you can remove a specific message
26 * With the help of the "Retry all" button you can redeliver all messages
27 * With the help of the "Delete all" button you can remove all messages waiting to be redelivered
28 * With the help of the "Save as test message" button you can save the test message and link it to the flow in which error occurred.
29 * You can access this overview in two ways:
30 ** Via Manage -> Explore -> Redelivery
31 ** Via Manage -> Dashboard -> Select Flow -> Select Error -> "Redelivery" button
32
33 == 3. Manage Message Redelivery ==
34
35 In this microlearning, we will learn how you can view the messages that are currently waiting for message redelivery. On top of that, we will learn how you can perform actions on these messages. The primary step we will be focusing on is the redelivery of the message itself.
36
37 The message redelivery overview can be found in the Manage phase of eMagiz. Within Manage you can navigate to Explore -> Redelivery to access the overview. In this overview you can search on the queue name or on the original ID (as can be found in the error message under the header called jms_messageId).
38
39 {{info}}Note that the overview is sorted ascending on date. This means that the oldest message is shown on top and the latest message is shown at the bottom of the list.{{/info}}
40
41 [[image:Main.Images.Microlearning.WebHome@intermediate-message-redelivery-redelivery-in-manage-gen3--message-redelivery-overview.png]]
42
43 On top of that you have the option to "Retry all", "Delete all" messages or "Refresh" the view. As the naming implies the "Retry all" button will retry all messages that are currently available in the message redelivery functionality. Note that for each message that generates a new error a new entry will be created in the message redelivery functionality. The "Delete all" button removes all messages from the message redelivery functionality. With the "Refresh" button you can refresh the overview to see whether new messages arrived on the queue.
44
45 By selecting a specific message your view changes as detail information of your selected message will be shown. In this additional overview you see the message, its headers, some metadata, and various options to execute on message level.
46
47 [[image:Main.Images.Microlearning.WebHome@intermediate-message-redelivery-redelivery-in-manage-gen3--message-redelivery-overview-detailed-view.png]]
48
49 After you have selected the specific message you have several additional buttons available. On message level you have the "Retry" and "Delete message" button. They work in a similar fashion as the retry and delete buttons on the overview level only these buttons work **on message level**.
50
51 By pressing the "Show error message" button you can view the accompanying error message that caused the message to end up in the message redelivery functionality.
52
53 [[image:Main.Images.Microlearning.WebHome@intermediate-message-redelivery-redelivery-in-manage-gen3--message-redelivery-overview-show-error-message.png]]
54
55 On top of that we have functionality that allows you to save the test message and link it to the correct flow so you can use it as a test message in your flow testing functionality. For this the button "Save as test message" is used. On top of that you can also "Download" your message if there is a need for it.
56
57 [[image:Main.Images.Microlearning.WebHome@intermediate-message-redelivery-redelivery-in-manage--error-message-details.png]]
58
59 Note that there is not always an accompanying error message to be found. In those cases eMagiz will show you an empty error messages pop-up.
60
61 === 3.1 Redeliver Message(s) ===
62
63 When you want to redeliver a message you simply select the message and press the button Redeliver. In case all errors originate from the same cause and the cause is resolved you could opt for the option "Redeliver All". This will redeliver all messages at once.
64
65 [[image:Main.Images.Microlearning.WebHome@intermediate-message-redelivery-redelivery-in-manage--redeliver-options.png]]
66
67 Note that when the message could not be redelivered after you press the redeliver button the old message will disappear from the screen and a new message corresponding to the new error will appear again in your list.
68
69 === 3.2 Remove Message(s)===
70
71 When you determine that it is not relevant anymore to redeliver a certain message you can have the option to remove a message by selecting it and pressing the button "Remove". On top of that you have the option to "Remove All". This will remove all messages at once.
72
73 [[image:Main.Images.Microlearning.WebHome@intermediate-message-redelivery-redelivery-in-manage--remove-options.png]]
74
75 == 4. Assignment ==
76
77 As this is a feature flagged functionality, no assignment will be associated with this microlearning.
78
79 == 5. Key takeaways==
80
81 * The message redelivery overview shows the following:
82 ** The queue on which the error occurred.
83 ** The payload of the message as it arrived on this queue
84 ** The header information of the message as it arrived on this queue
85 ** Metadata about the message
86 * Via the "Show error message" button you can see the accompanying error for a period of four weeks
87 * With the help of the "Retry" button you can redeliver a specific message
88 * With the help of the "Delete message" button you can remove a specific message
89 * With the help of the "Retry all" button you can redeliver all messages
90 * With the help of the "Delete all" button you can remove all messages waiting to be redelivered
91 * With the help of the "Save as test message" button you can save the test message and link it to the flow in which error occurred.
92 * You can access this overview in two ways:
93 ** Via Manage -> Explore -> Redelivery
94 ** Via Manage -> Dashboard -> Select Flow -> Select Error -> "Redelivery" button
95
96 == 6. Suggested Additional Readings ==
97
98 There are no suggested additional readings on this topic.
99
100 == 7. Silent demonstration video ==
101
102 This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
103
104 {{video attachment="intermediate-message-redelivery-redelivery-in-manage.mp4" reference="Main.Videos.Microlearning.WebHome"/}})))
105 ((({{toc/}}))){{/container}}
106 {{/container}}