INIT Initialize program unit

The INIT (initialize program) call is used to sign-on a program unit to openUTM. There are the following variants.

• INIT (no entry in KCOM)
  Initialize program unit

• INIT PU (Program Unit)
  Initialize program unit and request additional information.

• INIT MD (Modifiy)
  Initialize program unit and modify the size of the KB program area.

The following applies for these variants.

• The INIT call initiates cooperation between the program unit run and openUTM. It is the first KDCS call allowed in a program unit run, i.e. you are not allowed to enter any other KDCS or database calls prior to the INIT call.

• You are not allowed to enter INIT or INIT PU more than once in a program unit run.

• INIT MD may be specified more than once in a program unit. If you specify the INIT MD call as the first INIT call in the program unit, it is treated like an INIT without an operation modifier.

• You may not use the communication area (KB) and the standard primary working area (SPAB) between start of the program unit run and the first INIT call.

• Following the first INIT, openUTM makes the entire communication area (KB), including the KB parameter area, available to the program unit run. This area has the length specified in KCLKBPRG/kclcapa.

• The INIT MD call enables the length of the KB program area to be adjusted during the program unit run. This may be necessary if, for example, the size of the KB program area that openUTM is to save with the PEND call is not determined until processing has started.
  Example: Data that is read from a database is to be saved in the KB program area. If the length of the KB program area is adjusted to the volume of data read by INIT MD, openUTM need not save more data than necessary or less data than necessary at the synchronization point.

• If you use the INIT call with the operation modifier PU (Program Unit), openUTM provides the program unit additional information about application, system and communication partner in the message area.

Setting the 1st parameter (KDCS parameter area)

The following table shows the necessary entries in the KDCS parameter area.

Function of the call	Entries in the KDCS parameter area
	KCOP	KCOM	KCLKBPRG/kclcapa	KCLPAB/kclspa	KCLI
Initialize program unit	"INIT"	—	Length of KB program area	Length of SPAB	—
Initialize program unit and request information	"INIT"	"PU"	Length of KB program area	Length of SPAB	Length of message area
Modify length of KB program area	"INIT"	"MD"	Length of KB program area	—	—

The specified length of the KB program area must not be greater than the maximum length defined for this application at generation (operand KB in the MAX statement for KDCDEF).

The specified length of the SPAB  must not be longer than the value defined at generation (operand SPAB in the MAX statement for KDCDEF).

Setting the 2nd parameter (only necessary with INIT PU)

Here you enter the address of the message area to which openUTM is to write the requested information.

You can use language-specific data structures to structure the message area. For COBOL, they are defined in the KCINIC COPY element and for C/C++ in the kcini.h include file.

Specify the version number of the structure and select the return information requested from openUTM in the header of the data structure. These other fields (return information) are described in section "Structure of the message area with INIT PU".

Setting the parameters
Field name in the KDCS parameter area	Contents
KCOP	"INIT"
KCOM	—/ "PU"/"MD“
KCLKBPRG/kclcapa	Length in bytes
KCLPAB/kclspa	Length in bytes
KCLI	Length in bytes (with INIT PU)

Setting the header in the message area (only necessary with INIT PU)
Field name in message area	Contents
KCVER/if_ver	Version number (7)
KCDATE/dattim_info	Request date and time (Y/N)
KCAPPL/appl_info	Request application information (Y/N)
KCLOCALE/locale_info	Request Locale information (Y/N)
KCOSITP/ositp_info	Request OSI TP information (Y/N)
KCENCR/encr_info	Request encryption information (Y/N)
KCMISC/misc_info	Request miscellaneous information (Y/N)
KCHTTP/http_info	Request HTTP information (Y/N)

KDCS call
1st parameter	2nd parameter
KDCS parameter area	— / Message area (with INIT PU)

C/C++ macro calls
Macro names	Parameters
KDCS_INIT	(kclcapa,kclspa)
KDCS_INITPU	(nb,kclcapa,kclspa,kcli)
KDCS_INITMD	(kclcapa)

openUTM return information
Message area (only with INIT PU)	Contents
	INIT PU information
KB header area
	Current service data
