
	Version 6.3.8 for OpenVMS	SEARCH CONTENTS \| PDF PAGE PDF BOOKS \| HOME UP PREV NEXT

— Tools and Utilities —

`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

NORESTART
RESTART [restart-file]

[NUMBERPROCESS number]

[FIXEDLENGTH]

[FDIC (dbid,fnr,password,cipher)]

[FSEC (dbid,fnr,password,cipher)]

USE-FDDM

YES
NO

NEWWORKFILE
WORKFILE

file-name

WORKFILETYPE
WFTYPE

DEFAULT
PORTABLE
UTF-8

[ADAFDUWORKFILE file-name]

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`]

`internal-format-options`


	`XREF`	`ON` `OFF` `DOC` `FORCE` `SPECIAL`
[`DELETEALLOWED`]

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 Work File 4 or file-name. An existing file will be overwritten.

REPORT

Specifies the report file setting:

Report data is recorded and written to Work File 4 or file-name. This is the default setting for the commands UNLOAD, LOAD, LOADALL, SCAN, SCANALL and DELETE.

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).

NORESTART No restart information is written to a file. LOAD

RESTART Restart information is written to Work File 6 or restart-file. 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.

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

USE-FDDM

Specifies that the FDDM system file is used for processing: see Keyword Explanation of USE-FDDM below.

UNLOAD
LOAD
FIND
DELETE

NEWWORKFILE
or
WORKFILE

Specifies the work file to be used.

The UNLOAD or LOAD data is transferred into/from Natural Work File 1. If NEWWORKFILE is specified, the data overwrites the contents of the existing work file or fills a new work file from the top. Otherwise, the data is appended.

UNLOAD
LOAD
SCAN

WORKFILETYPE
or
WFTYPE

Not required by the LOAD and SCAN commands, which automatically choose the appropriate work file type and ignore this keyword if specified.

The work file type of Natural Work File 1 when data is read and written in internal format:

`DEFAULT`	Default binary work file.
`PORTABLE`	Portable work file.
`UTF-8`	Unicode/UTF-8 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`.

(See also Work File Format in Work Files.)

If WORKFILETYPE has not been specified, the current type is used.

UNLOAD
LOAD
SCAN

ADAFDUWORKFILE The complete path name assigned to the work file (Natural Work File 5) into which Adabas FDT data is loaded. LOAD

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 USE-FDDM

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. If no `conversion-program` is specified, the corresponding conversion table is used in NATCONV.INI ([ISO8859_1->EBCDIC] or [EBCDIC->ISO8859_1]).	`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`
`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`, the value assigned to the system variable `CODEPAGE` is used (see the System Variables documentation). If `code-page-name` is not specified, the source objects are converted with the code page used when unloading them. 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`

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 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 created by the utility NATUNLD when loading objects in internal format. LOAD

Keyword Explanation of USE-FDDM

Only applies when processing Natural library objects on UNIX, OpenVMS or Windows platforms.

Specifies that the FDDM system file is used for processing.

If the FDDM file has been activated in the NATPARM module, the default setting is YES.

The following applies when specifying the values YES or NO:

Value Explanation

Value	Explanation
`YES`	`UNLOAD`, `FIND` and `DELETE`: If the parameter `NATTYPE` is set to `V`, DDMs are only processed from the library SYSTEM located in the FDDM file or the file specified by the database ID (DBID) and the file number (FNR). No DDMs are processed if the parameter `NATTYPE` is set to `*`, or if `NATTYPE` is a combination of any Natural object types that does not include the type `V`. `LOAD`: DDMs are loaded into the library SYSTEM located in the FDDM file. See also `NATTYPE` in Natural Library Object and DDM Selection in `select-clause`.
`NO`	`UNLOAD`, `FIND` and `DELETE`: DDMs are processed from the libraries specified. `LOAD`: DDMs are loaded into the libraries specified.

YES

UNLOAD, FIND and DELETE:

If the parameter NATTYPE is set to V, DDMs are only processed from the library SYSTEM located in the FDDM file or the file specified by the database ID (DBID) and the file number (FNR).

No DDMs are processed if the parameter NATTYPE is set to *, or if NATTYPE is a combination of any Natural object types that does not include the type V.

LOAD:

DDMs are loaded into the library SYSTEM located in the FDDM file.

See also NATTYPE in Natural Library Object and DDM Selection in select-clause.

NO

UNLOAD, FIND and DELETE:

DDMs are processed from the libraries specified.

LOAD:

DDMs are loaded into the libraries specified.

SEARCH CONTENTS | PDF PAGE PDF BOOKS | HOME UP PREV NEXT

option-setting

Syntax of option-setting

Syntax of option-clause

Separators

transfer-options

internal-format-options

Keyword Explanation of option-setting

Keyword Explanation of transfer-options

Keyword Explanation of internal-format-options

Keyword Explanation of USE-FDDM

Only applies when processing Natural library objects on UNIX, OpenVMS or Windows platforms.

`option-setting`

Syntax of `option-setting`

Syntax of `option-clause`

`transfer-options`

`internal-format-options`

Keyword Explanation of `option-setting`

Keyword Explanation of `transfer-options`

Keyword Explanation of `internal-format-options`