option-setting

#### Search Results

Search

# option-setting

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.

- Syntax of option-setting

- Keyword Explanation of option-setting

## Syntax of option-setting

`WHERE` |
| (option-workplan) option-clause |

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.

- Syntax of option-clause

### Syntax of option-clause

| `REPLACE` |  | `ALL` `OBSOLETE` `EXCEPT` |  |  |
| transfer-options internal-format-options |  |
| `NOREPORT` `NEWREPORT` [file-name] `REPORT` [file-name] `BATCHREPORT` |  |
`[` | {`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` |  | `A` `E` `S` |  |  |
| `REPORT-FORMAT` |  | `S` `T` |  |  |
| `REPORT-MODE` |  | `S` `L` |  |  |
| `NORESTART` `RESTART` [restart-text-object] |  |
[`NUMBERPROCESS` number]
[`FIXEDLENGTH`]
[`FDIC` (dbid,fnr,password,cipher)]
[`FSEC` (dbid,fnr,password,cipher)]
|  | `WORKFILETYPE` `WFTYPE` |  |  | `DEFAULT` `UTF-8` |  |  |
|  | `PC` `NEWPC` |  | [file-name] |  |
|  | `PCCOMMANDFILENUMBER` `PCCFN` |  | command-file-number |  |

#### Separators

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-options

`TRANSFER`
| `CONVERSION-TABLE` |  | `SYSTEM-TABLE` `USER-TABLE` [conversion-program] |  |
[`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`]

#### internal-format-options

| `XREF` |  | `ON` `OFF` `DOC` `FORCE` `SPECIAL` |  |
[`DELETEALLOWED`]
[`NOSYMBOLTABLE`]
[`VERSIONCHECK`]

## Keyword Explanation of option-setting

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:
`ALL` | All objects (default setting).
`OBSOLETE` | All objects with a date older than the date of the object in the load file.
`EXCEPT` | All objects except those with a date newer than the date of the object in the load file.
| `LOAD` `LOADALL`
`TRANSFER` | Set Transfer mode. The data is read and written in Transfer format. For valid options, see Keyword Explanation of transfer-options. | `UNLOAD` `LOAD` `SCAN`
`NOREPORT` | Specifies the report file setting: No data is recorded to a report file. This is the default setting for the `FIND` and `FINDLIB` commands. |
`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 `UNLOAD`, `LOAD`, `LOADALL`, `SCAN`, `SCANALL` and `DELETE`. 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). |
`REPORT-LIBRARY` or `REPORT-LIB` or `REP-LIB` | 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 `WORKPLAN` or the library in the Object Handler profile parameter `Workplan-Library` is used. See also Profile Parameters. |
`REP-LIB-DBID` | The database ID of the system file where the `REPORT-LIBRARY` resides. (`0` is the current FNAT/FUSER.) |
`REP-LIB-FNR` | The file number of the system file where the `REPORT-LIBRARY` resides. (`0` is the current FNAT/FUSER.) |
`REP-LIB-NAME` | The VSAM name of the system file where the `REPORT-LIBRARY` resides. |
`REP-LIB-PASSWORD` or `REP-LIB-PSW` | 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. |
`REPORT-OPTION-1` `or` `REPOPT1` `or` `REP-OPT-1` | Specifies the report option to be used when a direct command is executed and a report is to be written:
`A` | Display all report items (default).
`E` | Display only error messages. This includes messages from Natural Security and messages that have incurred during the execution of a `LOAD` command, for instance "not replaced".
`S` | For batch mode only. The error report is split into two parts: Report items except error messages are written to the default report device (`REPORT(0)/CMPRINT`), error messages (including messages from Natural Security and messages that have incurred during the execution of a `LOAD` command) are written to the second report device (`REPORT(1)/CMPRT01`). Note that in online mode `S` has the same effect as `A`.
| `UNLOAD` `LOAD` `SCAN` `DELETE`
`REPORT-FORMAT` `or` `REPFRMT` | Specifies the report format to be used when a direct command is executed and a report is to be written:
`S` | Display the source data in the unload report, i.e. the data of the unloaded object before parameters (e.g. the library name) are changed (default setting).
`T` | Display the target data in the unload report, i.e. the data after parameters (e.g. the library name) have been changed.
| `UNLOAD`
`REPORT-MODE` `or` `REPM` | Specifies the report mode to be used when a direct command is executed and a report is to be written:
`S` | Write a short report, i.e. the most relevant data is displayed on the first 80 columns of the report line with short delimiters.
`L` | Write a large report, i.e. the data is displayed in the original order with large delimiters (default setting).
`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 `LOAD` or `SCAN` command stops execution after the number specified. | `LOAD` `SCAN`
`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. `Y` Use fixed length for work file records. `N` Use variable length for work file records (default setting). | `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 `0`) are specified, the current FDIC system file is used. | `UNLOAD` `LOAD` `DELETE`
`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 `0`) are specified, the current FSEC system file is used. | `UNLOAD` `LOAD` `DELETE`
`WORKFILETYPE` or `WFTYPE` | The work file type of Natural Work File 1 when data is read and written to the work file:
`DEFAULT` | Default binary work file.
`UTF-8` | Unicode/UTF-F8 encoded binary work file.
| UTF-8 only applies to the unload function and if `TRANSFER` is specified.
| If `UTF-8` is specified, you cannot use the options `CONVERSION-TABLE`, `SUBSTITUTE` and `INCORPORATE-FREE-RULES`.
If `WORKFILETYPE` has not been specified, the current type is used. | `UNLOAD`
`PC` `NEWPC` | 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 `NEWPC` is specified, the data unloaded overwrites the contents of the existing work file or fills a new work file from the top. Otherwise, the data is appended. See also Work File Assignment in Work Files. | `UNLOAD` `LOAD` `SCAN`
`PCCOMMANDFILENUMBER` or `PCCOM` or `PCCFN` | 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 `8` for Work File 8, which must be defined as Entire Connection work file. See also Work File Assignment in Work Files. | `UNLOAD` `LOAD` `SCAN`

The keywords and the variable values (if relevant) of transfer-options and internal-format-options are explained in the following section:

- Keyword Explanation of transfer-options

- Keyword Explanation of internal-format-options

### Keyword Explanation of transfer-options

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: `SYSTEM-TABLE`: The internal Natural conversion table. `USER-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. | `UNLOAD` `LOAD` `SCAN`
`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. By default, line numbers in Natural objects are not unloaded. | `UNLOAD`
`USE-LINE-NUMBER-INCREMENT` or `USE-LNI` |
`UNLOAD` | If the option `INCLUDE-LINE-NUMBERS` is not specified, the line number increment of Natural source objects will be unloaded. By default, the line number increment in Natural source objects is not unloaded.
`LOAD` | If the line number increment was transferred, it is used to rebuild the line numbers of the Natural source objects.
| `UNLOAD` `LOAD`
`UPPERCASE-TRANSLATION` | Translates any source code into upper case during the load in Transfer format. By default, source code in Natural objects is not translated. | `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 `*CODEPAGE` as code-page-name or if code-page-name is not specified, the value assigned to the system variable `*CODEPAGE` is used (see the System Variables documentation). If `LOAD-CODE-PAGE` is specified, you cannot use the options `CONVERSION-TABLE` and `UPPERCASE-TRANSLATION`. | `LOAD` `LOADALL`
`DA-FORMAT` | Specifies format conversion of data area sources: see Data area format in Transfer Options in Settings. | `UNLOAD` `LOAD`
`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. | `UNLOAD` `LOAD`

### Keyword Explanation of internal-format-options

When using internal-format-options, you can specify the following:

Option | Explanation | Restricted to Command
--- | --- | ---
`XREF` |
Only applies if Predict is installed. Loads or unloads XRef data of cataloged Natural objects. You can specify one of the following values:
`ON` | `UNLOAD`: Unloads cataloged objects and their cross-reference data (if any). `LOAD`: Loads cataloged objects and their cross-reference data if cross-references exist in the work file.
`OFF` | No XRef data is processed. This is the default.
`DOC` | Only applies to `LOAD`. Loads cataloged objects and their cross-reference data (if any) only if Predict entries exist for the objects in the FDIC system file.
`FORCE` | Only applies to `LOAD`. Loads cataloged objects and their cross-reference data only if cross-references exist in the work file and if Predict entries exist for the objects in the FDIC system file.
`SPECIAL` | Only applies to `LOAD`. Loads cataloged objects and their cross-reference data (if any).
| `LOAD` `UNLOAD`
`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 `RECAT=ON` (see the Parameter Reference documentation) will not apply. | `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. `VERSIONCHECK` can only be used if data is loaded in internal format, that is, if the `TRANSFER` option is not specified. | `LOAD`

### On this page

- Syntax of option-setting
- Keyword Explanation of option-setting