Configuring server custom properties

Use this page to configure server custom properties provided with the WebSphere Application Server for z/OS product.

Server custom properties can be specified in the administrative console by clicking Application Servers > server1 >Custom Properties. The support for the following server custom properties is

[5.0 only][Version 5.0.1]Note: You can also set these properties through the WebSphere variables mechanism at server, node, or cell level.

[Version 5.0.2 and later]Deprecation notice: Setting server properties as server-level WebSphere variables is deprecated. However, you can set a WebSphere variable with a scope of cell or node to establish custom defaults for server properties.

control_region_dreg_on_no_srs
Specifies whether or not the controller rejects requests for dispatch within a servant when it detects that there are no servants available to process requests.

If this property is set to 1, when the controller detects that there are no servants available to process requests, it rejects requests for dispatch within the servants, de-registers the application server with WLM, and stops the HTTP and MDB listeners. If this property is set to 0 (zero) the function is disabled.

When a minimal number of servants become available again, the controller re-registers the application server with WLM, starts the HTTP and MDB listeners, and allows requests to be dispatched to the servants.

Data Type Integer
Acceptable values 0 or 1
Default 0
control_region_confirm_recovery_on_no_srs
Indicates when requests should be dispatched to servants following the detection of a no-servants situation. This property is ignored if the control_region_dreg_on_no_srs custom property is set to 0.

If this property is set to 1, requests are not dispatched to the servants until after the WebSphere Application Server administrator responds to WTOR message BBOO0297A. This message is issued following a no-servant situation when the sever detects that the required minimal number of servants are available to process requests.

If this property is set to 0 (zero), the controller determines when to allow requests to be dispatched to the servants after a no-servant condition is detected.

Data Type Integer
Acceptable values 0 or 1
Default 0
control_region_mdb_request_timeout
Specifies the time, in seconds, that the server waits for a message-driven bean (MDB) request to receive a response. If the response is not received within the specified amount of time, the server removes the MDB request.

Set this value to 0 (zero) to disable the function.

Data Type Integer
Units Seconds
Default 120
control_region_ssl_thread_pool_size
Specifies the number of threads that are available to process SSL handshakes.

Note: It is strongly recommended that you do not modify this property without guidance from IBM Support.

Data Type Integer
Default 3
Used by Daemon yes
control_region_timeout_delay
Specifies the number of seconds a controller waits after detecting a timeout before it terminates the servant. This time delay gives work that is currently running in the servant a chance to complete before the servant is terminated. When a servant thread completes work and sees that the servant is being terminated, the servant thread waits instead of selecting a new piece of work.

Set this value to 0 (zero) to disable the function.

Data Type Integer
Units Seconds
Default 120
protocol_accept_http_work_after_min_srs
Specifies whether or not the application server waits for a minimum number of server regions (specified on the wlm_minimumSRCount variable) to be up before starting the HTTP transports. If this property is set to true, when the minimum number of server regions is ready for work, the HTTP transport starts accepting work. If this property is set to false, the HTTP transports are started when the control region starts.
Data Type Boolean
Default false
Used by Daemon no
protocol_bboc_log_response_failure
Specifies that if the BBOO0168W message is issued, the failure detected when attempting to send a response to a client is recorded. The message is sent to the error log. The message text contains the request method name, the reply status, and routing information identifying the client.
Data Type Boolean
Default false
Used by Daemon yes
protocol_bboc_log_return_exception
Used to indicate that if the BBOO0169W message is issued, the response that contains the SystemException is recorded. The message is sent to the error log. The message text contains the exception identifier and minor code, the request method name, and routing information identifying the client.
Data Type Boolean
Default false
Used by Daemon yes
protocol_giop_level_highest
Specifies the CORBA General Inter-ORB Protocol (GIOP) protocol version level that is used by the application server object request broker (ORB). Valid values are 1.1 and 1.2. Interoperable object references (IORs) exported from this server use the GIOP level indicated.

You might need to change this property from the default if you use a non-WebSphere Application Server client ORB that supports a lower version of the CORBA standard. For example, you might need to change from the default protocol version level of 1.2 to 1.1 to support an older, non-WebSphere Application Server client ORB.

