Installing Natural SQL Gateway on z/OS

This document describes the steps for installing the Natural SQL Gateway (product code NSB) on z/OS.

Related Topic:

For information on how to operate the Natural SQL Gateway, see Natural SQL Gateway in the Database Management System Interfaces 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

The following software must be installed before you can install the Natural SQL Gateway:

  • Software AG Editor

  • ConnecX SQL Engine (CXX)

    (included in the Natural SQL Gateway delivery)

    For information, refer to the installation documentation of the ConnecX SQL Engine.

    Note:
    Ensure that you have selected the Adabas precompiler component during installation.

  • A Natural SQL Adapter for each SQL database system that you want to access through the Natural SQL Gateway

  • If you install the Natural SQL Gateway Software without Natural for DB2, nevertheless, set NDB to status INSTALLED by using System Maintenance Aid (SMA), and set the SMA parameter NSB-ONLY to Y (Yes).

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

Special Considerations for DB2 Systems

The registry entry USECONNXSCHEMAFORNATIVE of the ConnecX SQL Engine has to be set to 1 in order to perform CREATE TABLE statements so that the table name qualifier on the target DB2 system is the same as the table name qualifier in the CDD and as specified in the CREATE TABLE statement.

On Windows systems, this can be done by using the Configuration Manager of the ConnecX SQL Engine.

On UNIX systems, this is accomplished by the following command SQLREGISTRY 5 CONNX.USECONNXSCHEMAFORNATIVE 0 1. The result of the above command can be verified by the following command SQLREGISTRY 1.

Installation Medium

The installation medium contains the following data set required for product installation:

Data Set Name Contents
NSBvrs.LOAD Load modules
NSBvrs.OBJS Object modules
NSBvrs.JOBS Sample installation jobs

The installation medium for the Natural SQL Gateway also contains the following Natural for DB2 data sets:

Data Set Name Contents
NDBvrs.LOAD Load modules
NDBvrs.SRCE Source modules and macros
NDBvrs.INPL Natural objects
NDBvrs.ERRN Natural error messages

Copy the data sets into your environment as described in Copying Data Sets to a z/OS Disk in the section Installing Natural.

If you have already installed the latest Natural for DB2 version, you need not copy the Natural for DB2 data sets from the medium again.

Installation Procedure

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

The installation procedure comprises the following:

Common Installation Steps

This section described the installation steps that apply to all environments where the Natural SQL Gateway can be installed. The steps additionally required for a particular TP monitor are described in the following sections.

The installation procedure comprises the following:

Step 1: Link-Edit NATGWDB2

(Job I055, Step 1680)

  • Link-edit the Natural SQL Gateway load module NATGWDB2.

Step 2: Build the Natural Parameter Module

(Job I060, Steps 0010, 0015)

Build the Natural parameter module for batch mode. The macros and parameters mentioned in this section are described in the Parameter Reference documentation.

  1. Modify the settings in the Natural parameter module if required:

    • Set the parameters supplied with the NTOSP macro to configure the z/OS batch interface. For descriptions of these parameters, see the corresponding dynamic profile parameter OSP.

    • Set the parameters specific to the Natural SQL Gateway supplied with the NTDB2 macro. For descriptions of these parameters, see the corresponding dynamic profile parameter DB2.

    See also Natural Parameter Modifications for Natural SQL Gateway.

  2. Assemble and link the Natural parameter module.

Step 3: Link the Nucleus

