The data structure kc_max_par_str is defined for the parameter type KC_MAX_PAR. In the case of KC_GET_OBJECT, UTM returns following information in kc_max_par_str:
The basic properties of the application, for example the application name, function versions, the name of the KDCFILE.
The maximum values for the parameters of the application, such as the size of the page pool, of the restart area and of the KDCS storage areas, the maximum number of users, the maximum number of lock codes and key codes of the application, the maximum time slice for time controlled asynchronous jobs, and the maximum number of processes that can be utilized for the application.
Only on Unix, Linux and Windows systems: The resources that will be used by the application, for example access keys for shared memory segments and semaphores.
mod 1 | Data structure kc_max_par_str | see 2 |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
x(GIR) |
| |
- |
| |
- |
| |
x(GIR) |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
x(IR) |
| |
x(GPD) |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
x (GIR) |
| |
x (GIR) |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
- |
| |
| ||
| ||
| ||
|
1 Field contents of the field can be modified with KC_MODIFY_OBJECT; see "obj_type=KC_MAX_PAR"
2 The meaning of the field is described on the page specified in this column.
3 Function from an earlier UTM version has been omitted; the field is filled with spaces by UTM.
4 UTM-internal field to support the diagnosis of certain error situations; the field content is irrelevant for a user and is therefore not described in the following.
The fields in the data structure have the following meanings:
applimode | ||
Specifies if the UTM application is a UTM-S or UTM-F application. | ||
'S' | The application was generated as a UTM-S application (Secure). | |
'F' | The application was generated as a UTM-F application (Fast). | |
appliname | ||
The name of the UTM application. This name is defined in MAX APPLINAME during the static generation with the KDCDEF generation tool. appliname is the name of the application that must be specified by terminals when establishing a connection. | ||
asyntasks | ||
Contains the maximum number of processes of the application that may process jobs to asynchronous transaction codes. asyntasks is the upper limit for the current number of processes used for processing asynchronous jobs. The value can be set at the start of the application or it can be set dynamically by the administration. | ||
blksize | ||
Specifies the size of a UTM page. The size is set during the KDCDEF generation to either 2K, 4K or 8K. Possible values: | ||
'2' | The size of a UTM page is 2K. | |
'4' | The size of a UTM page is 4K. | |
'8' | The size of a UTM page is 8K. | |
bretrynr (only on BS2000 systems) | ||
Contains the number of times UTM will attempt to pass a message to the transport system (BCAM) when BCAM cannot immediately accept the message at the present time. If the value of bretrynr is exceeded the connection to the dialog partner is closed down. The value of bretrynr influences the performance of the application. For asynchronous messages sent to a dialog partner with ptype= 'APPLI' (TS applications that are not socket applications), bretrynr >= 3 means that UTM will try to pass the message on to BCAM up to three times. If BCAM does not accept the message on the third try, then UTM will release the process for now, but will not close the connection. After a 3 second wait UTM will try again up to three times to pass the message to BCAM. If the attempts fail again, then UTM waits another 3 seconds before trying another three times, etc. Minimum value: '1' | ||
cacheshmkey (only on Unix, Linux and Windows systems) | ||
Contains the access key for the shared memory segment that contains the global application buffer for file accesses. cacheshmkey is a global parameter for Unix, Linux and Windows systems. cacheshmkey is a decimal number. | ||
cachesize_pages | ||
Specifies the size of the cache in UTM pages. The size of a UTM page is returned in blksize. All access to the page pool is carried out via the cache, i.e. all input and output to local secondary storage areas, global secondary storage areas, terminalspecific long-term storage area, LPUT and FPUT messages, MPUT messages, as well as some UTM administration data. A write to a KDCFILE is only executed if there is no more space in the cache or if the transaction is terminated. | ||
cachesize_paging | ||
Specifies the percentage of the cache that will be written at one time to the KDCFILE when a bottleneck occurs so that the storage space in the cache can be used for other data. The value of cachesize_paging influences the performance of your UTM application. UTM removes at least 8 UTM pages from the cache when paging even if the value of cachesize_paging is less than this number of UTM pages. Minimum value: '0', i.e. 8 UTM pages will be removed for storage elsewhere | ||
cachesize_res (only on BS2000 systems) | ||
Specifies whether or not the cache is resident. The contents of the field are to be interpreted as follows: | ||
'R' | The cache is resident. | |
'N' | The cache is pageable, i.e. not resident. | |
cardlth | ||
The length in bytes of the identification information that UTM stores when an ID reader is used in addition to the access privilege check done when signing on (KDCSIGN). The identification information can be read in a program unit using the KDCS call INFO. | ||
catid_a (only on BS2000 systems) | ||
Contains the catalog ID (CAT-ID) assigned to your KDCFILE with the suffix A for the B2000 system. | ||
catid_b (only on BS2000 systems) | ||
The catid_b is only relevant if you maintain a redundant copy of the KDCFILE . catid_b then contains the catalog ID (CAT-ID) assigned to your KDCFILE with the suffix B. If only one KDCFILE is used, then catid_b = catid_a . | ||
clrch ( clear character) | ||
Contains the character with which the communication area (KB) and the standard primary working area (SPAB) of the program units are overwritten at the end of a dialog step. If no character was defined during generation, then clrch contains blanks and clrch_type='N'. The storage areas are not overwritten then at the end of a dialog step. If a character was defined in the KDCDEF generation, then clrch contains one character. If the character is hexadecimal, then each half byte is represented as one character. clrch is returned in the form of the following union: |
union kc_clear_char |
|
|
The x field contains data if clrch is returned as a hexadecimal character. You can determine how to interpret the data contained in clrch using the clrch_type field. | ||
clrch_type | ||
Specifies how the contents of the | ||
'X' | clrch contains a hexadecimal character. | |
'C' | clrch contains a printable, alphanumeric character. | |
'N' | clrch contains a hexadecimal character. | |
conn_users | ||
The maximum number of users that may be signed on to the UTM application at the same time. Users are understood as being the number of user IDs that may be signed on at the same time. If the application is generated without user IDs, then the number of clients that can connect to the application via LTERM partners is limited by conn_users. User IDs generated with administration privileges can still sign on to the UTM application if the maximum number of simultaneously active user IDs has already been reached. conn_users='0' means that the number of simultaneously active users is unlimited. Minimum value: '0' | ||
destadm | ||
Contains the receiver to which UTM sends the results of KDCADM administration calls that were asynchronously processed (asynchronous transaction codes from KDCADM). The receiver can be an LTERM partner or an asynchronous TAC or a TAC queue. If destadm contains blanks, then no receiver is defined. The results of the asynchronous transaction codes from KDCADM are lost. In this case you are to define a receiver using, for example, KC_MODIFY_OBJECT. | ||
dputlimit1_day | ||
These parameters determine the upper limit of the time interval in which a time controlled job must be executed. Time controlled jobs are created with the KDCS call DPUT. A program unit call and hence also a DPUT call with an absolute time specification can be delayed to such an extent that the required execution time of the DPUT has already elapsed. This time at which a time controlled job is to be executed (specified in the DPUT call) must occur within the time span specified in dputlimit1 after the time of the DPUT call. dputlimit1 is specified as follows: The number of days (dputlimit1_day) + the number of hours (dputlimit1_hour) + the number of minutes (dputlimit1_min) + the number of seconds (dputlimit1_sec). Therefore, the following is true: Execution time < time of the DPUT call + dputlimit1 | ||
dputlimit2_day | ||
These parameters determine the lower limit of the time interval in which a time controlled job (DPUT call) must be executed. The time controlled job is to be executed (specified in the DPUT call) no earlier than within the time span specified in dputlimit1 before the time of the DPUT call. dputlimit2 is specified as follows: The number of days (dputlimit2_day) + the number of hours (dputlimit2_hour) + the number of minutes (dputlimit2_min) + the number of seconds (dputlimit2_sec). Therefore, the following is true: If the execution time specified lies between the limit specified in dputlimit2 and the time of the call, then the DPUT is immediately converted to an FPUT. | ||
gssbs | The maximum number of global secondary storage areas that may exist in the application at one time. | |
hostname | ||
BS2000 systems: Unix, Linux and Windows systems: If this name is longer than 8 characters, the computer name, up to 64 characters long, can be taken from the hostname_long field. In this case, the hostname field contains the first 8 characters of the long name. | ||
ipcshmkey (only on Unix, Linux and Windows systems) | ||
Contains the access key for the shared memory segment used for interprocess communication between the work processes on the one hand, and the external processes of the application on the other hand. On Unix, Linux and Windows systems ipcshmkey is a global parameter. ipcshmkey is a decimal number. | ||
ipctrace (only on Unix, Linux and Windows systems) | ||
Contains the number of entries in the trace area of the IPC. | ||
kaashmkey (only on Unix, Linux and Windows systems) | ||
Contains the access key for the shared memory segment in which the global application data is stored. kaashmkey is a global parameter on Unix, Linux and Windows systems. kaashmkey contains a decimal number. | ||
kb | Contains the length of the communication area in bytes. The communication area header and the communication area return area are not taken into consideration when determining this length. | |
kdcfile_name | ||
Base name of the KDCFILE, USLOG user log file and the SYSLOG system log file (see also the openUTM manual “Generating Applications”). kdcfile_name must also be specified for the start of the application in the FILEBASE start parameter. | ||
kdcfile_operation | ||
Specifies if a redundant copy of the KDCFILE is maintained or not. The contents of kdcfile_operation are interpreted as follows: | ||
'D' | A redundant copy of the KDCFILE is maintained. If the KDCFILE is split (see also the openUTM manual “Generating Applications”, KDCFILE), then all KDCFILE files will be maintained together with a redundant copy. | |
'S' | Only one copy of the KDCFILE is maintained. If the KDCFILE was split, then only one copy of each KDCFILE file is maintained. | |
keyvalue | ||
Contains the number of the highest key code in the application and therefore the number of the highest lock code that may be used for access protection for a transaction code or an LTERM partner. | ||
locale_lang_id | ||
Only on BS2000 systems: These contain the three components of the locale assigned to the UTM application. The locale defines the standard language environment of the application. The standard language environment is assigned to every user ID (KC_USER), every LTERM partner and every LTERM pool of the application as the standard setting for the language environment. The standard setting is in effect as long as a locale is not defined for these objects (see also the openUTM manual “Generating Applications”). locale_lang_id locale_terr_id locale_ccsname | ||
lputbuf | Contains the size of the buffer in which UTM temporarily stores the records created with the KDCS call LPUT before it writes them to the user log file (USLOG). The buffer is stored in the page pool. The LPUT statements created in the program units are temporarily stored in this buffer until it is full. Only then will UTM copy the statements into the user log file. The user log file (USLOG) is only open during this copy procedure. | |
lputlth | Contains the maximum length of the user data in an LPUT record. The length of an LPUT record consists of: | |
lssbs | Contains the maximum number of LSSBs (local secondary storage areas) that can be created within a service. | |
mp_wait_sec (memory pool wait) | ||
Specifies the maximum number of seconds a UTM application program will wait to connect a process to a common memory pool. | ||
nb (KDCS message area) | ||
Contains the maximum length of the message area for KDCS program units. | ||
net_access (only on Unix, Linux and Windows systems) | ||
This parameter is no longer supported. | ||
nrconv (number of conversations) | ||
The maximum number of services that a user may have on the stack at the same time. The value '0' means that no services may be placed on the stack. | ||
osi_scratch_area | ||
The size of an internal UTM working area that UTM needs for dynamically storing data when the OSI TP protocol is used. The number is specified in kilobytes. In UTM applications on BS2000 systems this working area is automatically increased in size, if necessary, during the application run. In UTM applications on Unix, Linux or Windows systems the size of the internal working area is constant during the entire application run. If the size of the internal working area is determined to be insufficient during operations, then the KDCDEF generation must be repeated using a higher value. | ||
osishmkey (only on Unix, Linux and Windows systems) | ||
Contains the access key for the shared memory segment used by OSS for the communication via OSI TP. osishmkey is a global parameter on Unix, Linux and Windows systems. osishmkey is a decimal number. | ||
pgpool_pages | ||
Specifies the size of the page pool as a number of UTM pages. The size of a UTM page is output in the blksize field. | ||
pgpool_warnlevel1 | ||
Contains the number of warning levels used by UTM to warn of an impending overrun of the page pool. pgpool_warnlevel1 pgpool_warnlevel2 | ||
pgpoolfs | ||
Contains the number of files over which the page pool is divided. If pgpoolfs = '0', then the page pool is stored in the main file of the KDCFILE, i.e. the page pool was not swapped out. In the case of dual opeation of the KDCFILE the page pool in the second KDCFILE also consists of pgpoolfs files. | ||
pisizelth (only on Unix and Linux systems) | ||
This parameter is no longer supported. | ||
recbuf_pages | ||
Contains the size of the restart area per process. The size is specified as a number of UTM pages. The size of a UTM page is output in the blksize field. The data needed for the restart after a system error is written to the restart area. recbuf_pages influences the performance of the application: if this area is large, then the load placed on the running application is lower; a restart after a system error takes longer, however. If the area is small, then the load placed on the running application is higher, but a restart is faster. | ||
recbuf_lth | ||
Contains the size of the buffer in bytes available per process of the application for temporarily storing restart data. The data is needed to execute a restart after a transaction or system error. | ||
recbuffs | ||
Contains the number of files over which the restart area is divided. If recbuffs = '0', then the restart area is stored in the main file of the KDCFILE, i.e. the restart area was not swapped out. In the case of dual opeation of the KDCFILE the restart area in the second KDCFILE also consists of recbuffs files | ||
reqnr (only on BS2000 systems) | ||
Contains the maximum number of PAM read/write jobs that may be accepted at one time in a UTM process for a file. reqnr contains the value set in the KDCDEF generation as long as this value is smaller than the value of cachesize_pages . If the value generated is larger, then the value of cachesize_pages is output for reqnr. | ||
sat ( security audit trail, only on BS2000 systems) | ||
Specifies if SAT logging is enabled for the application. The SAT logging can be enabled and disabled using the KDCMSAT transaction code (see the openUTM manual “Using UTM Applications on BS2000 Systems”, UTM-SAT administration). | ||
'Y' | The SAT logging is enabled (ON). | |
'N' | The SAT logging is disabled (OFF). | |
semarray_startkey | ||
Only on Unix, Linux and Windows systems: Specifies the area for keys for the global application semaphores. Semaphores are used for process synchronization. The keys are global parameters on Unix, Linux and Windows systems. semarray_startkey semarray_number UTM uses a key by adding 1 to the semarray_startkey key each time, starting with the first key number. If there was no key area defined in the KDCDEF generation, then UTM returns the value '0' in semarray_startkey and semarray_number. In this case, UTM returns the semaphore key in the semkey field. | ||
semkey (semaphore key, only on Unix, Linux and Windows systems) | ||
If UTM returns values in the semarray_startkey and semarray_number fields that are not equal to '0', then semkey contains '0'. If the semarray_startkey and semarray_number fields contain '0', then semkey contains the key of the application for all semaphores that are global to the application (process synchronization). The keys are global parameters on Unix, Linux and Windows systems. The keys are specified as decimal numbers. A maximum of 10 keys are returned. If less than 10 keys were generated, then the rest of the field contains '0'. | ||
signon_value | ||
Specifies the percentage of user IDs that may have a sign on service active at one time. UTM attempts to obtain the necessary resources according to this number (see the section "kc_signon_str - Properties of the sign-on process"). | ||
signon_restr | ||
Specifies if restrictions were generated for the sign-on procedure (see also the section "kc_signon_str - Properties of the sign-on process"): | ||
'R' | Database calls and access to the global UTM storage area are not permitted during the first part of the sign-on procedure (RESTRICTED). | |
'N' | Database calls and access to global UTM storage are permitted during the first part of the sign-on procedure. | |
signon_fail | ||
Specifies the number of unsuccessful sign-on attempts repeated by a terminal user without interruption after which UTM should trigger a "silent alarm". In the case of a silent alarm, UTM generates the message K094, writes this to SYSLOG and possibly also outputs it at other message destinations configured for this message. Minimum value: '1' | ||
sm2 | Specifies if the UTM application sends performance data to openSM2 for monitoring. | |
'0' | Performance monitoring using openSM2 is generally not permitted for the UTM application. This means that the UTM application may not send any data to openSM2. The sending of data to openSM2 cannot be enabled by the administration, either. | |
'N' | The UTM application may send data to openSM2. The sending of data to openSM2 is currently disabled, however. It can be enabled by the administration. | |
'Y' | The UTM application may send data to openSM2. The sending of data to openSM2 is enabled. It can be disabled by the administration. | |
spab | Contains the maximum length of the standard primary working area (SPAB). | |
syslog_size | ||
Contains the generated control value setting used by UTM for the automatic monitoring of the size of the SYSLOG file. The automatic monitoring of the size of the SYSLOG is only possible if the SYSLOG was created as a file generation group (FGG) or a file generation directory (see the openUTM manual “Using UTM Applications”). UTM switches to the next file generation of the SYSLOG FGG when the size of the file generation currently being written to reaches the syslog_size control value. syslog_size = '0' means that UTM does not monitor the size of the SYSLOG file. UTM writes all UTM messages with a SYSLOG message line into this file generation. syslog_size = '0' is always output when a redundant copy of the SYSLOG file is not maintained. You can switch the logging to another file generation, change the control value or enable/disable the monitoring of the size (see KC_SYSLOG "KC_SYSLOG - Administer the system log file" or KDCSLOG "KDCSLOG - Administer the SYSLOG file") | ||
tasks | The maximum number of processes that may be used for the application at one time. tasks contains the maximum value set using KDCDEF (in MAX TASKS). | |
tasks_in_pgwt | ||
Specifies the maximum number of processes that may simultaneously process jobs with blocking calls such as the KDCS call PGWT (Program Wait). The current setting for the number of processes is returned in kc_tasks_par_str when an information query with the KC_TASKS_PAR parameter type is sent. The current number of processes is set at the start of the application and can be altered by the administration when bottlenecks arise (see KDCAPPL "KDCAPPL - Change properties and limit values for an operation" and KC_MODIFY_OBJECT "obj_type=KC_TASKS_PAR"). Neither the number of processes specified at the start nor the number set by the administration may exceed the value returned here. If tasks_in_pgwt='0', no blocking calls are allowed. | ||
tracerec (trace records) | ||
Contains the maximum number of entries in the TRACE area. UTM writes diagnostic information to this area if TESTMODE=ON has been set. | ||
trmsglth (transfer message length) | ||
Contains the maximum length of the physical messages exchanged between clients, partner applications or printers and the UTM application. Control characters, position data, etc., is included in this length specification. The number is specified in bytes. | ||
uslog | Specifies if a redundant copy of the user log file is maintained for data security reasons. | |
'S' | (SINGLE) | |
'D' | (DOUBLE) | |
For more information on the user log file consult the openUTM manual “Using UTM Applications”. | ||
vgmsize (only on BS2000 systems) | ||
Contains the size of the buffer used for storing transaction and procedure information of an SQL database system. This will also limit the size of a user’s portion of the page pool. vgmsize is specified in KB. | ||
xaptpshmkey (only on Unix, Linux and Windows systems) | ||
Contains the access key for the shared memory segment used by XAPTP for the communication via OSI TP. xaptpshmkey is a global parameter on Unix, Linux and Windows systems. | ||
max_statistics_msg | ||
Indicates whether or not the application generates statistics message K081 every hour (see the openUTM manual ”Messages, Debugging and Diagnostics” for K081, and the openUTM manual “Generating Applications” for MAX STATISTICS-MSG). | ||
'Y' | Statistics message K081 is generated every hour and written into the SYSLOG file. | |
'N' | Statistics message K081 is not generated. | |
max_open_asyn_conv | ||
Contains the maximum number of asynchronous processes that can be active simultaneously. | ||
dead_letter_q_alarm | ||
Controls monitoring of the number of messages in the dead letter queue. Message K134 is output each time the threshold is reached. | ||
atac_redelivery | ||
Contains the maximum number of repeated deliveries of a message to an asynchronous service when the service is terminated abnormally. | ||
dget_redelivery | ||
Contains the maximum number of repeated deliveries of a message to a servicecontrolled queue when rolling back the transaction. | ||
principal_lth (only on BS2000 systems) | ||
Contains the maximum length of a Kerberos principal in bytes (see openUTM manual “Generating Applications”, MAX PRINCIPAL-LTH=). | ||
privileged_lterm | ||
Contains the name of the privileged LTERM (see openUTM manual “Generating Applications”, MAX PRIVILEGED-LTERM=). | ||
cache_location | ||
Returns the storage location of the UTM cache. | ||
'P' | The UTM cache is created in the program space. For Unix, Linux, and Windows systems. the value 'P' is always returned here. | |
'D' | On BS2000 systems, the UTM cache is created in one or more data spaces (see openUTM manual “Generating Applications”, MAX CACHESIZE=). | |
data_compression | ||
Specifies whether data compresion is permitted via generation: | ||
'Y' | Data compresion is permitted. | |
'N' | Data compresion is not permitted | |
See openUTM manual “Generating Applications”, KDCDEF statement DATA-COMPRESSION=. | ||
hostname_long | ||
BS2000 systems: Unix, Linux and Windows systems: | ||
move_bundle_msgs | ||
Contains the value generated in parameter MOVE-BUNDLE-MSGS of the MAX statement: | ||
'Y' | If no connection to the partner application can be established, UTM moves waiting asynchronous messages of a slave LTERM, slave LPAP or Slave OSI-LPAP to a different slave of the same bundle. | |
'N' | Waiting asynchronous messages on a slave are not moved. |