Settings in the agsoap.conf file

Settings in the agsoap.conf file lists the M-Business Anywhere-specific configuration directives in the agsoap.conf file. This file is located in the <M-Business_Home>/conf directory, where <M-Business_Home> is the M-Business Server install directory, or Destination Location, which you specified during installation.

Caution

Do not edit the agsoap.conf file directly. Instead, edit your changes into the agsoap.conf.default file, then run the defaults_setup.bat script (Windows) or defaults_setup script (UNIX). See Editing configuration files.

Caution

The @@...@@ variables agsoap.conf.default file must not be modified. Values for these variables are set globally in the defaults file; change the value of @@...@@ variables in the defaults file and run the defaults_setup.bat script (Windows) or defaults_setup script (UNIX) to update the values in agsoap.conf.

Table 2. agsoap.conf file settings

Setting

Description

Server configuration settings

ServerName

The name you define here must be a valid DNS name for your host. Your administrator should be able to tell you the valid DNS name. If your host does not have a registered DNS name, enter its IP address here. You will have to access it by its address (e.g., http://123.45.67.89/), and this will make redirections work in a sensible way.

PidFile

The file in which the server should record its process identification number when it starts.

ScoreBoardFile

File used to store internal server process information. Not all architectures require this. But if yours does (you'll know because this file will be created when you run Apache) then you must ensure that no two invocations of Apache share the same scoreboard file.

Timeout

The number of seconds before receives and sends expire.

KeepAlive

This setting determines whether to allow more than one request per connection.

Default: Off

ThreadsPerChild

Number of concurrent threads, or requests, the server will allow. You should set this value according to the responsiveness of the server and the amount of system resources you will allow the server to consume. The more active requests running at once, the slower each request will be handled. For more information on using this directive to improve performance, see Modifying the ThreadsPerChild directive.

Default: 50

MaxRequestsPerChild

The number of requests each child process is allowed to process before the child dies. The child will exit to avoid problems after prolonged use when Apache (and maybe the libraries it uses) leak memory or other resources. On most systems, this is not really needed, but a few (such as Solaris) do have notable leaks in the libraries.

Default: 20000

MaxClients

A limit on total number of servers running, i.e., a limit on the number of clients that can simultaneously connect. If this limit is ever reached, clients will be locked out, so it should not be set too low. MaxClients is intended mainly as a brake to keep a runaway server from taking the system with it as it spirals down. See Optimizing performance for further discussion of how to improve performance by changing this value. Default: 50

ListenBacklog

Default: 1024

HostnameLookups

Log the names of clients or just their IP addresses? Valid values:

  • On to log the names of clients (e.g., www.apache.org)
  • Off to log just their IP addresses (e.g., 204.62.129.132)

Default: Off, because it is better overall for the net if people have to intentionally turn this feature on, since enabling it means that each client request will result in at least one lookup request to the nameserver.

Listen @@SOAPPort@@

The port number on which the SOAP server listens for HTTP messages from clients.

Do not change the @@SOAPPort@@ portion. If you wish to change the SOAP server port number, you must change the value assigned to @@SOAPPort@@ in the defaults file. See Settings in the defaults file.

Note that the full parameter definition allows for setting a log level specific for this port:

Listen @@SOAPPort@@
<VirtualHost _default_:@@SOAPPort@@>
    LogLevel level
</VirtualHost>

For valid values of level, see main LogLevel entry below.

Listen @@WSDLPort@@

The port number on which WSDL is vended.

Do not change the @@WSDLPort@@ portion. If you wish to change the port number on which WSDL is vended, you must change the value assigned to @@WSDLPort@ in the defaults file. See Settings in the defaults file.

Note that the full parameter definition allows for setting a log level specific for this port:

Listen @@WSDLPort@
<VirtualHost _default_:@@WSDLPort@>
    LogLevel level 
</VirtualHost>

For valid values of level, see main LogLevel entry below.

Event logging settings

LogLevel

Control the level of detail (and number) of messages logged to the error log. Valid values:

  • emerg logs only emergencies
  • alert adds alerts
  • crit adds critical messages
  • error adds all error messages
  • warn adds warning messages
  • notice adds notices
  • info adds informational messages
  • debug includes routine messages
ErrorLog

The location of the error log file. If you do not specify an ErrorLog directive within a <VirtualHost> container, error messages relating to that virtual host will be logged here. If you do define an error log file for a <VirtualHost> container, that host's errors will be logged there and not here.

LogFormat

Directives defining format nicknames for use with the CustomLog directive below.

CustomLog

The location of the custom log file.

TypesConfig

Location of the mime.types file (or its equivalent).

Supporting libraries and modules settings

LoadFile

List of libraries required at runtime.

LoadModule

Loads the SOAP Apache module.

Note that the full parameter definition allows for setting a handler for the SOAP Apache module:

LoadModule agsoap_module ... 
<Location /agsoap>
    SetHandler agsoap-handler
</Location>

NT domain integration settings

ExternalAuthLibrary

Loads the NT domain (or LDAP) external auth library.

UseSSPIForNTAuth

Use SSPI for NT authorization? Valid values:

  • TRUE (default)
  • FALSE
NTDomainValidation

A comma separated list of domain names or a period ("." ) to use local accounts on this host.

Default: "."

NTDomainCache

If multiple domains are included in the validation list, authentication can take a long time for users who aren't found until late in the list. NTDomainCache can be used to cache the username->domain mappings so that future lookups are faster.

ExternalAuthCreatesUsers

Create M-Business users automatically for valid NT domain users? Valid values:

  • TRUE (default)
  • FALSE

LDAP adaptor configuration settings

LDAPServers

Holds the name of your LDAP server. It is recommended that you use only one to avoid user name conflicts. Additional hostnames should be separated by a space. If you are using a non-standard port for your normal or SSL connection, you can add it to the end of the server name. Set by @@LdapServer@@ variable in defaults file.

LDAPSearchBase

The distinguished name of the entry at which to start the search.

LDAPSearchFilter

Sets the user ID field that the avantgo user ID will be compared against in the LDAP directory for user authentication. The %s is replaced with the M-Business user ID during authentication.

LDAPFullName

Controls which fields are used to return the Full Name. If LDAPFullName is populated, M-Business Server uses this value for the Last Name and leaves the First Name blank. To force separate First Name and Last Name to be sent, comment out the LDAPFullName parameter by placing a "#" in front of it.

LDAPFirstName

If LDAPFullName is commented out, M-Business Server sends LDAPFirstName as the First Name. If LDAPFullName is populated, LDAPFirstName is ignored.

LDAPLastName

If LDAPFullName is commented out, M-Business Server sends LDAPLastName as the Last Name. If LDAPFullName is populated, LDAPLastName is ignored.

LDAPUseSSL

This setting (currently unavailable) allows M-Business Server to connect via a SSL connection to your LDAP server. Your LDAP server must be SSL enabled and you must set the port number in the LDAPServers setting if it is a non-standard SSL port. This must be set to TRUE to enable SSL.

LDAPDefaultUser

If user account on M-Business Server's machine does not have access to the LDAP server, here you can specify the user ID of an LDAP account to use for retrieval of LDAP information. This setting may also be necessary for the LDAP provider to query information about a user when an account is created from your LDAP directory. If the M-Business Server's machine does not have correct privileges, an account will be created without populating the user's first and last name.

Note

The LDAPDefaultUser is not the login ID of the user, but the user's DN in the LDAP directory.

LDAPDefaultPassword

See description above for LDAPDefaultUser. If you specify a value for LDAPDefaultUser, you must also specify the password for that user here.

Security module settings

LoadFile

Common security library. Load this library if sagd needs to be turned on (depends on sslcommon ).

SyncLoadFile

Common security library. Load this library if sagd needs to be turned on (depends on sslcommon ).

LoadModule sagd_module

Location of security library.

Sagd_RSACertFileName

Location of the RSA certificate issued to you.

Sagd_RSAKeyPassword

Password that protects your RSA private key.

Default: password

Sagd_RandomPoolFilename

Location of random pool file used by the security software for incoming (client) secure connections. This file is created by the server if necessary. Choose a directory where the server has read and write permissions.

Miscellaneous server configuration settings

AuthKey

Used as the shared secret between the SOAP server and client to blowfish encrypt the session ID and user’s password during authentication. Only the first 40 characters are used, so make sure they are unique.

WSDLPort

The port on which we vend the WSDL file. Used mainly by C# clients. Default: 8094 Access via http://localhost:wsdl_port

EntProviderDatabaseClassId

The datastore with which the provider talks to the database. M-Business Anywhere supports mysqldatastore or asadatastore.

EntProviderClassId

The datastore with which the provider talks to the database. M-Business Anywhere supports mysqldatastore or asadatastore.

ProviderClassId

The datastore with which the provider talks to the database. M-Business Anywhere supports mysqldatastore or asadatastore.

StoreUser

The user name under which the SOAP server runs.

StorePassword

The password for the user name under which the SOAP server runs.

StoreDB

The name of the M-Business Anywhere database. Default: AGDB

StoreHost

The host name for the database. (Not used with asadatastore.) Default: localhost

StorePort

The port number for the database. (Not used with asadatastore.) Default: 8099

ServerVersion

The server version, written by the installer. Do not change.

SyncServerPort

The Sync Server port number. Needed to send to the Admin UI via the SOAP API.

Debugging log files

DebugSentLog

Location of debug sent log.

DebugRecvLog

Location of debug received log.

DebugTestLog

Location of debug test log.