(Jobs I060, Steps 0020, 0105)

  1. Link the environment-dependent nucleus (Step 0020).

    Add the following INCLUDE statements and corresponding DD statements to the link instructions for the linkage editor: 

     INCLUDE SMALIB(nat-parm-module)
    		 Natural parameter module, where nat-parm-module is the module name used in Step 2: Build the Natural Parameter Module. 
     INCLUDE NDBLIB(NDBPARM)
    		 Natural SQL Gateway load module contained on the NDBvrs.LOAD data set. 
     INCLUDE NSBLIB(NSBCNXTB)
    		 Entry point table for the CXX interface 
     INCLUDE xxxxxxxx(yyyyyyyy)
    		 Environment-dependent CXX interface (see below)

    Depending on your environment, specify the appropriate CXX interface yyyyyyyy from library xxxxxxxx in your INCLUDE statement as shown in the following table:

    Interface Library Environment Function
    API3GL RCIOLIB

    RCIOLIB is the RCI.OBJ library from the installation of the ConnecX SQL Engine

    		TSO and z/OS batch ConnecX client
    CXXCLNT RCIOLIB CICS and Com-plete Natural SQL Gateway client

  2. Link the environment-independent nucleus (Step 0105):

    Add the following INCLUDE statement and corresponding DD statement to the link instructions for the Natural SQL Gateway load module: 

     INCLUDE SMALIB(NATGWDB2)

Alternatives

Instead of linking the nucleus in the way described above, you can use one of the following methods:

  1. Create an environment-dependent nucleus without environment-independent nucleus:

    Link all environment-dependent parts to the environment-independent parts, thus creating one environment-dependent nucleus.

  2. Separate the NATGWDB2 module (not linked to the nucleus):

    Remove the Natural SQL Gateway load module NATGWDB2 from the environment-independent nucleus and run it as a separate module by using the Natural Resolve CSTATIC Addresses feature (RCA).

    You can modify the name of the NATGWDB2 module linked in Step 1. However, if you use a name different from NATGWDB2, this name must be specified as an alias name in the NTALIAS macro (see the Parameter Reference documentation) in the Natural parameter module.

  3. Separate the Natural parameter module:

    Move all environment-dependent Natural parts (Natural parameter module) and Natural SQL Gateway parts (CXX interface, NSBCNXTB and NDBPARM) into a separate Natural parameter module with the mandatory name CMPRMTB.

    This Natural parameter module has a separate link and must be loaded by specifying its name in the profile parameter PARM (described in the Parameter Reference documentation).

The following applies when linking a separate NATGWDB2 module (Alternative 2 above) or a separate Natural parameter module (Alternative 3 above):

TP Monitor Requirement
CICS The resulting module must be defined as PPT entry or RDO.

PPT entry: 

DFHPPT TYPE=ENTRY,PROGRAM=module-name,PGMLANG=ASSEMBLER
Com-plete The resulting module must be defined as RESIDENTPAGE or reside in the LPA/(E)LPA.

Step 4: Load the Natural Objects

(Job I061, Step 1610)

Before executing this step, change the CMWKF01 DD statement to point to the NDBvrs.INPL data set.

  • Load the Natural objects specific to the Natural SQL Gateway from the NDBvrs.INPL data set into the Natural system file by using the Natural INPL utility. The Natural objects are loaded into the Natural system libraries SYSDDM, SYSTEM and SYSDB2 in the FNAT system file.

    Important:
    Ensure that your newly created SYSDB2 library contains all necessary Predict interface programs, which are loaded into SYSDB2 when installing Predict (see the relevant Predict documentation).

Step 5: Load the Natural Error Messages

(Job I061, Step 1620)

Before executing this step, change the CMWKF02 DD statement to point to the NDBvrs.ERRN data set.

  • Load the Natural error messages specific to the Natural SQL Gateway from the NDBvrs.ERRN data set by executing the Natural batch job that runs the ERRLODUS load program of the Natural SYSERR utility (see the Utilities documentation).

    ERRLODUS loads the error messages into the Natural system library SYSERR in the FNAT system file.

Installation Steps Specific to CICS

This section describes the additional steps required to install the Natural SQL Gateway in a CICS environment:

Step 1: Configure the TCP/IP Environment

  • Configure the CICS TCP/IP environment as described in the IP CICS Socket Guide by IBM.

    This is required since the Natural SQL Gateway uses TCP/IP communication in a CICS environment.

Step 2: Add the File Definition for the Natural File Server with VSAM

(Job I005, Steps 2213, 2232)

