parameter-setting

The parameter-setting clause is used to change attributes for the LOAD or UNLOAD command for the objects to be processed and to define target destinations for the LOAD command (for example, FNAT).

The following syntax applies to the parameter-setting clause:

WITH  

Opening bracket

(parameter-workplan)
 
parameter-clause

Closing bracket

For an explanation of the syntax that applies to parameter-workplan, refer to Referencing Workplans in the section Workplans.

This section covers the following topics:

Syntax of parameter-clause

The syntax of the parameter-clause is shown in the following diagram. If indicated, a variable value must be supplied with a keyword.

Opening bracket

 [NAME old-name] NEWNAME new-name

Closing bracket

          

Opening bracket

 [LIBRARY old-library-name] NEWLIBRARY new-library-name

Closing bracket

          

Opening bracket

   LOADFNATDBID fnat-dbid LOADFNATFNR fnat-fnr

Closing bracket

Opening bracket

   LOADFUSERDBID fuser-dbid LOADFUSERFNR fuser-fnr

Closing bracket

Opening bracket.

   LOADNCPDBID ncp-file-dbid LOADNCPFNR ncp-file-fnr
[LOADNCPCIPHER ncp-file-cipher]

Closing bracket.

Opening bracket

Opening bracket

LOADNCPPASSWORD
LOADNCPPSW

Closing bracket

 ncp-file-password

Closing bracket

Opening bracket

 [FDTDBID old-fdt-dbid FDTFNR old-fdt-fnr] NEWFDTDBID new-fdt-dbid NEWFDTFNR new-fdt-fnr

Closing bracket
[ERRNUMDIFF modification-of-error-message-range]

Opening bracket

 [LANGUAGE old-language] NEWLANGUAGE new-language

Closing bracket

        

Opening bracket

 [DATE old-date] NEWDATE new-date

Closing bracket

        

Opening bracket

 [USERID old-userid] NEWUSERID new-userid

Closing bracket

        

Opening bracket

 [TID old-terminal-id] NEWTID new-terminal-id

Closing bracket

        

Opening bracket

 [PATH old-external-path-name] NEWPATH new-external-path-name

Closing bracket

        

Keyword Explanation of parameter-clause

The keywords and variable values (if relevant) of the parameter-clause are explained in the following section.

Keyword Values Restricted to Command
NAME The object name to be checked if NEWNAME is specified.  
NEWNAME A new object name.

Note:
Not applicable to DDMs on mainframe platforms.

 
LIBRARY The library name to be checked if NEWLIBRARY is specified.  
NEWLIBRARY

A new library name.

Note for the LOAD function:

NEWLIBRARY does not affect the library name used in the delete instruction of a work file that is processed with the DELETEALLOWED option.

 
LOADFNATDBID

The database ID (DBID) of FNAT libraries.

 LOAD
LOADFNATFNR

The file number (FNR) of FNAT libraries.

 LOAD
LOADFUSERDBID The DBID of FUSER libraries. LOAD
LOADFUSERFNR The FNR of FUSER libraries. LOAD
LOADNCPDBID The DBID of the Adabas file for Natural command processor sources. LOAD
LOADNCPFNR The FNR of the Adabas file for Natural command processor sources. LOAD
LOADNCPCIPHER The cipher code of the Adabas file for Natural command processor sources. LOAD
LOADNCPPASSWORD

or

LOADNCPPSW

Only applies to objects on mainframes.
The Adabas password of the Adabas file for Natural command processor sources.

LOAD
FDTDBID The DBID of the Adabas FDT (Field Definition Table) to be checked if NEWFDTDBID is specified.  
NEWFDTDBID A new DBID of the FDT.  
FDTFNR The DBID of the FDT to be checked if NEWFDTFNR is specified.  
NEWFDTFNR A new FNR of the FDT.  
ERRNUMDIFF A number (positive or negative) that is to be added to the Natural error messages during the UNLOAD or LOAD command.

ERRNUMDIFF can only be specified if FMNUM and TONUM (see select-clause) have been specified as selection criteria. Otherwise, it is not possible to check for valid results.

 
LANGUAGE Up to 8 valid language codes (for example, code 1 for English) of Natural error messages to be checked if NEWLANGUAGE (see below) is specified.

If language contains more than one language code, new-language must contain the same numbers of language codes. Each language language code is replaced by the language code in the corresponding position of new-language.

If language is not specified, new-language must not contain more than one language code.

 
NEWLANGUAGE Up to 8 valid language codes (for example, code 4 for Spanish) for new user-defined error messages. This option does not apply to the long texts of Natural system error messages for which English (language code 1) is the only valid language.

See also LANGUAGE above.

 
DATE An object date.

You can add a time by inserting a blank between date and time. For the format and ranges allowed, see Date and Time in Name, Date and Time Specification.

 
NEWDATE A new object date.

NEWDATE can be a date followed by a time value. You can add a time by inserting a blank between date and time. See also Date and Time in Name, Date and Time Specification.

 
USERID The user ID to be checked if NEWUSERID is specified.  
NEWUSERID A new user ID.  
TID

Only applies to objects on mainframes.
The terminal ID to be checked if NEWTID is specified.

 
NEWTID

Only applies to objects on mainframes.
A new terminal ID.

 
PATH The path name to be checked if NEWPATH is specified.  
NEWPATH A new path name.  

Notes:

  1. Parameters not applicable to the selection criterion processed are ignored.
  2. LOADFNAT..., LOADFUSER... and LOADNCP... are used for the LOAD command only, and ignored otherwise.
  3. LOADFNAT... is used for libraries starting with SYS (except SYSTEM).
  4. LOADFUSER... is used for libraries not starting with SYS (but including SYSTEM).
  5. LOADNCP... is used for Natural command processor sources.