Field name in KB return area
KCRLM (only with INFO PU)	Length of transferred data
KCRCCC	Return code
KCRCDC	Internal return code
KCRMF/kcrfn	Format identifier/blanks
KCRPI	Service ID/Rollback ID/blanks
KB program area
KCKBPRG/kclcapa	Data

For the INIT call you make the following entries in the KDCS parameter area:

KCOP

In the KCOP field, enter the INIT operation code.

KCOM

In the KCOM field, the operation modifier:

• PU if openUTM is to make additional information available in the message area

• MD if the length of the KB program area is to be changed

KCLKBPRG/kclcapa

In the KCLKBPRG/kclcapa field, enter the length of the KB program area in bytes. It must not exceed the length predefined at generation time (operand KB in the MAX statement), otherwise the generated value is taken.

Only with INIT or INIT PU:

KCLPAB/kclspa

In the KCLPAB/kclspa field, enter the length of the standard primary working area (SPAB) used in the program unit run in bytes. It must not exceed the length predefined at generation time (operand SPAB in the MAX statement).

Only with INIT PU:

KCLI

in the KCLI field, enter the length of the message area to which openUTM is to transfer the information. Enter the length in bytes. The information transferred to the message area by openUTM has a maximum length of KCLI. To obtain all available information, you must specify the value 372 in the current interface version.

Setting the header of the message area (only necessary with INIT PU):

KCVER/if_ver

In the KCVER/if_ver field, enter the version number of the data structure. The current version is version 7.

KCDATE/dattim_info

Enter Y in the KCDATE/dattim_info field if you want information on the date and time of the start of the application and the program unit run, otherwise enter N.

KCAPPL/appl_info

Enter Y in the KCAPPL/appl_info field if you want to request information about the application, system and communication partner, otherwise enter N.

KCLOCALE/locale_info

Enter Y in the KCLOCALE/locale_info field if you to want to request information about the language environment of the user ID, otherwise enter N.

KCOSITP/ositp_info

Enter Y in the KCOSITP/ositp_info field if you require OSI TP specific information, otherwise enter N.

KCENCR/encr_info

Enter Y in the KCENCR/encr_info field if you require information on the encryption methods used to encode between the client and the UTM application, otherwise enter N. (The encryption mechanism can be coordinated. See the openUTM manual “Generating Applications”.)

KCMISC/misc_info

Enter Y in the KCMISC/misc_info field if you require miscellaneous information (e.g. number of queued messages in the user’s queue, password validity, time of last signon), otherwise enter N.

KCHTTP/http_info  

Enter Y in the KCHTTP/http_info field if you require HTTP specific information, otherwise enter N.

You specify the following for the KDCS call:

1st parameter

the address of the KDCS parameter area.

2nd parameter

(only necessary with INIT PU): the address of the message area to which openUTM is to write information (see "Setting the 2nd parameter").

Macro names

The use of C/C++ macro calls is described in detail in the section "C/C++ macro interface".

openUTM returns:

Message area

only with INIT PU:
in the message area, the information transferred by openUTM up to a maximum length of the value specified in KCLI.

KB header area

in the KB header area the current data of the KB header (see table).

KCRLM

only with INIT PU: in the KCRLM field, the actual length of the information available in UTM. If a lower value has been entered in the KCLI field, the information is returned at the length specified in KCLI and KCRCCC is set to 07Z.
If KCRCCC >= 40Z, no information is transferred. Thus, in such cases KCRLM=0.

KCRCCC

in the KCRCCC field, the KDCS return code, see below

KCRCDC

in the KCRCDC field, the internal return code of openUTM (see the openUTM manual ”Messages, Debugging and Diagnostics”).

KCRMF/kcrfn

Only with INIT or INIT PU:

• For a message from a terminal:

  Blanks (in line mode) or the format name (in format mode) of the last screen output, i.e. the name specified in the KCMF/kcfn field with the MPUT of the last dialog step. If the last output consisted of multiple partial formats, KCRMF/kcrfn contains the name of the first partial format into which data was entered. If no data was entered in any of the partial formats, KCRMF/kcrfn contains the name of the first partial format.

  Only on BS2000 systems: If an edit profile was used in the last screen output, KCRMF/kcrfn contains this edit profile.

• for a message from a TS application or a program unit of the same application: blanks.