This step only applies if you want to use a VSAM file for the Natural file server.

  • Add the file definition for the Natural file server to CICS: 

    DEFINE FILE(CMFSERV)                                                   *
         DSNAME(data-set-name)                                         *
         GROUP(SAGGRP)                                                 *
         DESC(NATURAL FILE SERVER)                                     *
         DISP(SHARE)                                                   *
         ADD(YES) UPDATE(YES) DELETE(YES)                              *
         STATUS(ENABLED) OPENTIME(FIRSTREF)                            *
         RECORDFORMAT(F)                                               *
         LSRPOOLID(NONE)                                               *
         JO(NO) DATAB(4) INDEXB(3)                                     *
         STR(3)

    where data-set-name is the name of the Natural file server under CICS (the default name is SAGLIB.NCIDB2.SERVER).

Step 3: Define the VSAM Data Set for the Natural File Server

(Job I008, Step 1610)

This step only applies if you want to use a VSAM file for the Natural file server.

  • Specify the size and the name of the VSAM RRDS that is to be used as the Natural file server (see also Preparations for Using the File Server in the Database Management System Interfaces documentation).

Step 4: Specify the Natural SQL Server TCP/IP Address and Port

  • Modify the macro NTDB2 (described in the Parameter Reference documentation) in the Natural parameter module:

    Specify the keyword subparameter NSBHOST to denote the TCP/IP address, and the keyword subparameter NSBPORT to denote the port number of the Natural SQL Gateway server.

Step 5: Format the VSAM Data Set for the Natural File Server

(Job I075, Step 1610)

This step only applies if you want to use a VSAM file for the Natural file server.

  • Specify the five input parameters required to format the Natural file server data set (see also Natural File Server in the Database Management System Interfaces documentation).

Step 6: Build the Natural Parameter Module

(Job I080, Steps 2210, 2220)

  1. Adapt the parameters specific to the Natural SQL Gateway supplied with the NTDB2 macro in the Natural parameter module to meet your requirements. For descriptions of these parameters, see the corresponding dynamic profile parameter DB2 described in the Parameter Reference documentation.

    See also Natural Parameter Modifications for Natural SQL Gateway.

  2. Assemble and link the Natural parameter module for CICS.

Step 7: Link the Nucleus

(Job I080, Step 2230)

Adapt the link steps for the environment-dependent nucleus.

  • In addition to the INCLUDE statements added in Step 3 (Common Installation Steps), add the following INCLUDE statements and corresponding DD statements to the link of the environment-dependent nucleus: 

     INCLUDE NATLIB(NAT2LE)
    		 Natural interface for the IBM Language Environment (LE)

    NATLIB is the Natural load library from the installation of base Natural. 

     INCLUDE NCIOLIB(NCI2TCP)
    		 Natural TCP/IP interface for CICS

    NCIOLIB is the Natural CICS Interface object library from the installation of the Natural CICS Interface. 

     INCLUDE TCPLIB(EZACIC17)
    		 CICS socket module

    TCPLIB is the CICS TCP/IP socket library from IBM (usually hilev.SEZARNT1, hilev.SEZATCP or hilev.SEZACMTX where hilev is a valid high level qualifier).

Installation Steps Specific to Com-plete

This section describes the additional steps required to install the Natural SQL Gateway in a Com-plete environment:

Step 1: Enable TCP/IP Support

  • Add the load library for the Natural Com-plete/SMARTS Interface to the COMPLIB concatenation for the Com-plete startup (see the relevant section in the Com-plete Installation documentation). This library contains the NCFTCP82 interface program required for TCP/IP support.

Step 2: Specify the Natural SQL Server TCP/IP Address and Port

  • Modify the macro NTDB2 (described in the Parameter Reference documentation) in the Natural parameter module:

    Specify the keyword subparameter NSBHOST to denote the TCP/IP address, and the keyword subparameter NSBPORT to denote the port number of the Natural SQL Gateway server.

Step 3: Build the Natural Parameter Module

(Job I080, Steps 2300, 2310)

  1. Adapt the parameters specific to the Natural SQL Gateway supplied with the NTDB2 macro in the Natural parameter module to meet your requirements. For descriptions of these parameters, see the corresponding dynamic profile parameter DB2 described in the Parameter Reference documentation.

    See also Natural Parameter Modifications for Natural SQL Gateway.

  2. Assemble and link the Natural parameter module for Com-plete.

