Natural under openUTM - Part 2

This part of the Natural openUTM Interface documentation deals with the macro parameters.

It covers the following topics:

• NATUTM Macro Parameters

• NATUTM Macro Entries

• NURENT Macro Parameters

NATUTM Macro Parameters

The following parameters are available:

ADACALL | ADACOM | ADAPRI | ADAUTM | APPLNAM | APRISTD | ASAPPLI | ASYNTAC | BADTAC | CDYNAM | CLRKEY | CURPRO | ICONTRL | INITPRG | KB | KBSAVE | KBUSEXT | LFH | LINK | LINK2/LINK3/LINK4 | LOFFMAP | NATMON | NUAADDR | NUCNAME | PARMOD | PENDPR | PFK | PRKEY | REFRKEY | ROLLACC | ROLLTSZ | RSTCNT | RSTWARM | SCRNOPT | SHUTALL | SHUTLST | SPOOL | STRTALL | STRTFST | SVDYPRM | SWAMODE | SWDPAGE | SWPUSID | SYAPPLI | SYNTAC | SYSLST | TACEND | TCLA1 | TCLA2, TCLA3, TCLA4 | TCLS1 | TCLS2, TCLS3, TCLS4 | TERMTAB | TID | TIMESTMP |TRACE | TTYLS | TTYPS | ULANG

ADACALL - Access to Adabas

This parameter defines an entry in the Natural openUTM Interface for the subroutine ADACALL. This subroutine must be called each time a non-Natural program accesses Adabas. ADACALL generates a valid Adabas user ID and subsequently invokes the Adabas interface module ADALNN. Possible values are:

ADACOM - Adabas Link Module Usage

This parameter determines which Adabas link module is to be used. Possible values are:

In any case a resolve to the Adabas module library has to be given in the linkage step for the environment-dependent nucleus.

ADAPRI - Activation of Adabas Priority Control for openUTM Application

See Adabas Priority Control for details. Possible values are:

ADAUTM - Synchronization of Async openUTM/Adabas Transactions

This parameter enables you to realize synchronized processing and coordinated restart of asynchronous transactions between openUTM and Adabas. This requires that the module ADAUTM is available; this module must be linked to the Natural environment-dependent nucleus (see the Installation documentation). Possible values are:

Value:	Explanation:
YES	Synchronized processing and coordinated restart of asynchronous transactions between openUTM and Adabas are enabled. Warning: If ADAUTM=YES is specified, the ADACALL parameter must not be set to ADABAS.
NO	This is the default value. Warning: Do not change the default value of this parameter without prior consultation of Software AG support.

APPLNAM - Name of Natural openUTM Application

With this parameter, you specify the name of the Natural openUTM application. The value of this parameter must be identical with the value of parameter APPLINAME in KDCDEF. This name is used to create a name for a task-specific SYSLST file (see also SYSLST parameter below). Possible values are:

The specified name is also used to construct a serialization marker for the initialization routine in the Natural openUTM Interface; an S is inserted in the first free character position (for example, if APPLNAM=NATUTM, the name of the serialization marker is NATUTMS).

Furthermore, this name is used to create an Adabas user ID if TID=N is specified.

A defined character position of the operand of APPLNAM can be used for constructing the Adabas user ID; see parameter TID.

APRISTD - Adabas Priority for Standard openUTM TAC

This parameter can be used to define the Adabas priority nnn for the standard openUTM TAC (default NAT). Possible values are:

The APRISTD parameter is only in effect if the ADAPRI parameter is set to YES. For individual TACs, individual priorities can be defined with the parameters TCLSn and TCLAn; see also Adabas Priority Control.

ASAPPLI - Name of Logical openUTM Communications Partner

This parameter specifies the name of the logical openUTM communications partner (as defined in KDCDEF) of the asynchronous openUTM application. This name is only relevant in the case of asynchronous transaction processing between two openUTM applications. Possible values are:

Value:	Explanation:
name	name specifies the name of the logical openUTM communications partner. Warning: If ASAPPLI=name is specified, the operand of the parameter SYAPPLI must also be defined.
NO	This is the default value.

ASYNTAC - openUTM Transaction Code for Asynchronous openUTM Task or Application

With this parameter you define the openUTM transaction code (TAC) for the openUTM task or application that runs asynchronously. Possible values are:

The specified openUTM TAC must be distinct from the "standard" Natural TAC and also from the TAC used for the synchronous openUTM application (if asynchronous transaction processing is used between two openUTM applications).

The first five characters determine the unique identifier for asynchronous openUTM TACs.

BADTAC - Activation of openUTM Function BADTACS

This parameter enables you to activate the openUTM function BADTACS, which means that in the assembled program of macro NATUTM, the startup program AUTOTAC is generated for undefined openUTM transaction codes. Possible values are:

KDCDEF:

PROGRAM AUTOTAC,COMP=ASSEMB
TAC KDCBADTC,CALL=FIRST,PROGRAM=AUTOTAC,EXIT=NUERROR,TYPE=D
TAC AUTOCONN,TYPE=D,PROGRAM=NATUTM,EXIT=NUERROR,CALL=BOTH

CDYNAM - Maximum Number of Modules to be Dynamically Loaded

This parameter specifies the maximum number of modules to be dynamically loaded (for example, COBOL or Assembler subroutines) and/or the number of modules which have been linked to the Natural environment-dependent nucleus (see the Installation documentation) and declared with parameters LINK to LINK4. Possible values are:

CLRKEY - Activation/Deactivation of CLEAR Key

This parameter activates or deactivates the CLEAR key. Possible values are:

CURPRO - Cursor Positioning to Protected Field

This parameter controls whether the cursor can be positioned to a protected field. Possible values are:

ICONTRL - openUTM Input Exit for Messages in Minus Format

This parameter allows you to generate an openUTM input exit for messages in minus (-) format; that is, messages from a Natural screen. Such an input exit controls the allowed (or not-allowed) user KDC commands. Possible values are:

Examples:

If YES is specified as first operand, the generated input exit must be defined in KDCDEF and KDCROOT as follows:

EXIT PROGRAM=ICONTRL,USAGE=(INPUT,USERFORM)
PROGRAM ICONTRL,COMP=ASSEMB

INITPRG - Value for Natural Variable *INIT-PROGRAM

This parameter defines the value for the Natural variable *INIT-PROGRAM. Possible values are:

KB - Pass KB Address as First Parameter

This parameter specifies whether the address of the openUTM communication area KB (Kommunikationsbereich) is passed as the first parameter address each time Natural calls a non-Natural program. This has been taken account of in the subroutines and utility programs of the Natural openUTM Interface. Possible values are:

KBSAVE - Saving of openUTM KB via SPUT

This parameter specifies whether the openUTM KB will be saved via SPUT or not. Possible values are:

To be able to use this parameter, you must set the following KDCDEF definition:

MAX LSSBS=1

If the user-specific partial openUTM program resumes, the original communication area will be refreshed via SGET. This allows the partial openUTM program to use the KB from the end of the openUTM communication area header plus twelve bytes. Therefore, the program must not destroy these twelve bytes. If a KB user extension is defined, this area will not be saved.

KBUSEXT - Length of openUTM KB User Extension

This parameter specifies the length of a openUTM KB user extension. Possible values are:

Length and address of a user extension are stored in the KB:

For more information, see the DSECT macro CMBS2TP.

LFH - Use of Adabas LFH

This parameter specifies that the Adabas large file handler (LFH) is to be used. Possible values are:

If you specify YES, you also must define the buffer size for the Adabas LFH in the Natural parameter module (parameter VSIZE ).

LINK - Programs and Modules Called from Natural

This parameter enables you to specify the names of programs and modules that are called from Natural programs and linked with the non-reentrant part. Possible values are:

A TABLE macro call is performed for the specified programs and modules, which enters their load addresses into the dynamic loader's link table. It is therefore not necessary to dynamically load these programs when they are called by Natural programs.

Example:

LINK=PROG1
LINK=(PROG1,PROG2,MODUL111)

LINK2/LINK3/LINK4 - Extensions of Parameter LINK

These parameters are an extension of the parameter LINK. Possible values are:

No default value is provided.

Since an operand definition must not be longer than 127 characters (including parentheses), the parameters LINK2 to LINK4 are provided for cases where the operand of parameter LINK would be too long.

Examples:

NATUTM LINK=(PROG1,PROG2,...),
       LINK2=(PROG54,...)
NATUTM LINK=(PROG1,PROG2,PROG3,PROG4)