• if a rollback message exists (after PEND RS): blanks.

• for a message from the LU6.1 partner or UPIC client:

  The format identifier of the first message segment specified by the LU6.1 partner or UPIC client on sending.

  Particularity in the job-submitting service:

  Blanks if a status flag exists for the service ID specified in KCRPI.

• for distributed processing via OSI TP:

  If the program unit run was started because of a distributed dialog, KCRMF/kcrfn in the job-submitting service contains the name of the abstract syntax which was allocated to the message by the job submitter; if the field contains blanks, the abstract syntax of the UTD syntax is selected.

  In the job-receiving service KCRMF/kcrfn contains the name of the abstract syntax which was allocated to the message by the job-receiving service described in KCRPI. If the field contains blanks, the abstract syntax of the UTD syntax is selected or an error message from the partner is present.

KCRPI

Only with INIT or INIT PU:

• For a message from a UPIC client program, terminal, a TS application or a program unit in the same application: blanks.

• If a rollback message exists: the rollback ID.

• In the job-submitting service with distributed processing:
  the service ID of the job-receiving service if a message from the job receiver exists.

• In the job-receiving service with distributed processing: blanks

KCKBPRG/kclcapa

In the KCKBPRG/kclcapa (KB program area) field, the data of the service, provided the program unit run includes service-specific data from another program. If this is the first program unit run of a service, the area is undefined or set with the generated fill character. If length zero is specified in KCLKBPRG/kclcapa of the preceding program unit, no data is transferred to the follow-up program unit run.

KDCS return codes in the KCRCCC field for the INIT call

The following codes can be analyzed in the program:

000	Operation carried out. For INIT PU: the requested information was transferred to the message area in full length.
01Z	Length specified in KCLKBPRG/kclcapa exceeds value specified when the application was generated.
02Z	For INIT or INIT PU: Length specified in KCLPAB/kclspa exceeds value specified when the application was generated.
07Z	For INIT PU: Function was executed, the available message area is too short (length in KCLI insufficient). No or incomplete information was returned.
48Z	For INIT PU: Invalid data structure version.

Additional error codes can be found in the dump:

71Z	For INIT or INIT PU: INIT call already issued in this program unit run.
73Z	Negative length specification. With INIT PU: KCLI is invalid.
77Z	Message area is missing or cannot be accessed in the specified length.
88Z	Interface version is invalid.
89Z	For INIT PUT or INIT MD: When the function was called, unused parameters were not set to binary zero.

openUTM return information in the header of the KDCS communication area

openUTM returns the following entries among others to the INIT call: the TAC of the service start, current TAC, date, time and the LTERM partner of the sender .
The generated length of the KB program area is located in the KCLKBPB/kclpa field. The table below shows which entries openUTM returns in the KB header:

Field name COBOL	Field name C/C++	Contents (entered by openUTM)
KCBENID	kcuserid	UTM user ID under which the service was initiated. When working without user IDs: KCBENID/kcuserid=KCLOGTER. With distributed processing via LU6.1:local session name (LSES). With distributed processing via OSI TP and Security type “N”: Local name of the connection (OSI-TP association), otherwise user ID
Service-specific data:
KCTACVG	kccv_tac	TAC used to start this service
KCTAGVG	kccv_day	Day of service start
KCMONVG	kccv_month	Month of service start
KCJHRVG	kccv_year	Year of service start
KCTJHVG	kccv_doy	Working day of service start
KCSTDVG	kccv_hour	Hour of service start
KCMINVG	kccv_minute	Minute of service start
KCSEKVG	kccv_second	Second of service start
KCKNZVG	kccv_status	Service ID F: First program unit run of dialog service A: First program unit run of an synchronous service N: Follow-up program unit run of service C: First program unit of a chained service R: Restart of a service D: End of service through loss of connection (only with LTERM partners which have been generated with RESTART=NO) Z: End of service by abort E: Normal end of service L: End of last process with normal termination
		The service identifiers D, Z, E can only occur in the VORGANG exit, the service identifier L only in the SHUT exit. All other service identifiers can occur either in the KDCS call INIT or in the exit VORGANG.
Program unit-specific data:
KCTACAL	kcpr_tac	TAC used to address the program
KCSTDAL	kcpr_hour	Hour of program unit start
KCMINAL	kcpr_minute	Minute of program unit start
KCSEKAL	kcpr_second	Second of program unit start
KCAUSWEIS	kccard	ID card identifier: A (card inserted) or blanks.
KCTAIND	kctaind	Transaction indicator: F (first) or N (next transaction)
KCLOGTER	kclogter	LTERM name; for distributed processing: (OSI-)LPAP name
KCTERMN	kctermn	Communication partner identifier, for distributed processing via LU6.1: CON....,TERMN=, for distributed processing via OSI TP: OSI-LPAP....,TERMN= otherwise: PTERM ..., TERMN (see also the table by PTERM in the openUTM manual “Generating Applications”)
KCLKBPB	kclpa	Maximum length of the KB program area as defined at generation time
Data for service stack:
KCHSTA	kchsta	Stack height, i.e. the number of stacked services as seen from the current service (0 through 15).
KCDSTA	kcdsta	Change of stack height: + (increased), - (decreased) or 0 (unchanged, also in the event of stacking after returning from an inserted service)
KCPRIND	kcprind	Program indicator: A =asynchronous service, D = dialog service
KCOF1	kcof1	OSI TP functions in an OSI TP job-receiving service.
KCCP	kccp	Indicator for the client protocol: 0: Asynchronous processing 1: LU6.1 2: OSI TP 3: UPIC 4: DTP (Unix, Linux and Windows systems) 4: TIAM (BS2000 systems) 5: APPLI 6: SOCKET (USP) 7: HTTP 8: USP-SECURE 9: HTTPS
KCTARB	kctarb	Information on rollback of an OSI TP transaction
KCYEARVG	kccv_year4	Year of service start (four positions)

Features of the KB program area and the SPAB

• The KB program area is assigned to a service, the SPAB to a program unit run.

• At the start of the service the contents of the KB program area and the SPAB are undefined or the areas are preset with the generated fill character.
  Such a fill character can be used, for example, to facilitate error location in the test or for data protection. The SPAB and KB program area are preset with this character at the start of a process and overwritten with it at the end of a processing step, see openUTM manual “Generating Applications”.

• If, at the INIT of a program unit, a KB program area is defined with a length of n bytes and a larger KB program area of m bytes (m > n) is requested in the next program unit run, the last (m - n) bytes of the KB program area are likewise undefined or padded with the generated fill character.

Particularities of the INIT calls with distributed processing

• INIT call in the job-submitting service

  If the distributed transaction is rolled back, openUTM returns the service indicator "R" at INIT of the first transaction of a follow-up transaction (in the KCKNZVG/kccv_status field of the KB header). In this case it is usually status information of the job-receiving service.

  In the follow-up program unit the INIT call in the job-submitting service supplies the following additional information in the KDCS return area:

  • KCRPI contains the service identifier of the job-receiving service which started this program unit.

  • KCRMF/kcrfn contains the format identifier which the job-receiving service entered in the first message segment to the job-submitting service, otherwise blanks.

• The first MGET call for reading the results must be issued with KCRN=KCRPI and KCMF=KCRMF (or: kcfn=kcrfn).

• INIT call in the job-receiving service

  There are the following modifications for entries in the KB header:

  KCBENID/kcuserid

  With LU6 protocol: contains the local session name (LSES name, see the LSES statement for KDCDEF)
  With OSI TP protocol with security type “N”: local association name (see ASSOCIATION-NAMES operand in the KDCDEF statement OSI-LPAP), otherwise user ID

  KCAUSWEIS/kccard

  Contains blanks, i.e. ID card reader is not supported.

  KCLOGTER

  Contains the logical name of the partner application (LPAP name or (MASTER-)OSI-LPAP name, see LPAP statement for LU6.1 protocol, or OSI-LPAP statement for OSI TP protocol: for KDCDEF).

  KCTERMN

  Contains the identifier (Terminal Mnemonic) of the partner application, (see operand TERMN= of the CON statement for LU6.1 protocol, or the OSI-LPAP statement for OSI TP protocol: for KDCDEF).

  KCOF1

  shows the OSI TP functions in an OSI TP job-receiving service for the dialog used to select the job submitter. The following values are possible:

  
  

  Blanks	The current service is not a job-receiving service or the OSI TP protocol is not used for communication with the job-submitting service.
  B	Basic functions
  H	Basis and handshake functions
  C	Basic and commit functions with chained transactions
  O	(other combination) No standard combination of OSI TP functions was selected for the dialog with the job submitter. The selected OSI TP functions can only be read with an INIT PU call.

  
  

  KCCP (client protocol)

  shows the protocol used for the communication:

  
  

  1	LU.1
  2	OSI TP

  
  

  KCTARB

  shows in an OSI TP service whether a situation occurred in a previous PGWT call which requires the rollback of a transaction:

  
  

  Blanks	a situation has occurred which requires the rollback of the transaction.
  Y	a situation has occurred in a previous PGWT call which does not permit the commit of the transaction and the transaction has not been rolled back yet. Communication with the partner services is permitted. A call to commit the transaction results in an abnormal end of service.