Step 4: Link the Nucleus

(Job I080, Step 2320)

Adapt the link steps for the environment-dependent nucleus.

  • In addition to the INCLUDE statements in Step 3 (Common Installation Steps), add the following INCLUDE statement and corresponding DD statement to the link of the environment-dependent nucleus: 

     INCLUDE NATLIB(NAT2LE)
    		 Natural interface for the IBM Language Environment (LE)

    NATLIB is the Natural load library from the installation of base Natural.

    Ensure that the TCP/IP interface program NCFTCP82 delivered with the Natural Com-plete/SMARTS Interface is defined as a resident program and that the library containing NCFTCP82 resides in the COMPLIB chain of the Com-plete library.

Installation Steps Specific to TSO

This section describes the additional steps required to install the Natural SQL Gateway in a TSO environment:

Step 1: Define the VSAM Data Set for the Natural File Server

(Job I008, Step 1620)

This step only applies if you want to use a VSAM file for the Natural file server.

  • Specify the size and the name of the VSAM RRDS that is to be used as the Natural file server (see also Preparations for Using the File Server in the Database Management System Interfaces documentation).

Step 2: Adapt Natural for the TSO CLIST

(Job I070, Step 2400)

  • Change the library and program names in the CLIST according to your site requirements. If you do not use the Natural file server, remove the ALLOC and FREE statements for CMFSERV.

Step 3: Format the VSAM Data Set for the Natural File Server

(Job I075, Step 1620)

This step only applies if you want to use a VSAM file for the Natural file server.

  • Specify the five input parameters required to format the Natural file server data set (see also Preparations for Using the File Server in the Database Management System Interfaces documentation).

Step 4: Build the Natural Parameter Module

(Job I080, Steps 0010, 0015)

Build the Natural parameter module for TSO. The macros and parameters mentioned in this section are described in the Parameter Reference documentation.

  1. Modify the settings of the parameters in the Natural parameter module as required:

    • Set the parameters supplied with the NTTSOP macro to configure TSO. For descriptions of these parameters, see the corresponding dynamic profile parameter TSOP.

    • Set the parameters specific to the Natural SQL Gateway supplied with the NTDB2 macro. For descriptions of these parameters, see the corresponding dynamic profile parameter DB2.

    See also Natural Parameter Modifications for Natural SQL Gateway.

  2. This step only applies if you want to use a VSAM file for the Natural file server:

    Set the keyword subparameter NDBFSRV in the macro NTTSOP to ON.

  3. Assemble and link the Natural parameter module for TSO.

Step 5: Link the Nucleus

(Job I080, Step 0020)

Link the nucleus as described in Step 3 of the Common Installation Steps.

Installation Verification

This section provides sample batch jobs and online methods for verifying the successful installation of the Natural SQL Gateway.

Test the Natural SQL Gateway in Batch Mode - Job NSBBATCA

NSBBATCA contains sample JCL to test the Natural SQL Gateway in batch mode. Modify the sample JCL according to your site requirements.

Before the first SQL call, you must call NSBDCON to explicitly connect to the ConnecX SQL Engine JDBC server. NSBDCON can be edited to specify the appropriate host name, port number and CDD registry name.

Connect to the JDBC Server

Invoke Natural with the appropriate setting of the Natural profile parameter DB2SIZE (see the Parameter Reference documentation).

Ensure that SQL tables can be accessed. Before the first SQL call, you must connect to the ConnecX SQL Engine JDBC server: use a PROCESS SQL statement to specify the required host name, port number, CDD file, user ID and password.

Invoke Natural with TSO CLIST

You can test the TSO installation of the Natural SQL Gateway by performing the following:

Invoke Natural by executing the CLIST adapted in Step 2: Adapt Natural for the TSO CLIST. Ensure that the SQL tables can be accessed. Before the first SQL call, you must connect to the ConnecX SQL Engine JDBC server: use a PROCESS SQL statement (described in the Statements documentation) to specify the desired host name, port number, CDD file, user ID and password.

Online Verification Methods

You can verify the successful installation of the Natural SQL Gateway online by using either SQL Services or Natural SQL Gateway example programs:

Using SQL Services

You can verify the successful installation of the Natural SQL Gateway by using the SQL Services (NSB) function (described in the Database Management System Interfaces documentation) of the Natural SYSDDM utility:

  1. Invoke Natural.

  2. Invoke the SYSDDM utility.

  3. In the SYSDDM main menu, enter function code Z to invoke the SQL Services (NSB) function.

    • If you are connected to a ConnecX SQL Engine JDBC server, the SQL Services: Menu screen appears.

    • If you are not connected to a ConnecX SQL Engine JDBC server, the SQL Services: CXX Connection screen appears where you have to provide connection and security credentials such as GATEWAY, DD, PORT, User and Password.

      If the credentials are accepted, press PF5 to establish the connection. Press PF3 after the connection has been established. The SQL Services: Menu screen appears.

  4. On the SQL Services: Menu screen, enter function code S to select an SQL table from a list of tables.

    The communication between Natural and the ConnecX SQL Engine JDBC server works if all existing SQL tables of the CDD are displayed.

  5. For one of the tables, generate a Natural DDM as described in the section Generate DDM from an SQL Table in the Database Management System Interfaces documentation.

  6. After you have generated a DDM, access the corresponding SQL table with a simple Natural program as indicated in the following example: 

    DEFINE DATA
01 view-name OF ddm-name 
02 field
...
END-DEFINE
FIND view-name WITH field = value
  DISPLAY field
END-FIND
END

    where:
    view-name is a view of the DDM ddm-name,
    field is a DDM field,
    value is the search value to be used for the field.

If you receive the message NAT3700, enter the Natural system command SQLERR to display the corresponding SQL return code. SQLERR is described in the System Commands documentation.

Using Natural SQL Gateway Example Programs

The following table lists all Natural SQL Gateway example programs contained in the system library SYSDB2.

Program Name Purpose
NSBDCON Connect to ConnecX SQL Engine JDBC server.
NSBDCREA Create table NSB.DEMO.
NSBDCRPR Create procedure NSB.NSBDSPT for DB2 for UNIX and Windows systems.
NSBDCSPT Call procedure NSB.NSBDSPT and read result set.
NSBDISC Disconnect from ConnecX SQL Engine JDBC server.
NSBDROP Drop table NSB.DEMO.
NSBDFIND Read NSB.DEMO by FIND statement (*).
NSBDINS Load NSB.DEMO by INSERT statement (*).
NSBDPDEL Delete from NSB.DEMO by positioned DELETE statement (*).
NSBDPUPD Update NSB.DEMO by positioned UPDATE statement (*).
NSBDSDEL Delete from NSB.DEMO by searched UPDATE statement.
NSBDSEL Read NSB.DEMO by SELECT statement (*).
NSBDSET Show SET SCHEMA and SET CATALOG statements (see Special Register Consideration in the Database Management System Interfaces documentation).
NSBDSTOR Load NSB.DEMO by STORE statement (*).
NSBDSUPD Update NSB.DEMO by searched UPDATE statement (*).

* described in the Statements documentation.

All programs use DDM NSB-DEMO which uses LFILE 102. Therefore, the Natural parameter module has to map LFILE 102 to a DBID (database ID), which is mapped to database type CXX in the Natural parameter module.

Before the demo programs can be executed, you have to connect to a ConnecX SQL Engine JDBC server. This can be done by a modified copy of the NSBDCON program.

The results of the example programs differ depending on the sequence of their execution.

If you receive the message NAT3700, enter the Natural system command SQLERR to display the corresponding SQL return code. SQLERR is described in the System Commands documentation.

Natural Parameter Modifications for the Natural SQL Gateway

This section covers the following topics:

Natural Profile Parameter Settings

Adapt the Natural parameter module to meet your requirements. The parameters mentioned in this section are described in the Natural Parameter Reference documentation.

DB2SIZE Parameter

Specify the profile parameter DB2SIZE: 

DB2SIZE=nn

DB2SIZE indicates the size of the work area used for processing SQL requests. It must be set to at least 6 KB.

