Configuration

The main parameter required to configure the Natural IMS TM Interface are specified with the following profile parameter macros of the Natural parameter module:

NTIMSP for general parameter settings,
NTIMSPE for specification of environment-specific parameter sets, and
NTIMSPT for transaction code definitions.

Important:
You must at least specify the NTIMSPT macro and define individual parameters for your Natural IMS TM transactions (there are no default values).

In addition to the Natural parameter macros, you can use the optional macros described in the following section. They are provided by the Natural IMS TM Interface.

NIMMSGT Macro Parameters
NIMPIXT Macro Parameters
NIMBOOT Macro Parameters

NIMMSGT Macro Parameters

The macro NIMMSGT generates each entry in the message text module NIIMSGT which is part of the Natural IMS TM Interface module. Each generated entry provides a message text for each possible Natural IMS TM error number.

The NIMMSGT macro is specified in one of the following two ways:

Nerror-number [*] NIMMSGT  message-text

In this case, Natural under IMS TM will display the message text as defined. The message text may be up to 72 characters long.

Xerror-number [*] NIMMSGT message-text

In this case, Natural under IMS TM will append an error-specific reason code to the current message text. The message text may be up to 64 characters long.

If the error number is followed by an asterisk (*), a snap dump will be generated when an error occurs. You may adapt the message text to your own requirements. You may also add or delete the DUMP option of a specific error number. You must not modify the error number and the characters N or R that precede the error number.

NIMPIXT Macro Parameters

The NIMPIXT macro generates the Physical Input Edit Routine.

The parameters which can be specified with the macro NIMPIXT are listed in alphabetical order below:

PIXTE | SIPSE | SPATID | WTO | USER

Parameter	Possible Value	Description	Default	Comment
`PIXTE`	`1 - 999`	Specifies the start value for error numbers if errors are detected by the physical input edit routine.	`400`	This value is added to the return code set by the physical input edit routine. The result is the IMS TM error message number in the user message table `DFSCMTU0`.
`SIPSE`	`1 - 999`	Specifies the start value for error numbers if errors are detected by the Authorized Services Manager.	`500`	This value is added to the return code set by the Authorized Services Manager. The result is the IMS TM error message number in the user message table `DFSCMTU0`.
`SPATID`	`xxxx`	Specifies the Natural subsystem ID for the Authorized Services Manager which is used to save the SPA for the non-conversational driver. Any string up to 4 characters is possible.	None	The value of this parameter must be the same as the value specified for the `SPATID` keyword subparameter in the `NTIMSPE` macro (Natural parameter module).
`WTO`	`YES`	Specifies whether a WTO message is issued if the Authorized Services Manager fails.	`NO`	None.
`WTO`	`NO`		`NO`	None.
`USER`	`xxxxxxxx`	Specifies whether a user-specific physical input edit routine is to be called if the `NIMPIXT` macro does not find the SPA. If a user-specific input edit routine is to be called, specify the name of the routine.	`NO`	None.
`USER`	`NO`		`NO`	None.

NIMBOOT Macro Parameters

The macro NIMBOOT generates the bootstrap module used by the message-oriented environment or the server call interface used by the server environment.

NIMBOOT includes the following parameters:

Parameter	Possible Values	Default	Comment
`TYPE`	`SERVER`	Empty	`TYPE` specifies the type of the interface module to be generated. With `TYPE=SERVER`, the server call interface `NIIBOOTS` is generated.
`TYPE`	Empty	Empty	If nothing is specified, the bootstrap module used by the message-oriented environment is generated.
`DRIVERN`	Any valid z/OS module name	None	This parameter specifies the name of the front-end module. If `TYPE=SERVER` is specified, the front-end module must have been generated for the server environment. If no `TYPE` is specified the front-end module must have been generated for the message-oriented environemt.
`ENVTNAM`	Any valid z/OS module name	None	This parameter is only used by the bootstrap module for the message-orineted environment (`TYPE` is empty). This parameter specifies the name of the environment table. This parameter is optional. If it is not specified, the environment table is determined by the entry in the transaction code table which corresponds to the transaction code used.
`TRNCODE`			This parameter is only used by the bootstrap module for the message-oriented environment (`TYPE` is empty). This parameter specifies the name of the transaction code which is internally used by the Natural IMS TM Interface. This parameter is optional and is only honored if `TRNCODE=ON` is specified in the `NTIMSP` macro (Natural parameter module). If it is not specified or if `TRNCODE=ON` is specified in the `NTIMSP` macro, the transaction code returned by the IMS TM `INQY` call is used. The transaction code is used to determine the entry in the transaction code table.
`DYNPARM`	Any character string of up to 80 characters.	None	This parameter is only used by the bootstrap module for the message-oriented environment (`TYPE` is empty). This parameter is used to define a valid string of up to 80 characters of Natural dynamic parameters.
`SERVERN`	Any valid z/OS module name	`NIIBOOTS`	This parameter is only used by the server call interface (`TYPE=SERVER`). This parameter specifies the name of the server environment. It is only relevant if you want to use several Natural servers in the same region. In this case, you must generate multiple server call interfaces and specify a unique name with `SERVERN` for each each of them. See Special Functions, Server Environment.