review_volumes

Allows you to view volume file attributes regarding OS volumes (file size, last modification date, and so on) and to remove unreferenced operating system files from these volumes. This utility can generate a report file describing volume usage by various groups and users, as well as reporting any unreferenced operating system files, missing operating system files, and unreferenced Teamcenter files. Unreferenced operating system files can be deleted at the time a report file is generated or at a later time using a previously-generated report file as an input. The report file format is plain text (ASCII) and can be manually edited in order to not delete certain files. To prevent files from being deleted, remove any file names before using the report file as input. You can also save any deleted files to a ZIP format compressed file. Note Before creating volumes, you must have an FMS server cache (FSC) installed and running, and you must set the FMS_BootStrap_Urls preference with the FSC host and port information. The report file contains three main sections that list issues with Teamcenter files: Section 1: Unreferenced OS files Lists files in the OS file system over a day old that are not referenced by Teamcenter. These are files that exist in the OS volume directory but are not referenced by any Teamcenter TcFile data objects. These are the OS files that are deleted when the review_volumes utility is run with the -if argument. During the -if run, these files are deleted only after a double-check that they are indeed not referenced. Section 2: Missing OS files Lists files missing from the OS file that are referenced by Teamcenter. These are files that do not exist in the OS volume directory but are referenced by Teamcenter data objects. This situation may be remedied by copying the missing files from backed-up volumes or whole file caches. The -if run does not take any additional action on files reported in this section. Section 3: Unreferenced Teamcenter files Lists files in the OS file system referenced from unreferenced ImanFile objects. These are files that exist as TcFile data objects, but those TcFile data objects are not referenced by any dataset data objects. For files that are listed in this section, the -if run deletes the TcFile object and the OS file from the volume. Teamcenter referential integrity ensures that the TcFile object deletions occur only if they are not referenced by other Teamcenter objects. To illustrate the report output, assume that the Teamcenter database has the following contents: Dataset Reference type Referenced TcFile Volume file name of the referenced file MyDataset1 - - - MyDataset2 Text MyFile.txt eng_3219879864/MYFILE209734EA_32470987.txt MyDataset3 MSWordX Schedule3.docx eng_3219879864/SCHED4867986324_3467.docx Zip MaintenanceSchedules.zip eng_3403297097f/MAINTE49907r3732498_kjlewuih.zip MyDataset4 File 4GMatrix.dat eng_3403297097f/4GMAFJKSN39479679_3234777429869.dat - - Lolapalooza.mid eng_3219879864/LOLAP214097409_32209874986.mid - - VennDiagram.dia eng_3219879864/VENND329879864_379407.dia Also assume that the volume contains the following files: eng_3219879864/LOLAP214097409_32209874986.mid eng_3219879864/MYFILE209734EA_32470987.txt eng_3403297097f/MAINTE49907r3732498_kjlewuih.zip eng_3403297097f/BARTFARGLE0321970_32986.tag eng_3403297097f/FASTNR2139840397_3219473209.prt The report lists the following: Unreferenced OS files The following files exist in the volume but are not referenced by any Teamcenter data objects: eng_3403297097f/BARTFARGLE0321970_32986.tag eng_3403297097f/FASTNR2139840397_3219473209.prt Missing OS files The following files do not exist in the volume but are referenced by Teamcenter data objects: eng_3219879864/SCHED4867986324_3467.docx eng_3403297097f/4GMAFJKSN39479679_3234777429869.dat eng_3219879864/VENND329879864_379407.dia Unreferenced Teamcenter files The following files exist as TcFile data objects, but these TcFile data objects are not referenced by any dataset data objects: eng_3219879864/LOLAP214097409_32209874986.mid eng_3219879864/VENND329879864_379407.dia Syntax review_volumes [-u=user-id {-p=password | -pf=password-file} -g=group] -v=volume -rf= file-name | -if=file-name [-of=file-name] [-zf=file-name] [ -lv] [-parallel=number-of-parallel-processes] [-rfolder=folder-name] [-noDeleteCheck] [-h] Arguments -u Specifies the user ID. This is a user with Teamcenter administration privileges. If Security Services single sign-on (SSO) is enabled for your server, the -u and -p arguments are authenticated externally through SSO rather than being authenticated against the Teamcenter database. If you do not supply these arguments, the utility attempts to join an existing SSO session. If no session is found, you are prompted to enter a user ID and password. -p Specifies the password. -pf Specifies the password file. For more information about managing password files, see Manage password files. This argument is mutually exclusive with the -p argument. -g Specifies the group associated with the user. If used without a value, the user's default group is assumed. -v Runs the utility against a single, specified volume. This argument is required unless the -lv or -parallel argument are specified. -rf Creates a report file listing unreferenced files in volumes. Note The -of, -if, and -zf arguments do not work in combination with the -rf argument. When the -rf argument is present, only the report file generation is performed. -if Specifies the report file to be used as input to delete unreferenced files in volumes. -of Deletes and logs the results to a specified file. This argument must be supplied if the -if argument is used. -zf Saves deleted files to the specified ZIP file. The .zip extension is automatically appended to the file name if another extension is not specified. -lv Lists all volumes defined in the database. -parallel Specifies the number of volumes on which to simultaneously run this utility. You can use this argument to generate reports on all volumes defined in your database simultaneously (use the -lv argument to determine the number of volumes defined in your database). However, you must consider available computing resources while setting this value. Even if you have 800 volumes defined in your database, you might only have enough computing power to run five or ten processes in parallel. This argument must be used with the -rfolder argument. -rfolder Specifies the folder in which the multiple reports generated by the -parallel argument are stored. This argument must be used with the -parallel argument. -noDeleteCheck Turns off double-checking of OS files to be deleted. Double-checking ensures that OS files to be deleted are checked again for ImanFile references before deletion. This avoids accidental deletions when corrupt or tampered report files are used. Use this argument with the -if argument. -h Displays help for this utility. Environment As specified in Manually configure the Teamcenter environment.. Files As specified in Log files produced by Teamcenter. Restrictions In versions prior to 8.3.2, you could supply the -rf argument in combination with the -of argument in order to have the review_volumes utility simultaneously generate a report file and delete files from the specified volume. Beginning with Teamcenter 8.3.2, this requires two separate steps: Run the review_volumes utility with the -rf argument. Use the -if and -of arguments to input the previously created report file and delete volume files. This change in how arguments are processed was required by the need to improve scalability and performance of the review_volumes utility, for example, the addition of the new -parallel argument. Examples To generate a report on a single volume, enter the following command on a single line: Copy review_volumes -u=user-id -p=password -g=group -v=volume -rf=file-name To delete files on a single volume from a previously executed report, enter the following command on a single line: Copy review_volumes -u=user-id -p=password -g=group -v=volume -if=file-name -of=file-name To list all volumes defined in the database, enter the following command on a single line: Copy review_volumes -u=user-id -p=password -g=group -lv To generate report on all volumes defined in the database, enter the following command on a single line: Copy review_volumes -u=user-id -p=password -g=group -parallel=number-of-parallel-processes -rfolder=folder-name Related Topics Introduction to administering volumes