Bookshelf v7.8: Parameters of the Database Extract Component

Table 15 lists the parameters and default values for the database extract component.

Table 15. Database Extract Parameters
Name	Alias	Required/Optional	Default Value and Usage Notes
CD directory	CDDir	Optional	Name of a directory to which snapshot files are copied for use by the CD-ROM initialization method.
Client Name	Client	Required	Name of the Mobile Web Client for which you are performing a database extract. This corresponds to the Mobile Client Name field in the Mobile Clients view.1
Database Init Method	InitMethod	Optional	Method for creating the Siebel Remote database. Default is SQL Anywhere.
Database template file name	DbTmplFile	Optional	Name of the SQL Anywhere Database Template file. Default is sse_utf8.dbf. This entry should match the entry you make for the SQL Anywhere Database parameter in the Generate New Database component. If you use the encrypted local database template, enter sse_encr.dbf in both places.
Encrypt client Db password	EncryptLocalDbPwd	Optional	If TRUE, the local database password is encrypted using RSA SHA-1 encryption before being passed to the local database for authentication. Default value is FALSE.
Extract all Repository Tables	ExtractRepos	Optional	Specifies that the repository tables will be included in a db extract. Values are TRUE and FALSE.
Last Extract Date	ExtractSince	Optional	When specified, Database Extract extracts Mobile Web Clients only if they have not been extracted since this date-time value. The value must use the format YYYY-MM-DD HH:MM:SS.
Last Sync Date	SyncSince	Optional	When specified, Database Extract extracts Mobile Web Clients only if they have not been synchronized since this data-time value. The value must use the format YYYY-MM-DD HH:MM:SS.
Maximum data file size	DatFileSize	Optional	Sets the maximum size of a data file in megabytes. Minimum size is 1. Maximum size is 1000. Default is 500.
Message Language Code	Language	Optional	Extract messages for this language. Default is ENU.
Move Siebel Remote client	Move	Optional	Specifies if Database Extract should set the Mobile Web Client's Siebel Server name to the local Siebel Remote server if the Mobile Web Client is currently registered on another Siebel Remote server. The default is FALSE.2
Nodes Per Group:	NodesPerGroup	Optional	Number of users in one group to be extracted together when OptMode is TRUE. Default is 35.
Optimal Mode	OptMode	Optional	Specifies whether to use the optimal mode to extract a group of users. Default is FALSE.
Save Client Transactions	SaveTxns	Optional	Save pending client transactions during database initialization. Default is TRUE. This feature will not work during the upgrade process. Save Client Transactions is valid only for Mobile Web Clients.
Specify the mobile client vers	ClientVersion	Optional	Specifies the client software version. This is important during upgrades. Default is 2000 for v7.x.
Truncate TS Table	TruncateTSTable		Specifies whether the S_DOCK_INITM_n table should be truncated instead of deleted after the database extract task completes. Used in the cleanup phase. Default is FALSE. When running the database extract (dbxtract) component with the Truncate TS Table parameter set to TRUE, the user ID used for running the server component must have administrative privileges in the database server.
TS Block Size	TSBlockSize	Optional	Block size for dobjinst.dbf database in bytes. The default is 0. The block size is automatically calculated depending on the total number of rows visible to the Mobile Web Client.
TS Cache Size	TSCacheSize	Optional	Cache size for dobjinst.dbf database in kilobytes. The default is 2048 kilobytes.
TS Table Number	TSTableNum		Number of dobjinst.dbf database tables available for dbxtract: 1 to 48. Default is 1. The ending number of the S_DOCK_INITIM_n table.

1You can specify a list of node names delimited by commas. If the first character is @, this parameter specifies the name of a file that contains a list of nodes. Client names in the file must be separated by one of the following delimiters: new line, comma, space, tab, period, or semicolon. You can specify wildcards, using * to match zero or more characters and ? to match a single character.

2This option applies to the Siebel Remote clients, including Mobile Web Clients and regional nodes. Database Extract returns an error if you try to extract a Mobile Web Client that was previously extracted on a different server. You can move the client to the current Siebel Server by setting the Move parameter to TRUE. You can also move a regional node to the current Siebel Server by using the Move parameter. The Transaction Router, Transaction Merger, and DB Extract processes on the old server stop servicing the Mobile Web Client or regional node in the next iteration.

You may get an error message if the target node is used by another Siebel Remote server process. For example, if another Siebel Remote server process were accessing the inbox or outbox directory for sjones, you would receive the following error message:

Target node "sjones" is currently in use by another server process. Try again later.

In this case, you should try to rerun a database extract in a few minutes when the file may be available and unlocked.

NOTE: After you have performed a database extract for a Mobile Web Client, the client database must be initialized before any data exchange between the client and the server can occur. This includes the uploading of any client database changes.