Data Type String
Default 1.2
Used by Daemon Yes
protocol_http_backlog
Specifies the maximum length for the queue of pending connections using HTTP. The value used can be limited by the specification of the SOMAXCONN statement in the TCP/IP profile.
Data Type Integer
Default 10
Used by Daemon No
protocol_http_large_data_response_buffer
Specifies, in bytes, the maximum length of the response buffer used for HTTP requests. Responses larger than this value are rejected. A value of 0 indicates not to allocate a large response buffer. An HTTP large response buffer is not required if all the HTTP responses are less than 10 MB.
Data Type Integer
Default 104857600
Used by Daemon No
protocol_http_large_data_inbound_buffer
Specifies, in bytes, the length of a serially reusable inbound buffer used for HTTP requests larger than 10 megabytes. This value limits the size of incoming requests. For example, if you set the property to 15 megabytes, any requests over 15 megabytes are rejected. Specify 0 (zero) to indicate that no buffer is needed. Requests that are larger than 10 megabytes are rejected.
Data Type Integer
Default 0
Used by Daemon No
protocol_http_timeout_output_recovery
Specifies the action for the timer expiration. Set the value to SESSION to send the client a message stating that the server timed out and let the server continue running.

To set this variable, in the administrative console click Environment > Manage WebSphere Variables > Scope Server > Apply > New . Then specify protocol_http_timeout_output_recovery for the variable name and either SESSION or SERVANT for the property value.

Data Type SESSION | SERVANT
Default SERVANT
Used by Daemon No
protocol_https_timeout_output_recovery
Specifies the action for the timer expiration. Set the value to SESSION to send the client a message stating that the server timed out and let the server continue running.

To set this variable, in the administrative console click Environment > Manage WebSphere Variables > Scope Server > Apply > New . Then specify protocol_https_timeout_output_recovery for the variable name and either SESSION or SERVANT for the property value.

Data Type SESSION | SERVANT
Default SERVANT
Used by Daemon No
protocol_https_backlog
Specifies the maximum length for the queue of pending connections using HTTPS. The value used can be limited by the specification of the SOMAXCONN statement in the TCP/IP Profile.
Data Type Integer
Default 10
Used by Daemon No
protocol_iiop_backlog
Specifies the maximum length for the queue of pending connections using the CORBA Internet Inter-ORB protocol (IIOP). The value used may be limited by the specification of the SOMAXCONN statement in the TCP/IP profile.
Data Type Integer
Default 10
Used by Daemon Yes
protocol_iiop_backlog_ssl
Specifies the maximum length for the queue of pending connections using IIOP Secure Sockets Layer (SSL). The value used can be limited by the specification of the SOMAXCONN statement in the TCP/IP Profile.
Data Type Integer
Default 10
Used by Daemon Yes
protocol_iiop_resolve_foreign_hostname
Specifies whether to perform DNS resolution of the IP address of a foreign client to a DNS registered hostname for each established IIOP session. If this property is set to 1, the DNS hostname resolution is performed. If this property is set to 0, the DNS hostname resolution is not performed, and a textual representation of the IP address of the foreign client is used instead of the DNS hostname.
Data Type boolean
Default 1
Used by Daemon Yes
ras_debugEnabled
Specifies to use an external debugger tool with the application server for tracing and debugging client and server application components such as JSP files, servlets, and enterprise beans.
Data Type Boolean
Default false
Used by Daemon Yes
ras_default_msg_dd
Specifies whether to redirect write-to-operator (WTO) messages that use the default routing to hardcopy. These messages are redirected to the location identified through the DD card on the server's job control language (JCL) start procedure. These write to operator (WTO) messages are primarily messages that WebSphere Application Server for z/OS issues during initialization.
Data Type String
Default empty string
Used by Daemon Yes
ras_dumpoptions_dumptype
Specifies the default dump that is used by the signal handler. Do not change this property unless directed by IBM service personnel.
0 No dump is generated.
1 A ctrace dump is taken.
2 A cdump dump is taken.
3 A csnap dump is taken.
4 A CEE3DMP dump is taken.
Data Type Integer
Default 3
Used by Daemon Yes
ras_dumpoptions_ledumpoptions
Specifies dump options use with a CEE3DMP dump. If you want more than one option, separate each option with a blank. Do not change this property unless directed by IBM service personnel.
Data Type String
Default THREAD(ALL) BLOCKS
Used by Daemon Yes
ras_hardcopy_msg_dd
Specifies redirect write to operator (WTO) messages that WebSphere Application Server for z/OS routes to hardcopy. These messages are redirected to the location that is identified through the DD card on the server JCL start procedure. These WTO messages are primarily audit messages issued from Java code during initialization.
Data Type String
Default empty string
Used by Daemon Yes
ras_log_logstreamName
Specifies the log stream for WebSphere Application Server for z/OS to use for error information. If the specified log stream is not found or not accessible, a message is issued and errors are written to the server job log. If this variable is not specified, WebSphere Application Server for z/OS uses the STDERR stream.
Data Type String
Default empty string
Used by Daemon Yes
ras_minorcode_action
Specifies the default behavior for gathering documentation about system exception minor codes.
Data Type String
Default NODIAGNOSTICDATA
Used by Daemon Yes

