This document describes the steps for installing Natural CICS InterfaceVersion 8.x (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).
Wichtig:
Before you install Natural CICS Interface Version 8.3.3, you
need to apply the
Natural
updates announced in the current Natural Release
Notes.
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, NCI83. This
prefix is determined by the value of the parameter
PREFIX in the NTCICSP macro of the Natural
parameter module, for example, in
Step 4 of the
Installation Procedure.
NTCICSP
and 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 3: Build the Natural CICS Interface System Directory Module
Step 7: 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, 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 I080, Step 2220)
Build the Natural parameter module for the Natural CICS Interface:
The NTCICSP macro in
the Natural parameter module contains parameters specific to the Natural CICS
Interface. You can generally use the default values for all parameters.
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 parameter module installation process, the
source module NTCICSP contains the NTCICSP
macro request with parameter PREFIX=&SYSPARM. Thus, when
generating a parameter module for the Natural CICS Interface, assemble the
Natural parameter module with the assembler option
SYSPARM=prefix rather than editing the
source module.
The individual parameters are described in the section NTCICSP Macro Parameters in the TP Monitor Interfaces documentation.
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:
NCINUCV,
NCINUC and the Natural parameter module built in
Step 4.
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.
See also Natural Nucleus under CICS in the TP Monitor Interfaces documentation.
(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, Steps 2270, 2271)
This step must be performed only if you want to use the external
CALLNAT interface module of the Natural CICS Interface.
For more information, see Natural 3GL CALLNAT Interface - Purpose, Prerequisites, Restrictions in the Operations documentation.
Link the external CALLNAT interface module
NCIXCALL by using the NCIXCALV module.
See also and Natural Nucleus under CICS in the TP Monitor Interfaces documentation.
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 by using
the NCIZNEPV module.
See also and Natural Nucleus under CICS in the TP Monitor Interfaces documentation.
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) by using the NCIXFATV module.
See also and Natural Nucleus under CICS in the TP Monitor Interfaces documentation.
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.
Link the Natural RPC server front-end module NCIRSFE
under the defined name by using the NCISFEDV module.
(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.
The Natural CICS Interface modules described in this section use startup
parameters to initialize Natural CICS Interface components. The
EXEC CICS ASSIGN command retrieves the value set by
these startup parameters with the INITPARM option using the
following syntax:
| INITPARM=(module='parameter',)... |
where:
module is the name of the
module that uses a startup parameter.
parameter the name of the
corresponding parameter.
The relevant Natural CICS Interface modules and corresponding parameters are described in the following section:
parameter
is the name of an NCIXCALL module from a previous Natural version
(for example, NCIXCIOV), if available. The NCIXCALL
module from the previous Natural version must be linked to assign it the new
name (see Step
7: Link the Natural CICS
Interface External CALLNAT Interface Module).
For more information, see Natural 3GL CALLNAT Interface - Purpose, Prerequisites, Restrictions in the Operations documentation.
parameter
is the name of the NCIZNEP module linked in
Step 8: Link the Natural CICS Interface
Node Error Program.
For more information on the NCIXFATU module, see
CICS 3270 Bridge
Support in the TP Monitor Interfaces
documentation.
parameter
is the name of the NCIZNEP module linked in
Step 8: Link the Natural CICS Interface
Node Error Program.
For more information on the NCIZNEP module, see
CICS Node Error
Program Considerations for Natural in the TP
Monitor Interfaces documentation.
The individual NCIZNEP parameters are described in the
following section:
- MSGTRAN - Internal Message Switching Transaction ID
This parameter specifies the transaction ID internally used by the Natural message switching and asynchronous session flushing facilities.
This parameter has the same meaning as the
MSGTRANparameter inNTCICSP(see the TP Monitor Interface documentation) and must be specified identically.Possible values are:
Value: Explanation: transaction-idAny valid CICS transaction ID. The Natural CICS Interface clean-up function is done by starting an asynchronous task to resume the terminal-bound session and to terminate it logically. Therefore, normally the original transaction ID of the session is used. This original transaction ID cannot be used if there is a front-end program calling Natural, as most likely the front-end is not prepared for being invoked asynchronously without a terminal. In such situations the message switching transaction ID of the Natural CICS Interface is used to deal with Natural directly.
NMSGThis is the default value. - NEPTRAN - Transaction ID for the NCIZNEP Module
This parameter specifies the transaction ID for the Natural/CICS Interface node error program (NEP)
NCIZNEPin an MRO environment, when the parameterPURGE(see below) is set toYES.Possible values are:
Value: Explanation: transaction-idAny valid CICS transaction ID. NETRThis is the default value. - PURGE - Purge Active Natural Task
This parameter defines how
NCIZNEPis to treat Natural sessions currently active, when the Natural/CICS Interface node error program (NEP) is invoked.Possible values are:
Value: Explanation: NOThis is the default value for compatibility reasons. The active Natural task is not purged. The active task will continue to run until a terminal I/O later on will result in abend
NT08due to a CICS TERMERR condition, as the terminal no longer exists.YESThe active Natural task is purged immediately. This functionality is supported in CICS Transaction Server systems only.
In MRO environments, a node error program is triggered in the CICS TOR; as the Natural session most likely is active in a CICS AOR, the task purge cannot be done in the TOR. Therefore, a transaction ID is required (see
NEPTRANabove) to start a "partner" NEP task in the AOR to do the task purge.Anmerkung:
PURGE=YESrequires that the relevant Natural transactions are defined as purgeable (SPURGE(YES)).- TSKEY - Prefix for Natural CICS Temporary Storage Key
This parameter defines the constant prefix of the temporary storage queue holding the Natural CICS Interface pseudo-conversational restart data.
Possible values are:
Value: Explanation: xxxxxxxxdefines the prefix for pseudo-conversational restart data.NCOMThis is the default value. This parameter has the same meaning as the second subparameter of the parameter
TSKEYin theNCMDIRmacro (see the TP Monitor Interfaces documentation) and must be specified identically.
parameter
is the name of the NCIRSFE module linked for the Natural RPC
server in Step 10: Link the Natural RPC Server
Front-End.
The following is an example of an INIPARM
specification:
INITPARM=( NCI83CAL='NCI82CAL', * NCIXCALL module NCI83ATU='NCI83NEP', * NCIXFATU module NCI83NEP='MSGTRAN=NMSG,TSKEY=NCOM,PURGE=YES', * NCIZNEP module NCI83SFE='NATTRAN=NC83,MSGDEST=CSSL', * NCIRSFE module )
This section describes the resource definitions required or recommended for customizing your CICS system.
Anmerkung:
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
environment-dependent nucleus linked in
Step 4.
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 the environment-dependent nucleus
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 environment-dependent
nucleus 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(CB) 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)
where ncixcall is the name
of the NCIXCALL module specified in
Step
7: Link the Natural CICS
Interface External CALLNAT Interface 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
8: Link 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(ncirsfe) GROUP(natgroup) LANGUAGE(ASSEMBLER) * DESCRIPTION(NATURAL RPC SERVER FRONT-END)
where:
ncirsfe is the name of the
NCIRSFE module specified for the Natural RPC server front-end in
Step 10: Link the Natural RPC Server
Front-End.
We recommend that you set the following parameter value in the CICS program definition under CICS TS:
DATALOCATION(ANY)
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
environment-dependent nucleus linked in
Step 5.
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
environment-dependent nucleus linked in
Step 5.
nmsg is the name of the
Natural CICS Interface message switching transaction ID as defined in the
MSGTRAN
parameter described in NTCICSP Macro Parameters 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 parameter of
the NCIZNEP module linked in
Step 8: Link the Natural CICS Interface
Node Error Program.
nciznep is the NEP name of
the NCIZNEP module linked in
Step 8: Link the Natural CICS Interface
Node Error Program.
Add a definition for the Natural RPC server front-end transaction:
DEFINE TRANSACTION(ncisfetransact) GROUP(natgroup) * PROGRAM(ncirsfe) TWASIZE(128) DUMP(NO) SPURGE (YES) * PROFILE(natprof) TRANCLASS(natclass)
where:
ncisfetransact is the
name of the Natural RPC server front-end transaction ID.
ncirsfe is the name of
the NCIRSFE module specified for the Natural RPC server front-end
in Step 10: 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 NTCICSP 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 NTCICSP 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 NTCICSP 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.