The setting of DB2SIZE also depends on whether you use the Natural file server. If the Natural file server is not used, the setting can be calculated according to the following formula: 

((1064 + n1 * 48 + n2 * 120) + 1023) / 1024 KB

If the Natural file server is used, the setting can be calculated according to the following formula: 

((1060 + n1 * 48 + n2 * 160 + n3 * 8) + 1023) / 1024 KB

The variables n1, n2 and n3 correspond to the following:

n1 Number of statements for dynamic access as specified with the MAXSTMT parameter in the NTDB2 macro
n2 Maximum number of nested database loops as specified with the MAXLOOP parameter in the NTDB2 macro
n3 Maximum number of Natural file server blocks to be allocated per user specified as the fifth parameter in Job I075, Step 1620 or the EBPMAX parameter (in the NTDB2 macro) if you decided to use the Software AG Editor buffer pool as the Natural file server

Since DB2SIZE applies to the Natural SQL Gateway and Natural for DB2, it must be set to the maximum value if you run both products in the same environment.

The DB2SIZE parameter can also be specified dynamically at the start of a Natural session.

Important:
Ensure that you have also specified the Natural parameters required for the Software AG Editor; see the relevant installation description in the section Installing Software AG Editor.

NTDB Macro

Specify database type CXX and a list of DBIDs (database IDs) in the NTDB macro. All Natural DDMs that refer to a CXX table must be cataloged with a DBID from this list. DBID can be any number from 1 to 65535. For most environments, one DBID (usually 249) is sufficient for database type CXX.

CXX DBIDs can also be specified dynamically at the start of a Natural session by using the DB parameter.

Important:
Ensure that all SQL DDMs used when cataloging a given program have a valid CXX or DB2 DBID. Also ensure that the DBIDs selected in the NTDB macro for CXX do not conflict with DBIDs selected for other database systems.

At execution time of a program cataloged with a DBID of database type CXX or DB2, the database type associated with the DBID in the NTDB macro determines whether the Natural SQL Gateway (type CXX) or Natural for DB2 (type DB2) processes the SQL request: 

NTDB CXX,249
NTDB2 Macro

Set the keyword subparameters in the NTDB2 macro according to your requirements.

The NTDB2 keyword subparameters can also be specified dynamically at the start of a Natural session by using the DB2 profile parameter.

NTLFILE Macro

Set the LFILE profile parameter in the NTLFILE macro to specify a logical DBID (database ID) that relates to database type CXX: 

NTLFILE 102,249,1

The LFILE parameter can also be specified dynamically at the start of a Natural session.

Performance Considerations for the DB2SIZE Parameter

During execution of an SQL statement, storage is allocated dynamically to build the SQLDA for passing the host variables to the CXX interface stub.

For performance reasons, it is first attempted to meet the storage requirements by free space in the work area (DB2SIZE). If there is not enough space available in this buffer, the TP monitor or operating system is invoked to provide additional storage.

You can avoid GETMAIN requests by setting DB2SIZE to a size larger than calculated with the formulas in the section DBSIZE Parameter.

Depending on the SQL execution mode and on the usage of the Natural file server, the additional storage requirements (in bytes) can be calculated as described in the following section:

Dynamic Mode

  • With sending fields:

    80 + n * 56

    With sending fields including LOB columns: 

    80 + 2 * n * 56

    where n is the number of sending fields in an SQL statement.

    The storage is freed immediately after the execution of the SQL statement.

  • With receiving fields (that is, with variables of the INTO clause (see into-clause) of a SELECT statement): 

    80 + n * 56 + 24 + n * 2

    With receiving fields including LOB columns: 

    80 + 2 * n * 56 + 24 + n * 2

    where n is the number of receiving fields in an SQL statement.

    The storage remains allocated until the loop is terminated.

Storage Requirements for the Natural File Server

When using the Natural file server, additional storage is required for each database loop that contains positioned UPDATE and/or DELETE statements.

For each of such loops, a buffer is allocated to save the contents of all receiving fields contained in the INTO clause (see into-clause). Therefore, the size of this buffer corresponds to the total length of all receiving fields: 

20 + 4 + sum (length (vl), ..., length (vn))