LOFFMAP - Format Name for Logoff Message

With this parameter, a format name for the logoff message can be specified. Possible values are:

NAT9994 - YOUR SESSION WAS SUCCESSFULLY FINISHED.
PLEASE GIVE "KDCOFF" (LEAVE THE APPLICATION) OR "UTM-TAC".

NAT9994 - Natural TERMINATED NORMALLY

In any case, the operand specified with the LOFFMAP parameter is used as the format name for openUTM. The operand is therefore restricted to a maximum of 8 characters.

NATMON - Automatic Activation of Natural Monitor during Application Startup

This parameter specifies whether the Natural monitor is activated automatically during application startup or not. Possible values are:

NUAADDR - Natural User Thread Address

With this parameter, you specify a Natural user thread address. The following happens if you specify a particular value:

Examples:

When the Natural user thread is allocated above the 16-MB line, the asynchronous write buffer and the thread for asynchronous transactions will also be allocated above the 16-MB line. In this case, the 31-bit address mode will not be switched back to 24-bit address mode before a 3GL program is called. This means the called 3GL program must be able to run in 31-bit address mode.

NUCNAME - Name of Bounded Reentrant Natural Module

This parameter specifies the name of the bounded, reentrant Natural module. Possible values are:

No default value is provided.

You must use the name of the bounded, reentrant Natural module for the Natural pool and load information in macro ADDON (macro ADDON assembles BS2STUB) and for program CMPSTART when a shared nucleus is to be used.

PARMOD - Application Address Mode and Location

This parameter applies to the generation of both the non-reentrant part and the reentrant part. Possible values are:

If you load the environment-dependent nucleus (see the Installation documentation) of the application above 16 MB, this must be defined in the link procedure of the environment-dependent nucleus as follows:

LOADPT=*XS

or

LOADPT=X'address'

Example:

/START-PROGRAM $BINDER
START-LLM-CREATION NATvrs
MODIFY-SYMBOL-ATTRIBUTES SYMBOL-NAME=*ALL,R-MODE=*ANY,A-MODE=31 [,SCOPE=*WHOLE-LLM]
INCLUDE-MODULES .... 
" PARMOD=(nn,loc) MUST ALSO BE DEFINED FOR ASSEMBLING MACRO NURENT, WHICH "
" BELONGS TO THE REENTRANT PART OF NATURAL openUTM; OPERANDS MUST BE IDENTICAL FOR "
" THE NON-REENTRANT AND REENTRANT PARTS. "
SAVE-LLM LIBRARY=...,ELEMENT=NATvrs [(VERSION=vrs)],LOADPT=*XS,...

where vrs represents the current product version.

PENDPR - Define openUTM TAC for PEND PR

This parameter defines a openUTM TAC for a PEND PR. Possible values are:

When PENDPR='zzzzzzzz' is specified, a PEND PR(OGRAM) is executed instead of a PEND FI(NISH) when the FIN system command is entered or a TERMINATE statement is executed or the PEND PR function key is pressed. The openUTM partial program that has been associated with the specified openUTM TAC is started after the PEND PR.

PFK - Function Key Modes

This parameter is used to set one of the following function-key modes:

Where y can be:

PRKEY - openUTM Return Code for Function Key

This parameter is used to define an openUTM return code for a function key (F1 to F5 or K1 to K14). Possible values are:

Whenever a function key defined with this parameter is activated in the Natural dialog, the Natural session is suspended and if an openUTM TAC for another openUTM partial program is available, a PEND PR(OGRAM) is executed.

This openUTM TAC can be defined in several ways:

• with the Natural profile parameter PROGRAM=tac,

• with the parameter PENDPR=tac,

• with the utility program TACSWTCH.

On return from the called openUTM partial program via the PEND PR(OGRAM) to the Natural openUTM Interface, the Natural session is continued at the point where it has been suspended.

The same return code as specified with the PRKEY parameter must also be defined with an SFUNC statement in KDCDEF.

REFRKEY - Definition of openUTM Function Key

This parameter can be used to define an openUTM function key. Possible values are:

If the defined function key is pressed, the last full Natural screen is refreshed. Thus it is possible to continue the dialog with Natural after the screen has been overwritten by messages from the operator or the operating system. The send key code is not passed to the Natural application. The interface sets the Natural key code to ENTER.

