XREF - Creation of XRef Data for Natural

#### Search Results

Search

# XREF - Creation of XRef Data for Natural

This Natural profile and session parameter is used to enable/disable the creation of XRef data for Natural. This parameter also determines how XRef data are treated when Natural members are processed with the Natural utilities `SYSMAIN` or `INPL` or with the Object Handler.

Possible settings | `ON` | XRef data are generated in the cases described above. Documentation premise is not checked.
`OFF` | XRef data are not generated. Documentation premise is not checked.
`FORCE` | A Natural object can only be cataloged if a documentation object already exists for this implementation object. XRef data are generated in the cases described above.
`DOC` | A Natural object can only be cataloged if a documentation object already exists for this object. XRef data are not generated.
Default setting | `OFF` |
Dynamic specification | yes |
Specification within session | yes |
Applicable statements | none |
Applicable commands | `GLOBALS`, `XREF` |

The following topics are covered below:

- Possibilities of Setting the XREF Parameter

- XRef Data Generation

- Extended XRef Data Generation (For Internal Use Only)

## Possibilities of Setting the XREF Parameter

There are different ways to set the Natural `XREF` parameter:

- In the Natural parameter file.

- As a dynamic parameter when starting a Natural session.

- In Natural Security. If Natural Security has been used to set the `XREF` parameter, the `XREF` command may only be used to enforce this setting (by changing from `ON` to `FORCE`, from `OFF` to `ON` or `FORCE`).

- With the Natural `XREF` command. If Natural Security is not installed, the `XREF` parameter is usually set with the Natural `XREF` command. The Natural command `XREF ?` displays the current setting of the `XREF` parameter.

## XRef Data Generation

XRef data is generated in two cases:

- The Natural compiler writes XRef data for Natural programs and data areas when these are cataloged (provided that the `XREF` parameter has been set to either `ON` or `FORCE`, see below).

- Natural Security writes XRef data for programs that are used as Startup, Restart or Error-Transaction in an application or as a special link if the `XREF` parameter is set to `ON` or `FORCE` in the application's Natural Security definition and a user system file is defined for the application.

The `XREF` parameter controls the compilation in two aspects:

- generation of XRef data in the cases described above and

- fulfilment of premise to document implementation objects. The adherence to this premise can be ensured by allowing the completion of the catalog operation only for objects that are documented in the Predict `FDIC` system file or in the development server file used in Natural Single Point of Development (SPoD).

Note
In a NaturalONE development environment, XRef data is only generated for libraries in shared mode. If there is an existing private mode library with XRef data, it is recommended that you recatalog the library to avoid redundant XRef data.

## Extended XRef Data Generation (For Internal Use Only)

The extended `XREF` parameter is reserved for internal use by Natural.

### On this page

- Possibilities of Setting the XREF Parameter
- XRef Data Generation
- Extended XRef Data Generation (For Internal Use Only)