Versions Compared

Key

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

...

Application uses a minimal set of windows and popping-up boxes. At first start of the application with default configuration parameters, it shows the short version of the main GUI. A couple of check boxes box may extend the number of control fields. Optional windows appear at click on "Help" and "Logger" buttons. These windows live as long as they needed. Warning message box may appear in case of incomplete or in-consistent input parameters, when

  • the message box is empty
  • the run number is shown together with response ID number.
    Standard GUI for file selection/saving dialog may also pop-up when necessary. The typical layout of application specific windows is shown in plots for
  • Default GUI
  • Extended GUI
  • Internal logger
  • Help box
  • Warning message box

Image ModifiedImage Modified
Image ModifiedImage ModifiedImage Modified

Functionality

LogBookGrabber main GUI contains buttons, check boxesbox, edit and info fields, graphical viewer/editor window, which functionality is explained below.

...

  • Grab – click on this button activates cursor to select the window or grab any rectangular area on monitor.
  • Load – activates the file selection menu to load the image from file. Image will appear in the Attachement window.
  • Reset – clears the graphical Attachement window.
  • Submit – submits entire message in ELog
  • Exit – closes the window, save current configuration parameters, closes all open windows, and exit application. The "x" button in the top right corner does the same operations, but does not save configuration file.
  • Select tag – activates the drop-down menu to select the tag from the list of known in the DB.
  • Logger – opens the internal logger window.
  • Help – displays in the Logger help message about navigation in graphical window.

Additional button Additional buttons in extended GUI:

  • Save img. – saves the image in file. Image is saved in full format in limits as displayed in the graphical Attachement window.
  • Logger – open the internal logger window.
  • Help – displays in the Logger help message about navigation in graphical window.

Check boxes

...

  • The Save img. button is visible if the image window is not empty.

Check box

  • Copy to ins. ELog on/off the message copy to the instrumental ELog with appropriate information fields.

Edit fields

  • Message: – window for message which will be sent to ELog.
  • Run number: – run number, which will be associated with this message (the Resp. to ID: should be empty).
  • Resp. to ID: – previous message ID number, which will be used for response(the Run number: should be empty).
  • Description: – image will be saved in ELog with this file name.
  • Tag – tag associated with message, which can be used in ELog for filtering.

...

Code Block
Options:
  -h, --help              show this help message and exit
  -i INSSTA, --ins=INSSTA the name of an instrument and station <INS>[:<station-number>]
  -e EXP, --exp=EXP       the name of some specific experiment
  -w URL, --url=URL       the base URL of the LogBook web service
  -u USR, --usr=USR       the user name to connect to the web service
  -p PAS, --pas=PAS       the password to connect to the web service
  -c CMD, --cmd=CMD       the command for child message
  -f CFNAME, --cfg=CFNAME the file name with configuration parameters

option "-i <INSTRUMENT>[:<station>]"

This parameter contains the name of instrument and optional station number, for example AMO, AMO:0, etc.

...

Currently use <web-service> = https://pswww.slac.stanford.edu/ws-authImage Removed

option "-c <child-message-command>"

...

If this parameter is missing, the default configuration file name confpars-grabber.txt is used. If file is missing in local directory, the default parameters will be used. At click on Exit button, current parameters will be saved in the configuration file, all open windows will be closed. Click on "x" button in the top right corner of the main window does the same operations, but does not save configuration file.