Click Mnemonics

This table describe the mnemonics that define whether a column value may be clicked and if so, what should happen.

Mnemonic

Description

Valid Values

Comments

navopt=

Defines the navigation option that references the target transaction or script when the user clicks a column.

Note, this mnemonic should be used in conjunction with the context= mnemonic to define what information is sent to the navigation option's target transaction.

This mnemonic is ignored if type=fkref because the FK reference code defines the hyperlink's destination.

Cx

This means navigation option code is defined in an earlier column.  For example, define C1 if column 1 defines the navigation option.

COLUMN_​​NAME

This means the navigation option was retrieved by the SELECT statement.  The value should match the name defined in the SELECT clause.

Example: navopt=MAIN_​​PORTAL

‘Navigation Option Code’

This means the navigation option code is defined directly. For example navopt=’userMaint’.

context=

This is used to define one or more context fields and values passed to the target navigation option to go along with the navopt= mnemonic.

The syntax is as follows: [FIELD_​​NAME=FIELD_​​REF FIELD_​​NAME=FIELD_​​REF ...]

In other words, the list of input values is surrounded by square brackets separated by a space. Each passed value first defines the FIELD_​​NAME, which is the name of the context field in the navigation option. FIELD_​​REF is the value passed in. The next column indicates the possible values for FIELD_​​REF.

Cx

Where Cx represents the value of a previous column. For example, if the value to pass is in the first column, reference C1.

COLUMN_​​NAME

This means the value to pass in was retrieved by the SELECT statement.  The value should match the name defined in the SELECT clause.

‘literal value’

This means a literal value within the single quotes should be passed in.

bpa=

Indicates that a BPA script should be executed with the user clicks the column and indicates the BPA to execute.

Note, this mnemonic should be used in conjunction with the tempstorage= mnemonic to define the temporary storage values that will be initiated when the script is executed.

This mnemonic is ignored if type=fkref because the FK reference code defines the hyperlink's destination.

Cx

Indicates that the BPA script is defined in a previous column.

COLUMN_​​NAME

This means the BPA script to execute was retrieved by the SELECT statement.  The value should match the name defined in the SELECT clause.

‘BPA Script Code’

This means that the BPA script to execute is defined directly.

tempstorage=

This is used to define how temporary storage variables are initiated when the bpa= mnemonic is used.

The syntax is as follows: [FIELD_​​NAME=FIELD_​​REF FIELD_​​NAME=FIELD_​​REF ...]

In other words, the list of input values is surrounded by square brackets separated by a space. Each passed value first defines the FIELD_​​NAME, which is the name of the field in temporary storage. FIELD_​​REF is the value passed in. The next column indicates the possible values for FIELD_​​REF.

Cx

Where Cx represents the value of a previous column. For example, if the value to pass is in the first column, reference C1.

COLUMN_​​NAME

This means the value to pass in was retrieved by the SELECT statement.  The value should match the name defined in the SELECT clause.

‘literal value’

This means a literal value within the single quotes should be passed in.

list=

This is used to enable work list capability for this column.

You may optionally populate the listdesc= mnemonic to override the text that will be placed in the worklist zone.

true

Setting list=true will cause the work list icon to appear in the column’s header. If a user clicks the column, it will populate all the rows in the output into the work list zone.

Note: In the case of the zone type Info Data Explorer - Multiple SQLs (F1–DE), the output may be showing a union of the results of multiple SQL statements. In this case, if some of the SQL statements configure a given column with list=true, but not all, only the data in the cells for the statements that configure this mnemonic are put into the work list when the user clicks the icon.

listdesc=

This is an optional mnemonic when using the list= mnemonic. It can be used to override the text that is placed in the work list zone.

Cx

Where Cx represents the value of a previous column. For example, if the text to use is in the first column, reference C1.

listbroadcast=

Indicates that the broadcast information for the column is also to be made available in the work list zone. This means that the work list can be used to broadcast information to a portal in the same manner as a data explorer.

true

Use this setting to turn on the feature.