kc_lterm_str - LTERM partners

The data structure kc_lterm_str is defined for the object type KC_LTERM. In the case of KC_GET_OBJECT, UTM returns the properties of LTERM partners and specifies to which client or printer the LTERM partner is presently assigned in kc_lterm_str.

LTERM partners can be dynamically created with KC_CREATE_OBJECT, deleted with KC_DELETE_OBJECT or modified with KC_MODIFY_OBJECT.

mod 1	Data structure kc_lterm_str
-	char lt_name[8];
-	char kset[8];
-	char locale_lang_id[2]; (only on BS2000 systems)
-	char locale_terr_id[2]; (only on BS2000 systems)
-	char locale_ccsname[8]; (only on BS2000 systems)
-	char lock_code[4];
x(GPD)	char state;
-	char usage_type;
-	char user_gen[8];
-	char cterm[8];
x(GPD)2	char format_attr; (only on BS2000 systems)
x(GPD)2	char format_name[7]; (only on BS2000 systems)
-	char plev[5];
-	char qamsg;
-	char qlev[5];
-	char restart;
-	char annoamsg; (only on BS2000 systems)
-	char netprio; (only on BS2000 systems)
x(PD)	char master[8];
-	char pterm[8];
-	char pronam[8];
-	char bcamappl[8];
-	char user_curr[8];
x(A)	char connect_mode;
x(IR)	char bcam_trace;
-	char bundle;
-	char pool;
-	char out_queue[5];
-	char incounter[10];
-	char seccounter[5];
-	char deleted;
-	char nbr_dputs[10];
-	char lt_group;
-	char out_queue_ex[10];
-	char kerberos_dialog (only on BS2000 systems)
-	char pronam_long[64];

1	The contents of the field can be modified with KC_MODIFY_OBJECT; see "obj_type=KC_LTERM"
2	When changing the start format with KC_MODIFY_OBJECT you must always enter data in format_name and format_attr.

The fields in the data structure have the following meanings:

multi_signon
	Name of the LTERM partner; It can also be an LTERM partner that belongs to an LTERM pool. The program units of the application communicate with the clients, printers and TS applications (no server-server communication) that are assigned to the LTERM partner using this name.
kset	Specifies which key set is assigned to this LTERM partner (access privileges). kset contains the name of the key set. The key set limits the access privileges of a client/user that connects via this LTERM partner. A client or client program can only start a service protected by a lock code or an access list when the key or access code corresponding to the lock code or the access list is contained both in the key set of the user ID under which the client or client program signs on and in the key set of the associated LTERM partner.
locale_lang_id, locale_terr_id, locale_ccsname (only on BS2000 systems)
	These contain the three components of the locale assigned to the partner. The locale defines the language environment of the client that is connected to the application via this LTERM partner. The language environment is relevant if messages and UTM messages of the application are to be output in different languages. The LTERM-specific language environment is set when outputting asynchronous messages and in the first part of the sign-on service if the userspecific environment has not been set. See the openUTM manual “Generating Applications” for more information on multilingual capabilities. locale_lang_id  Contains the up to two characters long language code. locale_terr_id  Contains an up to two characters long territory code. locale_ccsname  (coded character set name) Contains the up to 8 characters long name of an extended character set  (CCS name; see also the XHCS User Guide).
lock_code
	Contains the lock code assigned to the LTERM partner (access protection). Only users/clients who possess the corresponding key code may connect via this LTERM partner. The lock_code can contain a number between '0' and '4000'. In KC_CREATE_OBJECT, the maximum value that can be contained by lock_code is the maximum value defined using the KEYVALUE operand of the KDCDEF statement MAX. '0' means that the LTERM partner is not protected by a lock code.
state
	Specifies if the LTERM partner is currently disabled.
	'Y'	The LTERM partner is not disabled.
	'N'	The LTERM partner is disabled. No user/client can connect to the application at the present time via this LTERM partner.
usage_type
	Type of LTERM partner
	'D'	The LTERM partner is configured as a dialog partner. The client as well as the local application can send messages via the connections between the client (pterm) and local application.
	'O'	The LTERM partner is configured for an output medium (printer). Messages can only be sent from the application to the client/printer (pterm).
