Skip Headers
Oracle® Database Lite Administration and Deployment Guide
10g (10.0.0)
Part No. B12262-01
  Go To Table Of Contents
Contents
Go To Index
Index

Previous
Previous
Next
Next
 

B Mobile Server Configuration Parameters

This document describes configuration parameters for the Mobile Server. These parameters are included in the file webtogo.ora. The Mobile Server uses the webtogo.ora file to initialize the Mobile Server. When you launch the Mobile Server, it reads the parameters in the webtogo.ora file. This document defines the following system-wide parameters for the Mobile Server. Topics include:

B.1 [WEBTOGO]

The following WEBTOGO parameters control the behavior of both the Mobile Client for Web-to-Go and the Mobile Server.

Table B-1 lists WEBTOGO parameters and their usage definitions.

Table B-1 WEBTOGO Parameters

Parameter Definition
USE_SYSTEM_CLASSPATH=YES If set to yes, searches for Java classes in the computer's classpath before searching the Mobile Server Repository.
MODE=SERVER The mode the Mobile Server is running in. Valid modes are SERVER, CLIENT, and BRANCH. The value BRANCH indicates that the Mobile Server is running in BRANCH mode for client operations.
PORT=80 The port number on which the Mobile Server is running. Not valid in Oracle9i Application Server (Oracle9iAS) installation.
CLASSPATH= A list of directories in the Mobile Server Repository. Web-to-Go searches for Java classes.
PROXY_SERVER=proxy.com The proxy host name and number. The Mobile Client for Web-to-Go setup modifies this entry.
PROXY_PORT=80 The proxy port number. The Mobile Client for Web-to-Go setup modifies this entry.
SQL_RETRIES=5 Number of attempts to modify a JDBC connection before timing out.
SESSION_EXPIRATION=45 Logon session expiration time. The system logs out a user after the specified minutes of inactivity.
KEY_EXPIRATION=20 Number of minutes elapsed before invalidation.
PUBLIC_NAME=/public The public URLs name. The default value is /public.
BASE_URL=/webtogo Base URL on which Web-to-Go is installed in the Oracle9i Application Server (Oracle9iAS).
ADMIN_PORT=8080 Admin port for starting the Mobile Server.
ADMIN_TNS_NAME=WEBTOGO.WORLD The Mobile Server Repository's TNS name.
ADMIN_JDBC_URL=jdbc:oracle:oci8@webtogo.world Mobile Server Repository's JDBC URL.
FONT_NAME=Arial The Web-to-Go Workspace font.
APPLET_USE_THIN_JDBC=YES Requests that JDBC use the thin driver or the Web-to-Go data communication link for all database calls. Web-to-Go uses the internal Web-to-Go JDBC driver, if it is not using the JDBC thin driver. If this parameter is set to YES, then the parameter THIN_JDBC_URL should also be set.
THIN_JDBC_URL:jdbcoracle:thin:@foo-pc:1521:orcl The Mobile Server Repository's thin JDBC URL. This URL is used by the JDBC thin driver to connect to the Mobile Server Repository database.
LOAD_LIBRARIES The list of system libraries (DLLs) that need to be preloaded by the Mobile Server, separated by semi-colons. For example, LOAD_LIBRARIES=myapp;olmuadm. The DLLs myapp.dll and olmuadm.dll is loaded when the Mobile Server is started.
SOCKET_TIMEOUT The number of seconds that a read() call on the server socket will block before timing out. When set to 0, the lead call will never time out. The default value is 60 seconds.
ADMIN_USER Encrypted user name. Users must not try to edit the encrypted user name. This parameter can be set by navigating to the following URL.

<server>/webtogo/startup

ADMIN_PASSWORD Encrypted user password. Users must not try to edit the encrypted password. This parameter can be set by navigating to the following URL.

<server>/webtogo/startup

RESTRICTED_ADMIN_HOSTS=<list of comma separated IP addresses> This parameter provides security for accounts with Administrator access. With this parameter, the Mobile Server can be configured to allow login requests to a specified set of IP addresses for accounts with Administrator access.

With this parameter, you can also restrict access to the Mobile Server Startup feature. Only valid login requests from a browser that runs on machines whose IP address is listed as a value of this parameter will be granted access.

For example, RESTRICTED_ADMIN_HOSTS=144.125.127.150.144.125.127.101

Note: Users who have Administrator access should not connect through a proxy server.

