Cleaning Up the File System Directories Using the sfscleanup Utility

This topic describes how to clean up the Siebel File System directories by removing orphan records using the Siebel File System cleanup utility, sfscleanup.

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

To clean up the file attachment directory using sfscleanup

  1. At the command prompt, change directory to the bin subdirectory within the Siebel Server root directory.

  2. Run sfscleanup using parameters listed here, in a command like the following example:

    sfscleanup /U sadmin /P pwd /F \\server1\files /X \\server1\logs\sfscleanup.log
    

    For more information about the parameters you can use for the sfscleanup utility, see Parameters for the sfscleanup Utility.

About the sfscleanup Log File

If you specified an output file using the /X parameter, then sfscleanup 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.

  • Operation. This column lists the type of operation that was performed during processing. A table later in this topic provides descriptions of each operation.

File Types and Operations for the sfscleanup Utility

The following table lists the possible file types and the associated operation performed by sfscleanup during processing. The Operation column lists the type of operation that was performed during processing.

File Type

Description

Operation

CURRENT

The file has a corresponding record in the file attachment database table.

KEPT

NEW

The file is less than one hour old. The sfscleanup utility does 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.

If you used the /M parameter to set a move directory, then the operation performed is MOVED, not DELETED.

DELETED

INVALID

The file (or directory) is not a file attachment. If sfscleanup tries to delete a subdirectory that is not empty, then the operation errors out. Review the files contained within the directory before deleting them.

If you set the /G parameter to Y, then the operation performed is DELETED, not KEPT.

KEPT

ANCIENT

The file has an associated record in the database with a different revision number.

If you set the /N parameter to Y, then the operation performed is either MOVED (if you used the /M parameter to set a move directory) or DELETED, not KEPT.

KEPT

The operations mentioned in the previous table are described in the following table.

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 are 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.