6.5.10 Service-information change definition file
- Organization of this subsection
(1) Format
Outputs the information corresponding to each service in an ascending order of the key.
(a) Service information for SOAP adapters (SOAP 1.1 mode)
cluster-name.service-ID.WebService.url=URL-used-for-invoking-service-components
cluster-name.service-ID.WebService.c4web.application.socket_read_timeout=read-timeout-value
cluster-name.service-ID.WebService.c4web.application.socket_connect_timeout=connection-timeout-value
cluster-name.service-ID.WebService.c4web.application.socket_write_timeout=write-timeout-value
cluster-name.service-ID.WebService.c4web.application.proxy_host=host-name-of-proxy-server
cluster-name.service-ID.WebService.c4web.application.non_proxy_hosts=host-name-when-proxy-server-is-not-used
cluster-name.service-ID.WebService.c4web.application.proxy_port=port-number-of-proxy-server
cluster-name.service-ID.WebService.c4web.application.proxy_user=proxy-server-user
cluster-name.service-ID.WebService.c4web.application.proxy_password=proxy-server-password
cluster-name.service-ID.WebService.c4web.common.prf_trace_level=option-to-output-trace-based-performance-analysis
cluster-name.service-ID.WebService.c4web.common.receive_max_soap_envelope_size=maximum-number-of-bytes-of-receiving-SOAPEnvelope
cluster-name.service-ID.WebService.c4web.common.send_max_soap_envelope_size=maximum-number-of-bytes-of-sending-SOAPEnvelope
cluster-name.service-ID.WebService.basic_authentication_use={true|false}
cluster-name.service-ID.WebService.basic_authentication_id=basic-authentication-user
cluster-name.service-ID.WebService.basic_authentication_pass=basic-authentication-password
cluster-name.service-ID.WebService.c4web.application.app_maintainsession={true|false}(b) Service information for SOAP adapters (SOAP 1.1/ 1.2 combined mode)
cluster-name.service-ID.WebService.url=URL-used-for-invoking-service-components
cluster-name.service-ID.WebService.com.cosminexus.csc.request.timeout=read-timeout-value
cluster-name.service-ID.WebService.com.cosminexus.csc.connect.timeout=connection-timeout-value
cluster-name.service-ID.WebService.com.cosminexus.csc.session.maintain={true | false}
cluster-name.service-ID.WebService.com.cosminexus.csc.auto-delete-incomplete-file={true | false}
cluster-name.service-ID.WebService.com.cosminexus.csc.file.read-lock.retry.count=lock-retry-count
cluster-name.service-ID.WebService.com.cosminexus.csc.file.read-lock.retry.interval=lock-retry-interval
cluster-name.service-ID.WebService.basic_authentication_use={true|false}
cluster-name.service-ID.WebService.basic_authentication_id=basic-authentication-user
cluster-name.service-ID.WebService.basic_authentication_pass=basic-authentication-password(c) Service information for SessionBean adapters
cluster-name.service-ID.SessionBean.url=URL-used-for-invoking-service-components cluster-name.service-ID.SessionBean.lookup_name=lookup-name cluster-name.service-ID.SessionBean.c4web.application.ejb_timeout=invocation-timeout-value cluster-name.service-ID.SessionBean.c4web.common.prf_trace_level=option-to-output-trace-based-performance-analysis
(d) Service information for MDB (WS-R) adapters
cluster-name.service-ID.MDB_WSR.queue_name=name-of-queue-to-which-service-adapter-sends-messages
cluster-name.service-ID.MDB_WSR.local_call={true|false}
cluster-name.service-ID.MDB_WSR.url=Web-application-URL-for-transmission-between-transmit-destination-queues
cluster-name.service-ID.MDB_WSR.max_message_num=maximum-number-of-messages-that-can-be-stored-in-transmit-queue
cluster-name.service-ID.MDB_WSR.qos_in_order={true|false}
cluster-name.service-ID.MDB_WSR.rdarea_name=name-of-RD-area-where-transmit-queue-will-be-created(e) Service information for MDB (DB queue) adapters
cluster-name.service-ID.MDB_DBQ.queue_name=queue-name-related-to-service-components
(2) Function
Specifies the changes in the service information of a service adapter.
(3) File storage location
The file is stored in the path specified in the -getfile option of the cscsvcctl command.
(4) Specifiable parameters
(a) Service information for SOAP adapters (SOAP 1.1 mode)
cluster-name.service-ID.WebService.url=URL-used-for-invoking-service-components
Specifies the URL to be used for invoking service components.
cluster-name.service-ID.WebService.c4web.application.socket_read_timeout=read-timeout-value
Specifies a read timeout value for the service adapter socket in seconds. For details on the values to be specified, see the description for c4web.application.socket_read_timeout in 10.3 Setting up the client definition file in the uCosminexus Application Server SOAP Application Development Guide.
cluster-name.service-ID.WebService.c4web.application.socket_connect_timeout=connection-timeout-value
Specifies a connection timeout value for the service adapter socket in seconds. For details on the values to be specified, see the description for c4web.application.socket_connect_timeout in 10.3 Setting up the client definition file in the uCosminexus Application Server SOAP Application Development Guide.
cluster-name.service-ID.WebService.c4web.application.socket_write_timeout=write-timeout-value
Specifies a write timeout value for the service adapter socket in seconds. For details on the values to be specified, see the description for c4web.application.socket_write_timeout in 10.3 Setting up the client definition file in the uCosminexus Application Server SOAP Application Development Guide.
cluster-name.service-ID.WebService.c4web.application.proxy_host=host-name-of-proxy-server
Specifies the host name or the IP address of the proxy server. For details on the values to be specified, see the description for c4web.application.proxy_host in 10.3 Setting up the client definition file in the uCosminexus Application Server SOAP Application Development Guide.
cluster-name.service-ID.WebService.c4web.application.non_proxy_hosts=host-name-when-proxy-server-is-not-used
Specifies the host name or the IP address to be used when the proxy server is not used. For details on the values to be specified, see the description for c4web.application.non_proxy_hosts in 10.3 Setting up the client definition file in the uCosminexus Application Server SOAP Application Development Guide.
cluster-name.service-ID.WebService.c4web.application.proxy_port=port-number-of-proxy-server
Specifies the port number of the proxy server. For details on the values to be specified, see the description for c4web.application.proxy_port in 10.3 Setting up the client definition file in the uCosminexus Application Server SOAP Application Development Guide.
cluster-name.service-ID.WebService.c4web.application.proxy_user=proxy-server-user
Specifies the authentication user ID of the proxy server. For details on the values to be specified, see the description for c4web.application.proxy_user in 10.3 Setting up the client definition file in the uCosminexus Application Server SOAP Application Development Guide.
cluster-name.service-ID.WebService.c4web.application.proxy_password=proxy-server-password
Specifies the password corresponding to the authentication user ID of the proxy server. For details on the values to be specified, see the description for c4web.application.proxy_password in 10.3 Setting up the client definition file in the uCosminexus Application Server SOAP Application Development Guide.
cluster-name.service-ID.WebService.c4web.common.prf_trace_level=option-to-output-trace-based-performance-analysis
Specifies the output options for the trace based performance analysis. For details on the values to be specified, see the description for c4web.common.prf_trace_level in 10.3 Setting up the client definition file in the uCosminexus Application Server SOAP Application Development Guide.
cluster-name.service-ID.WebService.c4web.common.receive_max_soap_envelope_size=maximum-number-of-bytes-of-receiving-SOAPEnvelope
Specifies the maximum number of SOAP envelope bytes that can be received. For details on the values to be specified, see the description for c4web.common.receive_max_soap_envelope_size in 10.3 Setting up the client definition file in the uCosminexus Application Server SOAP Application Development Guide.
cluster-name.service-ID.WebService.c4web.common.send_max_soap_envelope_size=maximum-number-of-bytes-of-sending-SOAPEnvelope
Specifies the maximum number of SOAP envelope bytes that can be sent. For details on the values to be specified, see the description for c4web.common.send_max_soap_envelope_size in 10.3 Setting up the client definition file in the uCosminexus Application Server SOAP Application Development Guide.
cluster-name.service-ID.WebService.basic_authentication_use={true|false}
Specifies whether the service adapter will use basic authentication. When you set up basic authentication, make sure that you specify this parameter regardless of whether basic authentication is used.
-
true
Basic authentication will be used.
-
false
Basic authentication will not be used.
cluster-name.service-ID.WebService.basic_authentication_id=basic-authentication-user ~ <one-byte alphanumeric characters, one-byte symbols (0x21 to 0x7E# in ASCII encoding), and one-byte spaces (0x20 in ASCII encoding)> ((at least 1 character))
Specifies the user ID for basic authentication. When you set up basic authentication, make sure that you specify this parameter regardless of whether basic authentication is used.
To specify one-byte spaces (0x20 in ASCII encoding) at the beginning of the value, specify \ before the one-byte space. Also, to specify \ in the value, specify \\.
- #
-
You cannot use a hash mark (#), colon (:), question mark (?), at mark (@), or forward slash (/).
cluster-name.service-ID.WebService.basic_authentication_pass=basic-authentication-password ~ <one-byte alphanumeric characters, one-byte symbols (0x21 to 0x7E# in ASCII encoding), and one-byte spaces (0x20 in ASCII encoding)> ((1 to 40 characters))
Specifies the password for basic authentication. When you set up basic authentication, make sure that you specify this parameter regardless of whether basic authentication is used.
To specify one-byte spaces (0x20 in ASCII encoding) at the beginning of the value, specify \ before the one-byte space. Also, to specify \ in the value, specify \\.
- #
-
You cannot use a hash mark (#), colon (:), question mark (?), at mark (@), or forward slash (/).
cluster-name.service-ID.WebService.c4web.application.app_maintainsession={true|false}
Specifies whether an HTTP session will be maintained. For details on the values to be specified, see the description for c4web.application.app_maintainsession in 10.3 Setting up the client definition file in the uCosminexus Application Server SOAP Application Development Guide.
(b) Service information for SOAP adapters (SOAP 1.1/ 1.2 combined mode)
cluster-name.service-ID.WebService.url=URL-used-for-invoking-service-components
Specifies the URL to be used for invoking service components.
cluster-name.service-ID.WebService.com.cosminexus.csc.request.timeout=read-timeout-value
Specifies a read timeout value for the service adapter socket in seconds. For details on the values to be specified, see the description for com.cosminexus.csc.request.timeout in the items set in 3.6.2 Client definition file.
cluster-name.service-ID.WebService.com.cosminexus.csc.connect.timeout=connection-timeout-value
Specifies a connection timeout value for the service adapter socket in seconds. For details on the values to be specified, see the description for com.cosminexus.csc.connect.timeout in the items set in 3.6.2 Client definition file.
cluster-name.service-ID.WebService.com.cosminexus.csc.session.maintain={true | false}
Specifies whether an HTTP session will be maintained. set in 3.6.2 Client definition file.
cluster-name.service-ID.WebService.com.cosminexus.csc.auto-delete-incomplete-file={true | false}
Specifies whether to automatically delete the incomplete files generated due to an error during output of files to a work folder or common folder after the SOAP adapter has received attachments from a service component. For details about the values you can specify, see the description for com.cosminexus.csc.auto-delete-incomplete-file in the items set in 3.6.2 Client definition file.
cluster-name.service-ID.WebService.com.cosminexus.csc.file.read-lock.retry.count=lock-retry-count
Specifies the lock retry count when an attempt to acquire a shared lock for files in the common folder fails. For details about the values you can specify, see the description for com.cosminexus.csc.file.read-lock.retry.count in the items set in 3.6.2 Client definition file.
cluster-name.service-ID.WebService.com.cosminexus.csc.file.read-lock.retry.interval=lock-retry-interval
Specifies, in seconds, the retry interval when an attempt to acquire a shared lock for files in the common folder fails. For details about the values you can specify, see the description for com.cosminexus.csc.file.read-lock.retry.interval in the items set in 3.6.2 Client definition file.
cluster-name.service-ID.WebService.basic_authentication_use={true|false}
Checks the usability of basic authentication in a service adapter definition.
-
true
Basic authentication will be used.
-
false
Basic authentication will not be used.
cluster-name.service-ID.WebService.basic_authentication_id=basic-authentication-user ~ <Halfwidth alphanumeric characters, halfwidth symbols (0x21 to 0x7E in ASCII encoding#), and halfwidth spaces (0x20 in ASCII encoding)> ((at least 1 character))
Specifies the user name for basic authentication in a service adapter definition.
- #
-
You cannot use a colon (:) or forward slash (/).
cluster-name.service-ID.WebService.basic_authentication_pass=basic-authentication-password ~ <Halfwidth alphanumeric characters, halfwidth symbols (0x21 to 0x7E in ASCII encoding#), and halfwidth spaces (0x20 in ASCII encoding)> ((1 to 40 characters))
Specifies the password for basic authentication in a service adapter definition.
- #
-
You cannot use a colon (:) or forward slash (/).
(c) Service information for SessionBean adapters
cluster-name.service-ID.SessionBean.url=URL-used-for-invoking-service-components
Specifies the URL to be used for invoking service components.
cluster-name.service-ID.SessionBean.lookup_name=lookup-name
Specifies the lookup names to be used for invoking service components.
cluster-name.service-ID.SessionBean.c4web.application.ejb_timeout=invocation-timeout-value
Specifies a timeout value for invoking service components in seconds. Specify a value from 0 to 86400. A timeout does not occur if you specify 0.
cluster-name.service-ID.SessionBean.c4web.common.prf_trace_level=option-to-output-trace-based-performance-analysis
Specifies the output options for the trace based performance analysis. For details on the values to be specified, see the description for c4web.common.prf_trace_level in 10.3 Setting up the client definition file in the uCosminexus Application Server SOAP Application Development Guide.
(d) Service information for MDB (WS-R) adapters
cluster-name.service-ID.MDB_WSR.queue_name=name-of-queue-to-which-service-adapter-sends-messages
Specifies the name of the queue to which the service adapter will send messages.
cluster-name.service-ID.MDB_WSR.local_call={true|false}
Specifies the service components of the local host or remote host with which the service adapter will connect.
-
true
The service adapter will connect to the service components of the local host.
-
false
The service adapter will connect to the service components of the remote host.
You can change the local_call value from true to false only when all the correct values are specified in the parameters specified in the service-information change definition file. Do not change the local_call value from false to true.
cluster-name.service-ID.MDB_WSR.url=Web-application-URL-for-transmission-between-transmit-destination-queues
Specifies the message transmission destination for the transmit queue used by the service adapter. Specify the Web application URL for transmission between transmit destination queues as the message transmission destination. This parameter is valid only when the local_call parameter is false.
cluster-name.service-ID.MDB_WSR.max_message_num=maximum-number-of-messages-that-can-be-stored-in-transmit-queue ~ <Numeric character> ((1 to 65535))
Specifies the maximum number of messages that can be stored in the transmit queue used by the service adapter. This parameter is valid only when the local_call parameter is false.
cluster-name.service-ID.MDB_WSR.qos_in_order={true|false}
Specifies whether the correct order will be guaranteed when the transmit queue used by the service adapter transmits messages. This parameter is valid only when the local_call parameter is false.
-
true
The order will be guaranteed.
-
false
The order will not be guaranteed.
cluster-name.service-ID.MDB_WSR.rdarea_name=name-of-RD-area-where-transmit-queue-will-be-created~ <one-byte alphanumeric characters, underscores (_), and one-byte spaces ( )> ((30 bytes or less))
Specifies the name of the RD area to create the transmit queue used by the service adapter. This parameter is valid only when the local_call parameter is false. Do not specify ALL.
(e) Service information for MDB (DB queue) adapters
cluster-name.service-ID.MDB_DBQ.queue_name=queue-name-related-to-service-components
Specifies the queue name associated with service components.
(5) Usage
-
Obtain the service-information change definition file by specifying the file name in the -getfile option of the cscsvcctl command. Define the changed information in the obtained file, specify the file name in the -setfile option of the cscsvcctl command, and then perform the settings.
-
For the service information that is not changed in the operating environment, a hash mark (#) indicating a comment is added at the beginning of the parameters. To change the service information, delete the hash mark (#) added to the corresponding parameter.
-
To disable the changes made in the operating environment (to enable the development environment settings), add a hash mark (#) indicating a comment at the beginning of the parameters.
(6) Notes
-
To specify one-byte spaces (0x20 in ASCII encoding) at the beginning of the value, specify \ before the one-byte space. Also, to specify \ in the value, specify \\.
-
To set up or to change a value, edit the value in the Java property file format.
-
If the service information obtained with the -getfile option of the cscsvcctl command includes the following characters, the characters are output by adding \ to them.
-
One-byte exclamation mark (!)
-
One-byte hash mark (#)
-
One-byte colon (:)
-
One-byte equal sign (=)
-