Settings

#### Search Results

Search

# Settings

The settings option is used to specify option settings for the unload, load, find or scan function and parameter settings for the unload or load function.

To invoke the Unload/Load/Scan Settings screen

- On any of the unload, load or scan screens, enter the following internal command:

      SETTINGS

  See also Commands for Navigation and Special Functions in the section Direct Commands.

  Or:
  Activate advanced-user mode, choose a function and choose ENTER to start the processing procedure.

  Or:
  On advanced-user screens, choose PF7 (Setti).

Unless selected by default, to activate the options provided on the Unload/Load/Scan Settings screen described below, mark the corresponding input field with any single character.

This section covers the following topics:

- Settings Screen Fields

- Set Additional Options

- Set Global Parameters

## Settings Screen Fields

The Unload/Load/Scan Settings screen provides the following fields and PF keys:

Field | PF Key | Explanation
--- | --- | ---
Transfer format |  | Only valid if Use default options (this is the default) has been selected. If selected, the data to be processed is written/read in Transfer format to/from the work file. See also Work File Format in Work Files. Unload function: The data to be unloaded is written in Transfer format to the work file. Note that if you want to change the setting of this field for a subsequent unload, you need to return to the Main Menu or enter the command `GO UNLOAD END` (see Commands for Navigation and Special Functions in Direct Commands) and restart the unload function. Load and scan functions: The data to be loaded or scanned are expected to be in Transfer format.
Unicode work file |  | Only applies to the unload function and if Transfer format has been selected. If this option is selected, all object sources are converted to Unicode/UTF-8 (Universal Transformation Format, 8-bit form) before they are written to the work file. If a Unicode work file is specified, you cannot use the transfer options Use conversion table, Substitute line references and Incorporate free rules.
Use PC File |  | Only applies if Entire Connection is installed. If selected, the data to be processed is read from or written to an Entire Connection work file.
PC File |  | Only applies if Entire Connection is installed. The complete path name to the Entire Connection work file. If your system environment does not accept a backslash (\) separator, use a slash (/) instead.
Use default options |  | Default options are used (this is the default). See also Profile Settings and Set Additional Options.
Set additional options | PF4 | Only valid if Use default options has been selected. Invokes the Options screen where you can modify the default settings and enter additional options for the processing sequence. For the options available, see Set Additional Options.
Use Option Workplan |  | A Workplan of the type OPTION is used. See also Workplans.
Name (next to Use Option Workplan) |  | Only valid if Use Option Workplan has been selected. The name of a Workplan of the type OPTION to be used.
List Option Workplan | PF6 | Only valid if Use Option Workplan has been selected. Displays the contents of the Workplan specified in the Name field next to Use Option Workplan.
Select Option Workplan | PF5 | Only valid if Use Option Workplan has been selected. Displays a selection list of available Workplans of the type OPTION (see also List the Available Workplans in the Workplan Library in Administration).
Do not use parameters |  | If selected (default setting), no parameters are set.
Use global parameters |  | Global parameters are used. See Set Global Parameters.
Set global parameters | PF7 | Only valid if Use global parameters has been selected. Invokes the Parameters screen. See Set Global Parameters and parameter-setting (Direct Commands) for descriptions of keywords and valid input values.
Use Parameter Workplan |  | A Workplan of the type PARAMETER is used. See also Workplans.
Name (next to Use Parameter Workplan) |  | Only valid if Use Parameter Workplan has been selected. The name of a Workplan of the type PARAMETER to be used.
List Parameter Workplan | PF9 | Only valid if Use Parameter Workplan has been selected. Displays the contents of the Workplan specified in the Name field next to Use Parameter Workplan.
Select Parameter Workplan |  | Only valid if Use Parameter Workplan has been selected. Displays a selection list of available Workplans of the type PARAMETER. See also List the Available Workplans in the Workplan Library in Administration.

## Set Additional Options

The sections contained in the Options screen are described below. Note that not all of the sections may appear on the screen, because they depend on the function used, the settings defined and the products installed.

