Changes for page Manage Message Redelivery

Last modified by Danniar Firdausy on 2024/09/18 21:26

From 5.1 to 6.1

From version 6.1

edited by Erik Bakker
on 2022/09/01 09:10

Change comment: There is no comment for this version

To version 16.7

edited by Danniar Firdausy
on 2024/09/18 21:26

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (3 modified, 0 added, 0 removed)

Details

Page properties

Title

@@ -1,1 +1,1 @@
--Message Redelivery in Manage
++Manage Message Redelivery

Author

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

Content

@@ -1,78 +1,101 @@
  {{container}}
  {{container layoutStyle="columns"}}
  (((
--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.
++{{warning}}
++Please note that this microlearning is for the new monitoring stack only.
++{{/warning}}
++In the previous [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Message Redelivery.intermediate-message-redelivery-configuration-gen3.WebHome||target="blank"]], we have learned how to configure Message Redelivery functionality for a specific flow towards a system. 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.
++
  Should you have any questions, please get in touch with academy@emagiz.com.
  == 1. Prerequisites==
--- Basic knowledge of the eMagiz platform
++* Basic knowledge of the eMagiz platform
  == 2. Key concepts==
  This microlearning is about redelivering messages from the message redelivery overview in Manage.
--* The message redelivery overview shows metadata about each message that is yet to be redelivered
--* Via the Details button you can see the accompanying two weeks (assuming the message was not place in message redelivery more than two weeks ago)
--* With the help of the Redelivery button you can redeliver a specific message
--* With the help of the Remove button you can remove a specific message
--* With the help of the Redeliver All button you can redeliver all messages
--* With the help of the Remove All button you can remove all messages waiting to be redelivered
++* The message redelivery overview shows the following:
++  ** The queue on which the error occurred.
++  ** The payload of the message as it arrived on this queue
++  ** The header information of the message as it arrived on this queue
++  ** Metadata about the message
++* Via the "Show error message" button you can see the accompanying error for a period of four weeks
++* With the help of the "Retry" button you can redeliver a specific message
++* With the help of the "Delete message" button you can remove a specific message
++* With the help of the "Retry all" button you can redeliver all messages
++* With the help of the "Delete all" button you can remove all messages waiting to be redelivered
++* 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.
++* You can access this overview in two ways:
++  ** Via Manage -> Explore -> Redelivery
++  ** Via Manage -> Dashboard -> Select Flow -> Select Error -> "Redelivery" button
++== 3. Manage Message Redelivery ==
--== 3. Message Redelivery in Manage ==
++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).
--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.
++{{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}}
--The message redelivery overview can be found in the Manage phase of eMagiz. Within Manage you can navigate to Error Message -> Message Redelivery to access the overview.
++[[image:Main.Images.Microlearning.WebHome@intermediate-message-redelivery-redelivery-in-manage-gen3--message-redelivery-overview.png]]
--[[image:Main.Images.Microlearning.WebHome@intermediate-message-redelivery-redelivery-in-manage--message-redelivery-overview-empty.png]]
++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.
--Once the overview contains messages it will look something as follows. For each message we have a timestamp and two IDs.
++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.
--[[image:Main.Images.Microlearning.WebHome@intermediate-message-redelivery-redelivery-in-manage--message-redelivery-overview-filled-in.png]]
++[[image:Main.Images.Microlearning.WebHome@intermediate-message-redelivery-redelivery-in-manage-gen3--message-redelivery-overview-detailed-view.png]]
--By selecting a specific message and pressing the Details button eMagiz will search for the accompanying error message from the error message dashboard. If eMagiz can find the accompanying error message eMagiz will show you the error message details.
++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**.
--[[image:Main.Images.Microlearning.WebHome@intermediate-message-redelivery-redelivery-in-manage--error-message-details.png]]
++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.
--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.
++[[image:Main.Images.Microlearning.WebHome@intermediate-message-redelivery-redelivery-in-manage-gen3--message-redelivery-overview-show-error-message.png]]
--=== 3.1 Redeliver Message(s) ===
++{{warning}}
++* Error messages are only kept for a period of four weeks (when the limit on a hourly basis is not exceeded within this time period). Should eMagiz not be able to retrieve the error message you will be notified on this.
++* Should you have exceeded your error messages limit the message will be available in message redelivery but the accompanying error won't be visible.{{/warning}}
--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.
++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.
--[[image:Main.Images.Microlearning.WebHome@intermediate-message-redelivery-redelivery-in-manage--redeliver-options.png]]
++[[image:Main.Images.Microlearning.WebHome@intermediate-message-redelivery-redelivery-in-manage-gen3--error-message-details.png]]
--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.
++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.
--=== 3.2 Remove Message(s)===
++=== 3.1 Alternative view ===
--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.
++When you are in the Manage -> Dashboard you can show the error messages on flow level. After you select a flow for which there are error message and for which the message redelivery functionality is configured you can redeliver the message via this overview. This can be done by pressing the button "Redelivery".
--[[image:Main.Images.Microlearning.WebHome@intermediate-message-redelivery-redelivery-in-manage--remove-options.png]]
++[[image:Main.Images.Microlearning.WebHome@intermediate-message-redelivery-redelivery-in-manage-gen3--error-message-dashboard-redelivery.png]]
--== 4. Assignment ==
++Once you press this button a pop-up appears showing you the detailed view of that particular message. From here you have the same options available as when you would have selected the error message via Manage -> Explore -> Redelivery.
--As this is a feature flagged functionality, no assignment will be associated with this microlearning.
++[[image:Main.Images.Microlearning.WebHome@intermediate-message-redelivery-redelivery-in-manage-gen3--error-message-dashboard-redelivery-pop-up.png]]
--== 5. Key takeaways==
++== 4. Key takeaways==
--* The message redelivery overview shows metadata about each message that is yet to be redelivered
--* Via the Details button you can see the accompanying two weeks (assuming the message was not place in message redelivery more than two weeks ago)
--* With the help of the Redelivery button you can redeliver a specific message
--* With the help of the Remove button you can remove a specific message
--* With the help of the Redeliver All button you can redeliver all messages
--* With the help of the Remove All button you can remove all messages waiting to be redelivered
++* The message redelivery overview shows the following:
++  ** The queue on which the error occurred.
++  ** The payload of the message as it arrived on this queue
++  ** The header information of the message as it arrived on this queue
++  ** Metadata about the message
++* Via the "Show error message" button you can see the accompanying error for a period of four weeks
++* With the help of the "Retry" button you can redeliver a specific message
++* With the help of the "Delete message" button you can remove a specific message
++* With the help of the "Retry all" button you can redeliver all messages
++* With the help of the "Delete all" button you can remove all messages waiting to be redelivered
++* 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.
++* You can access this overview in two ways:
++  ** Via Manage -> Explore -> Redelivery
++  ** Via Manage -> Dashboard -> Select Flow -> Select Error -> "Redelivery" button
--== 6. Suggested Additional Readings ==
++== 5. Suggested Additional Readings ==
--There are no suggested additional readings on this topic.
++If you are interested in this topic please read the help text eMagiz provides you and see the following link:
--== 7. Silent demonstration video ==
--
--This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
--
--{{video attachment="intermediate-message-redelivery-redelivery-in-manage.mp4" reference="Main.Videos.Microlearning.WebHome"/}})))
++* [[Intermediate Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
++** [[Message Redelivery (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Message Redelivery.WebHome||target="blank"]]
++*** [[Configure Message Redelivery (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Message Redelivery.intermediate-message-redelivery-configuration-gen3.WebHome||target="blank"]]
++* [[Message Redelivery (Search Results)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&l_space_facet=10&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=%22message+redelivery%22||target="blank"]]
++)))
  ((({{toc/}}))){{/container}}
  {{/container}}