INPL Utility

The INPL utility (Initial Natural Program Load) is used to load or scan Natural objects and shared resources from files supplied by Software AG.

The INPL Utility documentation covers the following topics:

Notation vrs or vr:

When used in this document, the notation vrs or vr represents the relevant product version (see also Version in the Glossary).

Introducing the INPL Utility

The INPL utility processes Natural objects and shared resources provided by Software AG.

The following diagram is a basic illustration of the INPL functionality:

graphics/inpl_gen_winux.png

The Natural objects and shared resources are delivered as installation or update files which are assigned to Work File 1. The INPL utility loads the Natural objects and shared resources from Work File 1 into Natural system files.

The Natural objects and shared resources include cataloged objects and source objects that are contained in libraries in the Natural system files FNAT and FUSER.

In addition to loading Natural objects and shared resources, the INPL utility provides a scan function to check the contents of the file assigned to Work File 1 and a Natural Security Recover function which forces initialization of the Natural Security environment.

When loading cataloged objects into Natural system files, the INPL utility deletes any buffer pool entries of cataloged objects with identical names if contained in the same buffer pool used by the INPL utility.

If an error occurs during INPL execution, the INPL will be interrupted and terminate abnormally with Condition Code 40.

This section covers the following topics:

Restrictions

You can process only files which are marked as "SAG system INPL file".

Special Case

When an INPL is to be performed in a Natural Security environment, the INPL command can be specified using the dynamic Natural profile parameter STACK.

Invoking INPL

Start of instruction set To invoke the INPL utility

  1. Enter the following Natural system command:

    INPL

    An INPL menu similar to the example below is displayed: 

    11:04:48               ***** NATURAL INPL UTILITY *****             2001-11-09 
User: SAG                                                    Library: SYSTEM   
                     Code   Function                                           
                                                                               
                       L    Load Libraries Only                                  
                       D    Load DDMs Only                                     
                       E    Load Error Messages Only                           
                       B    Load All Objects              
                       S    Scan INPL File                                     
                       R    Natural Security Recover                           
                       ?    Help                                               
                       .    Exit                                               
                                                                               
                                                                               
         Code ........ B                                                       
         Replace ..... Y  (Y/N/O)     Load Except . N  (Y/N)                   
         DDM Name ....                                                         
         Library .....                                                         
         Object Name .                Date ........             (YYYY-MM-DD)   
         Check Date .. N  (Y/N)       Number ...... 0                          
         File Type ... D  (D/P)                                                
         Load File ... $NATWORK/SAGLOAD.sag                                    
         Report File . $HOME/report.txt

  2. From the INPL menu, you can choose one of the following functions by entering the corresponding function code in the Code field:

    For detailed information on these functions, refer to the corresponding sections.Modify or complete the remaining input fields as described in Options Available.

  3. Choose ENTER to confirm your entries.

Options Available

The following section describes the input fields on the INPL menu where you can specify the file to be used for the INPL and one or more parameters as object selection criteria for the INPL function specified in the Code field. The use of a parameter depends on the respective function as indicated in the relevant documentation sections.

Field Description
Replace

Specifies whether the Natural objects and shared resources to be processed are to replace any that already exist on the system files.

Possible settings are:

Y All existing Natural objects and shared resources are replaced. This is the default setting.
N Existing Natural objects and shared resources are not replaced.
O Resets the owner information of specified objects. Only applies to the function Natural Security Recover.

See also Check Date to replace only Natural objects and shared resources that are older than the Natural objects and shared resources to be processed.

If you use the function Natural Security Recover, you can enter Option O in this field to reset the owner information of specified objects.

DDM Name

The name of a DDM or a range of names.

If you enter a value that ends with an asterisk (*), each DDM with a name that starts with the specified value is processed. If only an asterisk (*) is entered or if this field is empty, all DDMs are processed.

Library The name of a library or a range of names.

If you enter a value that ends with an asterisk (*), each library with a name that starts with the specified value is processed. The library name is mandatory if Object Name is specified.

Object Name

The name of a Natural object (except DDMs) or a range of names.

If the value ends with an asterisk (*), each object with a name that starts with the specified value is processed.

If this field is empty, all objects contained in the library specified in the Library field are processed.

Check Date

Specifies whether existing Natural objects and shared resources are to be replaced depending on their time stamp.

This parameter has no effect if Replace is set to N.

Possible settings are:

Y Only objects which are older than the Natural objects or shared resources of the same name are replaced. An object is older if it was saved or cataloged before the object to be loaded.
N All objects are replaced. This is the default setting.
Load Except

Specifies whether to exclude Natural objects and shared resources from processing.

This parameter does not apply to error messages.

Possible settings are:

Y All Natural objects and shared resources are processed except for the objects specified in the fields DDM Name, Library and/or Object Name.
N No exceptions; all Natural objects and shared resources are processed. This is the default setting.
Examples of load exceptions:

All libraries except the library ABC are loaded:
Code = L
Library = ABC

All DDMs with a prefix other than XY are loaded:
Code = D
DDM Name = XY*