The KCRMF/kcrfn field in the KB return area provides information about the partner service.

Message area returns with INIT PU

If you use the INIT call with the operation modifier PU, openUTM supplies additional information for the program unit in the message area about application, system and communication partner.

You can use language specific data structures to structure the message area. For COBOL, they are defined in the KCINIC COPY element and for C/C++ in the kcini.h include file. In the header of the data structure you have to define which information openUTM is to return.

openUTM supplies the following information:

• The generated lengths for the KB program area and the standard primary working area. Any variant of the INIT PU call supplies this information.

• Date and time of the application starts and the start of the program unit run.

• Information about application and system

• Information about the communication partner:

  In a dialog service, this are information about:

  • name of the communication partner

  • host name of the communication partner

  • name of the UTM application via which communication with the communication partner was established (BCAMAPPL name)

  In an asynchronous service blanks are transferred.

• Information about the language environment of the user ID who started the service.

  Unix, Linux and Windows systems

  This information comprises language and territory identifier as well as $LANG variable. Language and territory identifier are retrieved from the $LANG variable during the runtime of the program. Example: From $LANG=En_US.ASCII openUTM creates the language identifier En and the territory identifier US.

  In an asynchronous service, the language of the user who started the service is transferred.

  BS2000 systems

  This information comprises:

  • Language and territory identifier and the character set of the user. If no user is signed on, openUTM transfers the language and territory identifier and the character set of the LTERM partner.

  • Name of the character set of the message.

  • Information whether the user is connected to a 7- or 8-bit terminal.

  In a locally started asynchronous service, the locale of the user who started the service is transferred. In such an asynchronous service, the 8-bit terminal information contains the value "7" and the character set name of the message contains blanks.

• Information about the job-submitting service when communication is carried out via OSI TP.

• Information about the encryption method used between the UTM application and the client.

• Miscellaneous information, e.g. the number of queued messages in the user’s queue, password validity, time the user last signed on, properties of the LTERM and OSI-LPAP partner which started the service with respect to LTERM groups and LTERM/LPAP bundles.

• Information about asynchronous messages for the user.

 Structure of the message area with INIT PU (with KCINIC or kcini.h)

Field name
COBOL

Field name
C/C++

Length
in bytes

Description 

Header: Version number and requested information 

KCVER

if_ver

2

To be assigned before the call:
Version number of the data structure (7)

KCDATE

dattim_info

1

To be assigned before the call:
Request date and time (Y/N)

KCAPPL

appl_info

1

To be assigned before the call:
Request application information (Y/N)

KCLOCALE

locale_info

1

To be assigned before the call:
Request location information (Y/N)

KCOSITP

ositp_info

1

To be assigned before the call:
Request OSI TP information (Y/N)

KCENCR

encr_info

1

To be assigned before the call:
Request encryption information (Y/N)

KCMISC

misc_info

1

To be assigned before the call:
Request miscellaneous information (Y/N)

KCHTTP

http_info

1

To be assigned before the call:
Request HTTP information (Y/N)

7

Reserved for future extensions

General information, which is always returned

KCGPAB

gen_spab_lth

2

Generated length of SPAB

KCGNB

gen_nb_lth

2

Generated length of message area

Information about date and time of the start of the application and the program unit.
(only if KCDATE/dattim_info=Y)

