NAME

Business::Bof::Server::CLI -- Server of The Business Oriented Framework

DESCRIPTION

The Server of the Business Oriented Framework (bof) will read its configuration parameters from an XML file (see the section "The configuration file" below), and will start listening on the specified port.

The Server uses SOAP as its transport, in principle making it easy to use any language to connect to as a client, and it will answer to these calls:

Using SOAP::Lite

See Business::Bof::Client for an example of using SOAP::Lite directly with the server. Business::Bof::Client is an easy to use Object Oriented interface to the BOF server. I recommend using it instead of talking directly with the server.

The configuration file

The BOF server needs a configuration file, the name of which has to be given on startup. It's an XML file looking like this:

Server Configuration

The name of this section in the XML file is ServerConfig

home

The place in the file system where the application located. home is used to tell where the log file configuration and the optional SSL configuration is stored.

appclass

The applications class name.

host

The SOAP host name.

hostname

The SOAP server proxy name.

name

The SOAP server session name.

port

The server's port number.

serviceName

The servers Service Name.

application

The application's name. Freetext, only for display- and logging purpose.

taskDelay

Number of seconds for the task process to sleep. The task process will wake up and look for new tasks in the framework database with this interval.

housekeepingDelay

Number of seconds for the clean up process to sleep. The clean up process will wake up and look for old sessions to purge.

expireAfter

Number of seconds to keep a session alive without activity. The clean up process will check if a session has been idle for more than this period of time, and if so, purge it.

logCheck

Number of seconds to tell the logger after which it will check for changes in the configuration file. Users of log4perl will know what I'm talking about.

Configuration of Framework Database

The name of this section in the XML file is fwdb. The database is a PostgreSQL database.

host

The database host name.

name

The database name.

username

Username that can access the Framework Database.

password

The user's password.

Settings for application objects

The name of this section in the XML file is ServerSettings. Any data in this section will be handed over to the application's new method through a hash ref. This gives the application a chance to know a little about its surroundings, e.g. directories where it may write files.

Settings for client programs

The name of this section in the XML file is ClientSettings. Any data in this section can be retrieved by the client program through the method getClientdata.

The server will also inform the client program about current session data, so please don't use these names in the ClientSettings section:

menu, allowed, userinfo

AUTHOR

Kaare Rasmussen <kar at kakidata.dk>