All objects contained in libraries with a prefix other than AB and all DDMs with a prefix other than CD are loaded:
Code = B
Library = AB*
DDM Name = CD*

Date

Restricts processing to Natural objects and shared resources which were saved or cataloged on or after the date entered in this field.

The date must be entered in the format YYYY-MM-DD (YYYY = year, MM = month, DD = day).

Number

Limits processing of Natural objects and shared resources to a specified number. All objects are counted which are loaded or scanned according to the selection criteria specified in the INPL menu.

If the number of Natural objects processed has reached the value entered in the Number field, processing is terminated with a corresponding message.

File Type

(batch or direct commands only)

 INPL automatically recognizes the type of the load file such as binary or portable. However, due to compatibility reasons, the File type parameter must still be specified when executing INPL in batch or direct command mode, but it will not be evaluated.
Load File The name of the file to be loaded. Work File 1 is used.

The name can be an environment variable pointing to the Load file.

The name can be a text file containing a list of Load files. Work Files 1 and 2 are used.

Report File The name of the file into which the INPL report (see below) is to be written. Work File 4 is used.

INPL Report

When the selected INPL function is complete, a corresponding INPL report is written to the file you specified in the Report File field. If no work file was specified, the report is displayed on a screen.

Load Libraries Only

This function of the INPL utility is used to load Natural cataloged objects and source objects and shared resources into specified libraries in the Natural system file FNAT or FUSER.

Start of instruction set To load libraries

  1. In the INPL menu, enter function code L. You can specify parameters to be valid during execution of this function:

    For detailed information on these parameters, refer to Options Available in the section Introducing the INPL Utility.

  2. Confirm your entries.

When the function is complete, a corresponding INPL report (see the section Introducing the INPL Utility) is output.

Load DDMs Only

This function of the INPL utility is used to load DDMs into the libraries indicated in the work file.

Start of instruction set To load DDMs

  1. In the INPL menu, enter function code D. You can specify parameters to be valid during execution of this function:

    For detailed information on these parameters, refer to Options Available in the section Introducing the INPL Utility.

  2. Confirm your entries.

When the function is complete, a corresponding INPL report (see the section Introducing the INPL Utility) is output.

Load Error Messages Only

This function of the INPL utility is used to load user-defined error messages or system error messages into specified libraries in the Natural system file FUSER or FNAT respectively.

Start of instruction set To load error messages

  1. In the INPL menu, enter function code E. You can specify parameters to be valid during execution of this function:

    For detailed information on these parameters, refer to Options Available in the section Introducing the INPL Utility.

  2. Confirm your entries.

When the function is complete, a corresponding INPL report (see the section Introducing the INPL Utility) is output.

Load All Objects

This function of the INPL utility is used to load all Natural objects (including error messages and DDMs) and shared resources into the libraries indicated in Work File 1.

Start of instruction set To load all objects and shared resources

  1. In the INPL menu, enter function code B. You can specify parameters to be valid during execution of this function:

    For detailed information on these parameters, refer to Options Available in the section Introducing the INPL Utility.

  2. Confirm your entries.

When the function is complete, a corresponding INPL report (see the section Introducing the INPL Utility) is output.

Scan INPL File

This function of the INPL utility is used to scan the contents of the file assigned to Work File 1.

Start of instruction set To scan an INPL File

  1. In the INPL menu, enter function code S. You can specify parameters to be valid during execution of this function:

    For detailed information on these parameters, refer to Options Available in the section Introducing the INPL Utility.

  2. Confirm your entries.

When the function is complete, a corresponding INPL report (see the section Introducing the INPL Utility) is output.

Natural Security Recover

This function of the INPL utility is used to force initialization of the Natural Security environment.

The following options are provided:

Reset Environment

Warning:
Execution of this function will reset the user profile DBA and the library profile SYSSEC as well as the link between these two objects as they were after the initial installation; all other links to the library SYSSEC will be canceled. Other Natural Security profiles and links will not be modified. Contact Software AG technical support for further information.

Start of instruction set To reset the environment

  • In the INPL menu, enter function code R.

Remove Owners

Start of instruction set To remove owners

  • In the INPL menu, enter function code R and enter an O in the Replace field to reset the owner information of specified objects.

User Exit Routines

An INPL user exit routine is supplied as source object INPLSXnn in the Natural system library SYSLIB where nn denotes the ID of the user exit routine.

Start of instruction setTo activate a user exit routine

  1. Copy the source code from SYSLIB into a user library.

  2. Catalog it under the name INPLUXnn.

  3. Copy it back into the Natural system library SYSLIB.

    Note:
    The source object that you might have modified, and the cataloged object of the user exit routine are renamed to avoid them to be overwritten by an update installation.

The following user exit routines are available:

Name Function
INPLUX01 Prevent error message texts to be replaced.

INPLUX01

You can use this user exit to define ranges for error messages (user defined or Natural system error messages) that cannot be replaced during an INPL session. For further details, see the source of INPLSX01 in the Natural system library SYSLIB.