user_gen
	user_gen contains data if the LTERM partner was configured as a dialog partner (usage_type = 'D'). If the LTERM partner is assigned with a terminal, user_gen contains the user ID for which UTM is to execute an automatic KDCSIGN (automatic sign-on) when the logical connection between the client and the application is established (defined in kc_lterm_str.user). If the LTERM partner is assigned to a UPIC client or a TS application ( ptype ='APPLI' or 'SOCKET'), then user_gen contains the connection user ID.
cterm
	cterm only contains data if the LTERM partner ( usage_type = 'O') is assigned to a printer control LTERM. cterm then contains the name of the printer control LTERM, which can be a maximum of 8 characters long. A printer control LTERM is assigned one or more printers. Asynchronous jobs in the message queues of the printers, the output of messages on the printers and the printer itself can be administered via the printer control LTERM (see chapter "Administering message queues and controlling printers" ).
format_attr, format_name (only on BS2000 systems)
	These parameters are only relevant when the LTERM partner is assigned to a terminal. format_attr and format_name define the LTERM-specific start format. An LTERM-specific start format is only useful in applications without user IDs and in applications with their own sign-on service. In applications without user IDs, the start format will be output on the terminal after establishing the connection between the terminal and the application instead of the message K001 as long as no LTERM-specific restart is being executed. In applications generated with user IDs, the name of the start format can be queried during the first part of the sign-on service (with SIGN ST). format_attr  Contains the format code:
	'A'	(format attribute ATTR) The start format is a format with user attributes. The properties of the format fields can be changed by the KDCS program unit. The format name at the KDCS program interface is +format_name.
	'N'	(format attribute NOATTR) The start format is a format without user attributes. Neither field properties nor format properties can be changed by the KDCS program units. The format name at the KDCS program interface is *format_name.
	'E'	(format attribute EXTEND) The start format is a format with expanded user attributes. The properties of the format fields as well as global format properties can be changed by the KDCS program unit. The format name at the KDCS program interface is #format_name.
	format_name  Contains the name of the start format. The name can be up to 7 characters long and contains only alphanumeric characters.
plev ( print level)
	If the LTERM partner is a dialog partner, then plev ='0' is always returned. If the LTERM partner is assigned to an output medium (printer), then plev contains the control value for the number of print jobs that are temporarily stored in the message queue of the LTERM partner. UTM collects the messages for the corresponding printer until the control value specified in plev is reached. Then UTM attempts to establish the connection to the printer. The connection is closed when no more messages for the printer are in the queue. The control value is specified when adding the LTERM partner to the configuration. plev ='0' means that no control value is defined and UTM can temporarily store any number of print jobs in the queue without having to close the connection to the printer.
qamsg (queue asynchronous message)
	Specifies whether asynchronous jobs are temporarily stored in the message queue of the LTERM partner even if the client/printer of the LTERM partner is not connected to the application.
	'Y'	An asynchronous job is placed in the message queue of the LTERM partner even if no connection to the client/printer exists. qamsg ='Y' is not possible for restart ='N'.
	'N'	An asynchronous job sent to this LTERM partner is rejected (return codes KCRCCC=44Z and KCRCDC=K705) if the corresponding client/printer is not connected to the application.
qlev ( queue level)
	Contains the maximum number of asynchronous messages that UTM may temporarily store in the message queue of the LTERM partner at one time. If this control value is exceeded, openUTM rejects any further FPUT or DPUT calls for this LTERM partner with 40Z. The control value is specified when adding the LTERM partner to the configuration.
restart
	Only relevant if the LTERM partner is assigned to a client. restart specifies how UTM will handle asynchronous messages that are in the message queue of the LTERM partner when shutting down a connection to the client.
	'Y'	Asynchronous messages to this client remain in the queue when a connection is shut down. If no user IDs (USER) were generated in the application, then UTM will execute an automatic restart for these LTERM partners.
	'N'	UTM deletes all asynchronous messages that are temporarily stored in the message queue of the LTERM partner when a connection is shut down. If the job is a job complex, then a negative confirmation job is activated. If no user IDs (USER) were generated in this application, then UTM will not execute an automatic restart for the LTERM partner.
