Software AG Editor

Each object in Predict has attributes which can be modified with the Software AG Editor. In addition, many Predict functions produce output which can be processed by the Software AG Editor. The functions of the Software AG Editor are described in detail in the Natural Editors documentation.

This document covers the following topics:

Where to Find More Information:

Installing the Software AG Editor is described in the Natural Installation documentation. The Natural Utilities documentation provides information on the editor buffer pool services utility SYSEDT.


General Information

Functional Scope

Editing Attributes

The Software AG Editor can be used to edit the following attributes of Predict objects:

  • Extended descriptions and extended description skeletons

  • Derived field expressions/subquery clauses of SQL views

  • Rules of a verification

  • Extract link list, see the section Extract in the Predefined Object Types in Predict documentation.

Editing Output from Predict Functions

Software AG Editor is called as standard for further processing of output from the following functional areas:

  • Retrieval

  • Active Retrieval

  • File Implementation: Display implementation plan

  • Function Display for file, database, dataspace and storagespace administration

  • Online help

The Software AG Editor is called even if the Natural Editor is defined as first choice in the Profile > Handling screen.

Note:
With the parameter Defaults > General Defaults > Miscellaneous > Use Software AG Editor for output it is possible for your administrator to deactivate the Software AG Editor for the above functions. If this parameter is set to N, retrieval output appears as in Predict version 3.2. See the section Defaults in the Predict Administration documentation.

Prerequisites

The Software AG Editor is available as standard in the Natural version required for Predict: No additional prerequisites need to be met.

Software AG Editor Profiles

To a certain extent the functions of the Software AG Editor can be adapted using the parameters of the editor profile. All available options are described in the Software AG Editor documentation.

The following rules apply when using the Software AG Editor in Predict:

  • Enter command SET to define an editor profile.

    • If the user does not have his/her own profile, the SYSTEM profile is displayed. This can be modified as required and saved under a new name.

    • If the user has already defined a profile with his/her ID, this is displayed for modification instead of the SYSTEM profile.

    • If another user-defined profile is active, this is displayed for modification.

  • The SYSTEM profile can be modified by any user.

  • Different profiles can be stored under different names. If a user ID is used as a profile name, the profile can only be modified by this user.

  • Editor profiles are activated with the command USE profile_name.

Software AG Editor Screen

The Software AG Editor screen as used in Predict is divided into four parts:

Header Lines

This area provides the following information:

  • ID of current object

  • type of attribute being edited, for example Extended Description

  • date and time.

Line Command Area

This area contains line numbers. It is used for entering line commands and can also contain information pertaining to the current line. Line commands are described in detail in the Software AG Editor Reference documentation.

Data Area

This area contains the text of the attribute.

Footer Lines

This area is used for entering main commands, and indicates the active PF keys and the active SCROLL value. Main commands are described in detail in the Software AG Editor Reference documentation.

Long Lines

The Software AG Editor enables you to edit and save lines of up to 250 characters. Lines exceeding 72 characters are marked =long.

Common Functions of the Software AG Editor

Standard Commands

For a detailed description of main and line commands, refer to the Software AG Editor Reference documentation.

Main Standard Commands

Main commands are issued from the command line. All Software AG Editor commands are available in Predict except the deactivated  main commands.

Line Commands

You can enter a line command on any data line by typing over the prefix information on the left of your edit screen. You can also enter a line command in the first column of the object itself if you precede it with the Editor escape character. The escape character is generally a period (.) or comma (,). A line command always applies to the line in which you enter it (or to a block of lines marked by multiple line commands).

Line commands can also be entered in command line at the top of the Editor screen. In this case, the command must be preceded by a colon (:) and applies to the line marked by the cursor.

Additional Editor Functionality in Predict

The following commands have been implemented in the Software AG Editor especially for use in Predict.

Main Commands

NUM[BER] Activate line numbering.
NUM[BER] OFF Deactivate line numbering.
SET Define an editor profile. See Software AG Editor Profiles.
USE Activate an editor profile. See Software AG Editor Profiles.
KEYS Define PF keys. A window appears for defining PF keys and descriptive text. Different PF key definition settings can be stored under different names. If a user ID is used as a name, the PF key definition can only be changed by that user.

Deactivated Main Commands

The following Software AG Editor commands have been deactivated because the corresponding functions are not applicable in Predict.

COPY, CREATE, CREATEALL, ENTER, FILE, MSO, NEXT, NEXTFILE, PREV, PREVFILE, PUTATTR, QUEUE, REPLACE, SEQUENCE, SORT, SUBMIT, TYPE, UNREN.

Troubleshooting

This section lists messages that may appear concerning the Software AG Editor buffer pool. Related messages are grouped together, and corrective action is suggested.

Installation Errors

Message Explanation/Action
SSIZE too small Modify your Natural parameter module using SSIZE=64.
This message is only applicable to mainframe environments.
Checkpoint file not active
-caution- profile changed to "recovery off" (from "recovery on") because checkpoint file not active (in Editor session)
The Editor workfile was not formatted correctly, no space was reserved for the checkpoint file. Check your job that allocates the workfile.
Failure in open Buffers The allocation of the Editor area failed or was not sufficient (SSIZE buffer). Check the SSIZE parameter. If the parameter has a value of at least 64, you can either increase the MSIZE parameter, or decrease the size value of other buffers you do not need, for example CSIZE, FSIZE or TSIZE (see the Natural Parameter Reference documentation).
BP not active The buffer pool was not initialized correctly. See the section Installing the Software AG Editor in the Natural Installation documentation.

Editor Workfile and Timeout Parameters

Message Explanation/Action
Checkpoint of file failed

Mainframe: These messages indicate that the Editor workfile is too small or the timeout parameters are too large, causing data to be kept in the buffer pool too long. You must increase the workfile size or decrease the timeout parameters.

Open Systems: FINish your current Natural session.
Change the number of buffer pool blocks by increasing the value for EDTBPSIZE in your Natural parameter module. The next Natural session you start with uses the increased number of buffer pool blocks.

No space for data block
No space for index block
Cannot allocate BP file
-caution- profile changed to "recovery off" (from "recovery on") because checkpoint file is full (in Editor session)
-caution- profile changed to "log off" (from "log on") because log file is full (undo command not active) (in Editor session)
Cannot allocate BP block
Cannot allocate checkpoint block
Suspending of a session failed
Activation of a session failed The session has been deleted due to a buffer pool timeout. Restart the session.

Internal Software AG Editor Problems

The following messages are not usually displayed. They appear in the rare case of some internal problem.

Message Explanation/Action
Some data may be ignored Contact your Software AG support representative.
Session does not exist
Cannot free BP block
Log error

I/O Problems on Editor Workfile or Volume

Message Explanation/Action
I/O ERROR Check the workfile. If the error persists, reallocate the file on another volume.
Cannot read index block
Write to BP failed
Read from BP failed
Read failed
Error reading log block
Cannot read checkpoint block
Cannot write checkpoint block
Recovery of file failed

Other Inconsistencies

Message Explanation/Action
Error in getting lines The Natural source area is corrupted, for example if the Predict editor session is aborted by %% and the source area was modified.
Getting text failed The Editor message table is inconsistent.