Chapter 7: Communications Processes and Service Listeners

This chapter describes communications process and service listener objects and what you can do with them.

Introduction

A communications process is the component of an enterprise server that handles communications between clients and the enterprise server. It contains a number of service listeners. An enterprise server is created with one communications process, but you can add more. For advice about how many communications processes you need see the section Number of Communications Processes in the chapter Configuration.

A service listener is an object that contains a network address that accepts incoming client requests on behalf of services. A service can have multiple listeners, and a listener can accept client requests on behalf of multiple services.

Your responsibilities as administrator include:

Communications Process and Listener Information

You can see the information held in the repository for communications processes and listeners by clicking Details on the Home page in the Communications Process column for the enterprise server that you are interested in. The communications process and listener table is shown in Figure 7-1.

Communications Processes and Service Listeners Table

Figure 7-1: Communications Processes and Service Listeners Table

The information for a communications process is as follows:

Communications processes don't have names; instead they have sequence numbers. The communications process that is automatically created when you add a new enterprise server is Communications Process 1, and any further communications processes that you create are numbered in ascending order of creation. When you delete a communications process, existing communications processes are not renumbered, however, the next communications process you create will use the same number as the process that was deleted - the lowest available number.

The information for a listener is as follows:

Listener display flters control how much listener information you can see. These appear just above the infomation for the first communications process. There are three listener display filters:

Each has a number of options that vary depending on the field; for example the Process filter allows you to select to see no listener details, all listener details, or listener details for a particular communications process, while the Status filter allows you to see all listener details regardless of status or just listener details for listeners with a specifc status:

For example, to see listener details for communications process 2, choose 2 in Listener Display Filters Process; to see only Web Services and J2EE listeners, choose Web Services and J2EE in Listener Display Filters Conversation Type; to see all listener details choose All in all three filters. Use all the filters in combination to achieve the maximum control over the level of detail you see.

When you first see the Communications Process and Listeners table, the Process filter is set to None and the other filters are set to All.

Configuration Information

You can use the Configuration Information field on the Edit Communications Process page, and the Add Listener and Edit Listener pages for configuration data specific to a communications process or a listener.

There are a number of additional configuration options, for logging and setting an SSL passphrase, that can be set in the file mf-server.dat. (On UNIX environments, this file is located in $COBDIR/etc. On Windows environments it is located in the base/bin directory of your product installation.) These are mostly options that require setting before the Micro Focus Communication Server (MFCS) contacts the MF Directory Server. In the case of logging, this can be useful where there are problems with the connection between MFCS and MFDS. For instructions on the use of mf-server.dat to configure logging for MFCS, please see the section Communications Process Log Files in the Troubleshooting chapter.

Note: If you have the optional Security Pack, it contains instructions on using mf-server.dat to configure the SSL passphrase.

Communications Processes

The Configuration Information field on the Edit Communications Process page can contain the following sections and settings:

[CCI]
timeout-grain=timeout-grain-number-of-seconds
[ISC]
listener-wait=listener-wait-number-of-seconds
[listeners]
logging=logging-level
[MFCC]
trace=trace-setting
[threading]
limit=number-of-threads

The parameters are explained below.

timeout-grain

Specifies the CCI timeout in seconds. Any MFCS timeout will be rounded up to a multiple of this value.

Syntax:
timeout-grain=timeout-grain-number-of-seconds
Properties:
Default: 5 seconds
Comments:

The communications process (MFCS) lets each conversation and listener set its own timeout value for receiving data, but because MFCS runs as part of CCI, and CCI only maintains one global timeout value for the whole process, the granularity of MFCS timeout values is limited by the CCI timeout setting. Setting a larger value than the default will make MFCS timeouts less precise, but will reduce CPU consumption, interrupts, and other factors, improving performance.

listener-wait (MTO only)

Specifies how many seconds to wait for a local ISC listener to become available when starting an ISC outbound connection to connect to another MTO instance or other ISC-compatible system.

Syntax:
listener-wait=listener-wait-number-of-seconds
Properties:
Default: 10 seconds
Comments:

MFCS needs to have an ISC listener available to support outbound ISC communications. This is most useful if you have outbound ISC connections configured at startup.

logging

Enables additional logging when starting listeners.

Syntax:
logging=logging-level
Parameters:
logging-levelCan be one of:
0No extra logging (default)
1 or YesBasic logging, which includes extra CCI error information
2Also log CCI loading and configuration, and listener address information
Properties:
Default: 0
trace

Controls common client (MFCC) tracing, in conjunction with the mf-client.dat file.

Syntax:
trace=trace-setting
Parameters:
trace-settingCan be one of:
0Disable MFCC tracing
any non-zero value Enable MFCC tracing during MFCS startup
Properties:
Default: 0
Comments:

MFCC tracing is off by default but can be enabled in the mf-client.dat file. MFCS uses MFCC during startup to verify that its control channel is working. If MFCC tracing is enabled in mf-client.dat, you can set this option to “0” to disable MFCC tracing in MFCS. Alternatively, you can set it to a non-zero value to enable MFCC tracing during MFCS startup, to diagnose a failure there.

limit

Specifies the thread limit.

Syntax:
limit=number-of-threads
Properties:
Default: 2000 on Windows and 200 on UNIX
Comments:

MFCS limits the number of threads it will try to start, in order to avoid exceeding system limits. Currently, MFCS uses one thread for each active conversation, so this limit directly affects the number of simultaneous conversations. Note that the operating system might not allow MFCS to actually create as many threads as the number you set.

Service Listeners

The available configuration settings for listener objects depend on the listener’s conversation type. Settings are grouped below by conversation type.

Web Services and J2EE

There are no settings for this conversation type.

Web

These options are checked for each request.

The [virtual paths] section is used to translate between the top-level path elements specified in URLs and the actual file-system directories they correspond to. For example, for the URL “http://host/path/to/file”, the [virtual paths] section will be consulted for an entry for “path”. Entries in this section are case-sensitive. For a more detailed explanation of the way these settings work, see the section Deployment Services and Listeners in the chapter Configuration.

The [allow] section is used to restrict what files the Web connector will serve out of a given directory.

[options]
logging=logging-level 
[virtual paths]
<default>=default-directory
element=file-system-path
[allow]
element=list-of-filenames
logging

Controls what information is logged.

Syntax:
logging=logging-level 
Parameters:
logging-levelCan be one of:
yes or 1 Log various information while processing web requests, including path translation and CGI program execution
any other value No logging
Properties:
Default: No logging
<default>

Specifies the directory to which unrecognized URL top-level path elements will be mapped.

Syntax:
default=default-directory
Properties:
Default: /dev/null
Comments:

The default directory must not exist, so that when the communications process translates the URL into a full path, the request will fail.

element in [virtual paths] Section

Specifies the file-system path to which element will be mapped.

Syntax:
 element=file-system-path
Parameters:
elementThe file-system path that element will be mapped to. element must be the top-level (first) element in the URL’s path. Some special tokens can be specified at the beginning of the value:
<ES>: Replaced with the path to the base installation directory on Windows, or $COBDIR on UNIX
<ASEE>:Historical synonym for ES.
<$name>: Replaced with the contents of environment variable name
element in [allow] Section

Lists one or more filenames or wildcard pattern specifications, separated by spaces, which the connector is allowed to serve for files on this virtual path.

Syntax:
element=list-of-filenames
Parameters:
elementThe file-system path that element will be mapped to.
list-of-filenamesZero or more filenames or filename patterns, separated by spaces. Only files which match one of these filenames will be served. You can use the wildcards "?" (matches any one character) and "*" (matches zero or more characters).
Properties:
Default: Permit serving all files

Fileshare

The Fileshare connector checks these settings at the beginning of each conversation. Changes to them will take effect for subsequent conversations.

[Operation]
timeout=number-of-seconds
[Trace]
control=control-flow-trace
data=data-trace
file=pathname
timeout

Sets the timeout, in seconds, for receiving data from the client.

Syntax:
timeout=number-of-seconds
Properties:
Default: Timeout for the communications process, which is 7200 seconds (two hours)
control

Enables the tracing of control flow in the connector.

Syntax:
control=control-flow-trace
Parameters:
control-flow-traceSet to "yes" to trace various connector activities, such as passing a request to an enterprise server
Properties:
Default: Control flow tracing is disabled
data

Enables the tracing of sent and received data.

Syntax:
data=data-trace
Parameters:
data-traceSet to "yes" to include data in the trace
Properties:
Default: Data tracing is disabled.
file

Specifies the full path of the file to receive trace messages.

Syntax:
file=pathname
Properties:
Default: Trace messages are written to the MFCS log (as HTML)

TN3270

The TN3270 connector checks the settings below periodically; changes affect current and new conversations.

[logging]
client-close=client-close-logging
[Operation]
default-terminal-type=terminal-type-name
Timeout=number-of-seconds
TN3270E=negotiation-type
[Trace]
trace=control-flow-trace
data=data-trace
length=trace-length
sem=send-semaphore-trace
file=trace-filename
client-close

Controls the logging of client disconnection.

Parameters:
client-close-logging If this is set to “yes”, log normal client disconnection
Properties:
Default: Log only abnormal client disconnection
default-terminal-type

