B File Vault Utilities

Several utilities are available to use with the File Vault. These utilities are installed in the AGILE_HOME\agileDomain\tools directory.

Note: Make sure the Purge task is disabled before executing any File Vault utility.

B.1 Dead File Utility

The Dead File utility locates dead files in a file vault.

Usage: java -jar DeadFileUtility.jar -attachmentPrefix<value>-vaultRoot<value>[-moveProblemFiles<Y/N>] [-archiveFileDest<value>][-db_url<value>] [-db_user<value>] [-db_password<value>]-file<value>VERBOSE<true/false>

where:

• attachmentPrefix is the file prefix.

• vaultRoot is the absolute path of the vault root.

• moveProblemFiles allows you to decide if you want to move the dead files to another location.

• archiveFileDest is the fully qualified path to an existing location where the dead files should be moved, if you have chosen to move the files.

• db_url is the URL of the database.

• db_user is the name of the database user.

• db_password is the password of the database user.

• file is the absolute path of the agile.properties file.

• VERBOSE allows you to choose the level of detail displayed when the command is run

B.2 Fix Vault

The Fix Vault utility corrects the file sizes in the database. The file size is determined based on the actual files in the vault and then corrects the size in the database. If the file size equals zero during an upgrade, the file size is returned to its original value after running this utility.

<Agile_Home>Usage: java -classpath @WLS-HOME@/server/lib/weblogic.jar:FixFileSizeUtility.jar com.agile.webfs.tools.upgrade.FixFileSizeUtility -dburl {DBURL} -dbuserid {DBUSERID} -dbpassword {DBPASSWORD} -ifsuser {IFSUSER} -ifspassword {IFSPASSWORD} -LOG

where:

• dburl is the URL of the database.

• dbuserid is the name of the database user.

• dbpassword is the password of the database user.

• ifsuser is the name of the iFS user.

• ifspassword is the password of the iFS user.

• LOG enables logging.

B.3 IFS Reorg

IFS Reorg is used to restructure the file vault during an upgrade from a version prior to Agile PLM 9.2.

Usage: java -jar iFSReorgV2.jar -basedir<value>-oldFilePrefix<value>[-newFilePrefix<value>] [-logging <true/false>] [-simulate <true/false>]

where

• basedir is the file vault location to be reorganized

• oldFilePrefix is the old file name prefix for the existing files in the vault

• newFilePrefix is the new file name prefix. All of the existing files will be renamed with this prefix. This is an optional argument. If it is not specified, the old file name prefix is used.

• logging enables logging of warnings or errors if set to true. The log is saved to a file named ifsReorg.log.

• simulate simulates the reorganization process without actually moving or renaming the files.

B.4 MetaFiles Remover

MetaFiles Remover is used to periodically remove metafiles from the file vault based on the last used date or size. This utility should be used when upgrading the Agile Viewer.

Note: A user-created .cmf file should not be listed or removed from the file vault.

Usage: java -jar MetaFilesRemover.jar [-delete] [-age<value>] [-size<value>] -basedir<value>-prefix<value>-serverURL<value>-username<value>-password-db_url<value> -db_user<value> -db_password<value><value>

where

• delete deletes the metafiles.

• age specifies the last access time (day in numbers).

• size specifies file size (KB).

• basedir is the file vault location where the metafiles are removed.

• prefix is the file name prefix.

• serverURL is the location of the DMS service, for example, http://server.company.com:7001/Agile/DmsService/DmsViewerAPIService.

• username is the DMS service username (ifsuser).

• password is the DMS service password (ifspassword).

• dburl is the URL of the database.

• dbuserid is the name of the database user.

• dbpassword is the password of the database user.

B.5 Missing Files Locator

Missing Files Locator is used to locate missing files, including redlined files, in a file vault, but not limited to a specific distributed file management server.

<Agile_Home>Usage: java -classpath @WLS-HOME@/server/lib/weblogic.jar:MissingFilesLocator.jar com.agile.webfs.tools.upgrade.MissingFilesLocator -dburl {DBURL} -dbuserid {DBUSERID} -dbpassword {DBPASSWORD} -ifsuser {IFSUSER} -ifspassword {IFSPASSWORD}

where:

• dburl is the URL of the database.

• dbuserid is the name of the database user.

• dbpassword is the password of the database user.

