This document describes the steps for installing Natural CICS Interface (product code NCI) on z/VSE.
For information on how to operate Natural in a CICS environment, see Using Natural with TP Monitors and Natural under CICS in the TP Monitor Interfaces documentation and the following topics:
When used in this document, the notation
vrs or
vr represents the relevant product
version (see also Version in the
Glossary).
A supported version of the following product must be installed before you can install the Natural CICS Interface:
Adabas CICS Interface (product code ACI), version as specified under Software AG Product Versions Required with Natural in the current Natural Release Notes for Mainframes.
See also General Prerequisites and System Support in the section Overview of the Installation Process.
The installation medium contains the following data set required for product installation:
| Data Set Name | Contents |
|---|---|
NCIvrs.LIBR |
Source modules, macros, phases and object modules |
Copy the data set into your environment as described in Copying Data Sets to a z/VSE Disk in the section Installing Natural.
Sample installation jobs are contained in the NATvrs.LIBJ data set
and are prefixed with the product code. The data set is provided on the
installation medium supplied for base Natural.
When used in this document,
prefix denotes a common Natural CICS
Interface prefix of 1 to 5 characters, for example, NCI43. This
prefix is determined by the value of the parameter
PREFIX in the Natural CICS Interface parameter module,
for example in Step 4 of the
Installation Procedure.
PREFIX is
described in the TP Monitor Interfaces documentation.
prefix is followed by specific
characters to make up the names of the following objects:
Before you start the installation procedure for the Natural CICS Interface, be sure to read the following:
System Control under CICS in the TP Monitor Interfaces documentation
The installation procedure comprises the following:
Step 2: Allocate the VSAM RRDS Roll Files for the Natural CICS Interface
Step 5: Build the Natural CICS Interface Starter Module NCISTART
Step 6: Build the Natural CICS Interface Root Module NCIROOT
Step 7: Build the Natural CICS Interface System Directory Module
Step 8: Build the Natural CICS Interface External CALLNAT Interface Module
Step 11: Build the Natural CICS Interface Front-End Driver NCISFED
Step 16: Link the Natural CICS Interface External CALLNAT Interface Module
(Job I005, Steps 2211, 2212, 2230)
Steps 2211 and 2212:
Create the CICS tables and RDO entries as described in CICS Resource Definitions.
Step 2230 (optional):
This step is only required if you want to dynamically load an ICU data item without using the SVC instruction on request during a Natural session instead of an entire ICU data library:
Set CFICU=(DATITEM=NONE)
and add one PPT entry for each ICU data item.
See also the corresponding step in Installing International Components for Unicode for Software AG.
ICU data items and ICU data libraries are described in the Unicode and Code Page Support documentation.
(Job I008, Step 2200)
This step must be performed only if VSAM roll files are used as CICS roll facility.
Allocate the VSAM RRDS roll files for the Natural CICS Interface.
The Natural CICS Interface uses VSAM RRDS roll files for optimum performance, which means without CI/CA splits.
(Job I070, Step 2205)
This step must be performed only if VSAM roll files are used as roll facility.
Assemble and catalog the NCISCPRI batch program of the
Natural CICS Interface to initialize a roll file.
This step creates an executable batch module which is used in Step 15: Link the VSAM Roll-File Initialization Module.
(Job I070, Steps 2220, 2225)
Edit, assemble and catalog the Natural CICS Interface parameter module
NCIPARM.
The Natural CICS Interface parameter module
NCIPARM contains a macro named
NCMPRM
which contains parameters specific to the Natural CICS Interface.
You can generally use the default values for all parameters. Modify only the values of those parameters whose default values do not suit your requirements. The only mandatory parameter without a default value is the common Natural CICS Interface prefix.
To simplify the Natural CICS Interface parameter module installation
process, the source module NCIPARM contains the
NCMPRM macro request with parameter
PREFIX=&SYSPARM. Thus, when generating a Natural CICS
Interface parameter module, assemble the NCIPARM source module
with assembler option SYSPARM=prefix
rather than editing the source module.
The individual parameters are described in the section NCMPRM Macro Parameters in the TP Monitor Interfaces documentation.
(Job I070, Step 2230)
Make sure that the IBM Language Environment macro library is
available in the SYSLIB chain in the assembler step.
Translate, assemble and catalog the Natural CICS Interface starter module
NCISTART. Repeat these steps after you have installed a new CICS
version.
If you are not using the most recent CICS version, the translate step may result in a non-zero return code (4 - 16, depending on your CICS version) because of CICS commands being used that are unknown to your CICS translator. This return code can be ignored as long as the subsequent assembly step will end with a return code of 0 by using conditional assemblies to bypass potential CICS translator messages.
(Job I070, Step 2235)
Translate, assemble and catalog the Natural CICS Interface module
NCIROOT. Repeat these steps after you have installed a new CICS
version.
If you are not using the most recent CICS version, the translate step may result in a non-zero return code (4 - 16, depending on your CICS version) because of CICS commands being used that are unknown to your CICS translator. This return code can be ignored as long as the subsequent assembly step will end with a return code of 0 by using conditional assemblies to bypass potential CICS translator messages.
(Job I070, Steps 2245, 2250)
Edit, assemble and catalog the NCISCPCB module.
The Natural CICS Interface system directory is generated by
assembling and cataloging the source module NCISCPCB.
A sample job is contained in the
NATvrs.LIBJ data set and a
comprehensive sample source in the
NCIvrs.LIBR data set.
For descriptions of the individual macros and parameters contained in
NCISCPCB, see
NCISCPCB
Generation Parameters in the TP Monitor
Interfaces documentation.
(Job I070, Step 2270)
This step must be performed only if you want to use the external
CALLNAT interface module of the Natural CICS Interface. See also
Environment
Dependencies in
Natural
3GL CALLNAT Interface - Purpose, Prerequisites,
Restrictions in the Operations
documentation.
Translate, assemble and catalog the external CALLNAT interface module
NCIXCALL. See also NCIXCALL as described for the
CALLNAT in
Environment
Dependencies in the Operations
documentation.
Repeat these steps after you have installed a new CICS version.
If you have an NCIXCALL module from a previous Natural
version, specify a new name for this module (for example,
NCIXCIOV) by using the SYSPARM parameter
contained in NCIXCALL. The NCIXCALL module from the
previous Natural version must be linked (see
Step 16: Link the Natural CICS
Interface External CALLNAT Interface Module) to assign it
the new name.
If you are not using the most recent CICS version, the translate step may result in a non-zero return code (4 - 16, depending on your CICS version) because of CICS commands being used that are unknown to your CICS translator. This return code can be ignored as long as the subsequent assembly step will end with a return code of 0 by using conditional assemblies to bypass potential CICS translator messages.
(Job I070, Step 2275)
This step must be performed only if you want to use the node error program (NEP) of the Natural CICS Interface.
Translate, assemble and catalog the Natural CICS Interface module
NCIZNEP. Repeat these steps after you have installed a new CICS
version.
For information on NCIZNEP, see
NCIZNEP
Functionality in the TP Monitor
Interfaces documentation.
If you are not using the most recent CICS version, the translate step may result in a non-zero return code (4 - 16, depending on your CICS version) because of CICS commands being used that are unknown to your CICS translator. This return code can be ignored as long as the subsequent assembly step will end with a return code of 0 by using conditional assemblies to bypass potential CICS translator messages.
(Job I070, Step 2280)
This step must be performed only if you want to use Natural via the CICS 3270 Bridge.
Translate, assemble and catalog the Natural CICS Interface module
NCIXFATU. Repeat these steps after you have installed a new CICS
version.
If you are not using the most recent CICS version, the translate step may result in a non-zero return code (4 - 16, depending on your CICS version) because of CICS commands being used that are unknown to your CICS translator. This return code can be ignored as long as the subsequent assembly step will end with a return code of 0 by using conditional assemblies to bypass potential CICS translator messages.
(Job I070, Step 2290)
This step must be performed only if you want to use the Natural RPC
server front-end under CICS. This step is only generated if the
System Maintenance Aid
(SMA) parameter NAT-RPC is set to
Y (Yes). NAT-RPC is used in connection with the SMA
parameter NCI-RPC-FRONT.
Make sure that the IBM Language Environment (LE) macro library is
available in the SYSLIB chain in the assembler step.
Translate, assemble and catalog the Natural CICS Interface front-end driver
NCISFED. Repeat these steps after you have installed a new CICS
version.
If you are not using the most recent CICS version, the translate step may result in a non-zero return code (4 - 16, depending on your CICS version) because of CICS commands being used that are unknown to your CICS translator. This return code can be ignored as long as the subsequent assembly step will end with a return code of 0 by using conditional assemblies to bypass potential CICS translator messages.
(Job I080, Step 2220)
Build the Natural parameter module for the Natural CICS Interface:
Modify the settings of the supplied Natural profile parameters as required and in accordance with the settings you specified when building the Natural parameter module for batch mode during the Installation Procedure for base Natural.
Make sure that the profile parameters
FNAT and
FUSER are
set to the same values you specified when loading the system file. The
parameters and corresponding macros (if applicable) are described in the
Parameter
Reference documentation.
Assemble and catalog the Natural parameter module.
(Job I080, Step 2230)
Link the environment-dependent nucleus for the Natural CICS Interface with the following modules:
NCIPARM built in
Step 4,
NCISTART built in
Step 5,
NCIROOT built in
Step 6, and
the Natural parameter module built in
Step 12.
Include the CICS stub module DFHELII (do not use
DFHEAI).
All components of the environment-dependent nucleus are reentrant. Therefore, you can link it with the shared virtual area (SVA) option to take advantage of the CICS (E)RDSA storage area.
(Job I080, Step 2250)
Link the Natural CICS Interface system directory into your CICS user
library under the module name prefixCB
(see Prefix Used for Natural
CICS Interface Components).
The Natural CICS Interface system directory is not reentrant. Therefore, it cannot be linked with the shared virtual area (SVA) option.
(Job I080, Step 2265)
This step must be performed only if VSAM roll files are used as CICS roll facility.
Link the VSAM roll-file initialization module NCISCPRI
into your CICS user library.
(Job I080, Steps 2270, 2271)
This step must be performed only if you want to use the external
CALLNAT interface module of the Natural CICS Interface.
Link the external CALLNAT interface module
NCIXCALL.
Step 2270 is needed if the NCIXCALL module has been
installed in the same CICS partition with a previous Natural version. The previous Natural
version NCIXCALL module must then be assigned a new name, for
example NCIXCIOV. Thus, you can preserve the name of the
NCIXCALL module used in the previous version and need not link it
to all your 3GL programs using it.
Step 2271 links the module NCIXCALL for the current
Natural version.
The external CALLNAT interface module of the
Natural CICS Interface is reentrant. Therefore, you can link it with the shared
virtual area (SVA) option to take advantage of the CICS (E)RDSA storage
area.
(Job I080, Step 2275)
This step must be performed only if you want to use the node error program (NEP) of the Natural CICS Interface. See also CICS Node Error Program Considerations for Natural in the TP Monitor Interfaces documentation.
Link the Natural CICS Interface module NCIZNEP.
The node error program of the Natural CICS Interface is reentrant. Therefore, you can link it with the shared virtual area (SVA) option to take advantage of the CICS (E)RDSA storage area.
(Job I080, Step 2280)
This step must be performed only if you want to use Natural with the CICS 3270 Bridge. See also CICS 3270 Bridge Support in the TP Monitor Interfaces documentation.
Link the Natural CICS Interface module NCIXFATU under
the name
prefixXFA; see
Prefix Used for Natural CICS
Interface Components.
The Natural CICS Interface module NCIXFATU is
reentrant. Therefore, you can link it with the shared virtual area (SVA) option
to take advantage of the CICS (E)RDSA storage area.
(Job I080, Step 2290)
This step must be performed only if you want to use the Natural RPC
server front-end under CICS. This step is only generated if the
System Maintenance Aid
(SMA) parameter NAT-RPC is set to
Y (Yes). NAT-RPC is used in connection with the SMA
parameter NCI-RPC-FRONT.
Define the name of the Natural RPC server front-end with the SMA
parameter NCI-RPC-FRONT.
The Natural RPC server front-end under CICS is reentrant. Therefore, you can link it with the shared virtual area (SVA) option to take advantage of the CICS (E)RDSA storage area.
(Job I081, Step 2200)
This step must be performed only if VSAM roll files are used as CICS roll facility.
Initialize the VSAM roll files.
This step must be repeated for all roll files used if roll files are the primary roll facility.
A VSAM RRDS file is a direct (random) access type file that must be formatted.
For the Natural CICS Interface VSAM roll files, formatting is done by
the NCISCPRI batch program. To execute NCISCPRI, the
Natural roll file to be initialized has to be assigned the file name
ROLL in the JCL DLBL statement. No other parameter input is required for
NCISCPRI; all data required for file initialization is obtained by
SHOWCB VSAM macro calls.
When running the Natural CICS Interface, supply an
end-of-data (/*) statement in the JCL for compatibility reasons,
although no parameter input is required for NCISCPRI.
For descriptions of the messages that can be output during this step, see NCISCPRI Warnings and Error Messages in the TP Monitor Interfaces documentation.
This section describes resource definitions required or recommended for customizing your CICS system.
Note:
We generally recommend
that you keep all Natural version-dependent components such as programs,
transactions and files in a separate resource group. Such a group is
represented by natgroup in this
section.
Add a program definition for the environment-dependent nucleus:
DEFINE PROGRAM(dep-nuc) GROUP(natgroup) LANGUAGE(ASSEMBLER) * DESCRIPTION(ENVIRONMENT-DEPENDENT NUCLEUS)
where dep-nuc is the Natural
CICS Interface module built during the link step.
We recommend that you set the following parameter value in the CICS program definition under CICS TS:
DATALOCATION(ANY)
Program attributes (for example, EXECKEY or
DATALOCATION) are inherited from
NCISTART
because standard linkage conventions (BALR 14,15) are used for the program
calls. Examples are calls for the environment-independent nucleus, the Adabas
CICS Interface or Natural calls (SET CONTROL 'P=S') for external
programs.
This definition is optional.
Add a program definition for the environment-independent nucleus:
DEFINE PROGRAM(ind-nuc) GROUP(natgroup) LANGUAGE(ASSEMBLER) * DESCRIPTION(NATURAL ENVIRONMENT-INDEPENDENT NUCLEUS)
where ind-nuc is the name
of the environment-independent
nucleus specified with the Natural profile parameter
NUCNAME.
The default name is INDNUCvr. You need
not specify EXECKEY or DATALOCATION for the
environment-independent nucleus as all attributes of the
NCISTART
program are inherited since standard linkage conventions (BALR 14,15) are
used.
To access the environment-independent nucleus in the SVA,
specify USESVACOPY(YES) for this program definition and
SVA=YES in the CICS startup parameters.
Add a program definition for the Natural CICS Interface system directory:
DEFINE PROGRAM(prefixCB) GROUP(natgroup) LANGUAGE(ASSEMBLER) * DESCRIPTION(NATURAL CICS INTERFACE SYSTEM DIRECTORY)
This definition is optional.
Add a program definition for the external CALLNAT
interface module:
DEFINE PROGRAM(ncixcall) GROUP(natgroup) LANGUAGE(ASSEMBLER) * DESCRIPTION(NATURAL CICS INTERFACE EXTERNAL CALLNAT MODULE)
We recommend that you set the following parameter value in the CICS program definition under CICS TS:
DATALOCATION(ANY)
This definition is optional.
Add a program definition for the node error program (NEP) of the Natural CICS Interface:
DEFINE PROGRAM(nciznep) GROUP(natgroup) LANGUAGE(ASSEMBLER) * EXECKEY(CICS) * DESCRIPTION(NATURAL CICS INTERFACE NODE ERROR PROGRAM)
where nciznep is the NEP
name specified in Step
9: Build the Natural CICS
Interface Node Error Program.
This definition is optional.
Add a program definition for the XFAINTU global user
exit:
DEFINE PROGRAM(prefixXFA) GROUP(natgroup) LANGUAGE(ASSEMBLER) * EXECKEY(CICS) * DESCRIPTION(NATURAL CICS INTERFACE XFAINTU GLUE)
This definition is optional.
This definition is only required if you want to use the Natural RPC
server front-end ncisfe. This
definition is only generated if the
System Maintenance Aid
(SMA) parameter NCI-RPC-FRONT is set.
Add a program definition for the Natural RPC server front-end:
DEFINE PROGRAM(ncisfe) GROUP(natgroup) LANGUAGE(ASSEMBLER) * DESCRIPTION(NATURAL RPC SERVER FRONT-END)
We recommend that you set the following parameter value in the CICS program definition under CICS TS:
DATALOCATION(ANY)
The name of the Natural RPC server front-end
ncisfe must be identical to the name
specified in Step
19: Link the Natural RPC
Server Front-End.
We recommend that you define or choose a CICS profile for the Natural transactions similar to the following:
DEFINE PROFILE(natprof) GROUP(natgroup) * DESCRIPTION(CICS PROFILE FOR NATURAL TRANSACTIONS) * SCRNSIZE(ALTERNATE) INBFMH(ALL)
where natprof is the name of
the CICS profile assigned to the Natural transactions.
We also recommend that you define a CICS transaction class for the Natural transactions similar to the following:
DEFINE TRANCLASS(natclass) GROUP(natgroup) MAXACTIVE(999) * DESCRIPTION(CLASS FOR NATURAL TRANSACTIONS)
where natclass is the name of
the CICS transaction class assigned to the Natural transactions.
A CICS transaction class dedicated to Natural helps control storage usage by Natural (see also Controlling Storage Usage in the TP Monitor Interfaces documentation). Assign this transaction class to the definitions of all transactions that directly or indirectly call Natural.
You can define the following:
Add a definition for the Natural transaction:
DEFINE TRANSACTION(ncitransact) GROUP(natgroup) * PROGRAM(dep-nuc) TWASIZE(128) DUMP(NO) SPURGE (YES) * PROFILE(natprof) TRANCLASS(natclass)
where:
ncitransact is the
name of the Natural CICS Interface user transaction ID.
dep-nuc is the Natural
CICS Interface module built during the link step.
We recommend that you set the following parameter value in the CICS transaction definitions under CICS TS:
TASKDATALOC(ANY)
TASKDATALOC(ANY) can have an impact on non-Natural
programs called by Natural; for details, see the relevant IBM literature on
CICS.
Add a definition for the Natural internal message switching transaction:
DEFINE TRANSACTION(nmsg) GROUP(natgroup) * PROGRAM(dep-nuc) TWASIZE(128) DUMP(NO) SPURGE (YES) * PROFILE(natprof) TRANCLASS(natclass)
where:
dep-nuc is the Natural CICS
Interface module built during the link
step.
nmsg is the name of the
Natural CICS Interface message switching transaction ID as defined in the
MSGTRAN
parameter described in Parameters in Macro
NCMPRM in the TP Monitor Interfaces
documentation. The default name is NMSG.
We recommend that you set the following parameter value in the CICS transaction definitions under CICS TS:
TASKDATALOC(ANY)
TASKDATALOC(ANY) can have an impact on non-Natural
programs called by Natural; for details, see the relevant IBM literature on
CICS.
This definition is optional and applies to CICS TS only.
Add a definition for the node error program (NEP) of the Natural CICS Interface:
DEFINE TRANSACTION(neptran) GROUP(natgroup) * PROGRAM(nciznep) DUMP(NO) PRIORITY(255) * TASKDATAKEY(CICS) TASKDATALOC(ANY) * PROFILE(natprof)
where:
neptran is the NEP
transaction code defined with the NEPTRAN
generation parameter in the SYSPARM specification in the
NCIZNEP module built in Step 9: Build the Natural CICS
Interface Node Error Program.
nciznep is the NEP name
specified in Step
9: Build the Natural CICS
Interface Node Error Program.
NCIZNEP and NEPTRAN are
described in the TP Monitor Interfaces documentation.
Add a definition for the Natural RPC server front-end transaction:
DEFINE TRANSACTION(ncisfetransact) GROUP(natgroup) * PROGRAM(ncisfe) TWASIZE(128) DUMP(NO) SPURGE (YES) * PROFILE(natprof) TRANCLASS(natclass)
where:
ncisfetransact is the
name of the Natural RPC server front-end transaction ID.
ncisfe is the name of
the Natural RPC server front-end specified in
Step 19: Link the Natural RPC Server
Front-End.
These definitions are only required if VSAM roll files are to be used.
Add one entry in the FCT for each Natural CICS Interface VSAM roll file:
DFHFCT TYPE=FILE, *
FILE=prefixRn, *
ACCMETH=VSAM, *
RECFORM=(FIXED,BLOCKED), *
SERVREQ=(UPDATE,DELETE,ADD), *
FILSTAT=(ENABLED,OPENED), *
BUFND=5,STRNO=3
Local shared resources (LSR) should be used whenever possible. If multiple LSR pools are supported, one pool should be dedicated exclusively to Natural CICS Interface roll files.
This definition is optional but highly recommended to log Natural CICS Interface informational messages and Natural abend codes and corresponding error messages.
Add entries in the DCT for the Natural CICS Interface error message logging facility. For Natural error messages, you can use:
A destination that is already defined in CICS (for example, CSSL); in this case, no extra DCT entry is required.
An extra partition destination as a synonym for an existing CICS message destination:
DFHDCT TYPE=INDIRECT, *
DESTID=nerr, *
INDDEST=name
where:
nerr is the name of the
Natural CICS Interface error message destination as defined in the
MSGDEST
parameter described in NCMPRM Macro
Parameters in the TP Monitor
Interfaces documentation. The default name is NERR.
name is the name of the
corresponding indirect destination.
An extra file:
DFHDCT TYPE=SDSCI, *
DSCNAME=NATMSG, *
RECFORM=VARUNB, *
RECSIZE=nnn, *
TYPEFLE=OUTPUT
DFHDCT TYPE=EXTRA, *
DSCNAME=NATMSG, *
DESTID=nerr, *
OPEN=INITIAL
where nerr is the name of
the Natural CICS Interface error message destination as defined in the
MSGDEST
parameter described in NCMPRM Macro
Parameters in the TP Monitor
Interfaces documentation. The default name is NERR.
You can, for example, change the RECFORM
format from VARUNB (variable unblocked) to VARBLK
(variable blocked). Natural and the Natural CICS Interface messages have a
length of up to 120 bytes. Therefore, the record size (RECSIZE=nnn) should
be at least 124 bytes for variable record format or 120 bytes for fixed record
format.
Sufficient disk space must be reserved for this data set; a DLBL statement must be added to the CICS startup JCL.
This definition is optional.
Add two entries in the DCT for the Natural CICS Interface session statistics:
DFHDCT TYPE=SDSCI, *
DSCNAME=NATLOG, *
RECFORM=VARBLK, *
BLKSIZE=4628, *
RECSIZE=4624, *
DEVICE=DISK
DFHDCT TYPE=EXTRA, *
TYPEFLE=OUTPUT, *
DSCNAME=NATLOG, *
DESTID=nlog, *
OPEN=INITIAL
where nlog is the name of
the Natural CICS Interface logging destination as defined in the parameter
LOGDEST
described in the TP Monitor Interfaces documentation. The
default name is NLOG.
Sufficient disk space must be reserved for this data set; a DLBL statement must be added to the CICS startup JCL.
This definition is optional.
Add two entries in the DCT for the Natural CICS Interface profile parameter file:
DFHDCT TYPE=SDSCI, *
RECSIZE=80, card image *
BLKSIZE=nnn, *
BUFNO=1, *
DSCNAME=cmprmin, *
RECFORM=FIXBLK, *
TYPEFLE=INPUT
DFHDCT TYPE=EXTRA, *
DESTID=nprm, *
DSCNAME=cmprmin, *
OPEN=DEFERRED
where:
nprm is the name of the
Natural CICS Interface profile parameter input destination as defined in the
PRMDEST
parameter described in NCMPRM Macro Parameters in the
TP Monitor Interfaces documentation. The default name is
NPRM.
nnn is a multiple of 80.
A DLBL statement must be added to the CICS startup JCL.
You can verify the successful installation of the Natural CICS Interface by performing the following steps:
From a CICS session, type in the Natural transaction ID to start a Natural session.
Proceed with the steps described in the section Test Online Natural.