annoamsg (announce asynchronous message, only on BS2000 systems))
	Is only of relevance for LTERM partners assigned to a terminal. annoamsg specifies if UTM will announce asynchronous messages on the terminal with a UTM message in the system line before outputting.
	'Y'	UTM announces every asynchronous message to this terminal with the K012 UTM message in the system line. The user must then explicitly request the asynchronous message with the KDCOUT command.
	'N'	Asynchronous messages are output on the terminal immediately, i.e. without announcement. KDCOUT is not permitted.
netprio	Specifies the transport priority used on the transport connection between the application and the client/printer.
	'M'	"Medium" transport priority
	'L'	"Low" transport priority
master
	The meaning of this field varies according to the operation code. You can establish what type of LTERM is involved from the lt_group parameter. KC_GET_OBJECT The associated master LTERM is returned here in the case of a slave LTERM of an LTERM bundle. The associated primary LTERM is returned here in the case of an alias LTERM of an LTERM group. KC_MODIFY_OBJECT For connection bundles: Exchange of two master LTERMs. The LTERM specified in master must be the master of an LTERM bundle. The master is specified with which the slaves are to be exchanged. You can only use this functionality in standalone UTM applications. For LTERM groups: Reassignment of a group LTERM to a different LTERM group. The LTERM that you specify in master must either be a normal LTERM, a primary LTERM of an LTERM group or a master LTERM of an LTERM bundle. You can only use this functionality in standalone UTM applications. A normal LTERM must fulfill the following conditions: A PTERM with the PTYPE APPLI or SOCKET must be assigned to the LTERM. The LTERM must not be a slave LTERM of an LTERM bundle. The LTERM must have been generated with USAGE=D. The primary LTERM of the group to which the LTERM is to be added is specified.  If the LTERM specified in master is already a primary LTERM of an LTERM group, the LTERM specified for lt_name is added to its LTERM group.  If the LTERM specified in master was not a primary LTERM, a new LTERM group is created. The LTERM specified in lt_name is added to the new LTERM group.  Primary LTERM is the LTERM specified in master.
pterm
	Name of the client/printer (PTERM name) currently assigned to this LTERM partner.  If the LTERM partner is not currently assigned to a client/printer, then pterm contains blanks. The assignments between the LTERM partner and the client/printer can be changed; see also kc_pterm_str in "kc_pterm_str - Clients and printers" .
pronam
	Name of the computer on which the client can be found or to which the printer is connected. If the real computer name is longer than 8 characters: The pronam field contains a symbolic local name assigned for this computer by the transport system. If no connection was established yet, pronam contains blanks. The complete name, up to 64 characters long, can be taken from the pronam_long field. If the LTERM partner is not currently assigned a client/printer, the field contains blanks. In UTM applications on BS2000 systems pronam is unequal blanks if the LTERM partner is assigned a client or printer. The name in pronam is identical to the name of the computer specified for the BCAM generation for this computer. If the LTERM partner is assigned to an RSO printer, then pronam contains the value '*RSO'. In UTM applications running on Unix, Linux or Windows systems, pronam contains blanks if the LTERM partner is assigned to a local client or printer.
bcamappl
	Name of the local UTM application (BCAMAPPL name) via which the connection to the client/printer will be established. If the LTERM partner is assigned to a terminal or printer, then bcamappl always contains the name of the application that was specified for the KDCDEF generation in MAX APPLINAME. If the LTERM partner is assigned to a UPIC client or a TS application, then bcamappl contains the application name (BCAMAPPL name) assigned to the client when it was added.
user_curr
	User ID of the user currently connected with the application through this LTERM partner. If there is currently no connection, user_curr is padded with blanks. If a connection to a terminal is established, but no user is as yet signed on, user_curr is also padded with blanks. If a connection to a UPIC client or to a TS application is established, we distinguish the following situations: The application is generated with SIGNON MULTI-SIGNON=YES (see kc_signon_str.multi_signon in "kc_signon_str - Properties of the sign-on process") user-curr contains the connection user ID (user_gen) until a client signs on with a “true” user ID for which kc_user_str.restart='Y'. The application is generated with SIGNON MULTI-SIGNON=NO. user_curr contains the connection user ID (user_gen) until a client signs on with a “true” user ID.
