Versions Compared

Old Version 9

changes.mady.by.user Ginger DeContreras

Saved on

compared with

New Version Current

changes.mady.by.user Unknown User (chevtsov)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

Judy's EPICS PV query application: https://seal.slac.stanford.edu/apex/mccqa/f?p=259:8

Panel

USER'S ONLINE GUIDE (version 1.2)

Panel

Table of Contents

Table of Contents

...

WEB START users, please read the information on the page where you got the program. Other users, please continue.

Wiki MarkupTo start ArchiveViewer, make sure JAVA_HOME is defined. Change to the directory that contains archiveviewer.jar.
Type java \ -jar archiveviewer.jar \ [-options\], where \ [-options\] can be one (or sometimes more) of these: \
-u "url"

Connects to the archive data server at the specified URL
-f "config file"

...

  • Absolute Times
    You can enter absolute times for start and end times of a query. Many of absolute time string components are optional. The format for absolute time strings is shown as a tool tip on a time text field. The minimal, mandatory, absolute time string must follow the pattern 'MM/dd' (MM is the month, dd- the day of month) The application will automatically enter these values for missing time components:
    • year: current system year
    • hours: 00
    • minutes: 00
    • seconds: 00
    • msecs: 000
  • Keyword "now"
    The application accepts the keyword "now". Milliseconds before the server request is actually sent, "now" is replaced by the current system time. Please note: If you press PLOT without checking "Keep Plot Ranges", despite caching new data request will be generated because "now" is resolved to a later value.
  • Relative Times
    One of ArchiveViewer's most innovative features is its ability to parse relative time strings. Unfortunately, as with all innovations, the correct usage requires some learning time.
    1. Following tokens are accepted for each of the relative time components (please, note that they indeed are case sensitive):
      • y - year
      • M - month
      • d - day
      • H - hours
      • m - minutes
      • s - seconds
    2. For numeric values, only integers are allowed. For positive integers, you may also use the preceeding "+" sign, which would makes sense semantically
    3. Finally, you can use absolute time entries at the end of each relative date string.
    4. Here are some examples of relative time strings:
      • Legal
        "+1d", "6m", "-1M 6d", "-8H", "-2d 08:00" (note: no spaces are allowed between numbers and relative time tokens)
      • Illegal
        "-1D", "+2 y", "2.5H"
    5. Semantics
      • The sole notion of "relative" time strings requires some kind of a base, and indeed there is something we call "base times", relatively to which "relative times" are resolved. In very most cases, base times can be determined intuitively. We call a relative time string "positive", if the result of parsing and calculating it (in seconds) is a positive number; and we call such string "negative", if the result is a negative number. Please, note that it makes no sense to use positive relative time strings for the start time of a query.
      • All in all, there are 6 cases to consider:
        1. Start time is absolute; end time is absolute Example: Start: 01/01/2003 8:00 End: 01/02/2003
        2. Start time is negative relative; end time is absolute => base time: end time Example: Start: -10d End: now Means: retrieve data from the last 10 days
        3. Start time is absolute; end time is positive relative => base time: start time Example: Start: 01/02/2004 10:00 End: +8H Means: retrieve data that was generated on January 2nd 2004 between 10am and 6pm
        4. Start time is negative relative; end time is positive relative => base time for start time: "now"; base time for end time: start time Example: Start: -7d 8:00 End: +8H Means: retrieve data from the current shift a week ago
        5. Start time is absolute; end time is negative relative => base time: "now" Example: Start: 06/01/2004 End: -5d Means: retrieve data from the 1st of June up to 5 days ago from now
        6. Start time is negative relative; end time is negative relative => base times: "now" for both time strings Example: Start: -10d End: -5d +8H Means: retrieve data from 10 days ago upto 5 days ago, plus 8 more hours of data
    6. Conclusion
      Relative time strings is a fairly intuitive and very useful feature because they allow automated processing of many desirable configurations (just think how easily you can retrieve "yesterday's shift data" day after day).

...

    1. Axes selection
      The labels in the selection box correspond to the labels of the axes in the main control panel. Note: If you want to plot a graph normalized, select the empty entry in the box
    2. Color
    3. Draw types
      • scatter
      • lines: connects graph data points directly
      • steps: connects data points of a graph by drawing a horizontal line and then a vertical line (like a step). This draw type is default/li>
    4. Width
      You can adjust the width of graph lines with this slider
    5. Visibility
      Uncheck the visibility box, if you don't want to display the graph in the next plot. This might be useful if, for example, you 'd like to see the underlying graphs.

...

8. Menubar
Anchor
Menubar
Menubar

    1. FILE menu
      • New Connection
        pops up a dialog where you can enter the connection parameters for the data server
      • Reconnect
        Sometimes there are (network) errors that may corrupt current connection to the data server. Simply press this menu button to re-establish the connection
      • Open, Open Recent..., Save, Save As
        These menu buttons are used for loading and saving the PVs/axes configuration from the main controls panel. Note: For preferences stuff, please go to the EDIT menu.
      • Export
        See #Export.
      • Print... and Page Setup...
        Displays widgets for printing the application window
      • Clear All
        Clears all information in the main window.
      • Quit
        Exits the application
    2. EDIT menu
      • Copy, cut, paste
        standard menu items, have the same effects as corresponding keyboard short cuts (e.g. Ctrl+x etc. on Windows)
      • Preferences
        Includes a plot title setter, a legend configurator, and a plot plugin loader
    3. VIEW menu
      • Search Dialog
        Displays the search dialog
      • Full Screen
        Resizes the main window to occupy the entire screen
      • Show Console, Show Event Log, Show Memory Console
        Some of XAL widgets
    4. TOOLS menu
      • Assign Selected Archive
        Assigns the selected archive to selected graphs (useful for formulas, or if archive names changed etc.)
      • Clear Cache
        Clears all cached data
    5. WINDOW menu
      • Capture As PNG...
        Does the same as the PRINT SCREEN key, but is more specific
    6. HELP menu
      • Contents
        Opens this guide
      • Server Info
        Shows information that the current archive server might have on itself
      • About
        Some basic information on the application

9. General Plot Plugin Features

...

    1. Plot legend
      Consists at least of colorful shapes. To configure the legend, please go to EDIT => Preferences...
    2. Zoom in
      You can zoom into the plot with your left mouse. There is a minimum dragging distance required to activate the zoom capability. This prevents accidental mouse "hang ups".
    3. Plot manipulation buttons
      From left to right:
      • goes back in time the time range(s) you currently see on screen
      • goes forth in time the time range(s) you currently see on screen
      • goes "up" the value range(s) you currently see on screen
      • goes "down" the value range(s) you currently see on screen
      • doubles the time range(s) you currently see on screen
      • doubles the value range(s) you currently see on screen
      • zooms out if you previously zoomed in (note: will be moved to the right mouse button - menu in nearest future)
      • displays a menu for advanced configuration:
        • uses anti-alias drawing method if checked
        • leaves ignored items if checked and no new data is retrieved
    4. Some typical "right mouse click" menu - features
      • Properties: some chart specific properties
      • Save as... : saves the plot as a PNG image
      • Print... : prints the plot
      • Ignore Item... : ignores the current plot item (may be inactive)
    5. Dock/undock
      In the top right corner of a plot plugin panel, there is the dock/undock button. Please, note that once a plot plugin is undocked, it can not be controlled from the main controls panel. However, zoom-in and plot manipulation buttons should continue to function.

Written by Sergei Chevtsov (chevtsovs@ornl.gov) April 11th, 2005