Chapter 8 - Creating and Using User Defined Options

SPLTOOL allows users to create user defined options very similar to the way you can create user defined options with PDM.

User defined options are create using the F16=User Options function key. When you use this function key, you will be shown a list of currently defined user options as shown below:

  2/26/00                 Spooled File Tools (SPLTOOL)
 16:41:38                         User Options
 Type options, press Enter.
   2=Change   3=Copy   4=Delete   5=Display
Opt Option  Command
 _    C     CPYSPLF FILE(&F) TOFILE(SPOOLF) JOB(&N/&U/&J) SPLNBR(&S) CTLCHAR(*F
                                                                         Bottom
  F3=Exit   F5=Refresh   F6=Create

The options listed allow you to change, copy, delete, or display the current user option. The F6=Create function key will allow you to create a new user option.

When creating user options, you can substitute special characters for parameters. A list and description of each follows:

  • &F - File Name - Use this parameter to substitute the file name into the command you wish to call.
  • &J - Job Name - Use this parameter to substitute the job name into the command you wish to call.
  • &U - User Name - Use this parameter to substitute the user name into the command you wish to call.
  • &N - Job Number - Use this parameter to substitute the job number into the command you wish to call.
  • &S - Spooled File Number - Use this parameter to substitute the spooled file number into the command you wish to call.
  • &Q - Output Queue - Use this parameter to substitute the output queue name into the command you wish to call.
  • &L - Output Queue Library - Use this parameter to substitute the output queue library into the command you wish to call.
  • &R - User Data - Use this parameter to substitute the user data into the command you wish to call.
  • &A - Creation Date - Use this parameter to substitute the spooled file creation date into the command you wish to call.
  • &E - Creation Time - Use this parameter to substitute the spooled file creation time into the command you wish to call.
  • &C - Current User - Use this parameter to substitute the current user id into the command you wish to call.

** NOTE: When using these parameters as input parameters when calling a program defined as a user option, (as opposed to calling a command such as DSPSPLF), enclose the parameters in quotation marks. Define the fields in the program as character and 10 characters long. Job number can be 6 characters and spooled file number can be 4 characters, but it shouldn't make much difference.