Siebel Pharma Handheld Guide > Siebel Handheld Application Administration >

Configuring Application Settings for Siebel Handheld Applications


The Administration - Mobile screen contains a Settings list that allows you to change default settings. Some of the settings are described in Table 9.

The Handheld setting value field has a limit of 2000 characters. To create a default business object (DefaultBusObj) setting value with more than 2000 characters, use the following general approach:

Break the value into multiple lines of DefaultBusObj settings. Enter these settings using the same DefaultBusObj value format:

BusObj|Visibility|Query|BusComp_1|query specifications_1[|BusComp_n|query specifications_n]

When defining multiple lines of DefaultBusObj settings for a single business object, all view modes and filters must match. If a business component is found in multiple DefaultBusObj settings for a single business object, then the business component's query specifications will be concatenated with a space and appended to the previous business component's query specifications. You must be aware of this effect in order to decide if both query specifications must be combined with an OR or AND operative.

The DefaultBCuserProps and DefaultFields settings for a single business component can also be broken into multiple lines of settings if their values exceed 2000 characters. These settings must all be entered using the same value format as well:

BusComp|BCUserProp_1[|BCUserProp_n] or BusComp|Field_1[|Field_n]

Table 9. Settings for Siebel Handheld Applications
Setting Name
Definition
Valid Values

AllowRememberPassword

Single-line setting. Specifies whether the Remember Password check box will be displayed on the Siebel Handheld Client Synchronization screen.

TRUE or FALSE

ApplicationDirectory

Single-line setting. Specifies the working directory (UNC path) for the Handheld application synchronization component where user data is stored.

\\server name\directory name

BatchDownloadStagger

Single-line setting. Enables the setting of the interval (in minutes) during which the polling for ready extracts is staggered.

integer >= 0; default is 30

BatchInitialDownload

Single-line setting. Enables the setting of the earliest time (HH:MM; 24-hour clock) at which the polling for a database extract can commence. The setting must be UTC enabled.

00:00 is the default value

BatchPollFrequency

Single-line setting. Enables the setting of the amount of time (in minutes) between polling sessions.

integer >= 0; default is 15

ClientSyncDefault

Determines the default synchronization options available to the synchronization client in the Handheld application. It can have the following values:

  • Upload which means that the Upload Only option is selected in the batch synchronization dialog on the client.
  • Deferred which means that the Upload Now, Auto Download Later option is selected.

Deferred,
Upload

DBExtractThreadLoad

Single-line setting. Enables Thread Throttling functionality for database extract threads. It is the load (or weight) that will be assigned to each individual Database Extractor thread. For each running database extracting thread, this load value will be used to determine the total system load, which is then compared against the MaxTotalThreadLoads value. A new thread will only be started if the total system load does not exceed the MaxTotalThreadLoads value. A value of zero disables throttling of Database Extractor threads.

integer >= 0; default is 2

DefaultBCUserProps

Multi-line setting. Reduces the number of User Properties that are extracted to the device metadata, thus decreasing the number of fields for a business component that need to be extracted. These reductions lower the metadata extract size and optimize client performance by removing irrelevant user properties from the Handheld application configuration. If this directive is not specified for a business component, then all user properties will be extracted.

 

DefaultBusObj

Multi-line setting. Used to force the extraction of a business object and its designated business components. This is typically used when a business component is not extracted because it is not specified via the "DefaultView" directive and is required for the application to function correctly. Another use of this directive is to designate business components that function as RBOs (reverse business objects).

Business Object Name|Visibility Level||Business Component Name|QBE query construct

For more information about QBE (query by example) structure, see Constructing Business Component and Business Object Filters for Siebel Handheld Applications.

DefaultFields

Multi-line setting. Used to force the extraction of fields for a particular business component. This is typically the case where the business component is extracted via the "DefaultView" directive but because the field is not visible on the applet, it is not extracted. Also when a hidden business component is extracted via the "DefaultBusObj" directive, it is necessary to specify all of the fields that need to be extracted for the business component. If no fields are specified via this directive, then the business component will not be extracted for this case.

Business Component Name|Field1|Field2|...

DefaultHandheldInsertMode

Single-line setting. Enables insert failure processing for synchronization. If enabled, synchronization will stop upon encountering a data conflict during an insert operation. Users or administrators must resolve the data conflict before synchronization can resume. This feature is disabled by default.

NoFail or FailOnError

DefaultHandheldSyncPickMode

Single-line setting. Enables Extended Pick processing for synchronization. If enabled, synchronization stops when a data conflict is encountered during a pick operation. Users or administrators must resolve the data conflict before the synchronization can resume. This feature is disabled by default.

NoFail or FailOnError

Enable Application Lockout

Single-line setting. If set to TRUE, locks the Siebel Handheld application after a number of invalid attempts. The number of invalid attempts is specified in the FailedLoginAttempts setting. The Siebel Handheld application locks for the number of days specified in the LockOutPeriod setting. The default value is FALSE.

TRUE or FALSE

Enable Encryption

Single-line setting. If set to TRUE, enables encryption of the database on the handheld device. The default value is FALSE.

TRUE or FALSE

EnableBatchExtraction

Single-line setting. This parameter enables or disables the batch synchronization functionality. Disable batch synchronization is the default.

TRUE or FALSE

EnableThrottleDebugMode

Single-line setting. This parameter enables or disables Thread Throttling functionality.

TRUE or FALSE

ExtractionExpiration

For batch synchronization functionality. It specifies the number of hours that is used to determine when a database extraction has expired. When a database extract expires, batch synchronization will reextract the databases. If no value is provided, then databases will be extracted every time they are requested.

integer >= 0

LoadBalanceLoc

Single-line setting. This setting can be specified only from the application level. The IP address or server name of the load balancer and port number are specified in the following format:

[IP Address]:[port number]

Load balancing must be used for batch synchronization, if enabled.

MaxBatchsyncTasks

Single-line setting. This parameter enables a percentage of synchronization component tasks to be allocated to performing DBextract or Transaction Processing.

integer >= 0; default is 0.5

MaxThrottleWaitTime

Single-line setting. For Thread Throttling functionality. This is the upper limit on the amount of time (in minutes) any individual throttling request will be allowed to wait.

integer >= 0; default is 5

MaxTotalThreadLoads

Single-line setting. For Thread Throttling functionality. It defines the maximum number of total thread loads (determined by DBExtractThreadLoad and TranProcThreadLoad for each type of thread) that will be allowed to run across the scope defined by ThreadThrottleScope. If a throttling request is made that causes this maximum to be exceeded, the requesting thread is delayed. The default value is zero, which completely disables the throttling mechanism.

integer >= 0; default is 0

NoDatabaseBusComp

Multi-line setting. Defines a business component that must be omitted from the device database and excluded from database extraction.

 

NoExtractBusComp

Multi-line setting. Defines a business component that must be excluded from database extraction.

 

SchemaChangeNotification

Multi-line setting. Defines a Business Service that must receive the Handheld Schema Change Notification.

(Siebel internal)

ThreadThrottleScope

Single-line setting. For Thread Throttling functionality. Defines the scope of the thread throttling mechanism as using one of two different modes:

  • Process Thread, where throttling occurs independently within each process.
  • Application, where throttling occurs across all processes running the same synchronization application on a single server.

Only the first character of the ThreadThrottleScope parameter is used to determine the value. All other characters are ignored. Thus aardvark is interpreted as Application. Case is also ignored. The default value is Application.

Application or Process

TranProcThreadLoad

Single-line setting. For Thread Throttling functionality. It is the load (or weight) that is assigned to each individual Transaction Processor thread. For each running transaction processing thread, this load value is used to determine the total system load, which is then compared against the MaxTotalThreadLoads value. A new thread will only be started if the total system load does not exceed the MaxTotalThreadLoads value. A value of zero disables throttling of transaction processing threads.

integer >= 0; default is 3

TranProcThreshold

Single-line setting. For Thread Throttling functionality. This is the minimum time (in minutes) that the Transaction Processor will continue processing transactions before performing a handshake with the client. Once this value has been exceeded, a handshake occurs instead of starting to process the next transaction. Doing so prevents the client from timing out the session when thread throttling is enabled.

integer >= 0; default is 5

TranReapplyComponent

Single-line setting. Server component to use for playback of transactions for parent component.

 

TranReapplyServer

Single-line setting. Siebel Application Server to use for playback of transactions for parent component.

 

To add a new application setting

  1. Navigate to the Administration - Mobile screen > Application Administration view.
  2. From the Settings list menu, select New Record.
  3. Click the name field, and select the setting you require.
  4. Click the Value field, and enter the text of the setting.
Siebel Pharma Handheld Guide Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices.