|
Server management requests contain content that is formatted as XML.
NoteYou cannot use symbols such as > or < in the content of server management requests. Instead, use > and <. |
Each server management request starts with an <actions> tag.
Each type of server management request includes it own XML tags. For example, to close a connector you use the <CloseConnector> tag.
In addition, most server management requests can include a <request> tag that describes the request. Within a <request> tag, you can use the following subtags:
| <request> subtags | Description |
|---|---|
| <condition> | Groups conditions for including a message in the report. Only used in the <request> tag, which is a subtag of <MessageDetailsRequest> and <CancelMessageRequest>. |
| <onEvent> | Specifies the events upon which the server should generate reports. Only used with <ClientStatusRequest>. You can include one or more <onEvent> tags, with one event type per tag. If these tags are omitted, the Client Status Request produces a one-time request. Otherwise, the Client Status Request registers event listeners for the specified events. |
| <persistent> | Specifies that the results of the request should be made persistent in the server database (so that the report is sent even if the server is restarted). Only used with schedules. |
| <report> | Specifies that a report should be sent each time the request is activated. Only used in the <request> tag, which is a subtag of <CancelMessageRequest>. |
| <requestId> | Specifies a unique identifier for the request that is included in each report generated as a result of this request. Only used when a server management request generates a response or report. Using different values for this field allows more than one request to be active at the same time. Using the same request ID allows the client to override or delete active requests. |
| <replyAddr> | Specifies the return address for each report generated as a result of this request. If this tag is omitted, the default return address of reports is the reply address of the originating message. Only used when a server management request generates a response or report. |
| <schedule> | Specifies that the report should be generated on a schedule. Only used when a server management request generates a response or report. See Scheduling server management requests. |
Use the following condition subtags to filter the messages to include in the MessageDetailsRequest. You can specify as many of these tags as you want in the <condition> tag. If you use more than one of the same tag, then the values given are logically "OR"ed together, whereas if you use two different tags, the values are logically "AND"ed together.
|
<condition> subtags |
Description |
|---|---|
|
<address> |
Selects the messages that are addressed to the specified address. |
| <customRule> | Selects messages based on rules. See Custom message requests. |
|
<kind> |
Filters either binary or text messages. For example, <kind>text</kind> filters text messages, and <kind>binary</kind> filters binary messages. |
|
<messageId> |
Selects the message with a particular message ID. |
|
<originator> |
Selects messages that originated from the specified client. |
|
<priority> |
Selects the messages that currently have the priority specified. |
|
<property> |
Selects messages that have the specified message property. To check a property name and value, use the syntax <property>property-name=property-value</property>. To check the existence of a property, use the format <property>property-name</property>. |
|
<status> |
Selects messages that currently have the status specified. |