Information
Important This documentation space contains information about PATROL Agents when deployed in a TrueSight Operations Management environment. If you are a BMC Helix Operations Management user, see PATROL Agent for BMC Helix Operations Management 23.3.

PSL Predefined Constants


A number of identifiers are predefined as constants so that they can be used without needing declarations. The predefined constants are used as PSL function parameters, PATROL object states, and for other PSL processing. These constants are read-only and will not accept user defined values. The following table lists the PSL predefined constants.

PSL Predefined Constants

Constant

Definition

chart() Function Actions

CHART_ADD_GRAPH

not currently implemented

CHART_DELETE_GRAPH

not currently implemented

CHART_DESTROY

destroys a previously loaded chart

CHART_LOAD

loads a chart

CHART_PRINT

prints a previously loaded chart

PATROL Object States

ALARM

PATROL ALARM object state

WARN

PATROL WARNING object state

OK

PATROL OK object state

OFFLINE

PATROL OFFLINE object state

VOID

PATROL VOID object state

response() Function Elements

R_CHECK_HORIZ

horizontal check box

R_CHECK_VERT

vertical check box

R_CLICKER

clicker widget

R_COLUMN

column compound

R_FRAME

frame compound

R_ICON

icon

R_LABEL

left-justified label

R_LABEL_CENTER

centered label

R_LIST_MULTIPLE

multiple-select scrolled list with defaults

R_LIST_MULTIPLE_ND

multiple-select scrolled list without defaults

R_LIST_SINGLE

single-select scrolled list with defaults

R_LIST_SINGLE_ND

single-select scrolled list without defaults

R_MENU

option menu

R_POPUP

non-scrolled pop-up

R_POPUP_SCROLLED

scrolled pop-up

R_RADIO_HORIZ

horizontal radio button

R_RADIO_VERT

vertical radio button

R_ROW

row compound element

R_SCALE_HORIZ

horizontal sliding scale

R_SCALE_VERT

vertical sliding scale

R_SEP_HORIZ

horizontal separator

R_SEP_VERT

vertical separator

R_SPINNER

time spinner button

R_TEXT_FIELD

text entry box without a label

R_TEXT_FIELD_LABEL

text entry box with a label

R_TOGGLE

toggle button

Other Constants

EOF

end-of-file condition constant

true/TRUE/True
yes/YES/Yes

boolean true value (logical 1)

false/FALSE/False
no/NO/No

boolean false value (logical 0)

 

Where to go from here

PSL-Data-Types-and-Objects

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

BMC PATROL Agent 23.3