SSL=YES If this parameter is set to YES, then the Mobile Server runs in SSL mode. To use this feature, the Mobile Server should be running as a module inside Oracle9i Application Server (Oracle9iAS).
CUSTOM_WORKSPACE=no Indicates whether or not a custom workspace should be used.
CUSTOM_DIRECTORY=/myworkspace Location of the custom workspace files in the repository.
DEFAULT_PAGE=myfirstpage.html The first page of the custom workspace. This page appears when the user accesses the following URL.

http://<server>/webtogo

CUSTOM_FIRSTSERVLET=HelloWorld;/hello Use this parameter to add the first servlet to the custom workspace. Within the first servlet, you can add more servlets to the custom workspace, using the addServlet() call.

Format: class;virtual path

WTG_PROXY HTTP proxy used to connect to the Mobile Server for application deployment.

Sample Value: www-proxy.dlsun1.com

WTG_PROXY_PORT HTTP proxy port used to connect to the Mobile Server for application deployment.

Sample Value: 80

TRACE Enables debug output.

Sample Value: NO

TRACE_ALL Enables detailed debug output. Includes SQL statements and execution times.

Sample Value: NO

JAVA_OPTION=value Use this parameter to specify additional runtime arguments for the Java VM.

Example:

JAVA_OPTION=-Djbo.SQLBuilder=OLite

-Djbo,TypeMapEntries=Oracle

DEFAULT_CLIENT_1CLICK The default value for the Mobile Client's "use default setting for sync"

Sample Value: YES

DEFAULT_CLIENT_UPGRADE The default value for the Mobile Client's "ask before upgrade" setting.

Sample Value: YES

DEFAULT_CLIENT_SYNCONLY The default value for the Mobile Client's "offline only/online/offline" setting.

Sample Value: YES

APPLET_SUPPORT_ENABLE=YES If you want to run an applet that uses a JDBC connection on the Mobile Client for Web-to-Go, you must set this parameter to YES and restart the client.

If the applet does not use a JDBC connection, you need not set this parameter. Setting this parameter to YES for an applet that does not use a JDBC connection, does not impair your settings.

SERVER_URL=http://<mobile_server_name>:<port_number>/webtogo This parameter points to the Mobile Server. It communicates with the Mobile Server over HTTP or HTTPS. Usually, you need not modify this parameter. If you want to run the Mobile Client for Web-to-Go and download the Mobile Client for Web-to-Go from the following URL, https://<mobile_server_name>/setup, the Mobile Client for Web-to-Go is automatically configured for SSL, and no manual configuration is required. The Mobile Client communicates with the Mobile Server over SSL.

However, if you do not download the Mobile Client for Web-to-Go from the Mobile Server that is running in SSL mode and you want to run your Mobile Server in SSL mode, you must modify the SERVER_URL parameter in the configuration file webtogo.ora, on the client side as displayed in the left column.

SYNC_CANCEL This parameter can be set on the client side to determine if the "Cancel" link should appear on the synchronization page.

If this parameter is set to YES, the "Cancel" link appears on the synchronization page. By clicking the Cancel link, you can stop the data synchronization. The link will not appear after the data synchronization is complete.

MAX_THREAD_POOL Limits the number of threads available in the connection pool. If threading problems occur, set this parameter to 0 or 1.
IAS_MODE This parameter must be set to the value YES only if the Mobile Server is running as a component of Oracle9iAS.

Example: IAS_MODE=YES

If the Mobile Server is running in Standalone mode or as a component of Oracle9iAS 1.0.2.2.0, this parameter must be set to the value NO.

The default value is NO.


B.2 [FILESYSTEM]

The following FILESYSTEM parameters control the behavior of the Mobile Server Repository.

Table B-2 lists [FILESYSTEM] parameters and their definitions.

Table B-2 FILESYSTEM Parameters

Parameter Definition
TYPE Type of File system.

O8 - Oracle based file system.

OL - Oracle Lite based file system.

OS - Operating system's file system.

MIXED - Mixed file system.

PRIMARY=OL Primary file system in MIXED mode.
SECONDARY=OS Secondary file system in MIXED mode.
ROOT_DIR=<ORACLE_HOME>/MOBILE/SERVER/REPOSITORY Root Directory. Valid only for OS file system.

This directory path format applies to the environment where the Mobile Server runs on Solaris.

Replace <ORACLE_HOME> with your actual Oracle Home.

ROOT_DIR=<ORACLE_HOME>\MOBILE\SERVER\REPOSITORY Root directory. Valid only for OS file system.