where v1 ... vn refers to the variables contained in the INTO clause.
The buffer remains allocated until the loop is terminated.

Example Calculation for Dynamic Mode without Using the Natural File Server

If you use the default value 10 for both variables (n1 and n2), the calculated DB2SIZE will be 2208 bytes. However, if you specify a DB2SIZE of 20 KB instead, the available space for dynamically allocated storage will be 18272 bytes, which means enough space for up to either 325 sending fields or 313 receiving fields.

Since space for receiving fields remains allocated until a database loop is terminated, the number of fields that can be used inside such a loop is reduced accordingly: for example, if you retrieve 200 fields, you can update about 110 fields inside the loop.

Considerations for VARCHAR Fields

When using VARCHAR fields (that is, fields with either an accompanying L@ field in the Natural view or an explicit LINDICATOR clause), additional storage is allocated dynamically if the L@ or LINDICATOR field is not specified directly in front of the corresponding base field. Therefore, always specify these fields in front of their base fields.

Installing Natural SQL Gateway Server

This document describes how to install a server for the Natural SQL Gateway.

Prerequisites

See the Prerequisites listed for the Natural SQL Gateway.

Installation Medium

The installation medium contains the following data sets required for product installation:

Data Set Name Contents
NSBvrs.OBJS Object modules
NSBvrs.JOBS Sample installation jobs

Installation Procedure

Step 1: Allocate the Natural SQL Gateway Server Load Library

(Job I008, Step 9500)

  • Allocate the Natural SQL Gateway load library for the batch server.

Step 2: Create a Natural SQL Gateway Server Configuration File and Sample CLIST

(Job I009, Steps 9510, 9520, 9530)

  1. Create the NSBCONFG sample configuration file for the batch server (Step 9510) as described in Configuring the Natural SQL Gateway Server in the Database Management System Interfaces documentation.

    The following parameters of the configuration file have to be defined:

    FRONTEND_NAME Specify the name of the Natural SQL Gateway server front-end module you will generate in one of the following steps.
    PORT_NUMBER Specify the TCP/IP port number under which the server can be connected.

    For the other parameters, the default values can be used. See also Natural SQL Gateway Server Configuration Parameters in the Database Management System Interfaces documentation.

  2. Create a CLIST sample member to ping and terminate a Natural SQL Gateway server (Step 9520).

  3. Create a sample member with a batch job to ping and terminate a Natural SQL Gateway server (Step 9530).

Step 3: Link the Object Modules to the Natural SQL Gateway Server Load Library

(Job I054, Step 9510)

  • Link the Natural SQL Gateway object modules with the necessary runtime extensions of your batch installations into executable load modules.

    See the sample job NSBI054 in the NSBvrs.JOBS data set.

Step 4: Create the Server Startup JCL

(Job I200, Step 9515)

  • Create a startup procedure for the batch server.

    Example: 

    //         PROC SRV=SAGNSB
//NSB      EXEC PGM=NATRNSV, 
// REGION=4000K,TIME=1440,PARM='POSIX(ON),TRAP(ON,NOSPIE)/&SRV' 
//STEPLIB  DD   DISP=SHR,DSN=NSBvrs.LOAD
//         DD   DISP=SHR,DSN=SAGLIB.SMALOAD 
//SYSUDUMP DD   SYSOUT=X 
//CEEDUMP  DD   SYSOUT=X 
//CMPRINT  DD   SYSOUT=X 
//STGCONFG DD   DISP=SHR, 
//              DSN=NSB.CONFIG(&SRV) 
//STGTRACE DD   SYSOUT=X 
//STGSTDO  DD   SYSOUT=X 
//STGSTDE  DD   SYSOUT=X 
//SYSOUT   DD   SYSOUT=X

    The parameters contained in the NSB.CONFIG data set are described in the section Configuring the Natural SQL Gateway Server in the Database Management System Interfaces documentation. See the sample job NSBSTART in the NSBvrs.JOBS data set.

Note:
The Natural SQL Gateway server account must be defined in the z/OS UNIX System Services (OE segment). If the server account is not defined, the server ends with U4093 and system message CEE5101C in the trace file.