ROLLACC - Access Method for Natural Roll File

This parameter defines the access method for the Natural roll file. Possible values are:

Prerequisites for ROLLACC=FASTPAM

To use the FASTPAM option, the following prerequisites apply:

• Parameter TERMTAB must be defined as SWP.

• The class II definition in the batch job for starting the resident FASTPAM environment and the FASTPAM I/O pool must be:

  /START-PROGRAM FROM-FILE=*LI-E(L=NATvrX.BS2.MOD,EL=NATUTM,TYPE=L), -
  /RESIDENT-PAGES=PARAMETERS(MIN=YY,MAX=NNN)

• The FASTPAM authorization in the user catalog must be:

  /SHOW-USER-ATTRIBUTES                  
                   FIELD:DMS-TUNING-RESOURCES=*EXCLUSIVE
  " OR ALTERNATIVELY: "
  /MODIFY-USER
                            FIELD: DMS-TUNING-RESOURCES=EXCLUSIVE-USE>

• The BIAS for the BS2000 operating system must be defined as follows:

  /MODIFY-SYSTEM-BIAS MAX-RESIDENT-PAGES=nnn

To calculate the necessary number of resident core pages, use the following formula (ignore all rest values):

(ROLLTSZ) + 3 / 4 * 2                      = N1 (FASTPAM I/O areas)
((ROLLTSZ + 31) / 32 * 36 + 4095) / 4096 * 2 = N2 (FASTPAM access lists)

N1 + N2 = number of resident pages for one Natural openUTM task

ROLLTSZ - Maximum Roll Thread Size

This parameter determines the maximum roll thread size nnn (in KB); that is, the maximum size of a compressed user thread on the Natural roll file. Possible values are:

If ROLLACC=UPAM-AS, valid values for ROLLTSZ are 4 to 1600 (KB).

If ROLLACC=UPAM-SY or ROLLACC=FASTPAM, valid values for ROLLTSZ are 4 to 3200 (KB).

To calculate the size of the Natural roll file, use the following formula:

ROLLTSZ / 2 * maximum number of users = nnn

nnn is the number of PAM pages for the Natural roll file.

As user threads are generally written to the roll file in compressed form, an optimum roll thread size contributes considerably to saving disc storage.

The optimum value for nnn can be ascertained with the Natural Swap Pool Statistics; see the SYSLST parameter.

RSTCNT - Control of Restart Situations

This parameter can be used to control restart situations in which the "lifetime" of a user results from an old Natural openUTM session. Possible values are:

RSTWARM - Control of Restart Situations

This parameter can be used to control restart situations. Possible values are:

SCRNOPT - Terminal Types with Deactivated Natural Screen Optimization

This parameter can be used to define (one or two) terminal types for which Natural screen optimization is to be de-activated. Possible values are:

Example:

SCRNOPT=(FL=Z9)

where:

This example would deactivate screen optimization for those 3270-type terminals which are defined as TERMN=Z9 in KDCDEF.

SHUTALL - Name of User Exit

With this parameter, you can specify the name of a user exit. Possible values are:

This user exit is invoked by the Natural openUTM Interface whenever an openUTM task is terminated with KDCSHUT, provided that the openUTM SHUTDOWN function has been defined in KDCDEF.

SHUTLST - Name of User Exit

With this parameter, you can specify the name of a user exit. Possible values are:

This user exit is invoked by the Natural under openUTM when the last openUTM task is terminated with KDCSHUT, provided that the openUTM SHUTDOWN function has been defined in KDCROOT.

SPOOL - Automatic Start and Termination of Printer Task

This parameter enables you to specify a spooling system. Possible values are:

No default value is provided

The following topics are covered below:

• Using NATSPOOL
• NATSPOOL Processing Logic
• Using REPRO-2000 Remote Spooling System
• Using RMSPOOL User Exit

Using NATSPOOL

When using NATSPOOL (Natural Advanced Facilities), the SPOOL parameter can be used to indicate that the printer task(s) required by NATSPOOL are to be started up automatically by means of ENTER calls whenever the Natural openUTM application is started, and terminated whenever the application is shut down. In this case, the operands of the parameter must be:

SPOOL=(NATSPOOL,'enter-parm',n)

where:

Example:

The following ENTER job is to be automatically started and terminated. The file name is AF.E.PRINT:

/LOGON
/OPTION MSG=FHL
/SYSFILE SYSLST=FILE
/EXEC NAFPTTSK
/LOGOFF

Operand definition for the parameter SPOOL:

SPOOL=(NATSPOOL,'AF.E.PRINT,TIME=999',2)

In this example, NATSPOOL is the name of the Natural spooling system; AF.E.PRINT is the file name of the ENTER job to be started and terminated; TIME=999 is an additional, optional parameter for the ENTER call (see the description of the BS2000 ENTER macro); and 2 means that two NATSPOOL printer tasks are to be started/terminated.

The second suboperand can contain any valid operands (enclosed in apostrophes) for the ENTER macro call.

The operand of parameter SPOOL in macro NURENT must be NATSPOOL.

NATSPOOL Processing Logic

The specified number of NATSPOOL printer tasks according to the operand definition in the parameter SPOOL is started when the application is started up. Interprocess communication is then used to check that at least one printer task is running. If this condition is not satisfied, the application is set to status SYSTEMERROR, an error message is output on the console and users who attempt to logon are rejected with the message:

NUI0036 - SYSTEMERROR ... PLEASE GIVE KDCOFF

For more information on this system error, see error message NUI0036.

Using REPRO-2000 Remote Spooling System

If a remote spooling system is used (for example, TD-SPOOL or REPRO-2000), set SPOOL=REPRO-2000 in the macros NATUTM and NURENT. This function is not supported by Software AG.

The logic used by Natural offline reports must be considered when implementing the interface module for a remote spooling system (see macro NURENT, label CMWHC). When an offline report is activated, Natural transfers output a record at a time. The logic for sending and accepting print records, the layout of the print record, etc., are in macro NURENT, subroutine CMWHC.

Using RMSPOOL User Exit

If you use your own user exit program named RMSPOOL as remote spooling interface, set SPOOL=RMSPOOL in the macros NATUTM and NURENT. See User Exits for details on the user exit RMSPOOL.

STRTALL - Name of User Exit for All openUTM Tasks

With this parameter, you can specify the name of a user exit. This user exit is invoked by Natural under openUTM whenever a openUTM task is started. Possible values are:

STRTFST - Name of User Exit for First openUTM Task

With this parameter, you can specify the name of a user exit. This user exit is invoked by Natural under openUTM when the first openUTM task is started, provided that the openUTM STARTUP function has been defined in KDCDEF. Possible values are:

SVDYPRM - Save Area Length for Dynamic Natural Parameters

This parameter determines the length in bytes of a save area for dynamic Natural parameters in the openUTM KB. These parameters are used when a Natural openUTM session is restarted. Possible values are:

SWAMODE - Switching from 31 to 24-Bit Address Mode

This parameter determines whether a 31-bit address mode is switched to 24-bit mode or not before a PEND PR is executed. What you must set depends on whether the partial openUTM program can run in 31-bit address mode (NO) or not (YES). Possible values are:

SWDPAGE - Pageability of Swap Pool Main Directory

This parameter determines whether the swap pool main directory is pageable or not. Possible values are:

A swap pool directory that is not pageable improves performance considerably. In that case, the BS2000 macro CSTAT will be used to declare the swap pool directory as not pageable. To be able to specify SWDPAGE=NO, you must define the maximum and minimum of resident core pages in the startup job.

Example:

/START-PROGRAM FROM-FILE=*LI(EL=E.NATvrs,LI=NATvrs.MOD),RES-PAGES=*PA(MIN=2,MAX=4)

where vrs represents the current product version.

For more information, see the description of BS2000 macro CSTAT or the description of BS2000 command EXECUTE, operand CLASSII or, when SDF is used, the description of BS2000 command START-PROGRAM, operand RESIDENT-PAGES=PARAMETERS...

If the call to macro CSTAT fails, the application is still able to run.

SWPUSID - Swap Pool User Identification

This parameter determines the swap pool user identification. Possible values are:

Warning:

The value KCBENID must not be specified if either or both of the following conditions in the KDCDEF of the Natural openUTM application apply:

1. SIGNON with parameter MULTI-SIGNON=YES is set;

2. UPIC or terminal server clients are defined in an LTERM pool (TPOOL) with CONNECT-MODE=MULTI set.

