Parameters for the sfscleanup Utility

The following table describes the parameters for the sfscleanup utility. More information about some of the parameters is provided after the table.

This topic is part of Cleaning Up the Siebel File System.

Parameter	Value	Description	Required?
/U	Username	User name ID.	Yes
/P	Password	User name password.	Yes
/C	ODBC_data_source	Set this value to the ODBC data source. The default value is the setting of the environment variable SIEBEL_DATA_SOURCE.	No
/D	Siebel_table_owner	Set this value to the Siebel table owner. The default value is the setting of the environment variable SIEBEL_TABLE_OWNER.	No
/F	Paths for file system directories	Set this value to the paths for the file system directories. Separate multiple directories using commas, with no spaces. If any of the paths themselves contain a space, then enclose the parameter value in double quotes. (Use the same value as the value of the FileSystem parameter.) Whether you must append att to each directory depends on how you use the /H parameter: If you use /H Y, then do not append att to each directory that you specify using /F. (The purpose of /H Y is to eliminate the need to append att.) If you use /H N (or omit /H), then you must append att to each directory that you specify using /F. The utility looks both in the specified directories and in the att subdirectories to find the files to be cleaned up.	Yes
/X	Path for output file	Set this value to the path for the output file.	No
/M	Path for move directory	Set this value to the path for the directory where discarded files are to be moved.	No
/N	Y or N	Determines whether old versions of file attachments are to be removed. To remove old versions, set this value to Y. The default value is N.	No
/R	Y or N	Set this value to Y to generate only a report file. If it is set to Y, then the report file contains only the columns File Name and File Type. The default value is N.	No
/H	Y or N	Set /H Y if you want the utility to automatically append att to each directory that you specify using /F. (Do not append att when you specify these directories.) Set /H N (or omit /H) if you do not want the utility to automatically append att to each directory that you specify using /F. (Append att when you specify these directories.)	N
/G	Y or N	Set this value to remove garbage files or non-Siebel files. The default value is N.	No
/Q	Y or N	Set /Q Y if you want the utility to perform a query by file attachment records. This parameter allows you to run the utility for a limited period of time and provides other ways to manage how the utility runs. The default value is N. Note: When you are using /Q Y, you can also use the parameters /I, /O, /S, and /T. Otherwise, these parameters have no effect.	N
/I	Number of file IDs	Set /I to the number of file attachment records to query. The default value is 300. The utility processes records and files in batches based on the specified number of records. After those files have been processed, the utility processes more records and files in another batch. Note: This parameter has an effect only if you are using /Q Y.	N
/O	Y or N	Use /O Y when you want the utility to use an OR clause to constrain the query row IDs, like this: (ROW_ID = 'Id1' OR ROW_ID = 'Id2' OR ...). The default value is Y. Use /O N to instead use a clause like this: ROW_ID IN ('Id1','Id2',...). Note: This parameter has an effect only if you are using /Q Y. It determines the internal query executed in Siebel database. No row ID is entered as an argument.	N
/S	Y or N	Use /S Y to resume the previous run, from the next unprocessed record, where information about the last processed record is available in a temporary directory. The default value is N. Use /S N (or omit /S) to instead start a new run. Note: This parameter has an effect only if you are using /Q Y.	N
/T	Number of minutes	Set /T to the number of minutes to run the query. When the utility reaches that time, the last processed file attachment record is noted in a temporary directory and the utility exits. Later, you can resume the previous run by using /S Y. By default, the utility runs to completion, until all of the records and files are processed. Note: This parameter has an effect only if you are using /Q Y.	N

More Information About Some sfscleanup Parameters

The following provides more information about some of the parameters for the sfscleanup utility.

• /N. By default, old file revisions are kept. Such files are marked ANCIENT in the log, and represent old revisions of an existing attachment record. That is, their row ID matches with the database record but not the file revision number. To delete such files, set the /N parameter to Y.

• /G. If the file system contains files that were not created by the File System Manager component (alias FSMSrvr), then their deletion or move is controlled by the /G parameter. This parameter includes non-Siebel files or directories. By default these files are not deleted. The directories are not affected or moved by sfscleanup.

• /Q. By default, the sfscleanup utility processes all of the files in the file attachment directories in a single long-running operation. For a Siebel File System that includes a very large number of files, such an operation might affect performance or inconvenience production users.

  Alternatively, the /Q parameter allows you, for example, to process files in batches based on a query of a given number or file attachment records (by using /I), to modify how the utility queries these records (by using /O), to run the utility for a specific period of time (by using /T), and to resume a run later where it left off (by using /S). For example, you might decide to run the sfscleanup utility only when most of your users are not logged in.