PLBSERVE Configuration Keywords

Server Configuration Keywords

The PL/B Application Server program information file (PLBSERVE.INI) file contains information that allows the user to tailor the runtime.

The .ini file name processing occurs as follows:

The runtime qualifies and uses an INI file when the file contains any section header. A section header is an INI file record that starts with '[' and is terminated with a ']'.
The runtime looks for and uses an INI filename found in three possible directories. The runtime always processes the INI files in the same order giving the user the ability to override globally defined parameters. The file name searching is as follows:

First, the runtime looks for an INI filename in the current working directory. This allows someone doing very specific and local program execution using keyword controls that override default keyword controls specified in (b) or (c) below.

Second, the runtime looks for an INI filename in the current user Windows directory. If the INI filename is found, it becomes the local keyword controls for the runtime. This allows someone to define workstation INI file controls. The local INI file controls can override (c) below.

Third, the runtime looks for an INI filename in the directory where PLBSERVE.EXE is found. If the INI filename is found, it becomes the global (default) keyword controls for the runtime.

If the runtime is started without using the '-i' option, the runtime looks for the default INI file named 'PLBSERVE.INI' in the three possible areas. Any PLBSERVE.INI files found in the three directories are then used to locate requested INI file keywords in the order as described in (B).
If the runtime is started with the '-i' option being specified and the INI file name does not have a path specified, the runtime looks for the INI file name in the three possible directories defined in (B) above. The runtime only processes the user named INI file from the three directories defined in (b.) above. This means the 'PLBSERVE.INI' is NOT used in this case.
If the runtime is started with the '-i' option being specified and the INI file name does have a path specified, the runtime looks for and uses the single specified INI file if found. This case disables the runtime from processing multiple INI files as described in (B) above.

Keywords with an associated value are placed in sections. The sections are indicated by surrounding the section name with square brackets. The [version] and [environment] sections are required and at a minimum should contain the following keywords and values:

[version]

Plbserve=10.7

[environment]

PLB_PATH=regular pathing information

PLBCS_PORTNUM=3933

PLBCS_LOGNAME=PLBSERVE.log

PLBCS_HOSTNAME=aaa.bbb.ccc.ddd

PLBCS_LOCALIP=aaa.bbb.ccc.ddd

Within the [environment] section, the user may specify additional runtime keywords as documented in the PLBWIN Runtime Keywords topic of the PL/B Runtime Reference. Additional keywords of interest to PL/B Application Server users are the following:

Keyword	Specifies the ...
PLB_<keyword>	A PL/B runtime keyword. See the Sunbelt PL/B Runtime Reference for a full list of keywords.
PLBCS_AUTH	optional authorization number.
PLBCS_CACHEAVIS	animation file caching method.
PLBCS_CACHEICONS	icon file caching method.
PLBCS_CACHEPICTS	picture file caching method.
PLBCS_CACHESNDS	sound file caching method.
PLBCS_CHECKTIME	optional event checking time period.
PLBCS_DEFAULTCWD	optional default current working directory.
PLB_ERRLOCKTIMEOUT	optional error locking timeout value.
PLB_EXITAFTERSUSPEND	optional CE client behavior modification.
PLBCS_HOSTNAME	required host name or IP address.
PLBCS_HOSTNAME6	required host name or IP address in ipv6 format.
PLBCS_IPFILE	IP filter for client connections.
PLBCS_KEYFILE	optional client access control information.
PLBCS_LOCALIP	optional local IP address.
PLBCS_LOCALIP6	optional local IP address in ipv6 format.
PLBCS_LOGMAX	optional maximum log file size.
PLBCS_LOGNAME	optional server log file name.
PLBCS_LOGON	optional key used to encrypt log on identifications to and from all PLBCLIENT workstations.
PLBCS_LOG_RECSIZE	optional key used to define the maximum log file record length.
PLBCS_LOG_RECVAR	optional key used to enable variable length log records.
PLBCS_MAXPROGVMEM	optional keyword that limits the client virtual memory size.
PLBCS_MAXTASKS	optional keyword that limits the number of simultaneous PLBCLIENT users.
PLBCS_MSGBUFFSIZE	optional maximum buffer size used when the server task communicates with the client
PLBCS_NOCLIENT	optional checkpoint monitoring function.
PLBCS_NOPLFNAMES	optional prevention of sending default object names to the client in a FORMLOAD.
PLBCS_PORTNUM	required IP port number to use.
PLBCS_PUBLIC	optional key used to encrypt messages to and from all PLBCLIENT workstations.
PLBCS_RECOVERYWAITTIME	optional maximum time allowed to detect a child recovery action
PLBCS_RECVTIMEOUT	optional maximum time allowed where no messages are received from the server.
PLBCS_SENDBLOCKSIZE	optional block size used when the server is sending a large amount of data to a client.
PLBCS_SOCKETRECOVERY	optionally restricts the socket recovery when a socket error occurs.
PLBCS_TERMTIME	optional number of seconds to wait during a server shutdown before clients are forced off.
PLBCS_TOPDOWN	assignment of virtual memory.
PLBCS_WINHIDE	optional main window of the client is to be hidden.