Overrides an invalid terminal type sent by the client.

Parameters:
terminal-type-nameA valid terminal-type name, for example, “ibm-3278-2”
Properties:
Default: None
Comments:

TN3270 conversation negotiation includes the client telling the server what terminal type it is emulating. TN3270E specifies a set of allowed terminal types, but classic TN3270 has less strict requirements, and even some TN3270E clients do not conform to the specification. When the connector receives an illegal terminal type, it normally asks the client to specify a different one, but some clients (for example NetManage ViewNow) do not respond correctly. In this case you are advised to provide this setting.

Timeout

Specifies the receive timeout, in seconds.

Syntax:
Timeout=number-of-seconds
Properties:
Default: 84600 seconds (one day)
TN3270E

Disables TN3270E (Enhanced TN3270) negotiation.

Syntax:
TN3270E=negotiation-type
Parameters:
negotiation-typeSet to “no” to disable TN3270E negotiation
Properties:
Default: Enhanced TN3270 negotiation is enabled
Comments:

Currently required for some NetManage terminal emulator products, such as ViewNow 1.0 Host Access Quick Connect 3270.

trace

Enables the tracing of control flow in the connector.

Syntax:
trace=control-flow-trace
Parameters:
control-flow-traceSet to “yes” to enable control flow tracing
Properties:
Default: Tracing is disabled
data

Enables data tracing.

Syntax:
data=data-trace
Parameters:
data-traceCan be one of:
yes
or
all
Trace all data flows
nvt
Trace data flows only in NVT mode (which essentially means only during negotiation)
anything elseDisable data tracing
Properties:
Default: Tracing is disabled
length

Specifies the maximum number of data bytes to include in the data trace.

Syntax:
length=trace-length
Properties:
Default: 40 bytes
sem

Enables the tracing of operations on the send semaphore.

Syntax:
sem=send-semaphore-trace
Parameters:
send-semaphore-traceSet to “yes” to trace operations on the send semaphore
Properties:
Default: Tracing is disabled
Comments:

This setting might be useful useful when problems with the send semaphore are suspected, for example, because conversations seem to hang but ESMAC does not show them as busy.

file

Specifies the full path of the file to receive trace messages. The file is written as HTML (unlike the Fileshare and ISC traces).

Syntax:
file=trace-filename
Properties:
Default: Trace messages are written to the MFCS log (as HTML)

MTO ISC

The ISC connector checks the [Operation] section settings at the beginning of each conversation. Changes to them will take effect for subsequent conversations.

The ISC connector checks the [Trace] section settings below periodically during each conversation, so changes to them will take effect for both new and existing conversations.

[Operation]
timeout=number-of-seconds
[Trace]
trace=control-flow-trace
data-trace=data-trace-setting
allmax=dump-size
file=pathname
timeout

Sets the timeout, in seconds, for receiving data from the client.

Syntax:
timeout=number-of-seconds
Properties:
Default: Timeout for the communications process, which is 7200 seconds (two hours)
trace

Enables the tracing of control flow in the connector.

Syntax:
trace=control-flow-trace
Parameters:
control-flow-traceSet to “yes” to trace various connector activities, such as passing a request to an enterprise server
Properties:
Default: Tracing is disabled
data-trace

Enables the tracing of sent and received data.

Syntax:
data-trace=data-trace-setting
Parameters:
data-trace-settingCan be one of:
no
Do not trace data flows
header
Create formatted trace of CTG protocol headers
fmh
or
structure
Create formatted trace of CTG headers and request and response headers
all
Create formatted trace of headers and dump of user data
dump
Create unformatted dump of all data
Properties:
Default: Tracing is disabled
allmax

If data-trace is set to “all”, sets the maximum number of bytes to include in the user data dump.

Syntax:
allmax=dump-size
Parameters:
dump-sizeSet to 0 (unlimited) if you want to include all the data
Properties:
Default: Unlimited, that is, include all the data.
file

Specifies the full path of the file to receive trace messages. The file is plain text.

Syntax:
file=pathname
Properties:
Default: Trace messages are written to the MFCS log (as HTML).

What You Can Do

If you have Modify permission level or higher you can:

If you have Add/Delete permission level or higher you can also:

A newly created communications process starts immediately if you checked Auto-start on the Copy page; otherwise you can start it by clicking the process's Start button on the Communications Process and Listeners page. Communications processes with Auto-start enabled also start automatically when the enterprise server starts.

When you first add a service listener, you can set its status to "Blocked", "Disabled" or "Stopped". Use the Edit Listener page to set its status to "Started". Listener statuses are described in detail in the context help.

How to...


Copyright © 2008 Micro Focus (IP) Ltd. All rights reserved.