connect_mode
	Specifies if the client or printer presently assigned to this LTERM partner is currently connected to the application.
	'Y'	The client/printer is currently connected to the application.
	'W'	UTM is currently attempting to establish a connection to the client/printer.
	'N'	The client/printer is not currently connected to the application.
bcam_trace
	Specifies if the BCAM trace is explicitly enabled or disabled for this LTERM partner. The trace function that monitors connection-specific activity within a UTM application (for example the BCAM trace function on BS2000 systems) is called the BCAM trace. The BCAM trace can be enabled for all connections of the application (i.e. for all LPAP and LTERM partners) or explicitly for certain LTERM or LPAP partners.
	'Y'	The BCAM trace was explicitly enabled for this LTERM partner. If the BCAM trace was enabled for all connections of the UTM application, then 'N' will be returned in bcam_trace. You can determine if the BCAM trace is enabled for all connections by, for example, calling KC_GET_OBJECT with the KC_DIAG_AND_ACCOUNT_PAR parameter type. Then bcam_trace ='Y' will be returned in kc_diag_and_account_par_str.
	'N'	The BCAM trace was not explicitly enabled for this LTERM partner.
	You can enable or disable the BCAM trace during the application run.
bundle	bundle is only relevant for LTERM partners that are assigned to a printer or an LTERM bundle. bundle specifies if the LTERM partner belongs to a printer pool or an LTERM bundle.
	'Y'	The printer is assigned to a printer pool.
	'N'	The printer is not assigned to a printer pool.
	'M'	The LTERM partner is a master of an LTERM bundle.
	'S'	The LTERM partner is a slave of an LTERM bundle.
pool	Specifies if the LTERM partner belongs to an LTERM pool.
	'Y'	The LTERM partner is assigned to an LTERM pool.
	'N'	The LTERM partner is not assigned to an LTERM pool.
out_queue
	The number of asynchronous messages presently in the message queue of the LTERM partner for outputting. If the number of messages is greater than 99999, then the number is not displayed in full. You should therefore use the field out_queue_ex since larger numbers can be entered in full here.
incounter
	The number of messages entered via this LTERM partner; if a printer is connected via this LTERM partner, then the number of print confirmations from the printer is entered here. The incounter counter is reset to 0 at every start of the application.
seccounter
	The number of security violations by users and clients that were connected to the application via this LTERM partner (for example, due to entering an unauthorized transaction code). The counter is reset to 0 at every start of the application.
deleted
	Specifies whether or not the LTERM partner was dynamically deleted from the configuration.
	'Y'	The LTERM partner was deleted. No more clients or printers may be connected to the application via this LTERM partner.
	'N'	The LTERM partner was not deleted.
nbr_dputs
	Number of time-controlled jobs for this LTERM partner whose start time has not yet been reached
lt_group
	Specifies whether the LTERM is a "normal" LTERM, part of an LTERM bundle or part of an LTERM group.
	' '	The LTERM is not part of an LTERM bundle or an LTERM group.
	'P'	The LTERM is the primary LTERM of an LTERM group.
	'A'	The LTERM is an alias LTERM of an LTERM group.
out_queue_ex
	see out_queue.
kerberos_dialog (only on BS2000 systems)
	Y	When the connection is established, a Kerberos dialog is conducted for clients that support Kerberos and are directly connected with the application via this LTERM partner (not via OMNIS).
	N	No Kerberos dialog is performed.
pronam_long
	Name of the computer on which the client or the printer is located. If no client/printer is currently assigned to the LTERM partner, the field is filled with blanks. In UTM applications on BS2000 systems, pronam_long is not blank if a client or printer is assigned to the LTERM partner. The name in pronam_long is identical to the computer name specified for this computer during BCAM generation. If the LTERM partner is assigned to an RSO printer, pronam_long contains the value '*RSO'. In UTM applications on Unix, Linux and Windows systems, pronam_long contains blanks if the LTERM partner is assigned to a local client or printer.