For descriptions of keywords and valid input values, see also option-setting in the section Direct Commands.

This section covers the following topics:

- Work File and Report Options

- XREF Options

- XRef Considerations

- Version Check

- Transfer Options

- Replace Options

- Number to Process

- FDIC Settings

- FSEC Settings

### Work File and Report Options

The options provided for work files and reports are described in the following section.

Field | Explanation
--- | ---
Use PC File | Only applies if Entire Connection is installed. If selected, the data to be processed is read from or written to an Entire Connection work file.
PC File | Only applies if Entire Connection is installed. 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.
Unicode work file | Only applies to the unload function and if Transfer format has been selected. If this option is selected, all object sources are converted to Unicode/UTF-8 (Universal Transformation Format, 8-bit form) before they are written to the work file. If a Unicode work file is specified, you cannot use the transfer options Use conversion table, Substitute line references and Incorporate free rules.
Write report | Writes a report of the objects processed to the report text member specified in the Report text member field. The Write report option is selected by default. To display the report, enter the internal command `SHOW REPORT FILE` (see Commands for Navigation and Special Functions in Direct Commands).
Start new report | Only valid if Write report has been selected. Deletes the contents of the report text member before a new report is written. Otherwise, a new report is appended to the existing one.
Error report only | Only valid if Write report has been selected. Write only error messages to the report. This includes messages from Natural Security and messages that have incurred during the execution of a LOAD command, for instance "not replaced". See also `REPORT-OPTION-1` in Direct Commands, option-setting.
Change report library | Only valid if Write report has been selected. Opens a new screen where you can change the report library. See also Change the Report Library (Administration) and `REPORT-LIBRARY` (Direct Commands, option-setting).
Report text member | Only valid if Write report has been selected. The name of the text member stored in the Workplan library to which the report is written.
Select text member | Displays a list of all text members stored in the Workplan library. From this list, you can select a Report text member.
Write restart information | Only applies to the load function. When this option is set, restart information is provided for the restart load function. For details, see Restart Load in Functions.
Restart text member | Only applies to the load function and if Write restart information has been selected. The name of the text member in the Workplan library to which the restart information is written. If you do not specify a name, the Object Handler generates a name and assigns it to the text member.
Select text member | Displays a list of all text members stored in the Workplan library. From this list, you can select a Restart text member.
Delete allowed | Only applies to the load function. Processes delete instructions from work files when loading objects in internal format.

### XREF Options

XREF options are only available when unloading or loading data in internal format, that is, if the field Transfer format has not been selected. Predict must be installed to process XRef data.

The XREF options provided and the functions to which they apply are described in the following section.

Field | Explanation | Function
--- | --- | ---
Yes (unload XRef data) or Yes (load XRef data) | Unloads cataloged objects and their cross-reference data, if any. Loads cataloged objects and their cross-reference data if cross-references exist in the work file. | Unload Load
No (ignore XRef data) | No XRef data is processed. | Unload Load
Force | 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. | Load
Doc | Loads cataloged objects and their cross-reference data (if any) only if Predict entries exist for the objects in the FDIC system file. | Load
Special | Loads cataloged objects and their cross-reference data (if any). | Load

### XRef Considerations

All cross-reference (XRef) data stored in the Predict system file can be processed with the Object Handler. The XREF option indicates whether the Object Handler should process XRef data. XRef data is always deleted if the delete or replace function is performed on a cataloged object.

If Predict has not been installed, set the XREF option to `N` and thus no validation of Predict files is performed. If the XREF option is set to `Y` and the FDIC file being used is not a valid Predict file, an error message is returned.

The rules for setting the XREF option are the same as the ones imposed by Natural Security. In a non-security environment there are no restrictions, see the first five cases described below. However, if Natural Security is active, as in the last case, the setting of the XREF option in the Object Handler depends on the value of the XREF option in the utility profiles of Natural Security.

Consider the following settings for XREF:

- XREF set to OFF or No
- XREF set to ON or Yes or Force
- XREF set to Force
- XREF set to Doc
- XREF set to Special
- XREF option with Natural Security