KCADAY

as_dt_day

2

Day of application start

KCAMONTH

as_dt_month

2

Month of application start

KCAYEAR

as_dt_year

4

Year of application start

KCADOY

as_dt_doy

3

Day of year of application start

KCAHOUR

as_tm_hour

2

Hour of application start 

KCAMIN

as_tm_minute

2

Minute of application start

KCASEC

as_tm_second

2

Second of application start

KCASEAS

as_season

1

Time of application start is specified in normal time (W) or summer time (S). If the operating system does not supply information about summer/normal time, blanks are output.

KCPDAY

ps_dt_day

2

Day of program start

KCPMONTH

ps_dt_month

2

Month of program start

KCPYEAR

ps_dt_year

4

Year of program start

KCPDOY

ps_dt_doy

3

Day of the year of program start

KCPHOUR

ps_tm_hour

2

Hour of program start

KCPMIN

ps_tm_minute

2

Minute of program start

KCPSEC

ps_tm_second

2

Second of program start

KCPSEAS

ps_season

1

Time of application start is specified in normal time (W) or summer time (S). If the operating system does not supply information about summer/normal time, blanks are output.

KCTMZONE

time_zone

12

Unix, Linux and Windows systems:
Blanks

BS2000 systems:
Time zone in format sHH:MM-hh:mm, where:

s
"+" or "-": sign of time difference between local time zone and UTC (Universal Time Coordinate, equivalent to Greenwich mean time).

HH:MM
Time difference between local time and UTC in hours (HH) and minutes (MM).

hh:mm
Time shift in hours (hh) and minutes (mm) between summer time and normal time in local time zone. 

Information about application, system and communication partner
(only if KCAPPL/appl_info=Y)

KCAPPLNM

applnm

8

UTM application name

KCHOSTNM

hostm

8

BS2000 systems:

• Name of host, where the application is running

Unix, Linux and Windows systems:

• Standalone applications: Name of the host generated with MAX HOSTNAME.

• UTM cluster applications: Name of the host generated with CLUSTER-NODE VIRTUAL-HOST

KCPTRMNM

ptrmnm

8

In a dialog service:

• with distributed processing via LU6.1: CON name of the communication partner;

• with distributed processing via OSI TP: OSI-CON name of the communication partner;

• otherwise: PTERM name of the communication partner.

In an asynchronous service: blanks

KCPRONM

pronm

8

In a dialog service:

• in the OSI TP job receiving service: blanks;

• otherwise: host name of the communication partner;

In an asynchronous service: blanks

KCBCAPNM

bcapnm

8

In a dialog service:

• in the OSI TP job receiving service: ACCESS-POINT name via which the association with the
  partner is established.
  otherwise: BCAMAPPL name via which the

• connection to the partner is established

In an asynchronous service: blanks

KCVERS

version

6

openUTM version in form Vnn.nx (e.g. V07.0A)

KCIVER

iversion

2

Version number of KDCS interface, indicates the state of the available function upgrades of the KDCS interface; in openUTM V07.0A it has the value 9

KCIVAR

ivariant

1

Identifier of product variant of openUTM:
'B' for BS2000 systems or ' X' for Unix and Linux systems or ’N’ for Windows systems

KCHSTNML

hostnm_long

64

BS2000 systems:

• Long name of the host on which the application is running.

Unix, Linux and Windows systems:

• Standalone applications: Long name of the host generated with MAX HOSTNAME.

• UTM cluster applications: Long name of the host generated with CLUSTER-NODE VIRTUAL-HOST

KCPRONML

pronm_long

64

In a dialog service

• OSI TP job-receiving service: Blanks

• otherwise: Long host name of the communication partner

In an asynchronous service: Blanks

Information about the location of the user ID which started the service
(only if KCLOCALE/locale_info=Y)

KCUSLANG

us_lang_id

2

Language identifier of the user;
if no user is signed on yet: language identifier of the LTERM partner

KCUSTERR

us_terr_id

2

Territory identifier of the user;
if no user is signed on yet: territory identifier of the LTERM partner

Only on Unix, Linux and Windows systems:

KCUSNLSL

us_nlslang

16

$LANG variable of the user

