Object Specification - Natural Library Objects

This section describes the options provided in the object-specification windows for processing Natural library objects.

Natural library objects are programming objects (including Natural DDMs), user-defined error messages and shared resources.

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

This section covers the following topics:


Natural Library Objects

The specification window for Natural library objects provides the following items:

Item Explanation
Library The name of a library or a range of names: see Name in Name, Date and Time Specification.

To choose a name from a selection list of all libraries available, open the drop-down list box.

DBID Only applies to the unload function.

The database ID of the system file where the Natural libraries are stored.

FNR Only applies to the unload function.

The file number of the system file where the Natural libraries are stored. If no values (or 0) are specified for DBID and FNR, the current FUSER or FNAT system file is used.

Password Only applies to the unload function if executed in remote environments located on mainframe platforms.

The Adabas password of the system file where the Natural libraries are stored.

Cipher key Only applies to the unload function if executed in remote environments located on mainframe platforms.

The Adabas cipher code of the system file where the Natural libraries are stored.

Name The name of a Natural programming object or shared resource or a range of names: see Name.

The default is an asterisk (*), which selects all objects available.

Only evaluated if the check boxes Natural programming objects and/or Shared resources are selected in the details window, which is the default. See also Natural Library Object Details.

Message from/to A valid range (1 - 9999) of user-defined error messages delimited by the first and the last message number.

Only evaluated if the Error messages check box is selected in the details window, which is the default. See also Natural Library Object Details.

Details Invokes an additional window where you can enter more detailed object specifications: see Natural Library Object Details.
Settings Only applies to functions executed in advanced-user mode.

Invokes the Settings window where you can specify option and parameter settings: see the section Settings.

Unload file
or
Load file
or
Scan file

(Server)

Only applies to functions executed in advanced-user mode.

The name of the work file to be used for the function.

See also the section Work Files.

Browse Only applies to functions executed in advanced-user mode.

Invokes the browse function to select a work file from a directory.

Natural Library Object Details

The details window for Natural library objects is used to specify further selection criteria for Natural library objects.

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

The details window for Natural library objects provides the following items:

Item Explanation
Library The name of a library or a range of names: see Name in Name, Date and Time Specification.

To choose a name from a selection list of all libraries available, open the drop-down list box.

Ranges are not allowed if the Predict set option is selected.

DBID

See DBID in Natural Library Objects above.

FNR See FNR in Natural Library Objects above.
Password See Password in Natural Library Objects above.
Cipher key See Cipher key in Natural Library Objects above.
Natural programming objects Natural programming objects.

Natural DDMs (data definition modules): In remote environments located on mainframe platforms, DDMs are located in the FDIC system file. They are not considered Natural library objects. In other system environments, DDMs are considered Natural programming objects, which are stored in Natural libraries.

If the FDDM system file has been activated, see also Use FDDM file for processing DDMs in Settings - Options.

Error messages User-defined error messages.
Shared resources Any non-Natural file that is used in a Natural environment and is maintained in the Natural library system.

Note that shared resources are not defined in remote environments located in mainframe systems.

Name See Name in Natural Library Objects above.
S/C-Kind The kind of Natural programming object:
Src   Source objects only.
Gp Generated programs (cataloged objects) only.
Any All source and/or cataloged objects (generated programs). This is the default.
Stowed       All STOWed objects: source and cataloged objects with identical date and time.
Both Both source and cataloged objects if both exist.

Note:
Stowed and Both are valid for the unload function only.

Predict set Only applies to the unload and find functions and if Predict is installed.

This option is used to read the names of the objects to be processed from a retained set. A retained set is created with the save set option of the LIST XREF command.

If the Predict set option is selected, the following applies:

  • The Name text box must contain asterisk (*) indicating all objects. This is the default setting.

  • The Library list box must contain the name of a single library. Name ranges are not allowed.

  • The Set number box must be filled.

For detailed information on Predict sets, refer to the Predict documentation.

Set number Only applies if Predict set is selected.

A one- or two-digit number that identifies the retained set to be used.

Set library Only applies if Predict set is selected.

The name of the library to be searched for a Predict set. If you do not specify a name, the library entered in the Library list box is used by default.

Set user Only applies if Predict set is selected.

The ID of the user who created the retained set. If no ID is entered, the ID specified with the system variable *USER (see the System Variables documentation) is used.

Natural Object Types The types of Natural programming object.
Select All Selects all types of Natural programming object (this is the default).
Deselect All Deselect all types of Natural programming object.
User-defined Messages:

from/to

A range of user-defined error messages as entered in the Message from/to boxes (see Natural Library Objects above).
User-defined Messages:

S/L-Kind

The kind of user-defined error message text:
Short   Short text.
Long Long text.
Any Short and/or long text. This is the default.
Both Short and long texts if both exist (unload function only).
User-defined Messages:

Language codes

