December 24 - AppLogic 2.4.7 is now available and is the latest production release!
Dashboard Message Management Commands
The following operations are supported:
| Command | Description |
|---|
| list | List messages |
| create | Create a new message |
| destroy | Destroy a message |
| get | Get message text/attributes |
| set | Set message text/attributes |
Messages are identified by an ID which has the following format: NNN, where N is a digit and ttttt is an alphanumeric identifier (regexp
/\d{3}[\d\w-]+/). For example,
220volcheck. The number determines the order of the messages; the name is usually the name of the logical service issuing the message (free word).
list
| Description: | List messages |
| Syntax: | message list [ --batch ] [ --verbose ] |
| Arguments: | --batch | Display output in UDL format |
| --verbose | Include timestamp and full message text in the output. |
| Examples | message list - List dashboard messages |
| Notes: | The following information is displayed for each message: ID, Severity, and Text. |
| The list is sorted alphabetically based on the message ID and message text is truncated if the length of the line exceeds 80 characters. |
| When displaying message text in batch mode, unprintable characters are escaped as per UDL requirements. |
Typical Output
110volcheck Message text
120ha !Message text that is important and too long...
450volscan More message text
create
| Description: | Create Message |
| Syntax: | message create id [ severity=val] [ text=val ] [append=val ] [ --fail-existing ] |
| Arguments: | id | Message ID |
| severity=val | Message severity. May be info or alert. Default is info. |
| text=val | Message text. |
| append=val | Message text to be appended to text or appended to existing text. |
| --fail-existing | Fail request if there is already a message with the same ID; otherwise, overwrite the message. |
| Examples | message create 120ha severity=alert text="Message text that is important" - create message |
| Notes: | If file= is provided, text argument must not be provided. |
| When the append argument is provided, the supplied text is appended to the existing message text if the message already exists or appended to the text supplied in the text argument. |
destroy
| Description: | Destroy dashboard message |
| Syntax: | message destroy id - destroy message specified by id |
| message destroy --all - destroy all messages |
| Arguments: | id | Message ID of message to destroy |
| Examples: | message destroy 120ha - destroy message 120ha |
get
| Description: | Get message text and attributes |
| Syntax: | message get id [ --batch ] |
| Arguments: | id | Message Id of message to retrieve text and attributes for |
| Examples: | message get 120ha - get text/attributes for message 120ha |
| Notes: | The following information is displayed for the message: severity, date and time the message was created, and message text. |
| When displaying message text in batch mode, unprintable characters are escaped as per UDL requirements. |
Typical Output
ID : 120ha
Important : 1
Timestamp : Thu Aug 31 15:20:44 2006
Text :
Message text that is important and too long and continues for a very
long time
set
| Description: | Modify message text and/or attributes |
| Syntax: | message set id [ severity=val ] [ text=val ] [ append=val ] |
| Arguments: | id | Message ID |
| severity=val | New message severity. |
| text=val | New message text. |
| append=val | Text to be appended to the message text |
| Examples | message set 120ha severity=info text=The importance of this message has been lowered" - change severity and modify text for message |
| Notes: | At least one of severity, text, or append arguments must be specified. |
| This command fails if the message does not already exist. |
--
BeckyH - 31 Aug 2006
AppLogic2 Web