set format

[set log_filesize=maximum-message-log-file-capacity]
[set log_msg_console=Y|N]
[set log_msg_allno=Y|N]
[set log_msg_prcid=Y|N]
[set log_msg_prcno=Y|N]
[set log_msg_sysid=Y|N]
[set log_msg_date=Y|N]
[set log_msg_time=Y|N]
[set log_msg_hostname=Y|N]
[set log_msg_pgmid=Y|N]
[set log_netm_out=Y|N]
[set log_netm_allno=Y|N]
[set log_netm_prcid=Y|N]
[set log_netm_prcno=Y|N]
[set log_netm_sysid=Y|N]
[set log_netm_date=Y|N]
[set log_netm_time=Y|N]
[set log_netm_hostname=Y|N]
[set log_netm_pgmid=Y|N]
[set log_jp1_allno=Y|N]
[set log_jp1_prcid=Y|N]
[set log_jp1_prcno=Y|N]
[set log_jp1_sysid=Y|N]
[set log_jp1_date=Y|N]
[set log_jp1_time=Y|N]
[set log_jp1_hostname=Y|N]
[set log_jp1_pgmid=Y|N]
[set log_notify_out=Y|N]
[set log_notify_allno=Y|N]
[set log_notify_prcid=Y|N]
[set log_notify_prcno=Y|N]
[set log_notify_sysid=Y|N]
[set log_notify_date=Y|N]
[set log_notify_time=Y|N]
[set log_notify_hostname=Y|N]
[set log_notify_pgmid=Y|N]
[set log_jerr_rint=number-of-suppressed-message-log-outputs]
[set log_syslog_out=syslog-output-level]
[set log_syslog_allno=Y|N]
[set log_syslog_prcid=Y|N]

[set log_syslog_prcno=Y|N]
[set log_syslog_sysid=Y|N]
[set log_syslog_date=Y|N]
[set log_syslog_time=Y|N]
[set log_syslog_hostname=Y|N]
[set log_syslog_pgmid=Y|N]
[set log_syslog_append_nodeid=Y|N]
[set log_syslog_elist=number-of-elements-of-syslog-error-list]
[set log_syslog_elist_rint=regular-output-interval-of-syslog-error-list]
[set log_syslog_synchro=Y|N]
[set log_audit_out=Y|N]
[set log_audit_path=audit-log-file-output-directory]
[set log_audit_size=maximum-audit-log-file-size]
[set log_audit_count=maximum-number-of-audit-log-files]
[set log_audit_message=message-ID-for-which-audit-log-data-is-to-be-acquired
                     [,message-ID-for-which-audit-log-data-is-to-be-acquired]...]
[set watch_time=maximum-response-waiting-time]

command format

None

putenv format

[putenv TZ time-zone]
[putenv DCSYSLOGOUT 1|character-string-other-than-1]

The log service definition defines the output environment for the message log. Use of the real time output facility enables the message log to be output to the message log file, as well as standard output.

log_filesize=maximum-message-log-file-capacity~<unsigned integer> ((1-32767)) <<1024>> (Unit: kilobytes)

Specify the maximum capacity of the message log file. There are two message log files for each log service. A file is switched when the specified maximum capacity is reached.

log_msg_console=Y|N~<<Y>>

Specify whether the real time output facility is to be used.

Y

The real time facility is used.

N

The real time facility is not used.

The following operands (log_msg_xxxx) become effective only when Y is specified.

log_msg_allno=Y|N~<<N>>

Specify whether to add system-specific message sequence numbers to the entries in the message log when the real-time output facility is used.

Y

System-specific message sequence numbers are added to the entries in the message log.

N

System-specific message sequence numbers are not added to the entries in the message log.

log_msg_prcid=Y|N~<<N>>

Specify whether the process ID of the requesting process is to be appended to the message log when using the real time output facility.

Y

The process ID is appended.

N

The process ID is not appended.

log_msg_prcno=Y|N~<<N>>

Specify whether to add process-specific message sequence numbers to the entries in the message log when the real-time output facility is used.

Y

Process-specific message sequence numbers are added to the entries in the message log.

N

Process-specific message sequence numbers are not added to the entries in the message log.

log_msg_sysid=Y|N~<<Y>>

