Listeners

In this section:

How to:

The listeners are:

These listen for activity on their respective ports.

Note: To include a SOAP listener, you need to configure one. For more information, see How to Configure a SOAP Listener


Top of page

x
Configuring Listeners

How to:

Reference:

All listeners have the same type of basic parameters. They differ in the advanced parameters that are available.



x
Procedure: How to Configure a Listener
  1. From the menu bar, select Workspace.
  2. Open the Special Services and Listeners folder in the navigation pane.
  3. Right-click a listener and select Properties.

    The Listener Configuration page opens.

  4. In the Basic section, you can enter a value for the HOST parameter.
  5. If you need to set advanced parameters, expand the Advanced section and enter values in the parameter fields.
  6. Click Save and Restart Server.


x
Reference: Listener Basic Parameters

The HTTP, TCP, and SOAP listeners have the same type of basic parameters.

NODE

Defines the logical name of a node block. The settings are:

For HTTP - LST_HTTP.

For TCP - LST_TCP.

For SOAP - LST_SOAP.

PORT

Defines the port number that a listener is listening on. The default value for the HTTP listener is 8117. The default value for the TCP listener is 8116.

HOST

Defines an IP address that a listener is listening on. If blank, the listener will listen on all IP addresses.



x
Reference: Listener Advanced Parameters

The HTTP, TCP, and SOAP listeners have the following advanced parameter:

RESTRICT_TO_IP

Defines the name of a host or IP address(es) that will be accepted by the listener. The syntax is

hostname, xxx.xxx.xxx.xxx, yyy.yyy.yyy, ...

The address must be in base 256 standard dot notation. For platforms that support IPv6, IPv6 notation can be used if it is enabled (for example, 2001:1b1:719:1b1:203:baff:fe0a:fe23)

The internal default is *.*.*.*, which allows all IP addresses.

Note: You can use a wildcard to mask an entire section of the address, as in the following examples:

172.204.201.*
172.*.*.*
172.204.*.*
2001:1b1:719:1b1:203:baff:*:fe23

Partial masking is not supported, for example:

172.204.201.1*
172.204.201.*23

The HTTP listener has the following advanced parameter:

IBI_HTML

Defines a URL alias for the primary file lookup directory. Lookup is performed first in the directory described by this alias. The default value is $EDAHOME/etc.

HTML_HOME

Defines a comma-delimited list of directories for file lookup. Directories are searched in the order in which they appear in this list.

SESSION_EXPIRATION

Defines how long the current user credentials will remain in effect. The value can be set to any combination of days, hours, minutes, and/or seconds. The default value is 1 hour.

PROXY_SERVER

Runs the HTTP Listener as a proxy server. The valid values are:

0 - Proxy server for the HTTP protocol is off.

1 - Proxy server for the HTTP protocol is on.

The default value is 0.

LOGIN_FAILURE

Defines the type of message shown for a login error. The valid values are:

0 - Shows a general error message.

1 - Shows a precise error message.

The default value is 0.

PERSISTENT_GLOBAL

Defines whether global FOCUS variables will be persistent within a browser session. The valid values are:

0 - Global variables are not persistent within a browser session.

1 - Global variables are persistent within a browser session.

The default value is 0.

PASS_EXPIRE_NOTIFICATION

Determines whether users receive a password expiration notification by defining the number of days before expiration at which a notification will occur. The default value is 0, meaning no notification.

MAX_WEBSESSION

Defines the maximum number of active sessions. The HTTP listener will reject connections to the Web Console if this number is reached. The default value is 0, meaning no limit.

LOG_LAST_REQUESTS

Defines the maximum number of last requests in a session that will be collected as statistics. The default value is 10.

Enable HTTPS

Enables HTTPS support, either for OpenSSL or Microsoft Windows SSL.

Both types have the following additional parameters:

SSL_CERTIFICATE

Defines the SSL certificate. The default certificate name for Microsoft SSL is iwaycert.p12.

SSL_PASSPHRASE_E

If the private key of the certificate is encrypted, an encrypted passphrase must be provided to decrypted the private key.

The following additional parameters are specific to OpenSSL:

SSL_PRIVATE_KEY

Defines the file that contains the private key for the listener. It must correspond to the public key embedded in the PEM certificate and must be in PEM format.

SSL_CA_CERTIFICATE

Defines the file containing the trusted CA certificate in PEM format. It is used to verify the client certificate. If the client fails to send the certificate or if verification fails, connections will be rejected. More than one CA certificate may be present in the file.

The following additional parameter is specific to Microsoft SSL:

SSL_FRIENDLY_NAME

Indicates a name used to identify the certificate in the PKCS#12 file, if the file contains more than one certificate.



x
Procedure: How to Configure a SOAP Listener

A SOAP listener needs to be configured before it will appear in the Special Services and Listeners folder.

  1. From the menu bar, select Workspace.
  2. Right-click the Special Services and Listeners folder, and select New, then SOAP.

    The Listener Configuration page opens.

  3. Enter values in the PORT and HOST fields.
  4. Optionally, enter a host or IP address that will be accepted by listener in the RESTRICT_TO_IP field.
  5. Click Save and Restart Listener.

The SOAP listener is added to the Special Services and Listeners folder.


iWay Software