Up to 8 valid language codes (for example, code 1 for English) of the specified error messages.

An asterisk (*) selects all language codes.

Properties Invokes an extra window where you can specify additional properties of Natural programming objects: see Natural Library Object Properties below.

Once you have specified any properties, you can activate them by selecting the check box to the left of the Properties button, or deactivate them by removing the mark from the check box.

Exceptions Invokes an extra window where you can specify exceptions to the selection of Natural programming objects: see Natural Library Object Exceptions below.

Once you have specified any exceptions, you can activate them by selecting the check box to the left of the Exceptions button, or deactivate them by removing the mark from the check box.

Natural Library Object Properties

The Properties window for Natural library objects is used to specify properties for the Natural library objects selected for processing.

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

The Properties window for Natural library objects provides the following items:

Item Explanation
User ID The ID of the user who last saved the object. Specify a single user ID or a range of user IDs: see Name in Name, Date and Time Specification.
Natural version The Natural version of the Natural programming objects. You can also specify a range of versions: see Name.
Mode
The programming mode of the Natural programming objects:
   
Structured Structured mode only.
Report Reporting mode only.
Any No mode check performed. This is the default.
DDM DBID Not valid in remote environments located on mainframe platforms.

The database ID (DBID) of the data definition modules (DDMs). Valid entries are: 1 to 65535 or 0 (all DBIDs)

DDM FNR Not valid in remote environments located on mainframe platforms.

The file number (FNR) of the DDMs: Valid entries are: 1 to 65535 or 0 (all FNRs).

Date:

Select all objects

Selects all objects, regardless of their date.
Date:

Select objects modified between/and

Selects all objects with a save or catalog date and/or time within the range specified in the Date boxes.

Select a value from the combo box or type values for a start date and/or time and/or values for an end date and/or time. For valid input values, see Date and Time in Name, Date and Time Specification. Special dates allowed are: TODAY, YESTERDAY, MONTH and YEAR.

Date:

Select objects modified on

Selects all objects with a save or catalog date and/or time that fits the date/time specified in the Date box.

Select or type values for a date and/or time. For valid input values, see Date and Time. Special dates allowed are: TODAY and YESTERDAY.

Size:

Select all objects

Selects all objects, regardless of their size.
Size:

Select objects with size between/and

Selects all objects with a size within the range specified in the Size boxes: type a value for a start size and/or an end size.
Size:

Select objects with size

Selects all objects with a size that fits the size specified in the Size box.

Natural Library Object Exceptions

The Exceptions window for Natural library objects is used to specify exceptions to the selection of Natural library objects.

All objects that match the selection criteria specified in Natural Library Objects, Natural Library Object Details and Natural Library Object Properties are checked against the specifications made in the Exceptions window. Objects that match all specifications defined as exceptions are exempted from processing.

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

The Exceptions window for Natural library objects is basically identical to the details window. For explanations of the items listed in the table below, see the relevant section. The Properties button is used to specify additional properties for Natural programming object exceptions: see Natural Library Object Exception Properties below.

Item

Location:

   Library

Object Types:

  Natural programming objects
  Error messages
  Shared resources

Natural Programming Objects and Shared Resources:

  Name

Natural Programming Objects:

  S/C-Kind
  Natural Object Types

Natural System Error Messages:

  from/to
  Language codes
  S/L-Kind

Extras:

  Properties

Natural Library Object Exception Properties

The Exception Properties window for Natural library objects is used to specify exceptions to the properties of the Natural library objects selected for processing.

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

The Exception Properties window for Natural library objects provides the following items:

Item Explanation
User ID See User ID in Natural Library Object Properties.
Natural version See Natural version in Natural Library Object Properties.
Mode See Mode in Natural Library Object Properties.
DDM DBID See DDM DBID in Natural Library Object Properties.
DDM FNR See DDM FNR in Natural Library Object Properties.
Date:

Ignore date

Performs no date check. Objects are processed, regardless of their date.
Date:

Exclude objects modified between/and

Exempts from processing all objects with a save or catalog date and/or time within the range specified in the Date boxes.

Select or type values for a start date and/or time and/or values for an end date and/or time. For valid input values, see Date and Time in Name, Date and Time Specification. Special dates allowed are: TODAY, YESTERDAY, MONTH and YEAR.

Date:

Exclude objects modified on

Exempts from processing all objects with a save or catalog date and/or time that fits the date/time specified in the Date box.

Select or type values for a date and/or time. For valid input values, see Date and Time. Special dates allowed are: TODAY and YESTERDAY.

Size:

Ignore size

Performs no size check. Objects are processed, regardless of their size.
Size:

Exclude objects with size between/and

Exempts from processing all objects with a size within the range specified in the Size boxes: type a value for a start size and/or an end size.
Size:

Exclude objects with size

Exempts from processing all objects with a size that fits the size specified in the Size box.