In both cases, KCBENID might not be unique and thus not suitable as swap pool user identification.

SYAPPLI - Name of Logical openUTM Communications Partner

With this parameter, you can specify the name of the logical openUTM communications partner (as defined in KDCDEF) of the synchronous openUTM application. Possible values are:

The operand is only significant in the case of asynchronous transaction processing between two openUTM applications.

SYNTAC - openUTM TAC for Sending Messages from Async to Sync openUTM Applications

This parameter defines the openUTM transaction code used to send free messages for a terminal from the asynchronous to the synchronous openUTM application. Possible values are:

The openUTM TAC specified in this parameter must be distinct from the "standard" Natural TAC and also from the TAC used for the asynchronous openUTM application.

SYSLST - SYSLIST File Generation for openUTM Task

This parameter defines whether a SYSLST file is generated for each openUTM task or not. The SYSLST file contains statistics data and error information (if a openUTM task ends abnormally). Possible values are:

The name of a SYSLST file is LST.name.tsn, which is generated from the following components:

TACEND - Action at PEND

This parameter defines the action to be taken in conjunction with the openUTM operation key PEND. Possible values are:

TCLA1 - openUTM TACs for Async Transaction w. Priority Level 1

This parameter allocates openUTM TACs for asynchronous transactions with priority level 1 using the openUTM TACCLASS concept. A TAC table is constructed that can be accessed from Natural programs by means of the subroutine NATTAC, passing a priority level as parameter; see openUTM TACCLASS Concept (Priority Control). 

Possible values are:

TCLA2, TCLA3, TCLA4 - openUTM TACs for Async Transaction w. Priority Levels 2, 3, 4

These parameters allocate openUTM TACs for asynchronous transactions with priority levels 2, 3 and 4  using the openUTM TACCLASS concept. Their values are used analogous to TCLA1 (see above). Possible values are:

TCLS1 - openUTM TACs for Async Transaction w. Priority Level 1

This parameter allocates openUTM TACs for synchronous transactions with priority level 1 using the openUTM TACCLASS concept. A TAC table is constructed that can be accessed from Natural programs by means of the subroutine NATTAC, passing a priority level as parameter; see openUTM TACCLASS Concept (Priority Control).

Possible values are:

TCLS2, TCLS3, TCLS4 - openUTM TACs for Async Transaction w. Priority Levels 2, 3, 4

These parameters allocate openUTM TACs for asynchronous transactions with priority levels 2, 3 and 4  using the openUTM TACCLASS concept. Their values are used analogous to TCLS1 (see above).

Possible values are:

TERMTAB - Terminal Control Table for Natural Roll File Management

This parameter defines the terminal control table needed to manage the Natural roll file. Possible values are:

The terminal control table is allocated either in the Natural swap pool or in the Natural roll file. It contains a header (48 bytes) and an entry for each active user or active session. Its size depends on the size of the Natural roll file, on the value of the parameter ROLLTSZ and on the length of its own entries.

The Natural openUTM Interface computes the length of the terminal control table as follows:

Roll file pages / (ROLLTSZ / 2) = N

N * terminal control table entry length + 48 = length of the
          terminal control table

Explanation of Operands

Examples:

TERMTAB=(2,TERMNAME)

The maximal number of entries in the terminal control table: 2 * 2048 - 48 / 10 = 404

TERMTAB=(1,INTERNID)

The maximum number of entries in the terminal control table: 1 * 2048 - 48 / 2 = 1000

TID - Adabas User ID Construction Method

This parameter specifies the method to be used to construct the "unique" Adabas user ID. Possible values are:

Value:	Explanation:
n	The Adabas user ID is constructed from the defined (n) character of the operand of the parameter APPLNAM (default value: N) and the last two characters of the user's first SWAPPAMKEY. n must be a number in the range of 1 to 8. Warning: If you specify TID= n, the "defined character" of the value specified with the parameter APPLNAM must be different from that of other Natural openUTM applications if these use the same Adabas; otherwise, the uniqueness of the Adabas user IDs - and thus data consistency - cannot be guaranteed.
(T, n)	A unique 4-byte user ID is constructed by taking characters n to (max. n +3) of the logical openUTM terminal name (KCLOGTER). n must be a number in the range 1 - 8. The resulting character string must consist of valid characters (0 - 9 and A - F) and must be unique. See example below.
(U, n)	The characters are taken from the openUTM user ID (KCBENID), starting at the position specified by the second subparameter. The resulting character string must consist of valid characters and must be unique.
(TID=1)	The Adabas user ID consists of the first digit from the operand of parameter APPLNAM and of the two-byte entry number in the terminal control table. This is the default value.

