Markup Language Tags › Web Option Control Comments

Web Option Control Comments

In each Web Option skeleton, one or more special HTML comments known as Web Option control comments may automatically be generated or manually added. Web Option control comments can be recognized as having the following format:

<!--%W2E% comment-string %W2E%-->

where comment-string contains control information used by the Web Option server job to perform skeleton-specific processing prior to the data-merge processing.

In all generated skeletons, the following Web Option comment line is generated automatically into the top of each skeleton as part of the *HTML MLS Syntax object group:

<!--%W2E% -vallstfil Y2VLLSP -pmtmsgf UUPMTMSG %W2E%-->

At runtime, this string is processed by the Web Option server job and the specified Values List File and Prompt Message File are loaded into memory. If the skeleton uses any replacement tags (following), these values are used by the Web Option server.

There is also a client-level value called PMTMSGFLIB which will hold the current prompt message file library name that the client should use. Therefore, the values list file variables VALLSTFIL and VALLSTLIB are totally separate from the prompt message file variables PMTMSGF and PMTMSGFLIB. The PMTMSGFLIB value can be set as follows:

1. Within a Web Option skeleton by including the following code within the special Web Option comment line (beginning "<!--%W2E%" and ending "%W2E%-->): <!--%W2E%...-PMTMSGFLIB library-name ...%W2E%-->

   For example:

   <!--%W2E% -pmtmsgf UUPMTMSG -pmtmsgflib RUNLIB %W2E%-->
   

   This forces the Web Option server to retrieve messages from message file UUPMTMSG in library RUNLIB when it encounters a prompt-message reference tag such as (_rMAA1B2F). If not specified (or *LIBL is specified), the Web Option server will calculate the actual library name to use (i.e. the highest library in the clients library list which contains the specified prompt message file) and will use that library until the PmtMsgfLib value is again set.

   Note that, by default, Web Option comment lines will continue to include only references to the VALLSTFIL and PMTMSGF variables - the VALLSTLIB and PMTMSGFLIB variables must either be added manually post-generation or the relevant MLS Syntax object group should be changed to include these variables. When not specified, *LIBL is assumed for both these variables.

2. Within a script PUT statement which uses the following syntax:

   PUT library-name YPMTLIB
   

   If a referenced tag (one beginning "(_r") is found within a skeleton and a Web Option comment line is NOT found and a load-script has not been specified, the tag processor will set the PMTMSGFLIB variable to *LIBL and pass that to the prompt message processing procedure, which will update PMTMSGFLIB to the correct library name.

Allowable switch/value pairs in a Web Option comment are as follows:

-waittime nnn

Specifying this switch ensures that the wait time used when the page is submitted will be the maximum of the specified value (nnn) and the current YSVRMWT value.

-timeout nnn

Specifying this switch ensures that the timeout value used when the page is submitted is the maximum of the specified value (nnn) and the currentYDFTSTO value.

-debugsession

Specifying this switch ensures that the Web Option server job processing this client session will have its internal YDBGSSN value set to the session identifier for the client session.

-nodebugsession

Specifying this switch ensures that the Web Option server job processing this client session will have its internal YDBGSSN value set to the current YDBGSSN Web Option control value.

-autodisconnect

Specifying this switch will ensure that the Web Option client session will have its auto-disconnect value set on (irrespective of the current YAUTDSC Web Option control value).

-noautodisconnect

Specifying this switch ensures that the Web Option client session will have its auto-disconnect value set off (irrespective of the current YAUTDSC Web Option control value).

-jitonly

Specifying this switch ensures that the Web Option client session will only use Just-In-Time screens for the remainder of its connection.

-vallstlib lib-name

Specifying this switch will ensure that the Web Option client session will have its internal Values List Library set to the specified value (lib-name).

-vallstfil file-name

Specifying this switch will ensure that the Web Option client session will have its internal Values List File set to the specified value (file-name). If the file is not already loaded by the Web Option server job processing the client session, the file will be loaded (either from the library specified for the -vallstlib switch or from the client jobs library list if the -vallstlib switch has not been specified).

-pmtmsgf msgf-name

Specifying this switch will ensure that the Web Option client session will have its internal Prompt Message File set to the specified value (msgf-name). If the message file is not already loaded by the Web Option server job processing the client session, it will be loaded (either from the library specified for the -vallstlib switch or from the client job's library list if the -vallstlib switch has not been specified).

pmtmsgflib lib-name

Specifying the current prompt message file library name that the client should use for finding the prompt message file.

The MLS Generator generates the following Web Option comment line into each skeleton:

<!--%W2E% -vallstfil &&_lstfil -pmtmsgf &&_pmtmsf %W2E%-->

where the 'Y2VLLSP' and 'UUPMTMSG' values are retrieved from the model definition. This comment line is defined in the *HTML object group in the MLS Syntax file YMLSSYNRFP.