The option-setting clause is used to change the default values of Object Handler command options.
The syntax that applies to the option-setting clause is shown and explained in the following section. The keywords and variable values contained in the syntax diagrams shown represent the parameters that are used to specify the default values. If indicated, a variable value must be supplied with a keyword.
WHERE
|
||
|
|
(option-workplan) |
|
The syntax diagram that applies to option-workplan is shown and described in Referencing Workplans in the section Workplans.
The syntax of the option-clause is shown in the following section.
|
|
REPLACE
|
|
|
|
|||||||||||
|
|
|
||||||||||||||
|
|
|
|
|||||||||||||
[ |
{REPORT-LIBRARY|REP-LIB}
library-name
|
||||||||||||||
[REP-LIB-DBID
dbid [REP-LIB-FNR
fnr]] [REP-LIB-NAME
vsam-name]
|
|||||||||||||||
[{REP-LIB-PASSWORD|REP-LIB-PSW}
password] [REP-LIB-CIPHER
cipher]
|
|||||||||||||||
] |
|||||||||||||||
|
|
REPORT-OPTION-1 |
|
|
|
|
||||||||||
|
|
REPORT-FORMAT |
|
|
|
|
||||||||||
|
|
REPORT-MODE |
|
|
|
|
||||||||||
|
|
|
||||||||||||||
[NUMBERPROCESS
number] |
|||||||||||||||
[FIXEDLENGTH] |
|||||||||||||||
[FDIC
(dbid,fnr,password,cipher)] |
|||||||||||||||
[FSEC
(dbid,fnr,password,cipher)] |
|||||||||||||||
|
|
|
|
|
|
|
||||||||||
|
|
|
|
[file-name] |
|
|||||||||||
|
|
|
|
command-file-number |
|
|||||||||||
Commas must be used as separators between the values following the FDIC
and FSEC keywords, or if a value is missing. For example: FDIC
(10,21,,2a).
If the session parameter ID (see ID - Input Delimiter Character in the
Parameter Reference documentation) has been set to a comma, use a
slash (/) as the separator between values.
TRANSFER
|
|||||
|
|
CONVERSION-TABLE
|
|
|
|
|
[SUBSTITUTE] |
|||||
[INCLUDE-LINE-NUMBERS]
|
|||||
[UPPERCASE-TRANSLATION] |
|||||
[INCORPORATE-FREE-RULES] |
|||||
[LOAD-CODE-PAGE
code-page-name]
|
|||||
[DA-FORMAT
data-area-format]
|
|||||
[UNSHAPE] |
|||||
[USE-LINE-NUMBER-INCREMENT] |
|||||
|
|
XREF |
|
|
|
||
[DELETEALLOWED] |
||||||
[NOSYMBOLTABLE] |
||||||
[VERSIONCHECK]
|
||||||
The keywords and the variable values (if relevant) of option-setting are explained in the following section:
| Option | Explanation | Restricted to Command | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
REPLACE |
Replaces existing objects according to the option specified:
|
|
||||||||
TRANSFER |
Set Transfer mode.
The data is read and written in Transfer format. For valid options, see Keyword Explanation of transfer-options. |
|
||||||||
NOREPORT |
Specifies the report file setting:
No data is recorded to a report file.
This is the default setting for the |
|||||||||
NEWREPORT |
Specifies the report file setting:
Report data is recorded and written to a Natural text member stored in the Workplan library. An existing file will be overwritten. |
|||||||||
REPORT
|
Specifies the report file setting:
Report data is recorded and written to
a Natural text
member stored in the Workplan library. This is the default setting
for the commands By default, this Natural text member is deleted when the Object Handler is terminated. To change default settings, see the documentation on profile parameter DELETE-TEMPORARY-REPORT-TEXT. |
|||||||||
BATCHREPORT |
Specifies the report setting for batch processing or when using the OBJHAPI Application Programming Interface: Report data is either written to SYSOUT or output on the screen respectively (report data is not written to a file). |
|||||||||
Specifies the library where the report text object is stored
if the option REPORT or NEWREPORT is specified.
If this option is not
specified, the library |
||||||||||
REP-LIB-DBID |
The database ID of the system file where the
REPORT-LIBRARY resides.
( |
|||||||||
REP-LIB-FNR |
The file number of the system file where the
REPORT-LIBRARY resides.
( |
|||||||||
REP-LIB-NAME |
The VSAM name of the system file where the
REPORT-LIBRARY resides.
|
|||||||||
The Adabas password of the system file where the
REPORT-LIBRARY resides.
|
||||||||||
REP-LIB-CIPHER |
The Adabas cipher code of the system file where the
REPORT-LIBRARY resides.
|
|||||||||
|
|
Specifies the report option to be used when a direct command
is executed and a report is to be written:
|
|
||||||||
|
|
Specifies the report format to be used when a direct command
is executed and a report is to be written:
|
|
||||||||
|
|
Specifies the report mode to be used when a direct command is
executed and a report is to be written:
|
|||||||||
NORESTART
|
No restart information is written to a file. | LOAD |
||||||||
RESTART
|
Restart information is written to a Natural text member stored in the Workplan library. | LOAD |
||||||||
NUMBERPROCESS
|
Specifies the number of objects to be processed.
The
|
|
||||||||
FIXEDLENGTH
|
Sets the format of the unload work file to a maximum record length of fixed
size.
Every data record contains 256 bytes if written in internal format, or 100 bytes in Transfer format. |
UNLOAD |
||||||||
FDIC |
Specifies the system file FDIC to be used for processing:
the database ID (dbid), file number (fnr), password (password) and cipher code (cipher) of the Adabas file. If no values (or |
|
||||||||
FSEC |
Specifies the system file FSEC to be used for processing:
the database ID (dbid), file number (fnr), password (password) and cipher code (cipher) of the Adabas file. If no values (or |
|
||||||||
The work file type of Natural Work File 1 when data is read and
written to the work file:
If |
UNLOAD |
|||||||||
| Only applies if Entire Connection is installed.
Writes data to or reads data from an Entire Connection work file. file-name denotes the complete path name assigned to the Entire Connection work file. If your system environment does not accept a backslash (\) separator, use a slash (/) instead. If you do not specify file-name, Entire Connection prompts you for the name of a work file. If See also Work File Assignment in Work Files. |
|
|||||||||
| Only applies if Entire Connection is installed.
Specifies the number of the work file that is used for processing Entire Connection commands. The default value is See also Work File Assignment in Work Files. |
|
The keywords and the variable values (if relevant) of transfer-options and internal-format-options are explained in the following section:
When using the TRANSFER keyword, you can specify the following
options:
| Option | Explanation | Restricted to Command | ||||
|---|---|---|---|---|---|---|
CONVERSION-TABLE |
Converts data processed in Transfer format by using either of the
following conversion tables:
The internal Natural conversion table.
A user-defined conversion table if conversion-program has been specified. This program must be stored in the library SYSOBJH or one of its steplibs; see the example programs OTNCONAE and OTNCONEA in the library SYSOBJH. |
|
||||
SUBSTITUTE
|
Replaces line references by labels during the unload in Transfer format. This option only applies if your source-code line numbers are used for statement references. If so, the line numbers of referenced lines and the line number references are replaced by labels. The sources are not modified in the database. |
UNLOAD |
||||
INCLUDE-LINE-NUMBERS |
Transfers line numbers during the unload in Transfer format. |
UNLOAD |
||||
|
|
|
|
||||
UPPERCASE-TRANSLATION |
Translates any source code into upper case during the load in Transfer
format. |
LOAD |
||||
INCORPORATE-FREE-RULES |
Incorporates source text of Predict free rules associated with a map into a map source during the unload in Transfer format if Predict is installed. | UNLOAD |
||||
LOAD-CODE-PAGE |
Specifies the code page to be used for converting object sources encoded in Unicode/UTF-8 (Universal Transformation Format, 8-bit form). If you use this option, all object sources unloaded into a work file in UTF-8, will be converted with the specified code page when they are loaded into a work file. If you specify If |
|
||||
DA-FORMAT |
Specifies format conversion of data area sources: see Data area format in Transfer Options in Settings. |
|
||||
UNSHAPE |
Replaces shaped Arabic characters (code page IBM420) with the corresponding unshaped characters in the following source objects: Natural programs , user error messages and system error messages. |
|
When using internal-format-options, you can specify the following:
| Option | Explanation | Restricted to Command | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
XREF |
|
|
||||||||||||||||||||||
DELETEALLOWED |
Processes delete instructions from work files when loading objects in internal format. | LOAD |
||||||||||||||||||||||
NOSYMBOLTABLE |
Unloads cataloged Natural library objects without their corresponding internal Natural symbol tables. This will reduce the amount of disk storage required. However, this is only
useful for a production environment, as several application development
functions which require the symbol tables will then not be available; in
addition, the profile parameter |
UNLOAD |
||||||||||||||||||||||
VERSIONCHECK |
Checks the Natural version of the cataloged object to be loaded. The Natural version under which the objects were cataloged and written to the work file is compared with the current Natural version. Objects cataloged under a Natural version higher than the current one will be rejected.
|
LOAD |
||||||||||||||||||||||
