G

genControlFormComboMSelect

File: vovcgi.tcl
Usage: genControlFormComboMSelect cgiScript name show size selections upstream options

genFormHiddenInputsFromOptions

File

vovcgi.tcl

Usage

genFormHiddenInputsFromOptions excludeList (default=) doInputs
                            (default=1)

Description

Frequently, we need to generate a form that upon submit, will get the URL again just with 1 or 2 options changed, while keeping the other options unchanged. This procedure will get all the options from array opt, except ones specified in excludeList, and generate HTML code of a hidden input for each option.

ARGS:

excludeList -- the list of option names to be excluded for generation of hidden input
doInputs -- if set to 0, just return the query string without generating hidden inputs

Returns

Returns the part of query string of the options that hidden inputs are generated. For example:

aa=vaa&bb=vbb&cc=vcc

Example

A form that just changes the username option but keeps all other options as they are.

FORM { INPUT text username $opt(username) VovCGI::genFormHiddenInputsFromOptions username }

genReportHeader

File: vovcgi.tcl
Usage: genReportHeader showTimeRange (default=1) showTag (default=1) showFeature (default=1)
Description: Currently used by Monitor only.; Inserts a fieldset that contains report parameters, making it easy to see the options (mainly time range and filters today) that are driving the report being viewed

genTimeRangeSelectorAndControlForm

File: vovcgi.tcl
Usage: genTimeRangeSelectorAndControlForm title sections url insertTopSubmit showWorkweek showFilterNegation showTimeRange args
Description: Monitor report options box, with time range selection, Ajax-driven cascading filters, and many other input types

genUrlArgs

File: vovcgi.tcl
Usage: genUrlArgs vars bCustomAccounts bPassTableFilters rOptions rFilters
Description: Processes opt array, identifying the elements that should be passed on to pages that are called from within the current page (filterOptions)

genWidgetAjax

File: vovcgi.tcl
Usage: genWidgetAjax page widget msg options
Description: Inserts a widget Ajax call into a page

GEO

File

vovfdl.tcl

Usage

GEO args

Description

Set the geometry (placement) of an object in the context of a set.

Two syntaxes are supported:

GEO setId objectId x y width height
GEO x y width height

In the second format, the setId and objectId are automatically assigned to the most recent set and object in FDL, so this syntax is generally best to use immediately following a set, job, or file (input/output). If the most recent object is a set, the parent set of that set is used for the context set (setId). For the second syntax, make(lastId) and make(setIdStack) are used to determine the correct IDs to use.

getCommonOptionsQueryString

File: vovcgi.tcl
Usage: getCommonOptionsQueryString excludeList (default=)
Description: Returns all options found in the current URL but does not generate hidden inputs. Also converts spaces to + for Tcl security.

getComponentOption

File: vovcgi.tcl
Usage: getComponentOption comp opt rtn (default=)
Description: Gets a specific option for an existing component

getCssName

File: vovcgi.tcl
Usage: getCssName inputName ext (default=css)

getData

File: vovregistrylib.tcl
Usage: GetData

getDataFrom

File: vovregistrylib.tcl
Usage: GetDataFrom filePathFull

getEmailAddress

File: vovnotifylib.tcl
Usage: getEmailAddress user
Description: This procedure can be overridden in the vovnotifyd/config.tcl file.

getHost

File: vovcgi.tcl
Usage: getHost

GetHostName

File: vovregistrylib.tcl
Usage: GetHostName

GetJsonFormatted

File: vovregistrylib.tcl
Usage: GetJsonFormatted dictInput

getJSScriptName

File: vovcgi.tcl
Usage: getJSScriptName inputName ext (default=js)

getMailToProp

File: vovnotifylib.tcl
Usage: getMailToProp jobid now

getMailWhatProp

File: vovnotifylib.tcl
Usage: getMailWhatProp jobid now

getMailWhatText

File: vovnotifylib.tcl
Usage: getMailWhatText jobid maxlen (default=0)
Description: Get the logfile text for jobid to mail for LSF emulation The email contains a hypertext link to the job.; maxlen parameter: If zero (default), get only the first 2^16 bytes, If positive, get first maxlen bytes A negative value for maxlen means do not truncate.

getMenuOption

File: vovcgi.tcl
Usage: getMenuOption tab menu opt rtn (default=)
Description: Gets a specific option for an existing menu.

getMinOrFullName

File: vovcgi.tcl
Usage: getMinOrFullName inputName ext

getPageOption

File: vovcgi.tcl
Usage: getPageOption tab menu page opt rtn (default=)
Description: Gets a specific option for an existing page.

getPort

File: vovcgi.tcl
Usage: getPort allowReadOnlyPort

GetPortNumber

File: vovregistrylib.tcl
Usage: GetPortNumber configString

GetQueue

File: vovregistrylib.tcl
Usage: GetQueue

getReadOnlyPort

File: vovcgi.tcl
Usage: getReadOnlyPort

GetRegDir

File: vovregistrylib.tcl
Usage: GetRegDir

GetRegFile

File: vovregistrylib.tcl
Usage: GetRegFile

getReportUrlHostPort

File: vovcgi.tcl
Usage: getReportUrlHostPort allowReadOnlyPort (default=true)

getTaskerColorFromStatus

File: vovcgi.tcl
Usage: getTaskerColorFromStatus status

GetSubDir

File: vovregistrylib.tcl
Usage: GetSubDir

getTabOption

File: vovcgi.tcl
Usage: getTabOption tab opt rtn (default=)
Description: Gets a specific option for an existing tab.

getTimeRangeFromCookieAndOptions

File: vovcgi.tcl
Usage: getTimeRangeFromCookieAndOptions
Description: This procedure is used to support needing a cookie to remember the time selection. First we get the cookie. Then we look at the timerange option (which could be a symbolic interval or the keyword "Custom").

getUrlHostPort

File: vovcgi.tcl
Usage: getUrlHostPort allowReadOnlyPort (default=true)
Description: Returns the URL for the product instance Uses the VOV_HOST_HTTP_NAME setting if set, VOV_HOST_NAME otherwise Uses the readonly port if available, regular port otherwise.

getUrlPath

File: vovcgi.tcl
Usage: getUrlPath args

GUI_LABEL

File: vovfdl.tcl
Usage: GUI_LABEL value
Description: Set the GUI_LABEL property on the most recent node.