OpenTP1 Version 7 System Definition
Format
set format
[set mode_conf=AUTO|MANUAL1|MANUAL2] [set static_shmpool_size=total-static-shared-memory] [set dynamic_shmpool_size=total-dynamic-shared-memory-at-maximum- usage] [set shmpool_attribute=free|fixed] [set user_command=user-environment-setting-command] [set server_count=maximum-server-count] [set user_server_ha=Y|N] [set system_terminate_watch_time=watching-time-for-system- terminate-process] [set start_scheduling_timing=BEFORE|AFTER] [set system_init_watch_time=system-initialization-waiting-time] [set user_command_online=command-of-completion-of-starting-system] [set preend_warning_watch_time=monitor-time-to-warn-pre- termination] [set user_command_online_tp1mngr_id=Y|N] |
command format
None
putenv format
[putenv DCCONFPATH definition-file-storage-directory] [putenv DCADMDEBUG 0|1] [putenv DCUAPCONFPATH user-service-definition-file-storage-directory] |
dcputenv format
[dcputenv DCCONFPATH definition-file-storage-directory] [dcputenv DCUAPCONFPATH user-service-definition-file-storage-directory] |
Function
The system environment definition defines the execution environment of an OpenTP1 system. This information is read by the process service at startup of an OpenTP1 system.
Explanation
set format
Operands
mode_conf=AUTO|MANUAL1|MANUAL2~<<MANUAL2>>
Specify the method to start the OpenTP1 system. The actual startup form will be a function of the method specified here and the previous termination mode (normal, forced normal, forced, planned (A), planned (B), or abnormal).
The following table shows the startup forms depending on the combination of the previous termination mode and the value specified in the mode_conf operand.
| Conditions for determining the startup form | Startup form | ||
|---|---|---|---|
| Previous termination mode | Value specified in the 'mode_conf' operand | Startup method | Startup mode |
| Normal termination | AUTO | Manual#1 | Normal start |
| MANUAL1 | Manual | ||
| MANUAL2 | |||
| Forced normal termination | AUTO | Manual#1 | Normal start |
| MANUAL1 | Manual | ||
| MANUAL2 | |||
| Planned termination A | AUTO | Manual#1 | Restart |
| MANUAL1 | Manual | Restart#2 | |
| MANUAL2 | |||
| Planned termination B | AUTO | Manual#1 | Restart |
| MANUAL1 | Manual | Restart#2 | |
| MANUAL2 | |||
| Forced termination | AUTO | Manual#1 | Restart |
| MANUAL1 | Manual | Restart#2 | |
| MANUAL2 | |||
| Abnormal termination | AUTO | Automatic | Restart |
| MANUAL1 | Automatic#3 | ||
| MANUAL2 | Manual | Restart#2 | |
For the specification of mode_conf when using the system switchover facility, see the manual OpenTP1 Description.
static_shmpool_size=total-static-shared-memory~<unsigned integer> ((0-1945600)) <<4096>> (Unit: kilobytes)
Specify the total amount of shared memory that an OpenTP1 system will possess from startup to termination (hereafter static shared memory). The sum of the total amount of dynamic shared memory and the value of the dynamic_shmpool_size must not exceed 1945600. Specify an amount to include memory for all system services that will be started as required.
dynamic_shmpool_size=total-dynamic-shared-memory-at-maximum-usage~<unsigned integer> ((0-1945600)) <<4096>> (Unit: kilobytes)
Specify the total amount of shared memory to be dynamically accessed by system services with a work area image (hereafter dynamic shared memory) at maximum usage. The sum of the total amount of dynamic shared memory at the time of maximum use and the value of the static_shmpool_size must not exceed 1945600.
Specify an amount to include memory for all system services that will be started as required.
shmpool_attribute=free|fixed~<<free>>
An OpenTP1 system secures for the system services a shared memory pool, sufficient in size for static shared memory and dynamic shared memory use. Specify whether this shared memory pool should be free or fixed in memory.
user_command=user-environment-setting-command~<path name>
Specify a user environment setting command to be executed in the path name before starting the OpenTP1 system. When this command is specified, the entire UAP environments such as shared memory allocation and file initialization can be set before starting the OpenTP1 system.
The execution environments of the user environment setting command are as follows:
server_count=maximum-server-count~<unsigned integer> ((32-4096)) <<64>>
Specify the maximum number of servers to be started on one machine during the entire OpenTP1 session. Specify a value equal to the total number of system services to be manipulated with OpenTP1 plus the number of user servers. Regardless of how many times a user server with the same name is started, the number of times the user server was started is considered to be 1. A multiserver is deemed to be one server.
user_server_ha=Y|N~<<N>>
Specify whether the wait user server is to be started without waiting for the system server startup at the time of system switchover.
system_terminate_watch_time=system-terminate-monitor-time~<unsigned integer> ((0-65535)) <<3600>> (Unit: seconds)
Specify the monitoring time when the OpenTP1 terminates using the dcstop command. If the OpenTP1 system does not terminate within the specified time, it is stopped forcibly. If a 0 is specified, the terminate time will not be monitored.
To use the automatic unload function by specifying Y in the jnl_auto_unload operand of the system journal service definition, determine the value of the system_terminate_watch_time operand, taking the unload time into account.
start_scheduling_timing=BEFORE|AFTER~<<AFTER>>
Specify the time to start receiving RPCs at the system start.
When BEFORE is specified, the shutdown status of user servers is not carried over after system complete recovery, regardless of the specification of the hold_recovery operands in the user service definition and user service default definition. If you want to carry over the shutdown status after system complete recovery, specify F in the scd_hold_recovery operand of the schedule service definition. For details about the operand specification for carrying over the shutdown status, see the description of the operands for the schedule service definition.
system_init_watch_time=system-initialization-waiting-time~<unsigned integer> ((0-65535)) (Unit: seconds)
Specify the maximum waiting time for system initialization including execution of the user_command (before the system service starts) during startup of the OpenTP1 system.
Specify 0 to have the system wait infinitely until system initialization terminates.
If this operand is not specified, the value of the watch_time operand of the system common definition is assumed.
user_command_online=command-of-completion-of-starting-system~<path name>
Use a path name to specify a command of completion of the starting system, which is to be executed at the start of OpenTP1. Specifying a command of completion of starting system makes it possible to start the processes that cannot be taken over at the restart of the dcstats or other command when the system start has been completed.
The dcstart command causes the system to wait for the finish of the command of completion of the starting system. If you want to execute the dcstart command asynchronously with the command of completion of starting the system, add an ampersand (&) at the end of the dcstart command.
If the program specified in the user_command_online operand requires environment variables, we recommend that you declare such environment variables in a shell script file and specify the shell script file in the user_command_online operand. If the environment variables required by the program are not declared in the shell script file, the operation of OpenTP1 may be affected if environment variables are not inherited because the system configuration is changed or for some other reason.
The command of completion of starting system is executed under the following environment conditions:
preend_warning_watch_time=monitor-time-to-warn pre-termination~ <unsigned integer> ((0-65535)) <<180>> (unit: seconds)
This specifies the period of time before the warning message KFCA01859-W appears in the pre-termination processing of the dcstop command. A value of 0 provides no monitoring of the time.
user_command_online_tp1mngr_id=Y|N
~<<N>>
Specify whether to execute the system-startup completion command with the OpenTP1 administrator UID and GID.
command format
None
putenv format
DCCONFPATH definition-file-storage-directory~<path name> <<$DCDIR/conf>>
Specify the full path name of the directory in which the definition files are stored. The full path name you specify can have a maximum of 246 bytes. Note that no environment variable can be specified.
This operand is normally used to change a directory if the files are stored in other than a standard directory. However, the system environment definition file env must always be stored in $DCDIR/conf.
DCADMDEBUG 0|1~<<0>>
This operand defines whether to acquire debug information.
OpenTP1 issues the netstat command to acquire the OpenTP1 error information if a UAP goes down. The netstat command is entered more than once if a UAP goes down more than once successively. Depending on the configuration, this command may use the CPU excessively, increasing machine load. To control the CPU use rate, specify 1 for this operand.
DCUAPCONFPATH user-service-definition-file-storage-directory~<path name>
If you want to store specific user service definition files in a directory other than the directory specified in the DCCONFPATH environment variable, specify the full path name of the directory. The full path name you specify can have a maximum of 246 bytes. Note that no environment variable can be specified in this operand.
dcputenv format
DCCONFPATH definition-file-storage-directory~<path name>
Specify the full path name of the directory in which each definition file is stored. When an environment variable name is included in the path name, the environment variable name is replaced with its value. Make sure that the number of bytes in the full path name including the value of the environment variable does not exceed 246.
This operand is normally used to change a directory if the files are stored in other than a standard directory.
DCUAPCONFPATH user-service-definition-file-storage-directory~<path name>
If you want to store specific user service definition files in a directory other than the directory specified in the DCCONFPATH environment variable, specify the full path name of the directory.
When an environment variable name is included in the path name, the environment variable name is replaced with its value. Make sure that the number of bytes in the full path name including the value of the environment variable does not exceed 246.
Notes
If a user service definition file is in the directory specified in the DCCONFPATH environment valuable, the user service definition file in the directory becomes valid.
If the DCCONFPATH and DCUAPCONFPATH environment valuables are specified in the login environment, specify the same values in these environment valuables of the login environment definition as specified in the system environment definition.
All Rights Reserved. Copyright (C) 2006, 2010, Hitachi, Ltd.