Example:

TID=(T,4)

If "mixed" Adabas calls occur within one Natural openUTM application (that is, calls from both Natural and non-Natural programs), the Adabas user ID can be found using the ENTRY CMTRMID in macro NATUTM. The current Adabas user ID (4 bytes) can be found at address CMTRMID; see also the parameter ADACALL.

Example:

EXTRN CMTRMID
.
.
L R1,CMTRMID
MVC ADAID(4),0(R1)

For the Adabas user ID, the full terminal name (KCLOGTER) will be used when TID=(T, n) or the full user ID (KCBENID) will be used when TID=(U,n). Default is TID=((T,1).

TIMESTMP

With this parameter, you specify the timebase for all system variables and timestamps derived from the machine time.

Possible values:

TRACE - Trace File Number and Trace Print Record Length

With this parameter, you specify the number of a trace file and the maximal length of a trace print record. Possible values are:

If any external Natural trace function is active, the trace records will be written to SYSLST nn. In this case, the Natural openUTM driver creates the following trace file:

Example:

applname.Natural.TRACE,SPACE=(90,60)
SYSFILE SYSLSTnn=applname.Natural.TRACE
" applname is the application name "

This file will be used by all tasks of the Natural openUTM application. Before the Natural openUTM application is terminated, the trace file will be closed as follows:

SYSFILE SYSLSTnn=(PRIMARY)

To activate the Natural trace functions, see the parameters ETRACE and ITRACE of the Natural parameter module.

TTYLS - Physical Line Size for TTY Devices

With this parameter you can adjust Natural's physical line length to different paper formats used with a telex machine. Possible values are:

TTYPS - Physical Page Size for TTY Devices

With this parameter you can adjust Natural's physical page size to different paper formats used with a telex machine. Possible values are:

ULANG - Session Language Indicator

This parameter determines the language of the restart message, the logoff message, and the "free-running messages". Possible values are:

NATUTM Macro Entries

• CMKBADR - Current Address of openUTM KB

• User Area in the Swap Pool Directory

CMKBADR - Current Address of openUTM KB

The entry CMKBADR holds the current address of the openUTM communication area KB(Kommunikationsbereich).

The communication area can be accessed as shown in the following example, which illustrates an Assembler program that could be called from a Natural program.

Example:

EXAMPLE CSECT
        STM   14,12,12(13)
        USING EXAMPLE,15
        L     2,VCONST         LOAD ADDRESS OF KB-ADDRESS
        L     3,0(,2)          LOAD ADDRESS OF KB
        .
        .
        LM    14,12,12(13)
        BR    14
VCONST  DC    V(CMKBADR)       ENTRY ADDRESS
        END

In this case, the program name EXAMPLE must be defined with the parameter LINK or LINK2 of macro NATUTM, and the program itself must be linked to the Natural environment-dependent nucleus (see the Installation documentation).

User Area in the Swap Pool Directory

One fullword is available for user-defined purposes in the Natural swap pool directory - see label USERWRD in DSECT MEMPOOL of macro NAMSWDIR. This word can be used for synchronization, for example, for switching accounting on and off, whilst the Natural openUTM application is running.

The following example shows how this area can be addressed.

Example:

         WXTRN CMKBADR       ENTRY IN MACRO NATUTM
PROG     CSECT
         STM   14,12,12(13)  SAVE REGISTERS
         USING PROG,15       BASE OF PROGRAM
         USING KB,4          BASE OF UTM KB
         USING MAINDIR,5     BASE OF SWAP POOL DIRECTORY
         L     3,KBADR       LOAD ADDRESS OF KB ADDRESS
         L     4,0(,3)       LOAD ADDRESS UTM KB
         L     5,ASWPDIR     ADDRESS SWAP POOL DIRECTORY
         OI    USERWRD+3,1   SET THE LOW ORDER BIT OF FIELD
*                            USERWRD TO 1
         LM    14,12,12(13)  RELOAD REGISTERS
         BR    14            RETURN
KBADR    DC    A(CMKBADR)    ENTRY IN MACRO NATUTM
         NAMSWDIR            MACRO CALL FOR SWAP POOL DSECT
MAINDIR  DSECT
         .
         .
USERWRD  DS    F             DIRECTORY USER AREA
         .
         CMKBNEX             MACRO CALL FOR UTM KB DSECT
KB       DSECT
         .
         .
ADRSWAP  DS    F             ADDRESS OF Natural SWAP POOL
         .
         END

When working in this area, the user must take care not to overwrite any other data in the swap pool directory. Mistakes could lead to abnormal termination of the openUTM task.

NURENT Macro Parameters

The following parameters are available:

ACCNT | ATTKEY | AUTOLINK | CALLM31 | CLR3270 | EXTAPPL | FPUT | ILCS | K2 | PARMOD | SCRNTRC | SPOOL | UINPEX | UOUTEX

ACCNT - Call Logic for User Account Routine

This parameter is used to define the logic for call of the user account routine (user exit ACCEXIT). Possible values are:

ATTKEY - Attention Interrupt Key

This parameter is used to define an attention interrupt key. Such a key definition only makes sense for output in non-conversational mode. Possible values are:

AUTOLINK - Use of AUTOLINK Function

This parameter specifies whether the AUTOLINK function of the dynamic binder/loader for loading of 3GL programs is activated or not. Possible values are:

CALLM31 - Switching from 31 to 24-Bit Address Mode

This parameter is only relevant if Natural is generated for the 31-bit addressing mode and the front part is loaded below (PARMOD=31, see below).

Exceptions:

• The 3GL program is loaded above the 16-MB line.

• The address of the parameter list is above the 16-MB line.

CLR3270= xxx - Definition of CLEAR Key

This parameter defines the CLEAR key in the AID character table V (AID3270) for 3270-type devices (IBM).

EXTAPPL - openUTM TERMN Name of External DCAM or PDN Applications

This parameter defines the openUTM TERMN name (see the parameter PTERM of openUTM KDCDEF) of external DCAM or PDN applications. For these TERMN names, the MGET return code 05Z (format changed) is ignored. Possible values are:

No default value is provided.

FPUT - Operation Supplement for Printing via KDCS-Call FPUT

This parameter defines the operation supplement for printing via KDCS-Call FPUT to a printer which is defined in the openUTM KDCDEF.

ILCS - Support of CRTE or ILCS

This parameter specifies whether the common runtime environment for calls (CRTE) or the ILCS interface for calls of 3GL programs will be supported. Possible values are:

INCLUDE-MODULES LIBRARY=SYSLNK.CRTE.010,ELEMENT=IT0SL#
RESOLVE-BY-AUTOLINK LIBRARY=SYSLNK.CRTE.01

INCLUDE-MODULES LIBRARY=SYSLNK.ILCS,ELEMENT=IT0INITS
RESOLVE-BY-AUTOLINK LIBRARY=SYSLNK.ILCS

K2 - openUTM Return Code for K2 Key

This parameter specifies the openUTM return code for the K2 key (for Natural PA2)

PARMOD - Application Address Mode and Location

This parameter applies to the generation of both the non-reentrant part and the reentrant part. Possible values are:

PARMOD=(nn,loc) must also be defined for assembling macro NATUTM. Operands must be identical for the non-reentrant part and the reentrant part.

SCRNTRC - Tracing of Screen I/Os

This parameter is used for debugging screen I/O to find out the reason for certain error situations. If this parameter is set to ON/(ON, nn), a special debug buffer for each user will be allocated (default buffer size is 3 KB). Possible values are:

Warning: You should only set this parameter to ON/(ON, nn) after having consulted with Software AG Technical Support.

SPOOL - Hardcopy Destination

This parameter enables you to specify a spooling system. The value for this parameter must correspond to the value for the SPOOL parameter in macro NATUTM. Possible values are:

UINPEX - Name of User Exit

With this parameter, you can specify the name of a user exit. This user exit is invoked by Natural under openUTM after a terminal message has been sent; see also User Exits. Possible values are:

UOUTEX - Name of User Exit

With this parameter, you can specify the name of a user exit. This user exit is invoked by Natural under openUTM before a terminal message is to be sent; see also User Exits.