You can also specify:

ras_stderr_ff_interval
Specifies the interval of time (in minutes) between the writing of a form-feed character to standard error, or SYSOUT.

Note: This environment setting must be combined with the SEGMENT= parameter on the SYSPRINT DD statement in order to segment the output. The value of the SEGMENT= parameter is the number of form-feeds required before the first segment is closed and a new segment is allocated. Due to special circumstances concerning the SYSOUT DD statement, additional JCL updates are required to exploit the SEGMENT option for SYSOUT.

The recommended method to enable segmenting of the SYSOUT DD statement is to define a new DD statement named SYSERR. The SYSERR DD statement should be defined exactly as the SYSOUT DD statement would be. Apply the SEGMENT= option to the new SYSERR DD statement. Finally, add this to the PARM= setting:

PARM='2>DD:SYSERR'

Another method that will enable segmenting of the SYSOUT DD statement is to define a new DD statement named CEEMSG. The CEEMSG DD statement should be defined exactly as the SYSOUT DD statement would be. Apply the SEGMENT= option to the SYSOUT DD statement. Finally, add this to the PARM= setting:

PARM='MSGFILE(CEEMSG)/2>DD:SYSOUT'

Data Type Integer
Default 0
Used by Daemon Yes
ras_stdout_ff_interval
Specifies the interval of time (in minutes) between the writing of a form-feed character to standard output, or SYSPRINT

Note: This environment setting must be combined with the SEGMENT= parameter on the SYSPRINT DD statement in order to segment the output. The value of the SEGMENT= parameter is the number of form-feeds required before the first segment is closed and a new segment is allocated.

Data Type Integer
Default 0
Used by Daemon Yes
ras_time_local
Specifies whether timestamps in the error log display in local time or Greenwich Mean Time (GMT), which is the default.
Data Type Boolean
Default false
Used by Daemon Yes
ras_trace_basic
Specifies tracing overrides for particular WebSphere Application Server for z/OS subcomponents. Subcomponents, specified by numbers, receive basic and exception traces. If you specify more than one subcomponent, use parentheses and separate the numbers with commas. Contact IBM service for the subcomponent numbers and their meanings. Do not change this property unless directed by IBM service personnel.
Data Type String
Default null (empty string)
Used by Daemon Yes
ras_trace_BufferCount
Specifies the number of trace buffers to allocate.
Data Type Integer
Valid values 4 through 8
Default 4
Used by Daemon Yes
ras_trace_BufferSize
Specifies the size of a single trace buffer in bytes. You can use the letters "K" (for kilobytes) or "M" (for megabytes).
Data Type String
Valid values 128K through 4M
Default 1M
Used by Daemon Yes
ras_trace_ctraceParms
Specifies to identify the CTRACE PARMLIB member. The value can be either a two-character suffix, which is added to the CTIBBO string to form the name of the PARMLIB member, or the fully specified name of the PARMLIB member. For example, you can use the 01 suffix, which the system resolves to CTIBBO01. A fully specified name must conform to the naming requirements for a CTRACE PARMLIB member. For details, see z/OS MVS Diagnosis: Tools and Service Aids, GA22-7589.

If this property is specified and the PARMLIB member is not found, the default PARMLIB member, CTIBBO00, is used. If neither the specified nor the default PARMLIB member is found, tracing is defined to CTRACE, but no connection is available to a CTRACE external writer.

Data Type String
Default null (empty string)
Used by Daemon Yes
ras_trace_defaultTracingLevel
Specifies the default tracing level for WebSphere Application Server for z/OS. Use this variable with the ras_trace_basic and ras_trace_detail variables to set tracing levels for Application Server for z/OS subcomponents. Do not change this property unless directed by IBM service personnel.
0 No tracing
1 Exception tracing
2 Basic and exception tracing
3 Detailed tracing, including basic and exception tracing
Data Type Integer
Default 1
Used by Daemon Yes
ras_trace_detail
Specifies tracing overrides for particular WebSphere Application Server for z/OS subcomponents. Subcomponents, specified by numbers, receive detailed traces. If you specify more than one subcomponent, use parentheses and separate the numbers with commas. Contact IBM service for the subcomponent numbers and their meanings. Do not change this property unless directed by IBM service personnel.
Data Type String
Default null (empty string)
Used by Daemon Yes
ras_trace_exclude_specific
Specifies WebSphere Application Server for z/OS trace points to exclude from tracing activity.

Trace points are specified by 8-digit, hexadecimal numbers. Do not use this property unless directed by IBM service personnel. If IBM service personnel directs you to specify more than one trace point, use parentheses and separate the numbers with commas. You also can specify a WebSphere variable name by enclosing the name in single quotes.