10

Blanks

Only on BS2000 systems:

KCUSCCSN

us_ccsname

8

Character set of the user;
if no user is signed on yet:character set of the LTERM partner

8

Blanks

KCCSCURR

curr_ccs

8

Character set of the message received from terminal (CCSN of the character set active at the terminal) 

KCDEVCAP

dev_cap

1

Information on whether the terminal is a 7- or 8-bit terminal. The specification is in the form "7" or "8" (printable)

OSI TP information
(only with KCOSITP/ositp_info=Y)

KCFUPOL

fupol

1

Displays whether the functional unit "Polarized Control" is selected (Y/N).

KCFUHSH

fuhsh

1

Displays whether the functional unit "Handshake" is selected (Y/N).

KCFUCOM

fucom

1

Displays whether the functional unit "Commit" is selected (Y/N).

KCFUCHN

fuchn

1

Displays whether the functional unit "Chained Transactions" is selected (Y/N).

KCENDTA

endta

1

This field indicates whether an end of transaction request is permitted at the end of the current processing step and, if this is the case, which calls you have to use.
If messages are sent to job-receiving services only in this processing step, the transaction can remain open after the end of the processing step.

• Blank: no instruction for the termination of the processing step

• O: no end of transaction may be requested at the end of the processing step.

• R: the transaction and the dialog step must be finished, the service may not be terminated.

• S: the transaction must be finished, the dialog step may not be terminated.

• C: the transaction must be finished, the service may not be terminated.

• F: the transaction must be finished and the service terminated.

KCSEND

send

1

This field indicates whether a message may be sent to the job-submitting service in the processing step.

• Y: You have to send a message to the job submitter at the end of the dialog step. If KCENDTA is set to "S", you also have to send a message to the job submitter at the end of the transaction.

• N: You cannot send an MPUT to the job submitter; you may send messages to jobreceiving services. However, in this case the transaction has to remain open after the processing step.

Encryption information
(only with KCENCR/encr_info=Y)

KCPTERM

pterm_enclev

1

Generated minimum encryption level of the client in the associated PTERM or TPOOL statement:

• N: No minimum encryption level was generated for the client.

• 3: The minimum encryption level 3 was generated for the client.

• 4: The minimum encryption level 4 was generated for the client.

• 5: The minimum encryption level 5 was generated for the client.

• T: The minimum encryption level TRUSTED was generated for the client, i.e. the client is trustworthy.

KCCLIENT

client_enclev

1

Maximum encryption mechanism supported by the client:

• N: The client does not support any encryption mechanism.

• 3: The maximum encryption mechanism supported is level 3.

• 4: The maximum encryption mechanism supported is level 4.

• 5: The maximum encryption mechanism supported is level 5.

KCSESS

session_enclev

1

Encryption mechanism defined for the current session between the client and server:

• N: No encryption mechanism was defined.

• 3: An encryption mechanism of level 3 was defined.

• 4: An encryption mechanism of level 4 was defined.

• 5: An encryption mechanism of level 5 was defined.

KCCNVTAC

convtac_enclev

1

Generated minimum encryption level of the TACs with which the service was started. There is an entry in this field even in the case of asynchronous services:

• N: No minimum encryption level has been generated for the TAC.

• 2: The minimum encryption level 2 has been generated for the TAC.

• 5: The minimum encryption level 5 has been generated for the TAC.

KCCONV

conv_enclev

1

This field indicates whether encryption has been defined for the service. This value is selected by the UPIC client or by the encryption level of the transaction code of the service, not that of the session.
This field is also supplied with a value in the asynchronous service:

• N: No encryption was defined for the service.

• 3: An encryption mechanism of level 3 was defined for the service.

• 4: An encryption mechanism of level 4 was defined for the service.

• 5: An encryption mechanism of level 5 was defined for the service.

KCINPMSG

inputmsg_enclev

1

This field indicates whether or not the dialog input message was encrypted by the client:

• N: The input message was not encrypted.

• 3: The input message was encrypted with an encryption mechanism of level 3.

• 4: The input message was encrypted with an encryption mechanism of level 4.

• 5: The input message was encrypted with an encryption mechanism of level 5.

