7.22 Reserved Words

LANSA Web functions uses special keywords as part of the LANSA tag definitions. These keywords are prefixed by either the '@' character or the ‘&’ character. Names prefixed by either the ‘@' or ‘&’ character are reserved for internal use by LANSA.

The table below lists the major keywords used by LANSA Web functions. These keywords are generally used in conjunction with the <RDML MERGE> tag. (The keywords are also used with the RDML Button tag.) You can use any of these reserved keywords to merge any of these fields into your application.

Keyword

Description

&ADD

Display the Add key as a button.

&BL<list name>

Display the browse list identified by <list name>.

&BUTTONS

Display the buttons (function keys) of the function.

&BV_<button>

Retrieve the description of the button specified in <button>.

&CANCEL

Display the Cancel key as a button.

&CGI

Merge the path where the CGI interface program is installed. This is based on your LANSA Web configuration.

&CHANGE

Display the Change key as a button.

&CHECKNUMERIC

This is used in DEFAULT_SCRIPT page to condition some javascript functions that are used to validate numeric data in the browser

&DBCS

This is used in DEFAULT_SCRIPT page to condition some javascript functions that are used to validate DBCS and SBCS data.

&DD<drop down name>

Processes the field to be a drop down. Data for the drop down is handled by your LANSA Web function.

This tag can be extended manually by using the SIZE, SPLIT and OFFSET attributes.

The SIZE attribute allows you to visualize the drop down as a list box. The OFFSET and SPLIT attributes allow you to manipulate the presentation of the data.

The example below is a list box for the DEPTMENT field. It instructs LANSA to apportion the first 4 characters as the VALUE to return to the program. Since the SPLIT keyword is used, the description displayed in the list box is the text offset by 4.

<RDML MERGE="&DDD01" FIELD="DEPTMENT" OFFSET="4" SPLIT SIZE="5">

&DEBUG

Determine if batch debugging is on. If batch debugging is enabled, the URL is modified to append the appropriate keywords.

&DELETE

Display the Delete key as a button.

&DEVICE

Merge the device name specified for batch debugging.

&DTD_FRAMESET

Merge the XHTML 1.0 Frameset DOCTYPE declaration.

&DTD_STRICT

Merge the XHTML 1.0 Strict DOCTYPE declaration.

&DTD_TRANSITIONAL

Merge the XHTML 1.0 Transitional DOCTYPE declaration.

&END

The <RDML MERGE="&END"> tag was introduced to help sites with high hit rates. This tag allows LWEB_JOB jobs to return to the pool of free jobs immediately. For more details, refer Using <RDML MERGE=”&END”>.

&EXIT

Display the Exit key as a button.

&FUNCHELP

Display the help text associated with the selected field.

&FUNCNAME

Embeds the current function name.

&FUNCTION

Display the function description.

&HEADER

Merge in the header information for the page.

If the HEADER attribute is specified in the <RDML LAYOUT> tag, the header page associated with the attribute is used. If not, LANSA will look for a process specific header page. If it does not exist, then it will look for the default header page, DEFAULT_HEADER.

&HELP

Display the Help key as a button.

&HIDDEN

Embed the hidden fields used by LANSA Web functions. These hidden fields are used internally and are defined in the DEFAULT_HIDDEN page.

&HMENU

Merge the Horizontal Menu component. This tag is used in the presentation layout by the e-Business Framework Wizard.

&IMAGE

Merge the location where the images are stored. This is based on your LANSA Web configuration.

&JOBID

Merge the job identifier of the LANSA job.

Note that this attribute must not be used as a unique identifier for your user jobs, especially if your applications consist of WEBEVENT functions.

WEBEVENT functions are restarted automatically when the jobs time out. These restarted jobs may be assigned to a different job.

&LINKDESC

Embeds Description of User Key in WEBEVENT functions.

&LINKFUNC

Embeds Linked Function Name of User Key in WEBEVENT functions.

&LINKPROC

Embeds Linked Process Name of User Key in WEBEVENT functions.

&LMENU

Merge the Left Menu component. This tag is used in the presentation layout by the e-Business Framework Wizard.

&MESSAGES

Check if there are any LANSA messages. If there are messages, display the messages.

&MSGQ

Merge the message queue specified for batch debugging.

&PAGE

Embeds the current page identifier.

&PARTITION

Embeds the current LANSA partition.

&PARTLANG

Embeds the current LANSA partition language.

&PROCNAME

Embeds the current process name.

&PROMPT

Display the Prompt key as a button.

&RMENU

Merge the Right Menu component. This tag is used in the presentation layout by the e-Business Framework Wizard.

&ROWNUM

This keyword must only be used in browse list components. It merges the current entry number of the browse list data.

An optional attribute for this tag is the FORMAT keyword. This attribute allows you to format the row number. For example,

<RDML MERGE="&ROWNUM" FORMAT="4">

instructs LANSA to format the row number as a 4-digit string, padded with leading zeros, if necessary.

Typically, this tag is used if you want to configure your own browse list component with an appropriate name. In this case, the NAME attribute of your component would be:

NAME="__<field name>-<RDML MERGE="&ROWNUM" FORMAT="4"> D"

where <field name> is the name of the field padded with trailing blanks up to 10 characters.

For an example, refer to the SET Collection.

&SCRIPT

Embed the JavaScript functions into the function. The functions are defined in the DEFAULT_SCRIPT page.

&SESSION

Include the encoded session identifier.

&SESSPL

Include the encoded session identifier and the partition and the language.

&STYLE

Embeds the CSS page, if a CSS page exists.

&TASK

Merge the current task identifier.

&Tnnn+ssss+eeee

Retrieve the multilingual description for the field.

&TRACEID

This is used for event logging. When event logging is enabled, a trace identifier is allocated for each unique user to your site. This tag instructs LANSA to merge the trace identifier.

&UD<user defined page>

Embeds the user defined page. LANSA will initially try to use the process level page, identified by <process>_UD<user defined page>. If this page cannot be found, it will use the DEFAULT_UD<user defined page> page.

&USER1

Displays the user defined key #1 as a button.

&USER2

Displays the user defined key #2 as a button.

&USER3

Displays the user defined key #3 as a button.

&USER4

Displays the user defined key #4 as a button.

&USER5

Displays the user defined key #5 as a button.