B
Mobile Server Configuration Parameters

This document describes the Mobile Server configuration parameters. The parameters are included in the webtogo.ora file. 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. The file defines the following system-wide parameters for the Mobile Server.

B.1 [WEBTOGO]

The WEBTOGO parameters control the behavior of both the Mobile Client for Web-to-Go and the Mobile Server. Table B-1 lists these parameters and their definitions.

Table B-1 WEBTOGO Parameters

Parameter	Definition
USE_SYSTEM_CLASSPATH=YES	Controls whether to search 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, BRANCH. A value of 'BRANCH' indicates that the Mobile Server is running in client mode for branch 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 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 establish a JDBC connection before timing out.
SESSION_EXPIRATION=45	Logon session expiration time. The system logs out a user after this many 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 Oracle9i Application Server (Oracle9iAS).
ADMIN_PORT=8080	Admin port for starting up 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 Web-to-Go use the JDBC 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: jdbc:oracle: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. Example: LOAD_LIBRARIES=myapp;olmuadm The DLLs myapp.dll and olmuadm.dll will be 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 zero, the read() call will never time out. The default is 60 seconds.
ADMIN_USER	Encrypted user name. The user should not try to edit it. This can be set by going to the URL: <server>/startup
ADMIN_PASSWORD	Encrypted user password. This can be set by going to the URL: <server>/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. 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. For information on how to bypass a proxy server, see Appendix F, "Bypassing 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 by using the addServlet() call. Format: classname;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. For 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 [which means offline only]
APPLET_SUPPORT_ENABLE= YES	If you want to run on the Mobile Client for Web-to-Go an applet that uses a JDBC connection, you must set this parameter to YES and restart the client. If the applet does not use a JDBC connection, you do not need to set this parameter. If you set this parameter to YES for an applet that does not use a JDBC connection, no harm will result from that.
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 do not need to modify this parameter. If you want to run the Mobile Client for Web-to-Go and you download the Mobile Client for Web-to-Go from the URL `https://<mobile_server_name>/setup`, then the Mobile Client for Web-to-Go is automatically configured for SSL, and no manual configuration is required. The Mobile Client can communicate with the Mobile Server over SSL However, if you do not download the Mobile Client for Web-to-Go from the Mobile Server running in SSL mode and you want to run in SSL mode, then you must modify the `SERVER_URL` parameter in the configuration file webtogo.ora on the client side as shown here in the left column.
ROWS_PER_PAGE_IN_ADMIN_TOOL= 25	This parameter enables you to determine the grouping of the users per page on the display screen of the Mobile Server Control Center when you get a listing of the users. For example, to display the users on the screen in groups of 20 users per page, you set this parameter to 20. The default is 25. If you set the parameter to zero, the rows will appear on one long page that is scrollable.
SYNC_CANCEL	This parameter can be set on the client side to determine if the `Cancel` link should appear on the synchronization page. If the parameter is set to `YES`, the `Cancel` link will appear 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. If the parameter is set to `NO`, the `Cancel` link will not appear on the synchronization page. The default value is YES. Example: `SYNC_CANCEL=YES`
MAX_THREAD_POOL	Limits the number of threads available in the connection pool. If threading problems occur, set this parameter to 0 or 1.

B.2 [FILESYSTEM]

The FILESYSTEM parameters control the behavior of the Mobile Server Repository. Table B-2 lists these 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 Oracle Home.
CACHE_SIZE=10	O8 file system cache in MB. 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 DEBUG parameters control the debugging messages in the Mobile Server. Table B-3 lists these parameters and their definitions.

Table B-3 DEBUG Parameters

Parameter	Definition
TRACE_ENABLE	Used to turn the trace feature on or off. When the Trace feature is off, trace output is not generated. The value is overridden only 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 screen 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. See also `TRACE_FILE_NAME, TRACE_FILE_SIZE, 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. Mobile Server sends the debug output to that machine.
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 the following parameters are set: `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` depending 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 binary 11111111. All java "System.out" output take over 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. Example: If the following parameters are set: `TRACE_LEVEL=3` then Basic and SQL level trace output is generated, but not Function level trace as "&" is bitwise AND operator. 3 & 1 (Basic) = 1 > 03 & 2 (SQL) = 2 > 03 & 4 (Function) = 0 = 0
`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. If the value is or contains `TRACE_NO_USER`, then no actual user is traced. The system trace information only is generated as output. Note: The administrator must not use the `TRACE_NO_USER` value as a username. Example: If the following parameters are set: TRACE_USERS=jane,jack Then only jane and jack's trace information is generated and displayed as output. The system level trace information is always generated as output.
`TRACE_FILE_PER_USER =YES`	Used to specify an own trace file pool for every individual user. Applicable only when "File" is the trace destination. If 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. For more information on the trace file naming convention, see Section 11.6, "Configuring the Trace File Pool" in Chapter 11, "Tracing". If no, then all traceable users share the same trace file pool, the actual trace file does not contain any user name. Example: TRACE_FILE_PER_USER=No
`TRACE_FILE_SIZE=10`	Used as the maximum file size in MB for trace files. If the value is about to be reached, the trace 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=<localhost>`	The trace output is generated to the named machine, on which the synchronized trace can be viewed using `wsh -m%TRACE_REMOTE_PORT%.` See also TRACE_REMOTE_PORT. Example: TRACE_REMOTE_HOST=adminhost

B.4 [PUBLIC]

You can use the PUBLIC parameters to make any servlet publically available in the Mobile Server. To make a servlet public, use the parameters listed in Table B-4.

Table B-4 PUBLIC Parameters

Class Name	URL (Virtual Path)
myservlet= /<virtual path>	To call this public URL from your application, call it as follows: http://<server>/public/<virtual path>
	For example, oracle.code.MyServlet=/my servlet

B.5 [SERVLET_PARAMETERS]

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

Table B-5 SERVLET Parameters

Parameter	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. Table B-6 lists these parameters and their definitions. The values that are displayed in Table B-6 are the default values.

Table B-6 Consolidator Parameters

Parameter	Definition
MAX_THREADS = 3	Specifies the number of threads spawned within the MGP process. It should be set to be at least equal to the number of CPUs.
TEMP = C:\\TEMP	Specifies the directory where the trace file is written.
MAX_CONNECTIONS = 1000	Sets the maximum number of JDBC connections that can be open at one time.
SLEEP_TIME = 20000	Specifies how long (in milliseconds) the MGP sleeps between client processings.
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 compose timeout for a client's synchronization to complete. If the synchronization does not finish, MGP will retry compose in the next cycle.
TRACE_ENABLE=NO	Used to turn the trace feature on or off. When the Trace feature is off, trace output is not generated. 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. The File option generates trace output to a file. See also `TRACE_FILE_NAME, TRACE_FILE_SIZE, 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. MGP sends the debug output to that machine.
TRACE_REMOTE_PORT=208	The port number in this section should be different from the port number which is used to set the same parameter in the DEBUG section. 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=208`
TRACE_FILE_NAME =mgp.log	Used as base name to arrange trace files in sequential order starting from 1 to `FILE_TRACE_POOL_SIZE.` The file name in this section should be different from the file name in the DEBUG section to prevent overwriting. For example: If the following parameters are set: `TRACE_FILE_NAME=mgp.log` `TRACE_FILE_POOL_COUNT=5` then the trace files will be named `mgp1.log, mgp2.log, mgp3.log, mgp4.log, mgp5.log`, depending on how you set the TRACE_FILE_PER_USER parameter. Sample Value: `mgp.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 binary 11111111. All java "System.out" output take over 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. Example: If the following parameters are set: `TRACE_LEVEL=3` then Basic and SQL level trace output is generated, but not Function level trace as "&" is bitwise AND operator. 3 & 1 (Basic) = 1 > 03 & 2 (SQL) = 2 > 03 & 4 (Function) = 0 = 0
`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. If the value is or contains `TRACE_NO_USER`, then no actual user is traced. The system trace information only is generated as output. Note: The administrator must not use the `TRACE_NO_USER` value as a username. Example: If the following parameters are set: TRACE_USERS=jane,jack Then only jane and jack's trace information is generated and displayed as output. The system level trace information is always generated as output.
`TRACE_FILE_PER_USER =YES`	Used to specify an own trace file pool for every individual user. Applicable only when "File" is the trace destination. If 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. For more information on the trace file naming convention, see Section 11.6, "Configuring the Trace File Pool" in Chapter 11, "Tracing". If no, then all traceable users share the same trace file pool, the actual trace file does not contain any user name. Example: TRACE_FILE_PER_USER=No
`TRACE_FILE_SIZE=10`	Used as the maximum file size in MB for trace files. If the value is about to be reached, the trace 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=<localhost>`	The trace output is generated to the named machine, on which the synchronized trace can be viewed using `wsh -m%TRACE_REMOTE_PORT%.` See also TRACE_REMOTE_PORT. Example: TRACE_REMOTE_HOST=adminhost