Parameters of the Database Extract Server Component

The following table describes some of the parameters of the Database Extract server component (alias DbXtract).

Parameter Name Alias Required Description

CD directory

CDDir

Optional

Name of a folder where Siebel Remote copies the snapshot files that the initialization uses.

Client Name

Client

Required

Name of the remote client for which Siebel Remote is extracting a database. This value corresponds to the Mobile Client Name field in the Mobile Clients view. For more information, see Specifying Client Names.

Database Init Method

InitMethod

Optional

Method for creating the Siebel Remote database. The default value is Oracle SE (for Oracle Database SE2).

Note: Prior to Siebel CRM 20.9 update, the default value was Oracle XE. (Both new and old values have the same effect in Siebel CRM 20.8 Update and later.) If the parameter still has the old value (Oracle XE), then you must synchronize the DbXtract server component in order for the correct value to be displayed (Oracle SE). For more information, see the information about synchronizing components, in Siebel System Administration Guide.

Number of Data Import Threads

DatImpThrdNum

Optional

Set this parameter to run DbXtract as a multithreaded component with the specified number of threads. The default value is 3.

Extract all Repository Tables

ExtractRepos

Optional

Configures Siebel Remote to include repository tables in a database extract. Values are TRUE and FALSE.

If the Extract all Repository Tables parameter is set to TRUE, then the Get is not necessary. Not using the Get can reduce the amount of time that you require to configure an environment for a developer.

Last Extract Date

ExtractSince

Optional

Specifies a date-time value for extraction. You must use the following format:

YYYY-MM-DD HH:MM:SS

If specified, then the Database Extract server component extracts a remote client only if Siebel Remote has not extracted this client since the date-time value that you specify in the Last Extract Date parameter.

Last Sync Date

SyncSince

Optional

Specifies a date-time value for synchronization. You must use the following format:

YYYY-MM-DD HH:MM:SS

If specified, then the Database Extract server component synchronizes a remote client only if Siebel Remote has not extracted this client since the date-time value that you specify in the Last Extract Date parameter.

Maximum data file size

DatFileSize

Optional

Sets the maximum size of a data file in megabytes:

  • The minimum size is 1.

  • The maximum size is 1000.

  • The default value is 500.

Message Language Code

Language

Optional

Extract messages for this language. The default value is ENU.

Mobile Client Version

ClientVersion

Optional

Specifies the remote client software version, which determines whether parallel extraction is supported. This parameter is important during an upgrade. The default value is 2000.

Move Siebel Remote Client

Move

Optional

For more information, see Using the Move Siebel Remote Client Parameter.

Nodes Per Group

NodesPerGroup

Optional

if the Optimal Mode parameter is TRUE, then the Nodes Per Group parameter specifies the number of users who Siebel Remote extracts together as a group. The default value is 35.

Optimal Mode

OptMode

Optional

Specifies to use the optimal mode to extract a group of users. The default value is FALSE.

Save Client Transactions

SaveTxns

Optional

Save pending client transactions during database initialization. The default value is TRUE. This feature does not work during an upgrade.

The Save Client Transactions parameter is valid only for the remote client.

Truncate TS Table

TruncateTSTable

Specifies to truncate the S_DOCK_INITM_n table instead of deleting it after the Siebel database extract task completes. Used in the cleanup phase. The default value is FALSE.

If you run the Database Extract server component with the Truncate TS Table parameter set to TRUE, then the user ID that you use to run the server component must possess administrator privileges on the Siebel Server.

TS Block Size

TSBlockSize

Optional

Block size for the dobjinst.dbf file in bytes. The default value is 0. Siebel Remote automatically calculates the block size depending on the total number of rows that are visible in the remote client.

TS Cache Size

TSCacheSize

Optional

Cache size for the dobjinst.dbf file in kilobytes. The default value is 2048 kilobytes.

TS Table Number

TSTableNum

Number of database tables in the dobjinst.dbf file that are available for Database Extract. The range is 1 through 48. The default value is 1. This parameter is the end number of the S_DOCK_INITIM_n table, where n is the TS Table Number.