The Software AG Editor is an optional Natural component that is required by several Natural utilities (for example, SYSRPC and SYSBPM), Natural add-on products (for example, Natural ISPF) and other Software AG products (for example, Predict).

When using SMA, the Software AG editor is automatically installed when installing Natural. If you are not using SMA, install the Software AG editor according to the procedure described in this document.

This document describes the steps for installing the Software AG Editor on BS2000/OSD.

• Prerequisites

• Installation Procedure

• Installation Verification

Related Topics:

• For operational information, see Operating the Software AG Editor in the Operations documentation.

• For information on the features and functions of the Software AG Editor, see the relevant section in the Editors documentation.

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).

---

Prerequisites

See General Prerequisites and System Support in the section Overview of the Installation Process.

Installation Procedure

Be sure to read Installation Process and Major Natural Features before you start the installation procedure.

• Step 1: Adapt the Natural Parameter Macro NTEDBP

• Step 2: Build the Natural Parameter Module

• Step 3: Allocate and Format the Editor Work File E.FRM.EDITWORK

• Step 4: Modify the Startup Procedures for the Nucleus

• Step 5: Start the Global Editor Buffer Pool

• Step 6: Link the Software AG Editor to the Nucleus

Step 1: Adapt the Natural Parameter Macro NTEDBP

The editor buffer pool parameters contained in Natural parameter module are stored in the editor buffer pool work-file control record during formatting (see Step 3: Allocate and Format the Editor Work File E.FRM.EDITWORK). The Natural parameter module can be linked to the Software AG Editor work file formatting utility (described in Editor Work File in the Operations documentation).

Caution:
Before adapting the editor parameter macro, first read the documentation of the editor buffer pool parameter EDBP and its corresponding macro NTEDBP in the Parameter Reference documentation.

• Assemble and link the Natural parameter module.

For the Initial Installation:

You can leave the defaults. In this case, it is not necessary to assemble and link the Natural parameter module.

Step 2: Build the Natural Parameter Module

(Jobs I060, I080)

1. Add the following parameter to your Natural parameter module to specify the size of the editor area:

   SSIZE=nn

   where nn must be set to at least 54.

2. Add the following macro to your Natural parameter module to specify the size of the editor buffer pool:

   NTBPI TYPE=EDIT

   The region size must be defined large enough to be able to allocate the buffer pool. For a detailed description of the NTBPI macro, refer to Building a Natural Parameter Module in the Operations documentation.

3. Assemble and link the Natural parameter module.

Step 3: Allocate and Format the Editor Work File E.FRM.EDITWORK

(Job I081, Step 1900)

1. Allocate the editor work file (see also Editor Work File in the Operations documentation) by issuing the command:

   /FILE file-name,LINK=CMEDIT,SPACE=...

2. Execute the Software AG editor work file formatting utility (NATEDFM2, NATvrs.MOD) by entering FORMAT to format and load the control record in the editor work file.

Step 4: Modify the Startup Procedures for the Nucleus

For TIAM and openUTM:

• Add a FILE command for the editor work file:

  /FILE file-name,LINK=CMEDIT

Step 5: Start the Global Editor Buffer Pool

(Job I061, Step 0001)

Once defined, a global editor buffer pool must be started.

• To start the global editor buffer pool, execute the module CMPSTART.

Step 6: Link the Software AG Editor to the Nucleus

(Job I080)

• Link the following Software AG Editor modules to either the environment-independent or the environment-dependent nucleus by using the corresponding INCLUDE statements:

  INCLUDE NATLIB(NATEDT)	Software AG Editor module
  INCLUDE NATLIB(NATEDWA2)	Software AG Editor work file access module

Installation Verification

You can verify the successful installation of the Software AG Editor by performing the following:

• Invoke Natural and enter the following system command:

  SYSEDT

  The SYSEDT Utility Main Menu appears, which can be used to display all buffer pool parameters and usage statistics; see SYSEDT Utility - Editor Buffer Pool Administration in the Utilities documentation.

You can only test the full operation of the Software AG Editor if another Software AG product (for example, Natural ISPF or Predict) that uses Software AG Editor functionality is installed.