This document describes configuration parameters for the in the webtogo.ora
file. The Mobile Server uses the webtogo.ora
file to initialize the Mobile Server; thus, if you modify these parameters, you must restart the Mobile Server to receive the change.
The following sections define system-wide parameters for the Mobile Server:
Table A-1 lists the APPLICATIONS
parameters and their usage definitions.
Table A-1 APPLICATIONS Parameters
Parameter | Definition |
---|---|
|
Location for the Packaging Wizard help file. This is only used with MDK. and only for the purpose of Debug / Support. |
|
Name of the XML file used by the Packaging Wizard to store the application information. This is only used for Debug / Support. |
The following WEBTOGO parameters control the behavior of both the Mobile client for OC4J or Web-to-Go and the Mobile Server.
Table A-2 lists WEBTOGO parameters and their usage definitions.
Parameter | Definition |
---|---|
|
Encrypted user password. Users must not try to edit the encrypted password. This parameter can be set by navigating to the following URL.
|
|
Admin port for starting the Mobile Server. |
|
Mobile Server Repository JDBC URL. |
|
Encrypted user name. Users must not try to edit the encrypted user name. This parameter can be set by navigating to the following URL.
|
|
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 |
|
If you want to run an applet that uses a JDBC connection on the Mobile client for OC4J or Web-to-Go, you must set this parameter to If the applet does not use a JDBC connection, you need not set this parameter. Setting this parameter to |
|
Applicable for Web-to-Go Client only. Specify the IP address on which the Web-to-Go listener is bound. By default, the listener is started on the local host. Use this parameter if you have a machine where there is more than one IP address. Define the IP address you wish to use as the Web-to-Go listener and then start the Web-to-Go client listener on that IP address. |
|
Indicates whether or not a custom workspace should be used. |
|
Location of the custom workspace files in the repository. |
|
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 Format: |
|
The first page of the custom workspace. This page appears when the user accesses the following URL.
|
|
The default value for the Mobile Client's "use default setting for sync" Sample Value: |
|
The default value for the Mobile Client's "ask before upgrade" setting. Sample Value: |
|
The default value for the Mobile Client " Sample Value: |
|
If set to Default value is |
|
Set to YES to turn on this feature to force the DeviceManager to synchronize the cached data on user-related events, such as create, edit or delete user. |
|
Set to TRUE to enable all valid users to log on to the Mobile Server in the Direct Access mode. By default, only users with Administrator privilege level can log in to the Mobile Server in the Direct Mode. Direct mode is when you point the browser directly to the Mobile Server. |
|
The Web-to-Go Workspace font. |
|
This parameter must be set to the value 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 |
|
Mobile Server Installation Type, such as STANDALONE, IAS10.1.2.0.0, IAS10.1.3.1.1.0, and so on. Do NOT modify, for internal use only. |
Set this parameter in the If you are using DHCP, then the underlying code needs to know to not use the IP address that was used for the previous connection/synchronization. If you are using DHCP and have set this parameter to Internally, the Disabling Java IP caching may effect performance with the additional DNS lookups. In addition, there is a risk of DNS spoofing. See the Sun Microsystems Java documentation for more information. |
|
|
If the loadbalancer is used for balancing two or more Mobile Servers, then you may include the LoadBalancer URL with port number. Format is |
|
Limits the number of threads available in the connection pool. If threading problems occur, set this parameter to 0 or 1. |
|
The mode the Mobile Server is running in. Valid modes are |
|
Location of the OC4J configuration files that are used by the Mobile Server during runtime. |
|
Location of the Oracle Home where the Mobile Server is installed. |
|
The port number on which the Mobile Server is running. Not valid in Oracle9i Application Server (Oracle9iAS) installation. |
|
The proxy host name and number. The Mobile client for OC4J or Web-to-Go setup modifies this entry. |
|
The proxy port number. The Mobile client for OC4J or Web-to-Go setup modifies this entry. |
|
The public URLs name. The default value is |
|
Turn this parameter on (TRUE) if your application is using the registry setting and you want to manage the registry settings in the Mobile Manager. This parameter enables the registry tab in the Mobile Manager and is only for backward capability. |
|
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. |
|
Set this parameter if a Reverse proxy is used with the Mobile Server. See Section 11.5.1, "Using Reverse Proxy to Communicate from Internet to Intranet" for details. |
|
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 OC4J or Web-to-Go and download the Mobile client for OC4J or Web-to-Go from the following URL, However, if you do not download the Mobile client for OC4J or 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 |
|
Turn this parameter on (TRUE) if you want to enable Oracle Single Sign on (SSO) authentication on the Mobile Server. If this parameter is turned on then the users trying to connect to the Mobile Server in the online mode will receive the login page from the SSO server. |
|
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 |
|
Number of attempts to modify a JDBC connection before timing out. |
|
If this parameter is set to |
|
The Mobile Server Repository's thin |
|
If set to yes, searches for Java classes in the computer's classpath before searching the Mobile Server Repository. |
|
HTTP proxy used to connect to the Mobile Server for application deployment. Sample Value: |
|
HTTP proxy port used to connect to the Mobile Server for application deployment. Sample Value: |
The following FILESYSTEM
parameters control the behavior of the Mobile Server Repository.
Table A-3 lists [FILESYSTEM]
parameters and their definitions.
Table A-3 FILESYSTEM Parameters
Parameter | Definition |
---|---|
|
Type of File system.
|
|
Primary file system in |
|
Secondary file system in |
|
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 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 A-4 lists DEBUG parameters and their definitions.
Parameter Name | Definition |
---|---|
|
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: Sample Value: |
|
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 |
|
Used as base name to arrange trace files in sequential order starting from For example: If you set the following parameters.
then, the Trace files will be named Sample Value: |
|
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 |
|
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, |
|
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: |
|
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 |
|
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 |
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 A-5 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 A-6 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.
Table A-7 Consolidator Parameters
Parameter Name | Definition |
---|---|
|
Specifies in seconds the delay between successive attempts to apply a client's In Queue. Related to the |
|
Comma-separated list of users, where each user's downloaded data is cached. |
|
If set to However, if you are developing an application and you are executing a test, such as a performance test, you will resend the same client request to the server repeatedly to test how the server responds under heavy load. Only in this case would you want to set this parameter to |
|
Specifies in seconds the MGP timeout for the compose phase for each user to complete. If the compose phase for this user does not complete, MGP retries the compose phase for this user in the next cycle. If the compose consistantly fails then increase timeout value. Monitor the MGP logging to evaluate how long the compose takes to complete; then add 50% to the value ensure that slightly larger datasets compose completely. |
|
Configure whether to validate a database connection before retrieving (borrowing) it from the connection pool. By default, this value is YES. |
|
Configure whether to validate the database connection before releasing it back to the connection pool. By default, this value is YES. If the examination determines that the connection is not valid, then it is destroyed instead of being returned to the connection pool. |
|
Enables pooling of database connections if set to YES. |
|
Specifies in minutes the JDBC connection timeout for the synchronization session. If synchronization takes longer than the value specified in this parameter, then the server can automatically disconnect. To avoid the connection from timing out during a valid synchronization, then set this value higher. |
By default, before the MGP processes the Compose phase for a user, it checks to see if user data has been uploaded into the In Queue. If so, then the Compose is not performed to ensure that user data is not overwritten. Instead, the Compose phase is not executed until the MGP runs the Apply/Compose phase again. Setting |
|
|
Specify the index attributes for the In Queue table indexes, which exist in the back-end Oracle database. These can include the storage characteristics and the following attributes: |
|
Specify the physical and/or table properties for the In Queue tables, which exist in the back-end Oracle database. These can include the storage characteristics and the following properties: |
|
This is the |
|
If set to |
|
The amount of time in seconds that the Job Scheduler sleeps in each loop. |
|
Specifies in the number seconds the delay between successive attempts to lock the log tables. Related to the |
|
Control the magic number checking of publication items. If enabled, and there is a mismatch between the server and the client magic numbers, then the publication item receives a complete refresh. If set to A shared publication item has the following characteristics:
Setting to |
|
Specify the index attributes for the map table indexes, which exist in the back-end Oracle database. These can include the storage characteristics and the following attributes: |
|
Specify the physical and/or table properties for the map tables, which exist in the back-end Oracle database. These can include the storage characteristics and the following properties: |
|
Specifies the maximum number of times the MGP retries to apply the client In Queue data before terminating the apply phase. |
|
JDBC performance parameter which defines the number of DML records (inserts only) to send from the Mobile Server to the back-end Oracle database at one time. Without batching, each record is sent to the database one at a time. These records are originally from client. This only applies to insert, and not to delete or update records. |
|
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. |
|
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. Active sessions are concurrently processed and the sessions where users are waiting to be processed are placed in a FIFO queue. The |
|
Sets the maximum number of seconds to wait |
|
Specifies the number of attempts to lock the logs before giving up the compose phase. |
|
Specifies the number of threads spawned within the MGP process. This parameter value should be set to an equivalent number of CPUs. We recommend this value is set to 1.5 times the number of CPUs. The default is 3. |
|
How often should MGP compose phase look for map table records that are marked for deletion but have been re-added to the subscription. By default, this is set to 1. If the application logic guarantees that such records never exist, then this check may be skipped altogether by setting the value to –1, which improves MGP compose performance. |
|
If set to |
|
The IP port used by MGP to report current state and/or coordinate multiple instances of the process. The default port number is 7373. |
|
If set to |
|
The Set the maximum data size in KiloBytes sent by a client in a single |
|
The Set the total number of seconds that the client should use to resume network timeout operations. |
|
This is a server-side parameter that defines the filename of the resume buffer. By default, we use memory mapped file; however, with this parameter, users can provide their own storage files. The size of this file is specified by the |
|
|
|
The |
|
The |
|
The |
By default, before the MGP processes the Compose for a user, it checks to see if user data has been uploaded into the In Queue. If so, then the Compose for the user is not performed to ensure that user data is not overwritten. Instead, the Compose phase is not executed until the MGP runs the Apply/Compose phase again. Setting |
|
Specifies how long (in milliseconds) the MGP sleeps before scheduling the next client's apply phase. By default, it is set to 2 milliseconds. |
|
|
The number of prepared statements to be cached for each connection. These statements are not re-parsed by the database when they are prepared again. To turn off caching, set this variable to |
|
If set to |
|
If set to |
|
Specifies the directory where the binary trace file, which includes the request and response data, is written. This file is created to cache the data in transport, so that if a failure occurs, Oracle Lite can recover. You initialize this binary trace file by selecting the Data Trace Type checkbox. |
|
Specifies whether the JVM implementation of ZIP or the Oracle pure Java version for compression should be used. This is a performance parameter, where depending on a particular environment, each implementation may have different performance results. By default, this is set to YES to use the JVM implementation. |
Data Synchronization uses a log engine that supports the following parameters for logging:
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
>]
Note:
Separate each parameter with the '|
' symbol. Separate values with a comma ',
'.
If there are any invalid values in the definition, the whole definition is ignored.
For each logger, the trace level, type, and destination parameters are mandatory.
The parameters TRACE_FILE_POOL_SIZE
and TRACE_FILE_SIZE
are only applicable for the GLOBALLogger
only.
If you define the LOCAL_CONSOLE
, then you must also define SYNCLogger
and GLOBALLogger
.
Table A-8 lists the parameters for each logger.
Table A-8 Acceptable Parameter Values
Parameter | Description |
---|---|
|
Trace Level parameter can be set to the following trace message levels:
Examples:
|
|
|
|
The Administrator can set this parameter to any of these destinations: Sample Value: |
|
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 |
|
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 |
|
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 |
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