Admin Access Keywords

Keyword	Specifies the ...
ADMIN_DATACLR	optional data items kept by the administrative task.
ADMIN_DATASET	optional data items kept by the administrative task.
ADMIN_HOSTNAME	optional administrative task host name.
ADMIN_HOSTNAME6	optional administrative task host name or address in ipv6 format..
ADMIN_IPFILE	optional administrative task IP filtering file name.
ADMIN_KEYFILE	optional administrative task logon key file name.
ADMIN_LOCALACCESS	ability of an ADMLOGON instruction to connect to the administrative server task using the 'local' I/P address.
ADMIN_LOGCHILD	optional administrative task logging of a child task.
ADMIN_LOGLEVEL	optional administrative task logging level of a child task.
ADMIN_LOGON	optional administrative task logon encryption key that is used as the default LOGON key in a PL/B ADMLOGON instruction.
ADMIN_MAIL	Enable or disable administrative emails
ADMIN_MAIL_OUT	Defines the administrative email outgoing mail server
ADMIN_MAIL_TO	Configures the administrative email receipients
ADMIN_MAIL_FROM	Defines the administrative email sender
ADMIN_MAIL_MAXUSERS	Triggers an email when the maximum users has been reached.
ADMIN_MAIL_STARTUP	Sends an email when the Application Server has been started.
ADMIN_MAIL_SHUTDOWN	Sends an email when the Application Server has been stopped.
ADMIN_MAIL_SUBJECT	Defines the subject of the administrative emails.
ADMIN_MAIL_BCC	Defines the blind carbon copy recipients of the administrative email.
ADMIN_MAIL_CC	Defines the carbon copy recipients of the administrative email.
ADMIN_MAIL_USER	Configure the user login for the email server.
ADMIN_MAIL_PASSWORD	Configures the user password for the email server
ADMIN_MAIL_PORT	Defines the port for the email server.
ADMIN_MAIL_SSL	Enables SSL for the email server.
ADMIN_MAIL_STARTTLS	Enables TLS for the email server.
ADMIN_MAIL_TIMEOUT	Defines a timeout value when communicating with the email server.
ADMIN_MAIL_TRACE	Provides debug tracing via email.
ADMIN_MAIL_TRACEAPPEND	Provides debug tracing via email.
ADMIN_MAIL_DSNRECEIPT	Provides delivery confirmation of the administrative emails.
ADMIN_MAIL_MDNRECEIPT	Reports receipt of the administrative emails.
ADMIN_MAIL_RETURN	Defines the administrative email return address.
ADMIN_MAIL_REPLYTO	Defines the administrative email Reply To address
ADMIN_MAINLOGIN	ability to log in to the administrative services of the server via the PLBCS_PORTNUM port.
ADMIN_PORTNUM	optional administrative task port number.
ADMIN_PUBLIC	optional administrative task public encryption key.
ADMIN_SHELLICON	optional optional display in the Windows taskbar icon area.
ADMIN_SRVNAME	optional descriptive server name string.
ADMIN_SUPPORT	optional administrative task control value.

