fms_file_uids

Finds the FMS file unique ID (UID) of the volume file associated with a dataset or absolute volume path. You can use this utility to fix corrupted files in the FMS cache or volume. Use the -f=list argument to obtain a list of file UIDs, and use the -f=download argument to download files from the FMS cache or a volume. File corruption is caused generally due to network issues in the environment. If a file is found corrupt in the FSC cache, the FMS file UID can be used to purge the file from the FSC cache using the fscadmin utility. If the file is found corrupt in the volume but not corrupt in the FSC cache, the FMS file UID can be used to download the uncorrupted file from the FSC cache. Once the file is recovered, it should be verified for correctness. This can be done by opening the file with the appropriate tool (for example, Microsoft Word or NX). Once it is verified as correct, it may simply be copied over the corrupted file in the volume. This may require permission changes depending upon what account has ownership. You can recover files in the following ways: Recover a file from the FSC cache The fscadmin utility can be used to verify whether a file UID has been previously cached, for example, fscadmin -s http://address:port./cachedetail. The console output looks similar to the following: Copy Cache details: FSC_tri6w035_nox-FSCReadMap Files: 8, Bytes: 3260416, Hits: 0, Misses: 0 FSC_tri6w035_nox-FSCReadMap cache contains fragments of files with the following guids: 00000000000004a55091052da5548113, len: 1529282 0000000000000367508fadc3a5548113, len: 3292 0000000000000397508fadc3a5548113, len: 3904 000000000000037f508fadc3a5548113, len: 3759 00000000000003df508fadc3a5548113, len: 2269 0000000000000425509a5190a5548113, len: 1529282 0000000000000429509a6102a5548113, len: 96626 00000000000003af508fadc3a5548113, len: 1909 Cache details: FSC_tri6w035_nox-FSCWriteMap Files: 2, Bytes: 1638400, Hits: 0, Misses: 0 FSC_tri6w035_nox-FSCWriteMap cache contains fragments of files with the following g guids: 000000000000042c50913584a5548113, len: 89120 00000000000004845097e951a5548113, len: 1529282 Cache details: whole file disabled. cachedetail done. Recover a file from the FCC cache It may be possible to recover a file from the FCC cache. Once you run the fms_file_uids utility with the -list argument, you can determine the file UIDs for each file and search the FCC cache for that file by that UID. For example steps (given a file UID of 00000000000021c84d2ba8e281f08a1f): Copy cd %FCC_CACHE_DIR% dir /s fmsr_00000000000021c84d2ba8e281f08a1f.* If this file is found in the FCC cache, it may be copied into the appropriate volume location in the same manner as you would copy a file recovered from FSC cache from the localfolder generated by the fms_file_uids utility. Syntax fms_file_uids [-u=user-id {-p=password | -pf=password-file} -g=group] -f=[list | download] -v -h Arguments -u Specifies the user ID. This is a user with Teamcenter administration privileges. If this argument is used without a value, the operating system user name is used. Note 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. If used without a value, the system assumes a null value. If this argument is not used, the system assumes the user-ID value to be the password. This argument is mutually exclusive with the -pf argument. -pf Specifies the password file. If used without a value, the system assumes a null value. If this argument is not used, the system assumes the user-ID value to be the password. 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. -f Specifies one of the following functions: list Lists the FMS file UIDs with the volume file name, associated dataset name, and dataset type (if any). This information is written to a file named fmscache_gile_guids.txt. Following is sample content: Copy FSC GUID = 000000000000217a50abb00620cc4bca, VolumeFile Name = tst031_text_ev309kc4nflj8.txt Dataset Name = tst031, Dataset Type = Text Dataset Name = tst031, Dataset Type = Text FSC GUID = 000000000000218e50abb00620cc4bca, VolumeFile Name = tst032_text_i6309kc4nfltd.txt Dataset Name = tst032, Dataset Type = Text Dataset Name = tst032, Dataset Type = Text FSC GUID = 000000000000224450abb00620cc4bca, VolumeFile Name = tst033_text_66x09kc4nflxf.txt Dataset Name = tst033, Dataset Type = Text Dataset Name = tst033, Dataset Type = Text FSC GUID = 000000000000222250c1d05c20cc4bca, VolumeFile Name = tst034__wor_5jw059g4oap0j.doc Dataset Name = tst034_item/A, Dataset Type = MSWord Item Id = tst034_item, Item Revision Id = A Dataset Name = tst034_item/A, Dataset Type = MSWord In this example, the first three files were created as named references to a dataset. The fourth file was created as part of a dataset under an item and item revision. download Downloads files from the FSC cache into a subfolder named localfolder. The FMS file UIDs not found in cache are downloaded from the volume if an FSC has been configured to serve a volume. The following subfunctions can be used with the download argument: -fscURI=URI Specifies the Uniform Resource Identifier (URI) of the FSC cache where the UID is stored, that is, http://address:port. This is only used with the -f=download argument. -volumePathList= filename Specifies the input file consisting of fully qualified volume filenames. This argument can be used instead of the -datasetNameList argument. Note The -volumePathList argument contents can be generated by running the move_volume_files utility using the -f=list and -srcvol=volume-name arguments (among others). This creates a file with fully qualified file names that can be used as input to this utility. -datasetNameList= filename Specifies the input file consisting of dataset names. This argument can be used instead of the -volumePathList argument. -v Specifies verbose mode. -help or -h or -? Displays help for this utility. Help can be localized if the FCC is running. Environment As specified in Setting up a Teamcenter command-line environment and the following: The FMS_HOME variable must be set to a valid FMS server directory. The JAVA_HOME variable must be set to a valid Java SDK directory. FCC must be running. This command must be run in an FMS operating environment. Configure two FSCs, one as a cache server and one as a volume server. For example: Copy …. … Files As specified in Log files produced by Teamcenter. Restrictions A functioning FSC is required to use this utility. To use the utility with older saved FSC caches, an FSC should be configured solely for the purpose of recovering files from the cache. Sometimes the file may have been partially cached in segment cache. In such an event, it attempts to pull down the missing segments from the volume file (if available). If the file has not been previously cached, the utility exports the file from the volume (again, if configured and available). When running the recovery utility, no volume should be configured in FMS. If a volume is configured there is no way of knowing if a recovered file came from cache or from the volume. Without a volume configured, the utility reports an error if the file cannot be found in either location. Examples The following example writes the list of UIDs to a file: Copy -fms_file_uids -u=username -p=password -g=dba -f=list -volumePathList=c:\myfilelist.txt The following example downloads files from the FSC cache: Copy -fms_file_uids -u=username -p=password -g=dba -f=download -fscURI=http://myhost:1234 -datasetNameList=C:\mydatasetlist.txt