• ifsuser is the name of the iFS user.

• ifspassword is the password of the iFS user.

B.6 Second Signature

Agile provides optional data migration scripts that can be used by customers who choose to implement the Signoff User Dual Identification feature for approval signoffs. The Signoff User Dual Identification feature was introduced to address FDA regulations laid out in 21 CFR Part 11 Section 11.200. The system now facilitates the usage of two forms of identification from the user when signing off on a document such as a change order.

For more information on these scripts, see the Agile PLM Database Upgrade Guide.

B.7 Thumbnail Generator Utility

Generates thumbnails in bulk for ITEM, MFRPART, and FILEFOLDERS (including Design) objects.

Usage: java -jar ThumbnailGeneratorUtility.jar -dburl<value>-dbuserid<value>-dbpassword<value>-DMSURL<value>-DMSUSER<value>-DMSPASSWORD<value> [-ALL] [-ITEMs<values>] [-MFRPARTs<values>][ -FILEFOLDERs<values>] [-log] [-createDate<value>]

where

• dburl is the URL of the database.

• dbuserid is the name of the database user.

• dbpassword is the password of the database user.

• DMSURL is the location of the DMS service.

• DMSUSER is the DMS service username.

• DMSPASSWORD is the DMS service password.

• ALL generates thumbnails for all of the supported files.

• ITEMs generates thumbnails for a specified list of items. For multiple items, the values should be comma separated.

• MFRPARTs generates thumbnails for a list of MFR parts. For multiple parts, the values should be comma separated as MFRNAME:MFRPART.

• FILEFOLDERS generates thumbnails for a list of file folders. For multiple folders, the values should be comma separated.

• createDate is the date the file was created in the MM/DD/YYYY format.

B.8 Vault Simulator

Used to create a virtual vault from the Agile PLM database.

Usage: java -Dagile.fileServer.config.file="<server.conf file full path>" -jar VaultSimulator.jar -VaultLoc<value>-URL<value>-userid <value> -password<value>-updateContentURL<value>-createfile<value>

where

• VaultLoc is the file vault location.

• URL is the database location.

• userid is the database userid.

• password is the database password.

• updateContentURL is the location of the Content URL.

• createFile is the name of the newly created file.

B.9 922 PPM Post Upgrade Utility

Agile Product Portfolio Management (PPM) gives you powerful capabilities to define, analyze, and manage all aspects of a project or program. In Agile PLM 9.2.2, some of the business rules were changed. If you are upgrading from a version of PPM prior to version 9.2.2, data migration is necessary in order for the existing data to comply with the new business rules.

The PPM Post Upgrade utility was developed to address these changes. The utility is installed after you have upgraded your system to Agile PLM 9.3.5.

To run the PPM Post Upgrade utility:

1. Unzip the utility files to a temporary directory.

2. Change to the directory where you have unzipped the files and locate the upgrade.properties file.

3. Edit the following entries in the upgrade.properties file to match your environment:

   Server Settings
   server.url URL of the Agile PLM application The format is <protocol>://<machine_name>/<application_name>. On WebLogic, the protocol is t3.
   server.login.id Login ID of the Agile user who has PPM-related privileges to run the utility. This is typically the Admin user.
   server.login.password Password of the Agile user.
   pe.weekend.days Weekends configured in the server. This value should be the same as the setting in the agile.properties file.
   Database Settings
   db.url The JDBC driver URL of the database The format is jdbc.oracle:thin@<db_machine_name>:<port>:<instance_name>.
   db.username Agile database username
   db.password Agile database password
   Application Server Settings
   agile.dir The parent directory where the library files for the Agile application are located.
   oc4j.dir N/A Location of the Oracle Application Server, if installed.
   wls.dir Location of the WebLogic Application Server.

   
   

4. Save the upgrade.properties file.

5. Verify that Agile PLM is running.

6. On a command line, make sure that the JAVA_HOME environment variable points to the location of the JDK. If it does not, set the value to the correct location.

7. In the directory where you unzipped the utility files, run install.cmd to start the utility.

   
   

   Important: If you configured the PPM Post Upgrade Utility in Agile PLM 9.2.2 and are upgrading to Agile PLM 9.3.5 from version 9.2.2, run install upgrade-actualtime.cmd, NOT install.cmd to start the utility.

   
   

8. Restart the Agile application server.