#### XREF set to OFF or No

If the XREF option is set to OFF or No, no XRef data is processed. But in situations where a cataloged object is deleted or replaced, the Object Handler deletes the XRef data. The target Predict system file is determined according to the current settings of the FDIC option. The default is the value assigned to the profile parameter FDIC (see FDIC - Predict System File in the Parameter Reference documentation) at the start of the Natural session.

#### XREF set to ON or Yes or Force

If the XREF option is set to Yes or Force, the following actions are applied during processing:

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

#### XREF set to 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.

If the XREF option is set to Force, the Object Handler additionally checks that the cataloged object has a Predict program entry defined on the Predict system target file. If not, processing of the object is terminated.

#### XREF set to Doc

Only applies to LOAD.

If the XREF option is set to Doc, the Object Handler checks that the cataloged object has a Predict program entry defined on the Predict system target file. If not, processing of the object is terminated. The cataloged objects that have cross-reference data are processed with their cross-reference data, and the cataloged objects that have none are also processed.

#### XREF set to Special

Only applies to LOAD.

If the XREF option is set to Special, the special case applies where a range of specified cataloged objects is processed with corresponding XRef data regardless of whether all of the cataloged objects have cross-reference data or not: the cataloged objects that have cross-reference data are processed with their cross-reference data, and the cataloged objects that have none are also processed.

#### XREF option with Natural Security

If Natural Security is active, the following applies:

- If the value of the XREF option in the utility profiles of Natural Security is `N` or `S`, you can specify any value (OFF/No, ON/Yes, Doc, Force or Special) for the XREF option in the Object Handler.

- If the value of the XREF option in the utility profiles of Natural Security is `D`, you can specify only the values Doc or Force for the XREF option in the Object Handler. If you specify ON/Yes, the value Force is used internally. If you specify OFF/No or Special, the value Doc is used internally.

- If the value of the XREF option in the utility profiles of Natural Security is `Y`, you can specify only the values ON/Yes or Force for the XREF option in the Object Handler. If you specify Doc, internally the value Force is used, if you specify OFF/No or Special, the value ON/Yes is used internally.

- If the value of the XREF option in the utility profiles of Natural Security is `F`, you can specify only the value Force for the XREF option in the Object Handler. If you specify any other value, the value Force is used internally.

### Version Check

The Version check option is only available when loading data in internal format, that is, if the field Transfer format has not been selected.

If Version check is selected, 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.

### Transfer Options

Transfer options are only available when processing data in Transfer format, that is, if the field Transfer format has been selected.

The transfer options provided and the functions to which they apply are described in the following section.