Specify whether the OpenTP1 identifier is to be appended to the message log when using the real time output facility.

Y

The OpenTP1 identifier is appended.

N

The OpenTP1 identifier is not appended.

log_msg_date=Y|N~<<Y>>

Specify whether the output request date is to be appended to the message log when using the real time output facility.

Y

The output request date is appended.

N

The output request date is not appended.

log_msg_time=Y|N~<<Y>>

Specify whether the output request time is to be appended to the message log when using the real time output facility.

Y

The output request time is appended.

N

The output request time is not appended.

log_msg_hostname=Y|N~<<Y>>

Specify whether the name of the host requesting output is to be appended to the message log when using the real time output facility.

Y

The host name is appended.

N

The host name is not appended.

log_msg_pgmid=Y|N~<<Y>>

Specify whether the ID of the program requesting output is to be appended to the message log when using the real time output facility.

Y

The program ID is appended.

N

The program ID is not appended.

log_netm_out=Y|N~<<N>>

Specify whether the message log is to be output to NETM.

Y

The message log is output to NETM.

N

The message log is not output to NETM.

Specifications of the following operands (log_netm_xxxx) are valid only if Y is specified.

log_netm_allno=Y|N~<<N>>

Specify whether the system sequence number is to be appended to the message log if outputting to NETM.

Y

The system sequence number is appended.

N

The system sequence number is not appended.

log_netm_prcid=Y|N~<<N>>

Specify whether the process ID is to be appended to the message log if outputting to NETM.

Y

The process ID is appended.

N

The process ID is not appended.

log_netm_prcno=Y|N~<<N>>

Specify whether the process sequence number is to be appended to the message log if outputting to NETM.

Y

The process number is appended.

N

The process number is not appended.

log_netm_sysid=Y|N~<<Y>>

Specify whether the OpenTP1 identifier is to be appended to the message log if outputting to NETM.

Y

The OpenTP1 identifier is appended.

N

The OpenTP1 identifier is not appended.

log_netm_date=Y|N~<<Y>>

Specify whether the date of the output request is to be appended to the message log if outputting to NETM.

Y

The date is appended.

N

The date is not appended.

log_netm_time=Y|N~<<Y>>

Specify whether the time of the output request is to be appended to the message log if outputting to NETM.

Y

The time is appended.

N

The time is not appended.

log_netm_hostname=Y|N~<<Y>>

Specify whether the name of the host making the output request is to be appended to the message log if outputting to NETM.

Y

The host name is appended.

N

The host name is not appended.

log_netm_pgmid=Y|N~<<Y>>

Specify whether the ID of the program making the output request is to be appended to the message log if outputting to NETM.

Y

The program ID is appended.

N

The program ID is not appended.

log_jp1_allno=Y|N~<<N>>

Specify whether the system sequence number is to be appended to the message log if outputting to the JP1 event service facility.

Y

The system sequence number is appended.

N

The system sequence number is not appended.

log_jp1_prcid=Y|N~<<N>>

Specify whether the process ID is to be appended to the message log if outputting to the JP1 event service facility.

Y

The process ID is appended.

N

The process ID is not appended.

log_jp1_prcno=Y|N~<<N>>

Specify whether the process sequence number is to be appended to the message log if outputting to the JP1 event service facility.

Y

The process sequence number is appended.

N

The process sequence number is not appended.

log_jp1_sysid=Y|N~<<Y>>

Specify whether the OpenTP1 identifier is to be appended if outputting to the JP1 event service facility.

Y

The process sequence number is appended.

N

The process sequence number is not appended.

log_jp1_date=Y|N~<<Y>>

Specify whether the date of the output request is to be appended to the message log if outputting to the JP1 event service facility.

Y

The date is appended.

N

The date is not appended.

log_jp1_time=Y|N~<<Y>>

Specify whether the time of the output request is to be appended to the message log if outputting to the JP1 event service facility.

Y

The time is appended.

N

The time is not appended.

log_jp1_hostname=Y|N~<<Y>>

Specify whether the name of the host making the output request is to be appended to the message log if outputting to the JP1 event service facility.

Y

The host name is appended.

N

The host name is not appended.

log_jp1_pgmid=Y|N~<<Y>>

Specify whether the ID of the program making the output request is to be appended to the message log if outputting to the JP1 event service facility.