Data Type String
Default empty string
Used by Daemon Yes

Note: Sometimes results depend on the ras_trace_minorCodeDefault environment variable. If you code ras_trace_minorCodeTraceBacks=ALL and ras_minorcode_action=NODIAGNOSTICDATA, you get a traceback. But, if you code ras_trace_minorCodeTraceBacks=(null value) and ras_minorcode_action=TRACEBACK, you also get a traceback. So, specifying ras_trace_minorCodeTraceBacks=(null value) does not cancel the traceback; it does not cause TRACEBACK data to be collected.

ras_trace_outputLocation
Specifies where to send trace records.

For servers, you might specify one or more values, separated by a space.

Data Type String
Default SYSPRINT BUFFER
Used by Daemon Yes
ras_trace_specific
Specifies tracing overrides for specific WebSphere Application Server for z/OS trace points. Trace points are indicated by 8-digit, hexadecimal numbers. To specify more than one trace point, use parentheses and separate the numbers with commas. You can also specify tracing on a specific environment variable by using the name enclosed in single quotes. Do not use this property unless directed by IBM service personnel.
Data Type String
Default null (empty string)
Used by Daemon Yes
server_region_jvm_localrefs
Do not use this property unless directed by IBM support personnel.
Data Type Integer
Default 128
Used by Daemon No
server_region_jvm_logfile
Specifies the Hierarchical File System (HFS) file in which Java Native Interface (JNI) and class debug messages from the Java virtual machine (JVM) are logged. Use this variable only in a single-server environment. If you use this property in a multiple-server environment, all of the servers write to the same file, so you might have difficulty using the file for diagnostic purposes.
Data Type String (file name)
Default empty string (no file name)
Used by Daemon No
server_region_recycle_count
Specifies the number of transactions processed by a servant process after which the servant process is recycled. Workload management (WLM) ends the server region after all affinity requirements have been met. Specify a non-zero value to enable recycling.

You might want to enable recycling if, after running for an extended period of time, your application is experiencing out-of-memory exceptions . (Out-of-memory exceptions can result from memory leakage by your application.)

Data Type Integer
Default 0
Used by Daemon No
server_start_wait_for_initialization_Timeout
Specifies how long the startServer.sh command processing waits for WebSphere Application Server initialization to complete. By default, it waits indefinitely until initialization is complete.

You might want to use this property if you want to:

Data Type Integer
Default 0
Used by Daemon No
transaction_recoveryTimeout
Specifies the time, in minutes, that this controller (region) uses to attempt to complete all restart transactions before issuing a write-to-operator-with-reply (WTOR) message to the console, requesting whether to:

If the operator replies to continue the recovery, the controller (region) attempts recovery for the specified amount of time before reissuing the WTOR message. After all the transactions are resolved, the control region terminates. This variable applies only to controllers in peer restart and recovery mode.

Data Type Integer
Default 15
Used by Daemon No
protocol_http_tcp_no_delay
Determines whether or not the setsockopt API is issued to set the TCP_NODELAY option for HTTP transport connections.

A value of true indicates that the TCP_NODELAY option should be used for HTTP transport connections. This TCP/IP option disables the Nagle algorithm for all HTTP transport connections.

Data Type Boolean
Default True
Used by Daemon Yes
protocol_https_tcp_no_delay
Determines whether or not the setsockopt API is issued to set the TCP_NODELAY option for HTTPS transport connections.

A value of true indicates that the TCP_NODELAY option should be used for HTTPS transport connections. This TCP/IP option disables the Nagle algorithm for all HTTPS transport connections.

Data Type Boolean
Default True
Used by Daemon Yes
security_SMF_record_first_auth_user
Specifies whether to record the first authenticated user under request dispatch in the SM120CRE field in the SMF server activity record.

Set security_SMF_record_first_auth_user equal to 1 to fill the SM120CRE field with the ID of the first authenticated user. By default, the property is set to 0, and the SM120CRE field is filled with the ID under which the server activity began. This is often the guest ID.

Data Type Boolean
Default 0
Used by Daemon No

Related tasks
Using the WebSphere Application Server administrative console to enable properties for specific SMF record types
Related reference
Cell-wide z/OS variables
Repository service custom properties
HTTP transport custom properties
Timeout values - controlling behavior



Searchable topic ID:   urun_rproperty_custproperties
Last updated: Jun 21, 2007 9:56:50 PM CDT    WebSphere Application Server for z/OS, Version 5.0.2
http://publib.boulder.ibm.com/infocenter/wasinfo/index.jsp?topic=/com.ibm.websphere.zseries.doc/info/zseries/ae/urun_rproperty_custproperties.html

Library | Support | Terms of Use | Feedback