SFUNC - define function keys

The SFUNC control statement allows you to assign

• transaction codes,

• KDCS return codes transferred to the program units,

• KDC commands, and

• the stacking function

to the function keys of terminals.

It should be issued once for each function key to be used.

A function key can be selected in UPIC clients and transferred to the UTM application.
If openUTM receives a function key from a UPIC client, then only the parameter RET is evaluated. If the parameter is not generated, openUTM returns the return code 19Z for the MGET call.

• On BS2000 system F and K keys assigned by SFUNC cannot be used by FHS-DE (see the "FHS User Guide").

• On Unix, Linux and Windows systems function keys are only relevant for UPIC clients. Only the RET operand is evaluated.

SFUNC

functionkey { [ ,CMD={ KDCDISP | KDCFOR1 | KDCLAST | KDCOFF | KDCOFF-BUT |             KDCOUT | KDCSIGN1 } ]   |   [ ,TAC=tac1 ] {[,RET=xxZ] | [,STACK=tac2]} }

¹only on BS2000 systems

functionkey	Short name for the function key. The following values are possible: With F keys, the value of the F key and an input message are displayed. With K keys, a short message is output indicating the value of the K key. K14 is required for ID card readers (see the openUTM manual „Programming Applications with KDCS”). BS2000 systems: Supported values are K1 to K14 and F1 to F24 Unix, Linux and Windows systems: Supported values are F1 to F20
CMD=	Name of the KDC command to be assigned to this function key. If the CMD is specified, it is not possible to define any further operands.
TAC=	tac1 Name of the transaction code to be assigned to the function key. This must be defined as a service TAC using the TAC statement (CALL=FIRST/BOTH). If the function key is pressed outside the service, this has the same effect as entering the transaction code. If the function key is pressed within the service and neither RET nor STACK is specified, the first MGET call in the next program unit of this service issues return code 19Z.
RET=	xxZ Return code contained in the KCRCCC field of the communication area following an MGET call if a particular function key is pressed during a service. If the function key at the terminal is pressed at the beginning of a service and TAC=tac1 is not set, openUTM responds by outputting the messaged K009 or by starting the BADTACS program unit. At the first MGET call, the BADTACS program unit receives the return code assigned to the function key in the field KCRCCC. If the function key activated from the UPIC client at the beginning of a conversation, that service is started that belongs to the TAC (TP_NAME) set by the UPIC client. At the first MGET call, the program unit receives the return code assigned to the function key in the field KCRCCC. The RET and STACK operands are mutually exclusive. Value range: 20 <= xx <= 39. The assignment is freely selectable.
STACK=	tac2 Name of the transaction code to be assigned to the function key. This must be defined as a dialog service TAC using the TAC statement (TYPE=D and CALL=FIRST/BOTH). If the function key is pressed within the service, the current service is stacked and the service with the transaction code tac2 is started. If the function key is pressed outside the service, transaction code  tac1 is started. If transaction code tac1 is not specified, pressing the function key starts the service with the transaction code tac2. The RET= and STACK= operands are mutually exclusive.

Alternative escape keys on BS2000 systems

For K and F keys not available on the keyboard the following alternative keys can be used:

Key	Alternative
K1
K2
K3
K4	ESC V
K5	ESC W
K6	ESC M
K7	ESC N
K8	ESC O
K9	ESC ?
K10	ESC >
K11	ESC =
K12	ESC <
K13	ESC ;
K14	ESC :
F1
F2
F3
F4	ESC ^
F5	ESC _