This directory path format applies to the environment where the Mobile Server runs on Windows NT.

Replace <ORACLE_HOME> with your actual home.

CACHE_SIZE=10 O8 file cache system in MB.

Note: Do not use this flag unless you have sufficient memory in your system.

MAX_CONNECTIONS=1 Maximum number of database connections for the O8 file system.

B.3 [DEBUG]

The following DEBUG parameters control the debugging messages in the Mobile Server.

Table B-3 lists DEBUG parameters and their definitions.

Table B-3 DEBUG Parameters

Parameter Name Definition
TRACE_ENABLE Used to turn the trace feature on or off. When the Trace feature is off, trace output is not generated. This value is only overridden when the Mobile Server is running in Standalone mode and with the -d0 command line option on. For example: TRACE_ENABLE=NO Is overridden by -d0 and the trace output is generated to the Console instead of being generated to a file.

Sample Value: YES

TRACE_DESTINATION Trace destinations are Console, File, and Remote. The Administrator can set this parameter to any of these destinations. The Console option generates trace output to the console screen.

Note: This trace destination is available only when the Mobile Server is running in Standalone mode. If you set this parameter to the option -d0, the trace output appears on your Console window without appearing in a file, because using the -d0 option with this parameter overrides the trace settings for other trace parameters, such as destination and level, in the webtogo.ora file. The -d0 setting enforces the trace output to appear on your console screen instead of appearing in a file.

The File option generates trace output to a file. For more information, see TRACE_FILE_ NAME, TRACE_FILE_SIZE, and TRACE_FILE_POOL_SIZE.

The Remote option generates trace output to a remote machine where it can be viewed using wsh -m%TRACE_REMOTE_PORT%. See also TRACE_REMOTE_MACHINE, TRACE_REMOTE_PORT.Sample Value: TRACE_DESTINATION=FILE

TRACE_REMOTE_MACHINE Machine name where wsh -m is running. The Mobile Server sends the debug output to the machine where wsh -m is running.
TRACE_REMOTE_PORT=2080 Trace output is generated to the named port on the %TRACE_REMOTE_MACHINE% on which the trace output can be viewed using wsh -m TRACE_REMOTE_PORT%. See also TRACE_REMOTE_MACHINE.Sample Value: TRACE_REMOTE_HOST=2080
TRACE_FILE_NAME=trace.log Used as base name to arrange trace files in sequential order starting from 1 to FILE_TRACE_POOL_SIZE.

For example: If you set the following parameters.

TRACE_FILE_NAME=mytrace.log

TRACE_FILE_POOL_COUNT=5

then, the Trace files will be named mytrace1.log, mytrace2.log, mytrace3.log, mytrace4.log, mytrace5.log, based on how you set the TRACE_FILE_PER_USER parameter.

Sample Value: trace.log

TRACE_LEVEL=1 There are three levels of trace messages:

1(binary 00000001), Basic Trace: General system information, most of the Web-To-Go trace output belongs to this level.

2 (binary 00000010), Function Trace: Traces the function sequence being called, mostly used by Consolidator.

4 (binary 00000100), SQL Trace: Traces SQL queries being executed, mostly used by Consolidator.

In addition, all errors and exceptions are sent to level -1, which have the binary 11111111. All java System.out output are sent to level 9. Both these two levels are always generated as output, if the user is not filtered out. For more information, see TRACE_USER.The parameter value for TRACE_LEVEL is used to do a Bitwise AND operation against all 3 trace levels. If the result is greater than 0, then trace output of that level will be generated as trace output.

The parameter value for TRACE_LEVEL used to do a Bitwise AND operation against all 3 trace levels. If the result is greater than 0, then trace output of that level will be generated as trace output.

EXAMPLE: If you set the following parameters, TRACE_LEVEL=3, then the Basic and SQL level trace output is generated, but not Function level trace as the & character is a Bitwise AND operator.

3 & 1 (Basic) = 1 > 03 & 2 (SQL)  =  2 > 03 & 4 (Function) = 0 = 0
TRACE_USERS List of valid user names. The user trace and system trace information which is listed is generated as trace output.

If the value is an empty string "", then every user is traced. If the value is or contains TRACE_NO_USER, then no actual user is traced. Only the system trace information is generated as trace output.

Note: As the administrator, you must not use the TRACE_NO_USER value as the user name.

Example: If you set this parameter as follows, TRACE_USERS=jane,jack, then only jane and jack's trace information is generated and displayed as trace output.