Option | Explanation | Function
--- | --- | ---
Substitute line references | Only applies if source-code line numbers are used for statement references. If line numbers are used as references in the source code, the line numbers of referenced lines and the line number references are replaced with labels. The sources are not modified in the database. | Unload
Include line numbers | If you choose this option, the line numbers will be transferred. (By default, line numbers in Natural objects are not transferred.) | Unload
Incorporate free rules | If Predict is installed, Predict rules associated with a map are incorporated into the map source. | Unload
Use conversion table | Caution: Use this option only in special cases, such as when performing a non-FTP transfer between environments with different character sets, where no conversion is performed by the transfer tool. Unload: Converts data to ASCII format by using the internal Natural conversion table (System table) or a conversion table defined by the user (User table). Load: Converts data to EBCDIC format by using the internal Natural conversion table (System table) or a conversion table defined by the user (User table). Note that this only applies if the data in the work file is in ASCII format or if a conversion program is specified (see User table). | Unload Load
System table | Only valid if Use conversion table has been selected. Unload: Converts data to ASCII format by using the internal Natural conversion table. Load: Converts data to EBCDIC format by using the internal Natural conversion table. | Unload Load
User table | Only valid if Use conversion table has been selected. If the name of a conversion program has been entered in the field, data is converted to EBCDIC or ASCII format by using the conversion program defined. To specify an individual conversion program, the program must be located in the library SYSOBJH or one of its steplibs. See the example subprograms OTNCONAE and OTNCONEA in the library SYSOBJH. If no conversion program is specified, by default, the corresponding conversion table in the Natural file NATCONV.INI is used for the unload ([ISO8859_1->EBCDIC] ) and the load ([EBCDIC->ISO8859_1]) functions. | Unload Load
Use load code page | If you choose this option, a window appears where you can enter the name of the code page to be used for the load function. If this option is selected, 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. See also Unicode work file. If you enter `*CODEPAGE` as the code page name, the value assigned to the system variable `*CODEPAGE` is used (see the System Variables documentation). If no code page name is specified, the source objects are converted with the code page used when unloading them. If Use load code page is specified, you cannot use the options Use conversion table and Translate to upper case. | Load
Translate to upper case | Translates any source code to be loaded into upper case. | Load
Data area format |
Only applies to data areas.
Specifies the format in which to unload or load data area sources. Possible input values are:
`N` | Converts data areas to the new internal data area format.
`O` | Converts data areas to the old internal data area format. If one or more data area sources cannot be converted to the old internal data area format, the Object Handler issues a corresponding message when unloading is complete. In addition, in the Status column of the unload report generated by the unload function, a corresponding remark appears next to the names of the data area sources affected.
`*` | Does not convert data areas. This is the default.
For details, see Data Area Editor in the Editors documentation.
| Unload Load
Unshape Arabic characters | This option is used to replace shaped Arabic characters (code page IBM420) with the corresponding unshaped characters in the following source objects: Natural programs, DDMs, user error messages and system error messages. | Unload Load

### Replace Options

The replace options described below only apply to the load function:

Do not replace | Does not replace any objects. This is the default.
Replace all | Replaces all objects.
Replace obsolete | Replaces objects with a date older than the date of the objects in the load file.
Replace except newer | Replaces all objects except those with a date newer than the date of the objects in the load file.

### Number to Process

Number to process only applies to the load and scan functions.

In the field Number to process, enter a value with a maximum of 5 digits. If a value greater than 0 is specified, the load or scan function stops after the specified number of objects has been processed.

Note
If a cataloged Natural object is processed directly after the source object of the same name, they are considered one object.

### FDIC Settings

FDIC settings are used to specify the Predict file (FDIC) to be used for processing XRef data (only applies if Predict is installed) or load DDMs:

DBID | The database ID where the FDIC file is located.
FNR | The file number where the FDIC file is located.
Password | Optional. The Adabas password of the Adabas file where the FDIC file is located.
Cipher | Optional. The cipher code of the Adabas file where the FDIC file is located.

### FSEC Settings

FSEC settings only apply if Natural Security is installed.

FSEC settings are used to specify the Natural Security data file (FSEC) to be used for security checks:

DBID | The database ID where the FSEC file is located.
FNR | The file number where the FSEC file is located.
Password | Optional. The Adabas password of the Adabas file where the FSEC file is located.
Cipher | Optional. The cipher code of the Adabas file where the FSEC file is located.

## Set Global Parameters

#### Only applies to the load or unload function.

The fields provided on the Parameters screen can be used to change global parameter settings for the objects to be processed with the load or unload function, and to change the target environment for the load function. For example, you can specify new names (or name ranges) under which the selected objects are unloaded to the work file, or you can specify a different library into which the selected objects are loaded from the work file.

If global parameters are specified during the unload function, the parameter settings affect the objects before they are written to the work file. If they are specified during the load function, the parameter settings affect the objects before they are written to the target environment.

The values that can be specified to change parameter settings, are entered next to the required parameters in the fields Check Value and New Value.

If no value has been entered in Check Value, the value entered in New Value affects all objects to which the specific parameter setting applies. If a value has been entered in Check Value, the value entered in New Value only affects objects to which the specific parameter setting and the value entered in Check Value apply. If a Check Value or New Value is not relevant to the type of object to be processed, any value entered in either field will be ignored. For example: Natural system error messages have no library name. Therefore, when processing Natural system error messages, a value entered in Check Value or New Value for the Library field will be ignored.