Various information about the user who started the service (KCBENID, kcuserid), the LTERM or (OSI-)LPAP from which the service was started (KCLOGTER,kclogter) and the application
(only for KCMISC/misc_info=Y) 

KCUMSGS

amsgs_user

10

Number of queued messages in the user’s queue.

KCPWVMAX

pw_val_max

2

Number of days for which the user’s password is still valid.
Values with a special significance:

• 0: The password will become invalid within the next 24 hours.

• -1: The password was generated without any limitation to validity. The password has unrestricted validity.

• -2: The password’s period of validity has expired.This value can only occur in an asynchronous service or during sign-on.

• -3: The complexity or minimum length of the password has been increased and the password transferred with the KDCUPD tool may not satisfy the requirements for the generated complexity level or may be too short.
  This value can only occur in an asynchronous service or during sign-on.

KCPWVMIN

pw_val_min

2

Number of days during which the user’s password can only be modified at the administrative level but, for example, not via a SIGN CP call (minimum period of password validity).
Values with a special significance:

• 0: The password may be modified.

• -1: No password may be set for the user. This may occur in the following cases:
  a) Applications without users
  b) The user is an LU6.1-Session or OSI TP association
  c) Connection user (only for TS or UPIC clients)
  d) internal user KDCMSGUS
  e) BS2000 systems: Users generated with Kerberos authentication

KCLSTSGN

last_sign

14

Date and time of the last sign-on. The date and time are specified in the form YYYMMDDHHMMSS.
The following cases return zeros:

• During the sign-on operation, after the first successful sign on after regeneration

• Internal user KDCMSGUS

• User is a LU6.1 session or OSI TP association

KCBNDLMS

bundle_master

8

Name of the master of the LTERM-/LPAP bundle if the LTERM-/(OSI-)LPAP is a slave of this bundle.

KCISGRMS

is_group_master

1

The field indicates whether the LTERM (or the master of the LTERM bundle) is the master of an LTERM group.

• Y: (Master) LTERM is a group master.

• N: (Master) LTERM is not a group master.

KCLTCP

lterm_client_prot

1

The field indicates the LTERM’s client protocol

• 0: The service is running for the internal LTERM KDCMSGLT (only in an asynchronous service)

• 1: LU6.1

• 2: OSI TP

• 3: UPIC

• 4: DTP (Unix, Linux and Windows systems)

• 4: TIAM (BS2000 systems)

• 5: APPLI

• 6: SOCKET (USP)

• 7: HTTP

• 8: USP-SECURE

• 9: HTTPS

KCAPPLST

application_state

1

The field indicates the status of the application:

• N: The application is running normally.

• G: The application has the "Graceful Shutdown" status.

• W: The application has the "Shutdown Warn" status.

• S: The application is being terminated normally.

• T: The application is being terminated abnormally.

KCKRBCAP

kerberos_capability

1

In a dialog service, the field indicates whether the client is Kerberos-capable.

• Y: The client is Kerberos-capable.

• N: The client is not Kerberos-capable.

In an asynchronous service: Blank.

KCCDINFO

info_cd_available

1

Only on BS2000 systems:
The following INFO CD information is available in a dialog service:

• C: Card information (magnetic stripe card)

• K: Kerberos information

• E: Kerberos information, but the Kerberos dialog returned an error or the information could not be stored at its full length because it is longer than the value generated with MAX PRINCIPAL-LTH.

• N: No INFO CD information

INFO CD is not permitted in an asynchronous service: Blank.

HTTP information can only be supplied in dialog services, which are called by an HTTP or HTTPS client i.e. field KCCP in KBKOPF contains value 7 or 9.
(only with KCHTTP/http_info=Y)

KCHTMTD

httpMethod

1

HTTP method: 1=GET, 2=PUT, 3=POST, 4=DELETE

KCHTVERS

httpVersion

1

HTTP version: 1=1.1

KCSCHEME

scheme

1

Scheme: 1=HTTP, 2=HTTPS

KCHTEXIT

httpExit

1

A user specific, the system specific or no HTTP exit will be called (U/S/N)

KCCDCONV

codeConversion

1

Code conversion of input and output message:

N	no code conversion
S	system code conversion
1/2/3/4	code conversion SYS1/2/3/4