TRACE_FILE_PER_USER=YES Used to specify an individual trace file pool for every individual user. Applicable only when the File option is the Trace destination.

If set to YES, then every traceable user has an own trace file pool, and the trace file name includes the user's name. In addition, the system trace output goes to the user's system trace file.

If set to NO, all traceable users share the same trace file pool, the actual trace file does not contain any user name.

Example: TRACE_FILE_POOL_PER_USER=No

TRACE_FILE_SIZE=10 Used as the maximum file size in MB for trace files. If the threshold value is about to be reached, the trace feature generates output to the next trace file in the pool. For more information, see TRACE_FILE_NAME, TRACE_FILE_POOL_SIZE, and TRACE_FILE_PER_USER.
TRACE_FILE_POOL_SIZE=5 The default value is 5. This parameter specifies the number of files in the trace file pool. If the pool limit is reached, the trace output is overwritten to the first file in the pool. See also TRACE_FILE_NAME, TRACE_FILE_POOL_SIZE, and TRACE_FILE_PER_USER
TRACE_REMOTE_HOST=<local_host> The trace output is generated to the named machine, on which the synchronized trace can be viewed using the wsh -m%TRACE_REMOTE_PORT%. See also TRACE_REMOTE_PORT.

Example: TRACE_REMOTE_HOST=adminhost


B.4 [PUBLIC]

The following PUBLIC parameters control public availability of servlets in the Mobile Server. To make a servlet public, you can use the parameters as listed in the following table.

Table B-4 lists PUBLIC parameters and their definitions.

Table B-4 PUBLIC Parameters

Parameter Name Definition
myservlet=/<virtualpath> To call this public URL from your application, call it as follows:

http://<server>/public/<virtual path>

For example, oracle.codeMyservlet=/my servlet

oracle.codeMyservlet=/myservlet


B.5 [SERVLET_PARAMETERS]

In the SERVLET parameters section, you can list the set of custom parameters which are available to all servlets inside the Mobile Server.

Table B-5 lists SERVLET_PARAMETERS and their definitions.

Table B-5 SERVLET Parameters

Parameter Name Definition
MY_VAR=MY_VALUE Custom parameter which can be accessed by all servlets.

B.6 [CONSOLIDATOR]

The CONSOLIDATOR parameters control the behavior of the Consolidator. The values that are listed in the following table are default values.

Starting with the Oracle Database Lite 10g Edition, the Consolidator component uses a new log engine that supports new parameters for logging. They are:

Each parameter sets up a logger for a component which you can use to specify the trace level, trace type, trace destination, trace file pool size, trace file size, and trace users in the following sample format.

XLogger=TRACE_LEVEL=<trace_level>|TRACE_TYPE=<trace_type[,trace_type...]>|TRACE_DESTINATION=<trace_destination>[|TRACE_FILE_POOL_SIZE=<trace_file_pool_size>|TRACE_FILE_SIZE=<trace_file_size>|TRACE_USER=<trace_users>]

The following parameters have been made part of the above listed logging parameters.

Although the meaning of some of these parameters remains the same, the acceptable values are different. Table B-6 describes parameter values that are acceptable.

Table B-6 Acceptable Parameter Values

Parameter Name Acceptable Values
TRACE_DESTINATION LOCAL_CONSOLE, TEXTFILE
TRACE_LEVEL MANDATORY, WARNING, NORMAL, INFO, CONFIG, FINEST, ALL

The parameters TRACE_FILE_POOL_SIZE and TRACE_FILE_SIZE are only applicable for the GLOBALLogger only.

The new log engine does not support the parameters that have been used in the old log engine. They are:

Table B-7 lists CONSOLIDATOR parameters and their definitions.

Table B-7 Consolidator Parameters

