.
Eloquence B.07.10 contact contact

Documentation / Eloquence WEBDLG / Configuring the Eloquence WEB Daemon

Configuring the Eloquence WEB Daemon

 
.
  The eloqwebd Eloquence WEB Daemon serves as a bridge between the mod_eloq Eloquence Apache Module and your Eloquence WEBDLG programs:
  • Whenever mod_eloq requests a new session, eloqwebd contacts the configured Eloquence eloqsd application server to start the desired program.

  • Next, a DLG connection between eloqwebd and the program is established automatically.

  • During the program's runtime, eloqwebd stays in contact with the program and handles its DLG requests until a DLG STOP occurs. On each interactive DLG statement (DLG DO and POPUP BOX), it generates HTML output from the current dialog and uses mod_eloq to delegate it back to the user's browser.
These functional aspects have its equivalent configuration directives in the eloqwebd configuration file.

Contents:


Introduction

The eloqwebd configuration file is located at /etc/opt/eloquence6/eloqwebd.cfg. As with most of the Eloquence configuration files it has several sections which cover the different functional aspects.

Each section is introduced with its title in sqare brackets, e.g. [Server]. Inside a section, a variable number of name = value pairs represent the various configuration items. Both the section and item names are case-insensitive. If a value contains space characters it must be enclosed in double quotes. Everything after a hash (#) character is considered a comment and therefore ignored.


Server Configuration

In the [Server] section, the global runtime settins are configured. The default values are normally appropriate in a production environment.

[Server]
UseKeepAlive Numeric flag if the KEEP ALIVE socket option should be used. Valid values are 1/0. If this option is active, the server will check after a system defined period of inactivity if the client is still alive.
Example:
  UseKeepAlive = 1
  
The default value is 1.
NoDNS If set, no reverse DNS lookup is performed on connection to the eloqwebd server. A broken DNS configuration or a slow DNS server could lead to long connection times.
Example:
  NoDNS = 0
  
The default value is 0 (reverse DNS lookup enabled).
LogFile This defines where log messages are written to. This configuration value either specifies a path/file or one of the keywords:
  • console - log messages are written to the console
  • syslog - log messages will be sent to the syslog daemon
Example:
  LogFile = syslog
  
The default value is "syslog".
SysIdent When logging to the syslog daemon, you can define a syslog identifier. See syslogd(1M) for more information.
Example:
  SysIdent = eloqwebd
  
The default value is "eloqwebd".
SysFacility When logging to the syslog daemon, you can define a syslog facility (USER/DAEMON/LOCAL0..LOCAL7). See syslogd(1M) for more information.
Example:
  SysFacility = USER
  
The default value is "USER".
LogFlags Each log message has an associated origin and severity. The log flags define which messages will be logged. The "*" origin matches all message origins, so it can be used to setup a default which can be overriden for a specific message origin (eg. "*1N0").

The following origins are in use:

  • * = All origins
  • S = The server framework
  • C = Configuration subsystem
  • E = Child process execution
  • D = DLG subsystem
  • N = Network communications
The following severities are in use:
  • 0 - error messages
  • 1 - information
  • 2 - debug
  • 3 - verbose debug
Example:
  LogFlags = *0
  
The default LogFlags are "*0".


Session Configuration

The default values in the [Session] section are normally appropriate in a production environment, however during development it might be useful to lower the Expires item to 300 seconds (5 minutes).

[Session]
Expires Number of seconds until a DLG session expires. During a DLG DO or POPUP BOX command, this is the maximum idle time until an error #684 is returned.
Example:
  Expires = 3600
  
The default value is 3600 seconds (1 hour).
InitTimeout Initial timeout in seconds until the DLG connection to the Eloquence program is expected to be established.
Example:
  InitTimeout = 10
  
The default value is 10 seconds.
DlgTimeout Maximum number of seconds between two DLG DO or POPUP BOX commands. This should avoid that a session hangs infinitely.
Example:
  DlgTimeout = 60
  
The default value is 60 seconds.
Cache Depending on this setting, the browser will be allowed to cache any WEBDLG document locally. This could be useful for debugging purposes if the browser does not provide the HTML source code unless caching would be allowed. In such a case, a value of 1 can be configured here.
Example:
  Cache = 0
  
The default value is 0 which disallows the browser any local caching. This is the recommended setting which should be used in a production environment.


EloqSD Protocol

The Eloquence eloqsd application server is used to start your Eloquence programs. This gives you the flexibility to start your programs either locally or on a remote system and run them with permissions independend from the Apache web server.

If all or most of your programs require the same eloqsd settings it is convenient to configure them in the [EloqSD] section. Different settings per program can be defined in the mod_eloq configuration.

Regardless if a program is started locally or remotely, an eloqsd server must be appropriately configured and running on the system where the particular program is about to be started.

[EloqSD]
Hostname The host name or IP address of the system where the Eloquence programs are started by default.
Example:
  Hostname = 127.0.0.1
  
The default value is "localhost" (aka. 127.0.0.1).
Service The default eloqsd service name (as defined in /etc/services) or the port number.
Example:
  Service = eloqsd
  
The default value is "eloqsd".
User The default user name which is used to log-on to the eloqsd.
Example:
  User = eloqwww
  
Password The default Password which is used to authenticate to the eloqsd.
Example:
  Password = secret
  


HTML Generator

Several aspects of the generated HTML code can be configured in the [HTML] section. They apply commonly to all programs.

[HTML]
SelectOnFocus Whether the contents of edittext fields are selected on focus:
  • 0 - don't select anything
  • 1 - select singleline edittext
  • 2 - select multiline edittext
  • 3 - select both single- and multiline edittext
Please note that JavaScript must be activated or this setting won't have any effect. However, due to the different implementation levels of HTML 4.0 in the current browsers even with JavaScript activated this is not guaranteed to work correctly with every browser.
Example:
  SelectOnFocus = 1
  
The default value is 1.
RuleOnChange Whether an edittext rule is triggered when contents change:
  • 0 - rule is triggered when edittext loses focus
  • 1 - rule is triggered when edittext contents change
Aditionally, this behavior can be controlled for each dialog, groupbox and object by means of the .ruleonchange attribute.
Example:
  RuleOnChange = 0
  
The default value is 1. This is the recommended setting because it minimizes HTTP overhead. The 0 setting could cause the current dialog to flicker unexpectedly because each HTTP transaction redraws the current dialog (i.e. the current HTML document).

However, some applications probably require the 0 setting because it is fully compatible to ASCII DLG and JDLG. In this case, it should be considered to use the .ruleonchange attribute for a specific dialog, groupbox or object instead.

XRaster Width in pixels of a character cell, used for internal coordinate calculations. Change this setting if your dialogs appear too wide or too narrow. However, since the size of your dialogs depend on the particular font configuration on the user's browser this is only a hint and not an absolute setting.
Example:
  XRaster = 9
  
The default value is 9 pixels.
YRaster Height in pixels of a character cell, used for internal coordinate calculations. Change this setting if your dialogs appear too high or too low. However, since the size of your dialogs depend on the particular font configuration on the user's browser this is only a hint and not an absolute setting.
Example:
  YRaster = 18
  
The default value is 18 pixels.
TableComments Depending on this setting, additional comments are included into any HTML table generated:
  • 1 - for each DLG object
This could be useful for debugging purposes to clarify the structure of the HTML source code.
Example:
  TableComments = 0
  
The default value is 0 which will not include any comments.
TableBorder Sets the border attribute of any HTML table generated. This could be useful for debugging purposes to clarify the particular HTML table layout.
Example:
  TableBorder = 0
  
The default value is 0 which will disable any table borders.
ExtCharset Configures the character set encoding of external files which are accessed with the .file attribute. The following character sets are recognized:
  • HPROMAN8 - external files' encoding is HP Roman 8
  • ISO8859-1 - external files' encoding is ISO 8859-1
Example:
  ExtCharset = ISO8859-1
  
The default value is "HPROMAN8".
PopupBorder Configures the border width of POPUP BOX objects in pixel units. If set to 0, the border width can be specified with a CSS definition for the .eq_popup_box class.
Example:

To use a CSS definition to specify the POPUP BOX border width, first set PopupBorder to 0:

  PopupBorder = 0
  
The following CSS definition then specifies that POPUP BOXes will be displayed with a 3 pixels wide 3D-border:
  .eq_popup_box
  {
   border-width:3px;
   border-style:groove;
  }
  
Please refer to the Compatibility document for details about using CSS definitions.
The default value is 3.


 
 
 
  Privacy | Webmaster | Terms of use | Impressum Revision: 2005-04-22  
  Copyright © 1995-2024 Marxmeier Software AG