Y

The program ID is appended.

N

The program ID is not appended.

log_notify_out=Y|N~<<N>>

Specify whether the message log notification facility is to be used.

Y

The message log notification facility is used.

N

The message log notification facility is not used.

Only when Y is specified, the specification of the following operands (log_notify_xxxx) is validated.

log_notify_allno=Y|N~<<N>>

Specify whether the system sequence number is to be appended to the message log when using the message log notification facility.

Y

The system sequence number is appended.

N

The system sequence number is not appended.

log_notify_prcid=Y|N~<<N>>

Specify whether the ID of the process making the request is to be appended when using the message notification facility.

Y

The process ID is appended.

N

The process ID is not appended.

log_notify_prcno=Y|N~<<N>>

Specify whether the process sequence number is appended to the message log when using the message notification facility.

Y

The process sequence number is appended.

N

The process sequence number is not appended.

log_notify_sysid=Y|N~<<Y>>

Specify whether the OpenTP1 identifier is to be appended when using the message log notification facility.

Y

The OpenTP1 identifier is appended.

N

The OpenTP1 identifier is not appended.

log_notify_date=Y|N~<<Y>>

Specify whether the date of the output request is to be appended to the message log when using the message log notification facility.

Y

The date is appended.

N

The date is not appended.

log_notify_time=Y|N~<<Y>>

Specify whether the time of the output request is to be appended to the message log when using the message log notification facility.

Y

The time is appended.

N

The time is not appended.

log_notify_hostname=Y|N~<<Y>>

Specify whether the name of the host making the output request is to be appended to the message log when using the message log notification facility.

Y

The host name is appended.

N

The host name is not appended.

log_notify_pgmid=Y|N~<<Y>>

Specify whether the ID of the program making the output request is to be appended to the message log when using the message log notification facility.

Y

The program ID is appended.

N

The program ID is not appended.

log_jerr_rint=number-of-suppressed-message-log-outputs~<unsigned integer> ((1-65536)) <<32>>

Specify the number of suppressed message log outputs if an error occurs while the message log is being output to the JP1 event service facility.

If an error occurs during message log output to the JP1 event service facility, the log output is suppressed as many times as specified in the log_jerr_rint operand, after which output is retried.

log_syslog_out=syslog-output-level~<unsigned integer> ((0-2)) <<1>>

For all messages that output to log files, specify the output request level of those messages to output to syslog.

0

No message is output to syslog.

1

Messages are output to syslog only when the message type is -E or -W.

2

All messages are output to syslog.

If 1 or 2 is specified, this operand takes effect when 1 is specified for the DCSYSLOGOUT environment variable.

The log_syslog_xxxx operands specified below take effect when 1 or 2 is specified in the log_syslog_out operand.

By specifying this operand, you can control the messages that are output by the dc_logprint function issued from the UAP. Note, however, that you cannot completely control other messages. Therefore, even when 1 is specified for the DCSYSLOGOUT environment variable, messages that are supposed to be suppressed may be output to syslog if 1 or 2 is specified for the log_syslog_out operand in some cases.

To completely control the messages that are output to syslog, you need to change the syslogd configuration file settings.

In OpenTP1, the information described below is added to syslog output requests. To completely control output to syslog, change the syslogd configuration file settings based on this information.

• syslog facility: LOG_USER
• syslog level
  When the message type is -E: LOG_ERR
  When the message type is -W: LOG_WARNING
  When the message type is -I: LOG_INFO
  When the message type is -R: LOG_NOTICE
  

The table below shows whether messages can be output to syslog for each OS.

Legend:

Y: Messages can be output.

N: Messages cannot be output.

--: Not applicable

log_syslog_allno=Y|N~<<N>>

Specify whether to append the intra-system serial number of the message log when using the syslog output facility.

Y

The intra-system serial number of the message log is appended.

N

The intra-system serial number of the message log is not appended.

log_syslog_prcid=Y|N~<<N>>

Specify whether to append the ID of the process making the request when using the syslog output facility.

Y

The ID of the processing making the request is appended.

N

The ID of the processing making the request is not appended.

log_syslog_prcno=Y|N~<<N>>

Specify whether to append the intra-process serial number of the message log when using the syslog output facility.

Y

The intra-process serial number of the message log is appended.