Check Value and New Value do not apply to the parameter Error number difference and the parameters contained in the section System files for load of the Parameters screen.

For valid parameter settings, see also parameter-setting in the section Direct Commands.

The following fields are contained in the Parameters screen:

Field/Section | Explanation
--- | ---
Object name | Check Value/New Value: A single object name or a range of names: see Name in Name, Date and Time Specification and Rules for New Values. Note Not applicable to DDMs on mainframe platforms.
Library | Check Value/New Value: A single library name or a range of names: see Name and Rules for New Values.
Date | Check Value/New Value: A single date or a range of dates: see Date in Name, Date and Time Specification and Rules for New Values.
Time | Check Value/New Value: A time or a range of times: see Time in Name, Date and Time Specification and Rules for New Values.
User ID | Check Value/New Value: A single user ID or a range of user IDs: see Name and Rules for New Values.
Terminal ID | Check Value/New Value: A single terminal ID or a range of terminal IDs: see Name and Rules for New Values.
Lang. codes | Only applies when processing Natural system error messages or user-defined error messages. Check Value/New Value: Up to 8 valid language codes such as code `4` for Spanish. If more than one language code is specified, Check Value must contain the same number of language codes. In this case, the language code in Check Value is replaced by the language code in the corresponding New Value. Note: New Value does not apply to the long texts of Natural system error messages for which English (code `1`) is the only valid language.
Error number difference | Only applies when processing Natural system error messages or user-defined error messages. A 4-digit positive or negative value (+/-nnnn) to be used as a new number range for error messages. Start and end values must be provided in the Error number from/to fields (see Natural Library Objects) to validate whether the new range can be applied to the selected error messages. Example: If Error number from/to selects message numbers 1 to 10 and Error number difference is set to `2000`, the messages will be renumbered from 2001 to 2010. A value of `-1000` in Error number difference would cause a validation error.
FDT DBID/FNR | Check Value/New Value: A valid database ID (DBID) and/or file number (FNR) for Adabas FDTs.
System files for load: Load FNAT
DBID
FNR
Password
Cipher
| Only applies to the load function. The database ID (DBID) and file number (FNR) of the target FNAT system file. This system file is used for all library objects whose library name starts with `SYS`, but not SYSTEM. If required, enter the Adabas password (Password) and the cipher code (Cipher) for the system file.
System files for load: Load FUSER
DBID
FNR
Password
Cipher
| Only applies to the load function. The database ID (DBID) and file number (FNR) of the target FUSER system file. This system file is used for all library objects whose library name does not start with `SYS`, and for the library SYSTEM. If required, enter the Adabas password (Password) and the cipher code (Cipher) for the system file.
System files for load: Load FNAT/FUSER Select | Only applies to the load function. Invokes the Select System File window with a list of all system files available in your Natural environment: see Select System File.
System files for load: Load NCP
DBID
FNR
Password
Cipher
| Only applies to the load function. The database ID (DBID) and file number (FNR) of the target Adabas file into which the Natural command processor sources are to be loaded. If required, enter the Adabas password (Password) and the cipher code (Cipher) for the system file.

This section covers the following topic:

- Rules for New Values

### Rules for New Values

The following applies to New Value for Object name, Library, Date/Time, User ID and Terminal ID.

If New Value contains a range with an asterisk (*) such as `ABC*`, the number of characters before the asterisk (*) determines the number of characters to be replaced in Check Value. This is also valid if Check Value is shorter than the range specified in New Value (see the second example in Examples below).

#### Examples:

1. If Object name is `ABCDEFG` and New Value is set to `ZYX*`, the resulting object name is ZYXDEFG.

2. If Object name is `AB` and New Value is set to `ZYX*`, the resulting object name is ZYX.

3. If Date/Time is `2005-03-26` and New Value is set to `2006*`, the resulting object date is 2006-03-26.

### On this page

- Settings Screen Fields
- Set Additional Options
- Set Global Parameters