Parameter Name Definition
MAX_THREADS=3 Specifies the number of threads spawned within the MGP process. This parameter value should be set to an equivalent number of CPUs.
TEMP = C:\TEMP Specifies the directory where the trace file is written. The log files saved in the TEMP directory are for the Resume Type (Reliable Transport) only.
MAX_CONNECTIONS=1000 Sets the maximum number of JDBC connections that can be open at one time by the Mobile Server. When this number is reached, no further synchronization sessions are allowed until active connections are released back to the connection pool.
MAX_CONCURRENT Sets the maximum number of concurrent active synchronization sessions. When this number is reached, subsequent synchronization session requests are placed in a FIFO queue, and are only allowed to continue when active sessions complete and slots become available. This parameter is designed to prevent the Mobile Server from being overloaded by concurrency and can help to improve throughput when the hardware is being stressed.
SLEEP_TIME=20000 Specifies how long (in milliseconds) the MGP sleeps between client synchronization processes.
CONNECTION_POOL=YES Enables pooling of database connections.
CONNECTION_TIMEOUT=120 Specifies in minutes the JDBC connection timeout for the synchronization session.
COMPOSE_TIMEOUT=300 Specifies in seconds the MGP timeout for a client's synchronization process to complete. If the synchronization does not complete, MGP will retry Compose in the next cycle.
TRACE_DESTINATION The Administrator can set this parameter to any of these destinations: LOCAL_CONSOLE or TEXTFILE. The Console option generates trace output to the Console screen. The TEXTFILE option generates trace output to a file. See also TRACE_FILE_SIZE, and TRACE_FILE_POOL_SIZE.

Sample Value: TRACE_DESTINATION=TEXTFILE

TRACE_LEVEL Trace Level parameter can be set to the following trace message levels:

MANDATORY: This option logs mandatory messages only. For example, Program Exceptions. Regardless of component settings, this option logs exceptions in the error log file (err.log) located in the Conslog directory.

WARNING: This option logs warning messages and messages at the Mandatory level. For example, Program Exceptions that users can ignore, messages that the program wants to warn the users with, and so on.

NORMAL: This option logs normal messages that the user must be informed with and messages at the Mandatory and Warning level.

INFO: This option logs information messages and messages at the Mandatory, Warning, and Normal levels.

Examples:

  • Timing of synchronization: When the SYNCLogger is set to the TRACE_TYPE=TIMING and TRACE_LEVEL=INFO.

  • MGP Apply: When the MGPAPPLYLogger is set to the TRACE_TYPE=TIMING and TRACE_LEVEL=INFO. MGP Apply must be started with Timing of. COMPOSE must be started with Timing of MGP Compose. MGP must be started with Timing of.

  • COMPOSE: When the MGPAPPLYLogger is set to the TRACE_TYPE=TIMING and TRACE_LEVEL=INFO.

  • Status of MGP: When the MGPLogger is set to the TRACE_TYPE=GENERAL and TRACE_LEVEL=INFO.

CONFIG: This option logs configuration messages and messages at the Mandatory, Warning, Normal, and Info levels. For example, JDBC driver version.

FINEST: The finest level. This level is used for developers only.

ALL: This option logs all messages according to the other settings such as Trace Type and Users.

TRACE_TYPE SQL: This option logs SQL-related messages only. For example, SQL statements. Note: This option is not trace level sensitive.

TIMING: This option logs timing data only. Note: This option is trace level sensitive. For MGP Cycle time and Synchronization time, use the Trace Level INFO option. If the MGPLogger is set to TIMING and INFO, it will log the MGP Cycle time. If the SYNCLogger is set to TIMING and INFO, it logs the synchronization time.

DATA: This option logs data only. Note: This option is not trace level sensitive. This option prints all data with any trace level other than the OFF option.

RESUME: Messages dealing with Reliable Transport have a RESUME trace type. This option only logs messages with Reliable Transport. Note: This option is not trace level sensitive. This option prints all the RESUME trace type messages with any trace level other than the OFF option.

FUNCTION: This option displays the program flow by logging methods such as Entry, Exit or Invoke. For Long methods, this option logs the method's entry or exit; which is a simple invoke log. Note: This option is not trace level sensitive. This option prints all the FUNCTION trace type messages with any trace level other than the OFF option.

GENERAL: This option logs messages that do not belong to any of the above listed trace types. Note: This type is trace level sensitive.

ALL: This option generates logs of all trace types.

TRACE_USERS List of valid user names. The listed user trace information and system trace information is generated as output. If the value is an empty string "", then every user is traced.
TRACE_FILE_SIZE=1 Used as the maximum file size in MB for trace files. If the value is about to be reached, the trace feature generates output to the next trace file in the pool. For more information, see TRACE_FILE_POOL_SIZE.
TRACE_FILE_POOL_SIZE=2 The default value is 2. This parameter specifies the number of files in the trace file pool. If the pool limit is reached, the trace output is overwritten to the first file in the pool. See also TRACE_FILE_POOL_SIZE.
JDBC_URL This is the JDBC_URL used by the Sync Service and the MGP for connections to the Mobile Server Repository. If absent, it defaults to the ADMIN_JDBC_URL in the WEBTOGO section of the webtogo.ora file.