N

The intra-process serial number of the message log is not appended.

log_syslog_sysid=Y|N~<<N>>

Specify whether to append the OpenTP1 identifier when using the syslog output facility.

Y

The OpenTP1 identifier is appended.

N

The OpenTP1 identifier is not appended.

log_syslog_date=Y|N~<<N>>

Specify whether to append the date of the output request to the message log when using the syslog output facility.

Y

The date is appended.

N

The date is not appended.

log_syslog_time=Y|N~<<N>>

Specify whether to append the time of the output request to the message log when using the syslog output facility.

Y

The time is appended.

N

The time is not appended.

log_syslog_hostname=Y|N~<<N>>

Specify whether to append the name of the host making the output request to the message log when using the syslog output facility.

Y

The host name is appended.

N

The host name is not appended.

log_syslog_pgmid=Y|N~<<N>>

Specify whether to append the ID of the program making the output request to the message log when using the syslog output facility.

Y

The program ID is appended.

N

The program ID is not appended.

log_syslog_append_nodeid=Y|N~<<N>>

Specify whether to append the node identifier when using the syslog output facility.

Y

The node identifier is appended.

N

The node identifier is not appended.

log_syslog_elist=number-of-elements-of-syslog-error-list~<unsigned integer> ((0-65536)) <<0>>

Specify the number of memory queue elements that store messages when the log service failed to output to the syslog file. The messages are stored until the retry time.

If the syslog error list being full must store a new message, the oldest message is deleted and the new one is stored.

One element consists of 512 bytes.

This operand is effective when 1 or greater value is specified for both of this operand and the log_syslog_out operand.

The interval for outputting messages that are contained in the syslog error list is specified in the log_syslog_elist_rint operand.

This operand can be used in AIX and Linux (IPF). In Linux (IPF), however, the extended SYSLOG facility^# is required. Accordingly, in an environment in which the extended SYSLOG facility has not been installed or in which the facility does not operate, this operand cannot be specified.

#:

The extended SYSLOG facility is a program provided by the support service (SD-LS100-FR1N1 or SD-LS200-FR1N1).

log_syslog_elist_rint=regular-output-interval-of-syslog-error-list~ <unsigned integer> ((0-65536)) <<0>> (Unit: seconds)

Specify the interval of regular output of the messages from the syslog error list to the syslog file.

Specify 0 to disable the regular output of the messages from the syslog error list to the syslog file.

This operand is effective when 1 or greater value is specified for both the log_syslog_out and the log_syslog_elist operands.

This operand can be used in AIX and Linux (IPF). In Linux (IPF), however, the extended SYSLOG facility^# is required. Accordingly, in an environment in which the extended SYSLOG facility has not been installed or in which the facility does not operate, this operand cannot be specified.

#:

The extended SYSLOG facility is a program provided by the support service (SD-LS100-FR1N1 or SD-LS200-FR1N1).

log_syslog_synchro=Y|N~<<N>>

This operand specifies whether to output the applicable message log using the format specified in the related operand (log_syslog_xxxx) if the communication to the log server fails while the syslog output facility is being used.

However, this operand is invalid when the log_syslog_allno operand is specified. If you specify the log_syslog_synchro operand with the log_syslog_allno operand, a blank is displayed.

Y

Outputs the message log using the format specified in the related operand.

N

Does not output the message log using the format specified in the related operand.

log_audit_out=Y|N ~<<N>>

Specify whether to use the audit logging facility.

Y

The audit logging facility is used.

N

The audit logging facility is not used.

The following operands (log_audit_xxxx) take effect only when Y is specified:

log_audit_path=audit-log-file-output-directory ~<1-to-63-character path name> <<$DCDIR/auditlog>>

Specify the absolute path name of the directory in which audit log files are created when the audit logging facility is used. Do not specify a directory on a shared disk. Although the directory that will directly contain the audit log files is created when the dcauditsetup command is executed, make sure that all the upper-level directories already exist.

On all the directories that constitute the path specified in this operand, execution permission must be set for owner, group, and others. If execution permission has not been set for owner, group, and others, an error might occur during output of the audit log data.

The directory specified in this operand must be on a disk with enough capacity to store audit log files. You can use the following formula to calculate the capacity of the disk that contains the audit log file output directory:

Disk capacity (megabytes) = maximum-size-of-an-audit-log-file x maximum-number-of-audit-log-files

This operand takes effect when Y has been specified for the log_audit_out operand.

log_audit_size=maximum-size-of-an-audit-log-file ~<unsigned integer> ((1-2047)) <<10>> (units: megabytes)

Specify the maximum size of each audit log file created when the audit logging facility is used. When the size of an audit log file reaches the specified maximum size, output switches to a new file.

This operand takes effect when Y has been specified for the log_audit_out operand.

log_audit_count=maximum-number-of-audit-log-files ~<unsigned integer> ((1-256)) <<2>>

Specify the maximum number of audit log files created when the audit logging facility is used.

When a new file replaces the current audit log file, if the number of files (number-of-log-files + number of backup log files) has already reached the maximum number specified in this operand, the oldest file is deleted.

The following table shows how backup log files are created according to the value of this operand.

Table 3-6 Value of the log_audit_count operand and backup log file names

Note: The greater the value of this operand, the larger the overhead when the output destination file is switched.

This operand takes effect when Y has been specified for the log_audit_out operand.

log_audit_message=message-ID-for-which-audit-log-data-is-to-be-acquired[,message-ID-for-which-audit-log-data-is-to-be-acquired]... ~<unsigned integer> ((33400-99999)))

Specify the message IDs of the items for which you want to acquire audit log data in the range from 33400 to 99999. You can specify a maximum of 2048 message IDs.

For details about message IDs that can be specified in this operand, see C. Definition for Acquiring Audit Events.

This operand can also be specified in the user service definition, RAP-processing listener service definition, and user service default definition. The priority of the specified values is (1. > 2. > 3.):

1. The user service definition or the RAP-processing listener service definition
2. The user service default definition
3. The log service definition

This operand takes effect when Y has been specified for the log_audit_out operand.

watch_time=maximum-response-waiting-time~<unsigned integer> ((0-65535)) (Unit: seconds)

Specify the maximum waiting time between sending a service request and receipt of a response when communicating between processes by RPC.

OpenTP1 may suspend termination processing for the length of time specified in this operand. Therefore, if you specify a large value, the termination processing of OpenTP1 may take some time.

If no response is received within the specified time, RPC returns a transmission timeout error.

Specify 0 if the system is to wait for a response. When you specify 0, OpenTP1 may not terminate.

If this operand is omitted, the value specified with the watch_time operand of the system common definition is assumed.

Use the default of the watch_time operand of the system common definition for this operand.

We recommend that you do not change the operand unless special tuning is necessary.

If a value that is much greater or smaller than the default of the watch_time operand of the system common definition is specified, a failure may occur causing OpenTP1 to go down.

None

TZ time-zone~<character string>

Set a value for the environment variable TZ.

A time zone sets the environment if the time or similar parameter is being displayed.

Make sure that the time zone specified in this operand is the same as the time zone of the command execution environment. If the time zones are different, the times of data output to syslog will not be correct.

DCSYSLOGOUT 1|character-string-other-than-1

Specify whether to output messages to syslog.

To output messages to syslog, specify 1 for the DCSYSLOGOUT environment variable. If you specify a character string other than 1 or if you omit specification of this operand, messages are not output to syslog.

For details on how to control output, see the description of the log_syslog_out operand.

• The maximum length of each message that can be output to syslog is 255 bytes. If a message is longer than 255 bytes, only the first 255 bytes of the message are output to syslog.
• For some operands in the log service definition, a header is added to each user message when Y is specified. When headers are added, the amount of message content that can be output to syslog decreases.
  The following table lists the operands that add a header when Y is specified, and the length of the header to be added. The length of the header includes a space character placed between the header and the message. Also note that 12 additional bytes are added to the header as the message ID.
  

  Operand	Size of the header to be added (bytes)
  log_syslog_allno	8
  log_syslog_prcid	11
  log_syslog_prcno	8
  log_syslog_sysid	3
  log_syslog_date	11
  log_syslog_time	9
  log_syslog_hostname	9
  log_syslog_pgmid	4
  log_syslog_append_nodeid	5

• If the last character of a message output to syslog is a multi-byte character when the 256th and subsequent bytes of a message are discarded, the character may be displayed incorrectly.