GUI_Label Property

The GUI_LABEL property can be added to jobs, files, and sets to control what text is shown in the VovConsole. If the property is missing, the system decides what text to show based on available space.

The value of GUI_LABEL can be multiple lines. In the case of files and jobs, the GUI_LABEL can contain fields in the form @FIELDNAME@. Example:
# Note: it is easier to pass new line chars using the Tcl API,  rather than the shell command.
% vovsh -x 'vtk_prop_set 123456 GUI_LABEL "id=@ID@ host=@HOST@\nNAME=@JOBNAME@\n@DURATIONPP@"'
  • The GUI_LABEL for subsets does not support fields
  • Keep labels short; long labels are truncated to fit into the geometry of the node being shown.
  • Not all fields are meaningful in the GUI_LABELS, because the fields are expanded using cached information on the client side and some fields are only available on the vovserver side (example: @TASKERNAME@ for a job).
When updating the GUI_LABEL from a Tcl script, it may be useful to notify all vovconsoles that the node needs to be updated. This can be done with the following call:
vtk_prop_set -text $nodeId "GUI_LABEL" "Hi there!\nMy id is @ID@" 
vtk_event_hurl $nodeId NODE GUIUPDATE

Adding a GUI_LABEL to a set in FDL

If you are using the procedure S, you can use the option -gui_label to attach the property GUI_LABEL to the set.

S "AAA" {
} -gui_label "My gui label"