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:
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.
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. |
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. |
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.
|
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.
|
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, 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.
|
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: |
WTG_PROXY |
HTTP proxy used to connect to the Mobile Server for application deployment.
Sample Value: |
WTG_PROXY_PORT |
HTTP proxy port used to connect to the Mobile Server for application deployment.
Sample Value: |
JAVA_OPTION=value |
Use this parameter to specify additional runtime arguments for the Java VM.
Example:
|
DEFAULT_CLIENT_1CLICK |
The default value for the Mobile Client's "use default setting for sync"
Sample Value: |
DEFAULT_CLIENT_UPGRADE |
The default value for the Mobile Client's "ask before upgrade" setting.
Sample Value: |
DEFAULT_CLIENT_SYNCONLY |
The default value for the Mobile Client's "offline only/online/offline " setting.
Sample Value: |
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 |
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 |
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 |
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: 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 The default value is |
DISABLE_REMOTE_ACCESS |
If set to YES , blocks a remote machine getting access to the Mobile Client for Web or Mobile Client for BC4J. You can set this parameter in the client side webtogo.ora file. Once this parameter is set and Mobile Client is restarted, only the request coming from the local machine is served by the Mobile Client listener. Any other request is blocked and not served.
Default value is |
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.
|
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 |
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 |
The following DEBUG parameters control the debugging messages in the Mobile Server.
Table B-3 lists DEBUG parameters and their definitions.
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: |
TRACE_DESTINATION |
Trace destinations are Console and File. 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.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.
then, the Trace files will be named Sample Value: |
TRACE_LEVEL=1 |
There are three levels of trace messages:
In addition, all errors and exceptions are sent to level -1, which have the binary 11111111. All Java The parameter value for EXAMPLE: If you set the following parameters, 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 Note: As the administrator, you must not use the Example: If you set this parameter as follows, |
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 If set to Example: |
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 |
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.
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.
The CONSOLIDATOR
parameters control the behavior of Data Synchronization. The values that are listed in the following table are default values.
Starting with the Oracle Database Lite 10g Edition, Data Synchronization uses a new log engine that supports new parameters for logging. They are:
GLOBALLogger
SYNCLogger
MGPLogger
MGPAPPLYLogger
MGPCOMPOSELogger
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.
TRACE_LEVEL
TRACE_DESTINATION
TRACE_FILE_POOL_SIZE
TRACE_FILE_SIZE
TRACE_USERS
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:
TRACE_ENABLE
TRACE_REMOTE_PORT
TRACE_REMOTE_MACHINE
TRACE_FILE_PER_USER
TRACE_FILE_NAME
TRACE_REMOTE_HOST
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_LEVEL |
Trace Level parameter can be set to the following trace message levels:
Examples:
|
TRACE_TYPE |
SQL : This option logs SQL-related messages only. For example, SQL statements. Note: This option is not trace level sensitive.
|
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. |
MAGIC_CHECK |
Control the magic number checking of publication items. If enabled, and there is a mismatche between the server and the client magic numbers, then the publication item receives a complete refresh. If set to ALL , then the magic check is enabled, which is the default. If NONSHARED , then the magic check is enabled only for publication items that are not shared among users.
A shared publication item has the following characteristics:
Setting to |