ShowSymbolSelector

Use this Longview Application Framework function in a procedure document to display a customizable prompt that allows users to select a symbol from the Symbol Selector for a specified dimension. You can use ShowSymbolSelector to specify the following:

• the button options
• the label for the Symbol Selector
• the parameters of the Symbol Selector

This function is specific to Longview Apps.

Note: You must use the ShowSymbolSelector function with Set Variable to set the value to the variable to which the function will be returning data. See the syntax example below. You cannot use the ShowSymbolSelector function in batch mode.

Syntax:

SHOWSYMBOLSELECTOR (Button, "Label", "dimension", "spec", "initial", allowLeaf, allowParent, allowReadOnly, allowMultiple, "attributefilters")

where:

• Button is the set of buttons to display and can be OK or OKCancel. OK displays a single OK button; OKCancel displays both an OK button and a Cancel button. The lvs_buttonClicked variable is populated by the button clicked in the Symbol Selector.
• Label is the label to display for the symbol selector, enclosed in double quotation marks. If you want to omit this parameter, use two double quotation marks ( "" ).
• dimension is the name of the dimension containing the symbols that should appear in the Symbol Selector, enclosed in double quotation marks.
• spec is the level of symbols to display in the Symbol Selector hierarchy, in relation to the specified symbol, for example, SymbolName### or SymbolName#99. You may also include multiple hierarchical specs separated by a pipe charactcer (|), for example, SymbolName#99|SymbolName2#99. If you want to include all symbols a user has access to, omit this parameter and use two double quotation marks ( "" ). For more information on symbol hierarchy specifications, see Symbol hierarchies.
• initial is the initial symbol selected, enclosed in double quotation marks. If you don’t want an initial symbol selected, use two double quotation marks ( "" ).
• allowLeaf specifies whether users can select leaf symbols and can have a value of TRUE or FALSE.
• allowParent specifies whether users can select parent symbols and can have a value of TRUE or FALSE.
• allowReadOnly specifies whether users can select read-only symbols and can have a value of TRUE or FALSE.
• allowMultiple specifies whether users can select multiple symbols and can have a value of TRUE or FALSE.
• attributefilters can be up to two attribute filters linked by AND or OR, enclosed in double quotation marks, using the syntax FilterType{AttrName{Operation{Expression where:

  Value	Description
  FilterType	specifies the method to use to search the hierarchy for symbols matching the filter criteria and can be one of ALL, PARENT, LEAF, or ROOT. If you specify two attribute filters, FilterType must be the same for both filters.
  AttrName	is the name of an attribute.
  Operation	can be EQ for exactly equal to or NE for not equal to.
  Expression	is a character string. If the expression contains spaces, enclose the expression in double quotation marks preceded by a backslash (\"expression with spaces\"). If the expression is a list, separate multiple items with a pipe ( | ). For Non-List Attributes, the filter behaves as follows: Attribute EQ Expression — Matches only if the attribute is an exact match of the expression. Attribute NE Expression — Matches if the attribute is not an exact match of the expression. For List Attributes, the filter behaves as follows: Attribute EQ Expression — Matches if the attribute is an exact match of the expression, or is a list of values, any one of which exactly matches the expression. Attribute NE Expression — Matches if the attribute is empty or a list of values, none of which exactly matches the expression.

  If you specify two attribute filters, enclose each filter in parentheses, for example "(attributefilter1) AND (attributefilter2)".

  If you don’t want to include an attribute filter, use two double quotation marks ( "" ).

Syntax example:

Syntax example: