Bookshelf Home | Contents | Index | Search | PDF

Siebel Server Administration Guide > Siebel Server Infrastructure Administration > Administering the Siebel File System >

Using the Siebel File System Cleanup Utility

---

The Siebel File System Cleanup Utility is a command-line utility, named sfscleanup.exe, located in the bin subdirectory within the Siebel Server root directory. The sfscleanup.exe utility processes every file in the file attachment directory and performs one of several operations to each file depending on the file type and the parameters that you set. For descriptions of the run-time parameters that you can set when running sfscleanup.exe, see Table 12. For descriptions of the file types and the associated operation that will be performed by sfscleanup.exe during processing, see Table 13.

To cleanup the file attachment directory using sfscleanup.exe

At the command prompt, change directory to the bin subdirectory within the Siebel Server root directory.
Run sfscleanup.exe using the parameters listed in Table 12 as shown in the following example:

sfscleanup /u sadmin /p secret /f \\server1\files /x \\server1\logs\sfscleanup.log

Table 12.  Sfscleanup.exe Parameters

Parameter	Value	Description	Required?
/u	Username	Username ID.	Y
/p	Password	Username password.	Y
/c	ODBC data source	Set this value to the ODBC data source. Default value is set to the environment variable, SIEBEL_DATA_SOURCE.	N
/d	Siebel table owner	Set this value to the Siebel table owner. Default value is set to the environment variable, SIEBEL_TABLE_OWNER.	N
/f	Path for file directory	Set this value to the path for the file attachment directory. Do not append att to the file attachment directory path.	Y
/x	Path for output file	Set this value to the path for the output file.	N
/m	Path for move directory	Set this value to the path for the directory where discarded files will be moved.	N
/n	Remove old revisions	Determines if old versions of file attachments will be removed. To remove old versions, set this value to Y. Default value is N.	N
/r	Generate report file only	Set this value to Y to generate only a report file. If set to Y, the report file will contain only the columns File Name and File Type. Default value is N.	N
/g	Garbage files	Set this value to remove garbage or non-Siebel files. Default value is N.	N

Further details on some parameter settings:

/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 (FSM), 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.exe.

If you specified an output file using the /x parameter, sfscleanup.exe generates a log file listing the operations that were performed. The output file is a tab-delimited text file that contains the following columns:

File Name

This column lists the name of each file that was processed.

File Type

This column lists the type of each file that was processed. Table 13 lists the possible file types and the associated operation that will be performed by sfscleanup.exe during processing.

Table 13.  File Types and Associated Operation

File Type	Description	Operation1
CURRENT	The file has a corresponding record in the file attachment database table.	KEPT
NEW	The file is less than one hour old. Sfscleanup.exe will not check for the file in the file attachment database table.	KEPT
ORPHAN	The file does not have a corresponding record in the file attachment database table.	DELETED2
INVALID	The file (or directory) is not a file attachment. If sfscleanup.exe is attempting to delete a subdirectory that is not empty, the operation will error out. This gives you an opportunity to review the files contained within the directory before deletion.	KEPT3
ANCIENT	The file has an associated record in the database with a different revision number.	KEPT4

1For descriptions of each operation, see Table 14. 2If you used the /m parameter to set a move directory, the operation performed is MOVED. 3If you set the /g parameter to Y, the operation performed is DELETED. 4If you set the /n parameter to Y, the operation performed is DELETED (or MOVED if you used the /m parameter to set a move directory).

Operation

This column lists the type of operation that was performed during processing. Table 14 lists the types of operation that sfscleanup.exe may have performed during processing.

Table 14.  Operations

Operation	Description
KEPT	The file was kept.
DELETED	The file was deleted.
MOVED	The file was moved to the directory specified by the /m parameter. Files will only be moved if you used the /m parameter.
KEPT_DIR	The item was kept because it was a directory and requires manual processing.
KEPT_ERROR	The file was kept because an error occurred while trying to move or delete the file.

Bookshelf Home | Contents | Index | Search | PDF