CATALL

#### Search Results

Search

# CATALL

`CATALL` | object-name [`TO` object-name] `{XSET / XREFSET} set-number` `[SETUSER set-user]` | `RECAT` `ALL` | [`TYPES` types] | `SAVE` `CATALOG` `STOW` `CHECK` | [options ...]
| text-name |  |  |  |

This command is used to catalog (compile) and store single or multiple Natural objects in the current Natural library.

When you enter the `CATALL` command without any additional options, the Catalog Objects in Library screen is displayed, which you use to perform the functions described below. You can also issue the `CATALL` command directly using the command syntax shown above.

`CATALL` processes all objects in the order in which the object types are listed on the Catalog Objects in Library screen (see also the information for `TYPES` in the section Direct Command Syntax).

You can also select functions on the Catalog Objects in Library screen by default using the subprogram `CATALLU2`. In addition you may enable `CATALLU2` to be called in batch or command mode. The subprogram is delivered as a source object in library `SYSTEM` (`FNAT`). To activate the subprogram, modify it as described in its source, then catalog it and copy it to `SYSLIB`. The subprogram is called before the Catalog Objects in Library screen is output.

See also Object Naming Conventions in the Using Natural documentation.

This document covers the following topics:

- Catalog Objects from/to

- Predict Set and Set User

- Select Cataloged Source Objects Only, or Select All Source Objects

- Select Object Types

- Select Function

- Select Options

- Selection List

- Direct Command Syntax

## Catalog Objects from/to

If you wish `CATALL` to be performed for all objects of the selected types in the current library, specify an asterisk (*) as object name in the from field.

If you wish `CATALL` to be performed for a certain range of objects, you can use asterisk notation (*) and wildcard notation (?) for the name in the from field, as described for the system command `LIST`.

You can also specify a start setting and an end setting for a certain range of objects by entering corresponding object names (without asterisk or wildcard notation) in the from and to fields.

Instead of entering settings in these fields, you can also select objects from a selection list.

Moreover, you can use the from field to enter the name of an object of type text which contains a list of `CATALL` commands. The `CATALL` commands contained in the text will then be executed. You can either create such a text manually or have it created automatically when you use the selection list.

## Predict Set and Set User

If you wish `CATALL` to be performed for the objects of a Predict set, specify in Predict Set a one- or two-digit number that identifies the retained set to be used for the names of the objects to be processed. `CATALL` processes all objects in the order in which they are listed in the Predict set.

If you use a Predict set, the from field and the to field must not be used. Additionally, you can specify in Set User the ID of the user who created the Predict set. If no ID is specified, the value of the system variable `*USER` is used.

A retained set is created with the save set option of the `LIST XREF` command.

Note
Predict has to be installed. For detailed information on Predict sets, refer to the Predict documentation.

## Select Cataloged Source Objects Only, or Select All Source Objects

The following applies:

- If you mark Select cataloged source objects only, only the source objects in the current library that have already been cataloged earlier (a corresponding cataloged object exists) are cataloged.

- If you mark Select all source objects, all source objects (with or without corresponding cataloged objects) in the current library are cataloged.

## Select Object Types

By default, `CATALL` applies to objects of all types in the current library (all object types are marked with X).

If you wish objects of a certain type not to be processed by `CATALL`, overwrite the respective X with a blank.

## Select Function

You can select one of the following functions to be applied to the selected objects: `SAVE`, `CATALOG`, `STOW` or `CHECK`. The functions correspond to the system commands of the same names.

Note
Objects of type copycode and text will be saved, even if you select Stow. They will not be saved, if you select Catalog.

## Select Options

You can select one or more of the following options for `CATALL` processing:

Condition Code in Batch | If you execute `CATALL` in batch mode and mark this option with a character, Condition Code 55 will be returned either if a syntax error is detected during `CATALL` execution or if no objects are found within the specified range of objects to be processed (applies to `CATALOG` and `STOW` only).
Renumber Source-Code Lines | By default, the source-code lines of sources that were saved or stowed are also renumbered. If you wish no automatic renumbering of lines, overwrite the X in this field with a blank.
Keep Result List | `CATALL` generates a result list. If you wish to keep this list for further use, mark this field with a character. The library `SYSEXT` contains the application programming interface `USR1024N`, which you can use to output the result list. You can also re-display the result list with another `CATALL` command. Since the parameters are also stored in the result list, the parameters of the `CATALL` which created the result list are valid. In batch, if a library contains a result list, it is displayed automatically with a `CATALL` command. In this case, the batch `CATALL` job will issue a message and because no objects will be cataloged the job will end with Condition Code 56. Online, if a library contains a result list, you will be asked whether to display the previous result list or start a new `CATALL` run.
Processing Information | During online processing, `CATALL` shows a scrolling display of processing status information. During batch processing, `CATALL` only outputs the objects which caused an error. To suppress this display, overwrite the X in this field with a blank.
Error Report | At the end of processing, `CATALL` displays a list of the errors that occurred. To suppress this error list, overwrite the X in this field with a blank.
Extended Error Report | The error report will be output in extended form, with directory information, error line and error message. To output the Extended Error Report, mark this field with an X.
PF4 AddOp | Pressing PF4 causes a window to appear in which you can select or enter additional options. Report Text Object: Enter the name of a Natural text object. An error report of a `CATALL` run will be written to this text object.

## Selection List

If you wish to use `CATALL` only for certain objects, you can select these objects from a selection list.

To do so, first make the desired specifications under Select Function and Select Options, and then press PF5. A list of the objects stored in the current library is displayed.

The list corresponds to that of the system command `LIST`. Scrolling the selection list and the specification of new selection criteria on the list is also done in the same way as with the `LIST` command.

On the list, select the desired objects by marking them with a character in the column Cmd. To simultaneously select all objects of the current selection list, press PF5. You can then scroll the list, specify other selection criteria, and select further objects.

When you have selected all objects you wish to process, press PF3.

A window is displayed which allows you to store the selected set of objects so that you can re-use it in other `CATALL` processing:

- If you enter a name in the window, the selected set of objects will automatically be stored (in the form of `CATALL` commands) in an object of type text of that name. You can later use that text name in the field Catalog Objects from of the Catalog Objects in Library screen.

- If this is not desired, press ENTER without entering anything in the window.

`CATALL` will then begin to process the selected objects.

## Direct Command Syntax

For the various specifications you can make on the Catalog Objects in Library screen, there are also corresponding options which you can specify directly with the system command `CATALL`:

`object-name TO object-name` | Corresponds to the fields Catalog Objects from and to of the Catalog Objects in Library screen, see Catalog Objects from/to.
`{XSET / XREFSET} set-number` | Corresponds to the field Predict Set of the Catalog Objects in Library screen, see Predict Set and Set User.
`[SETUSER set-user]` | Corresponds to the field Set user of the Catalog Objects in Library screen, see Predict Set and Set User.
`RECAT / ALL` | Corresponds to the options Select cataloged source objects only (`RECAT`) and Select all source objects (`ALL`) of the Catalog Objects in Library screen. `RECAT` is the default. See also Select Cataloged Source Objects Only, or Select All Source Objects.
`TYPES types` | Corresponds to the object types listed on the Catalog Objects in Library screen. Possible types (processed in the order below) are:
G | Global data areas
L | Local data areas
A | Parameter data areas
C | Copycodes
T | Texts
7 | Functions
N | Subprograms
S | External subroutines
H | Helproutines
M | Maps
8 | Adapters
P | Programs
4 | Classes
* | All types (this is the default)
The types have to be specified as one character string, for example, `LAG` for local, parameter and global data areas. By default, `CATALL` applies to objects of all types in the current library.
`SAVE / CATALOG / STOW / CHECK` | Corresponds to the actions of the same names on the Catalog Objects in Library screen, see Select Function. `CATALOG` is the default.
`options` |
These options correspond to Select Options on the Catalog Objects in Library screen, see Select Options. Possible options are:
CC | Condition Code will be returned.
NOREN | No automatic renumbering of source-code lines.
KEEP | Result list will be kept.
NOSCROLL | Online: scrolling display of processing status information will be suppressed. Batch: output of only those objects, which caused an error.
NOREPORT | Error report will be suppressed.
FULL | Error report will be extended.
EL text-object [R]
EL text-object | Output error list to a Natural text object.
R | If an object already exits, the `EL` parameter is disabled, unless `R` (replace) is specified behind text-object.
Note If you specify `NOREPORT` and `NOSCROLL`, `KEEP` will automatically apply, too.
`text-name` | Corresponds to specifying a text name in the Catalog Objects from field of the Catalog Objects in Library screen, see Catalog Objects from/to.

Examples:

To stow only source objects for which a cataloged object already exist

- Enter the following command:

      CATALL * STOW KEEP CC NOREN

  The above command is with implicit `RECAT` and has the same effect as the following command.

      CATALL * RECAT STOW KEEP CC NOREN

To stow all objects

- Enter the following command:

      CATALL * ALL STOW KEEP CC NOREN

Note
The individual command components must be separated from one another either by a blank or by the input delimiter character (as defined with the session parameter `ID`).

### On this page

- Catalog Objects from/to
- Predict Set and Set User
- Select Cataloged Source Objects Only, or Select All Source Objects
- Select Object Types
- Select Function
- Select Options
- Selection List
- Direct Command Syntax