To allow simultaneous support of normal Windows and CE Windows PLBCLIENTs, the PLBSERVE.INI may have specialized sections named to support CE and non-CE clients. The PLBSERVE.INI sections can be named as follows:

[environment]

This section contains the basic startup keywords required to specify the TCP/IP communication parameters to access the PL/B program server. This section also includes the required runtime keywords required (PLB_TERM, PLB_PATH, etc) to execute a program for a normal Windows PLBCLIENT.

[env_wincepk]

This section contains specific keywords required (PLB_TERM, PLB_PATH, etc) to execute a program for a Windows CE Pocket PC PLBCLIENT executable. This allows a user to setup specialized programs, screen definition files, and pathing to support Windows CE PL/B applications. Also, notice that this section DOES NOT include the TCP/IP communications keywords. In addition to normal runtime program supported keywords, the following PLBSERVE keywords can be included in this section:

PLBCS_CHECKTIME

PLBCS_WINHIDE

PLBCS_MSGBUFFSIZE

PLBCS_LOGNAME

[env_console]

This section contains specific keywords required (PLB_TERM, PLB_PATH, etc) to execute a program for a Windows PLBCLICON executable. This allows a user to setup specialized programs, screen definition files, and pathing to support Windows console applications. In addition to normal runtime program supported keywords, the following PLBSERVE keywords can be included in this section:

PLBCS_CHECKTIME

PLBCS_WINHIDE

PLBCS_MSGBUFFSIZE

PLBCS_LOGNAME

[env_child]

This section contains user-defined keywords that are searched if not found in the user specific INI file.

[mapdrives]

This section contains the mapped drive assignments. The PLBSERVE runtime uses the mapped drive settings to redirect either network drives or local DOS drives.

Format:

{drv}:=[~]{redir}[,{username},{password}]

Where:

{drv}: Drive device letter ( a to z ) inclusive.
{redir}: Drive device redirection string. This string can be a UNC path or a DOS drive path.
[~]: Optional character before the {redir} string to prevent removal of the {drv}.
{username}: Optional user name that may be required to access a network share.
{password}: The password is required when the user name is specified. It accesses a network share.

Notes:

1. When the {redir} string starts with the '\' character, it identifies a network UNC path name. In this case, the {drv} is redirected as a network drive. If the {drv} already exists, the mapped drive redirection does not occur and no changes are made.

2. When the {redir} string is a DOS drive path string, the mapped drive redirection is executed as a local DOS drive device. If the {drv} already exists, the mapped drive redirection does not occur and no changes are made. The local DOS drive substitution is not supported for the Windows 95, 98, and ME OS versions. The mapped drives are ignored for these Windows versions.

3. The mapped drives redirection support can declare drive specifications when an NT service is started. This is the original intended use for mapped drives.

4. By default, the runtime removes the {drv} mapped drive when the runtime process is terminated. If the '~' character is specified as the leading character before the {redir} string, the runtime does not remove the {drv} when the runtime process is terminated.

5. The {username} and {password} exist as raw text strings. Care should be taken to protect the ini file from unauthorized access since the user name and password are stored in plane text. Limited access to an Application Server or Data Manager should be considered when the {username} and {password} parameters are used.

6. When the application server starts and terminates, the mapped drives are logged.

Example:

[mapdrives]

f:=c:\temp

g:=\\server\sharename\directory

h:=~c:\sunbelt

i:=~\\server\sharename\directory

j:=\\server\sharename\directory;myname;mypassword