This is an automated email from the ASF dual-hosted git repository.
robbie pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/activemq-artemis-console.git
The following commit(s) were added to refs/heads/main by this push:
new 3356af1 ARTEMIS-5395 - add a help modal to explain message filtering
in the message table
3356af1 is described below
commit 3356af12c17bb563a6f9dffc8f54000d3f0b07eb
Author: Andy Taylor <[email protected]>
AuthorDate: Wed May 14 10:44:01 2025 +0100
ARTEMIS-5395 - add a help modal to explain message filtering in the message
table
---
.../artemis-console-plugin/src/queues/QueuesView.tsx | 14 ++++++++------
1 file changed, 8 insertions(+), 6 deletions(-)
diff --git
a/artemis-console-extension/artemis-extension/packages/artemis-console-plugin/src/queues/QueuesView.tsx
b/artemis-console-extension/artemis-extension/packages/artemis-console-plugin/src/queues/QueuesView.tsx
index d8d4c22..b37dd81 100644
---
a/artemis-console-extension/artemis-extension/packages/artemis-console-plugin/src/queues/QueuesView.tsx
+++
b/artemis-console-extension/artemis-extension/packages/artemis-console-plugin/src/queues/QueuesView.tsx
@@ -22,6 +22,7 @@ import { Filter } from '../table/ArtemisTable';
import { Button, Modal, ModalVariant, TextContent, Title, Text, Icon,
TextVariants, TextList, TextListItem, TextListItemVariants, TextListVariants }
from '@patternfly/react-core';
import { Message, MessageView } from '../messages/MessageView';
import { HelpIcon } from '@patternfly/react-icons';
+import { Link } from 'react-router-dom';
export type QueueNavigate = {
search: Function
@@ -104,6 +105,7 @@ export const QueuesView: React.FunctionComponent<Navigate>
= navigate => {
<Modal aria-label='copy-message-modal'
variant={ModalVariant.medium}
isOpen={showHelpModal}
+ onClose={() => setShowHelpModal(false)}
actions={[
<Button key="cancel" variant="secondary" onClick={() =>
setShowHelpModal(false)}>
Close
@@ -112,9 +114,9 @@ export const QueuesView: React.FunctionComponent<Navigate>
= navigate => {
<TextContent>
<Text component={TextVariants.h1}>Using Filter Expressions</Text>
<Text component={TextVariants.h2}>Apache ActiveMQ Artemis provides
a powerful filter language based on a subset of the SQL 92 expression
syntax.</Text>
- <Text>It is the same as the syntax used for JMS & Jakarta
Messaging selectors.
- For documentation on JMS selector syntax please the JavaDoc for
javax.jms.Message or jakarta.jms.Message</Text>
- <Text>A Filter will search for messages that have a matching
header.</Text>
+ <Text>It is similar to the syntax used for JMS Message selectors.
+ For documentation on JMS selector syntax please the JavaDoc for
javax.jms.Message or <Link target='_BLANK'
to={'https://jakarta.ee/specifications/messaging/3.1/apidocs/jakarta.messaging/jakarta/jms/message'}>jakarta.jms.Message</Link></Text>
+ <Text>A Filter will search for messages that have a matching
property.</Text>
<Text component={TextVariants.h3}>Filter Examples</Text>
<TextList component={TextListVariants.dl}>
<TextListItem component={TextListItemVariants.dt}>header =
'value'</TextListItem>
@@ -125,7 +127,7 @@ export const QueuesView: React.FunctionComponent<Navigate>
= navigate => {
<TextListItem component={TextListItemVariants.dd}> This will
return any message where the message header <b>header</b> has an int, short,
long or double value greater than <b>1</b></TextListItem>
<TextListItem component={TextListItemVariants.dt}>header
{'<>'} 'value'</TextListItem>
<TextListItem component={TextListItemVariants.dd}> This will
return any message where the message header <b>header</b> exists and does not
equal <b>value</b></TextListItem>
- <TextListItem component={TextListItemVariants.dt}>header in
('value1', 'value2')</TextListItem>
+ <TextListItem component={TextListItemVariants.dt}>header IN
('value1', 'value2')</TextListItem>
<TextListItem component={TextListItemVariants.dd}> This will
return any message where the message header <b>header</b> equals either
<b>value1</b> or <b>value2</b></TextListItem>
<TextListItem component={TextListItemVariants.dt}>header1 =
'value1' AND header2 = 'value2'</TextListItem>
<TextListItem component={TextListItemVariants.dd}> This will
return any message where the message header <b>header1</b> has the value
<b>value1</b> and the message header <b>header2</b> has the value
<b>value2</b></TextListItem>
@@ -133,7 +135,7 @@ export const QueuesView: React.FunctionComponent<Navigate>
= navigate => {
<TextListItem component={TextListItemVariants.dd}> This will
return any message where the message header <b>header</b> has the pattern
matching value <b>value%</b> such as <b>value1</b>, <b>value2345</b>
etc</TextListItem>
<TextListItem component={TextListItemVariants.dt}>header LIKE
'value_'</TextListItem>
<TextListItem component={TextListItemVariants.dd}> This will
return any message where the message header <b>header</b> has the pattern
matching value <b>value_</b> such as <b>value1</b> but not
<b>value2345</b></TextListItem>
- <TextListItem component={TextListItemVariants.dt}>header is
null</TextListItem>
+ <TextListItem component={TextListItemVariants.dt}>header IS
null</TextListItem>
<TextListItem component={TextListItemVariants.dd}> This will
return any message where the message header <b>header</b> has a null value or
does not exist</TextListItem>
</TextList>
<Text> The following pre defined identifiers can also be used to
filter messages </Text>
@@ -141,7 +143,7 @@ export const QueuesView: React.FunctionComponent<Navigate>
= navigate => {
<TextListItem
component={TextListItemVariants.dt}>AMQUserID</TextListItem>
<TextListItem component={TextListItemVariants.dd}>The ID set
by the user when the message is sent. This is analogous to the
<b>JMSMessageID</b> for JMS-based clients.</TextListItem>
<TextListItem
component={TextListItemVariants.dt}>AMQAddress</TextListItem>
- <TextListItem component={TextListItemVariants.dd}>The group ID
used when sending the message.</TextListItem>
+ <TextListItem component={TextListItemVariants.dd}>The address
to which the message was sent.</TextListItem>
<TextListItem
component={TextListItemVariants.dt}>AMQPriority</TextListItem>
<TextListItem component={TextListItemVariants.dd}>To refer to
the priority of a message. Message priorities are integers with valid values
from 0 - 9. 0 is the lowest priority and 9 is the highest. e.g. <i>AMQPriority
= 3 AND animal = 'aardvark'</i></TextListItem>
<TextListItem
component={TextListItemVariants.dt}>AMQExpiration</TextListItem>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
For further information, visit: https://activemq.apache.org/contact
