Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The viewer allows you to browse control system messages, receiving updates from the live system as well as those previously logged.  You can specify keyword filters to narrow messages to only those that interest you.  It also supports printing, saving to a file, cutting and pasting, sorting, pausing and resuming.

How do I use it?

Starting

Within SEAL: Start the cmlog viewer by starting its Eclipse View. That is, Window -> Show View (you may need to select Other ... at this point) SEAL -> cmlog. Once started, use the File -> Get Messages dialog to connect to a cmlog server.

Stand-Alone viewer: Run cmlogviewer from the command-line. 

Getting some messages

Under the "File" menu, select "Get Messages...".  Doing so will open a dialog box that allows you to specify the message server, filter messages by content, and indicate whether to listen for live messages, or only to search through old messages.

...

If you choose to retrieve old messages only, then you specify a time range in the text box.  Only messages logged within that time range will be retrieved by the viewer.  You may select a pre-defined time range, or enter one yourself in the format of "begin - end".  In addition to the standard mm/dd/yy hh:mm:ss format, you may also use several special phrases as shorthand.  (e.g. 11/26/07 08:00 - 11/26/07 12:30, or current day - now, or current hour - current minute, or current day - current shift).  If instead of using a pre-defined date or typing one manually, you select "Assist..." from the drop down box, you'll get a little wizard that will help you construct a time range by specifying an anchor time and a duration.

Using the Viewer

Sorting: Normally, messages are sorted by the time field, with newer ones at the bottom.  But you can sort by any of the fields.  To do so, simply click on the desired column heading.  Clicking the currently selected column will reverse the sort order.  Note that the black triangle in the sort column header designates the direction: the vertex indicates the direction of descending values.

Pausing updates: Because the message view is continuously updating, it can be useful at times to freeze the display.  You can do this by clicking the "Pause Updates" button in the bottom right corner of the window.  When you pause updates, you prevent the window contents from changing, but things are still happening under the hood.  When you un-click the button, the window contents will look the same as they would have, had you never paused in the first place.

Changing the message retrieval parameters: 

Copying messages to the clip board:

Saving to a file\:

Printing:

Known Issues

In Jira, Cmlog Viewer is a component in the SEAL Project.
Summary of known Jira Issues: https://jira.slac.stanford.edu/secure/IssueNavigator.jspa?reset=true&mode=hide&sorter/order=ASC&sorter/field=priority&pid=10447&component=10850