Skip Headers

Agile Product Lifecycle Management Database Upgrade Guide Release 9.3.3 E39282-01 |
| Contents

Previous | Next |

# 3 Understanding the Property Files

AUT uses property files to supply the input information to the database scripts. If you are not upgrading a Product Cost Management 8.5 or Program Execution 8.5 database, you should only complete the aut.properties file.

You can use the averify.properties file to specify destination database details, Averify options, and email options. You should run Averify and use the results to eliminate known errors, as a prerequisite for diagnosing problems.

If you are also upgrading a Product Cost Management 8.5 or Program Execution 8.5 database, you should complete either the psupgrade.properties file or the peupgrade.properties file, in addition to the aut.properties file.

## 3.1 The aut.properties File

The aut.properties file, located in the $AUT_HOME\config directory, contains user-supplied information on the source and destination databases. The source database parameters contain information about the database to be upgraded. The destination database parameters contain information about the user and host details of the database where the source database is being upgraded. These parameters are used by the database scripts during the upgrade process.

### 3.1.1 Defining the aut.properties Parameters

You can edit the aut.properties file to define the following parameters:

- RMW Only Details

- Whether Source Equals Destination

- Destination Details

- Source Database Backup

- Sequence Project

- Source Details

- Averify Details

- Ignore Import Warnings

- Language Details

- Character Set Encoding Details

- File Manager URL

- Destination Version

- 8.5 Only Details

- PPM 9.3.1 Details

Each parameter is followed by an example displaying the correct format for each parameter value. You must complete the source and destination details in order for AUT to proceed with the upgrade.

#### 3.1.1.1 RMW Only Details

Parameter | Value Definition
--- | ---
rmwUpgrade | Specifies whether you want to upgrade the RMW database. Default value is false. Set this value to true to upgrade the RMW database to the dest.version specified.

#### 3.1.1.2 Whether Source Equals Destination

Parameter | Value Definition
sourceEqualsDest | Determines if the source database is upgraded to the destination database with or without the database user. If this value is set to true (upgrade destination in-place): ú the source database is upgraded without exporting and importing the database user to the destination database. This means that the existing database user is upgraded instead of importing to a new database user and then upgrading. Note This does NOT apply if your source and destination databases are on different versions of the Oracle database. ú AUT does not perform an export unless a value for the src.db.backup parameter is specified. ú the source database details are not required.

#### 3.1.1.3 Destination Details

Parameter | Value Definition
--- | ---
dest.jdbc.url | The JDBC connection string to the destination database. The format is jdbc:oracle:thin@<DESTINATION_DB_HOST_NAME>:<PORT>:<SID> where DESTINATION_DB_HOST_NAME is the hostname of the destination database, PORT is the listener port of the destination database (1521 is the default), and SID is the database instance.
dest.jdbc.driver | The database driver to use for JDBC connections to the destination database. The default is oracle.jdbc.driver.OracleDriver.
dest.tns.name | The TNS name for the destination database.
dest.oracle.home | The Oracle Home of the destination database. This value can be a mapped drive on the system where the AUT is run which points to the shared folder on the host machine. Note Use either double back slashes or a forward slash for directory separation, for example, d:/oracle/ora102 or D:\\oracle\\ora102

#### 3.1.1.4 Source Database Backup

Parameter | Value Definition
db.backup | Specifies whether a backup of the source database is required. Set this value to true to take a backup.

#### 3.1.1.5 Sequence Project

Parameter | Value Definition
--- | ---
gap_threshold | Size of block of unused or orphaned sequence IDs than can be reused. The default minimum value is 5000.

#### 3.1.1.6 Source Details

Parameter | Value definition
--- | ---
src.jdbc.url | The JDBC connection string to the source database. The format is jdbc:oracle:thin@<SOURCE_DB_HOST_NAME>:<PORT>:<SID> where SOURCE_DB_HOST_NAME is the hostname of the source database, PORT is the listener port of the source database (1521 is the default), and SID is the database instance.
src.jdbc.driver | The database driver to use for JDBC connections to the source database. The default is oracle.jdbc.driver.OracleDriver.
src.tns.name | The TNS name for the source database.
src.oracle.home | The Oracle Home of the source database. This value can be a mapped drive on the system where the AUT is run which points to the shared folder on the host machine. Note Use either double back slashes or a forward slash for directory separation, for example, d:/oracle/ora102 or D:\\oracle\\ora102.

Note: If you are upgrading from Product Cost Management or Program Execution only, leave all Source detail properties blank in the aut.properties file.

#### 3.1.1.7 Averify Details

Parameter | Value Definition
--- | ---
averify.error.count | Specifies the number of averify errors to occur before the AUT stops the upgrade. Specify -1 to ignore the errors and continue with the upgrade. Specify +1 to stop the upgrade if an error occurs. Once you fix the error, you can run AUT again to continue the upgrade.

#### 3.1.1.8 Ignore Import Warnings

Parameter | Value Definition
--- | ---
ignore.imp.warnings | Decide if the AUT ignores the import warnings or not while importing the database. If set to true, the warnings are ignored. AUT will stop if there is a critical error.

#### 3.1.1.9 Language Details

Parameter | Value Definition
--- | ---
i18n.lang | Specifies the language of the operating system where the database is located. The values are English, Japanese, Chinese, or French.

#### 3.1.1.10 Character Set Encoding Details

Parameter | Value Definition
--- | ---
nls.lang | Specifies the character set encoding being used during database import and export. For example, AMERICAN_AMERICA.AL32UTF8. Note: Customers upgrading from AA and 8.5 releases to Agile PLM should set this variable to 'American_America.AL32UTF8' when running AUT on a non-English client. This is necessary to ensure that the following database users - ifsuser, superadmin, and agileuser - are successfully upgraded.

#### 3.1.1.11 File Manager URL

Parameter | Value Definition
--- | ---
file.manager.url | Specifies the location of the file manager. The content_url column in the files table is upgraded with an encrypted URL based on the file type. This URL is used after upgrading for full text search configuration. The format is http://<FILE_MANAGER_HOST>:<PORT>/Filemgr/AttachmentServlet.

#### 3.1.1.12 Destination Version

Parameter | Value Definition
--- | ---
dest.version | The version of the upgraded Agile PLM database.

#### 3.1.1.13 8.5 Only Details

Parameter | Value Definition
--- | ---
isPC | Each of the parameters must have a value if the source database is either 8.5 or 8.5 SPx only. Set the parameter to true for the components that are installed on the source database and to false for the components that are not installed.
isPSI
isPCM
isPE
username.migration.action | Determine how you want the Agile users in the source database to appear in the destination database. The value is set as the number of one of the following choices: 1. FIRSTNAME LASTNAME 2. LASTNAME FIRSTNAME 3. FIRSTNAME, LASTNAME 4. LASTNAME, FIRSTNAME 5. None of the above. FIRSTNAME will be migrated to LASTNAME. If your database contains mixed cases, choose the option that reflects the format for most of your users. The remaining users must be migrated manually after the upgrade.
gmt.timezone.difference | The GMT time zone of your database. The database and Agile application server must be on the same GMT time zone. The GMT time zone format is six characters, (+ or -)hh:mm, for example, GMT would be -00:00.
dest.users.timezone | The timezone to be used for the upgraded database. A text file listing the time zones that are supported is provided in the <AUT_HOME/config directory . Each timezone has a corresponding ID. Enter the ID that corresponds to the applicable time zone as the value for this parameter.
dest.users.encode.type | The encode type to be used for the upgraded database. All the supported encode types are specified in comments immediately above this parameter in the aut.properties file. Each encode type has a corresponding ID number. Enter the ID number that corresponds to the applicable encode type as the value for this parameter. For example, to set the default encode type to Unicode (UTF-8), set dest.users.encode.type= 5

#### 3.1.1.14 PPM 9.3.1 Details

PPM 9.3.1 supports time-stamps for Schedule, Estimated, and Actual Dates, allowing users to define tasks with durations in hours, minutes or even seconds.

To ensure that the correct durations are reflected in programs that were created with earlier releases, the following parameters need to be specified. These specifications should match related entries in the agile.properties file. If the default start and end times specified in the agile.properties file do not match your entries here, change the entries manually.

Parameter | Value Definition
--- | ---
dest.ppm.start.time | Start time of the work day in 24-hr format. For example, 08:00.
dest.ppm.end.time | End time of the work day in 24-hr format. For example, 17:00.
dest.ppm.working.hours | Total working hours in a day, in 24-hr format. For example, 08:00.

Note: Although PPM supports timestamps with hours, minutes and seconds, the time span defined as working hours in the agile.properties file should be specified only in hours and minutes, not in seconds. For example, you can use the time span 08:30:00 to 17:30:00, but not 8:30:25 to 17:30:25. Customers upgrading from a previous release to 9.3.1 may notice a discrepancy in the schedule dates of upgraded programs which have an Activity-Milestone-Activity construct with FS dependencies and time buffers, as described in the following scenario: Task 1 (1-day duration) has an FS dependency with Gate1, and Gate 1 has an FS dependency with Task 2 (1-day duration). Both dependencies have a 1-day time buffer also specified. During upgrade to 9.3.1, an extra day is added to the schedule. The duration for these tasks in 9.2.2.x will be 3 days, in 9.3.1, it will show up as 4 days. Upgrading customers who encounter this issue are requested to contact Oracle Support for assistance in fixing the data.

## 3.2 The averify.properties file

The averify.properties file, located in the \config directory, contains a set of properties where you can specify database details. By default, the file does not contain user-supplied information. You must modify the averify.properties file to complete the destination database details, averify options, and email options. The destination database parameters contain information about the user and host details of the database you are checking. The Averify options contain information on which portions of the database you want to verify. The email options enable you to send the averify.zip file, containing the averify.log and oracle_averify_report.log, to a specific email address upon completion.

If you do not wish to change the averify.properties file each time you run Averify with different options, you can set the environment variable, PROPERTYFILE, with the full path to another .properties file. You can create multiple .properties files modified with the parameters you need for specific runs of Averify.

### 3.2.1 Destination Database Details

Parameter | Value Definition
averify.dest.jdbc.url | The JDBC connection string to the destination database. The format is jdbc:oracle:thin:@<DESTINATION_DB_HOST_NAME>:<PORT>:<SID> where DESTINATION_DB_HOST_NAME is the hostname of the destination database, PORT is the listener port of the destination database (1521 is the default), and SID is the database instance.
averify.dest.jdbc.driver | The database driver of the destination database. The default is oracle.jdbc.driver.OracleDriver.
averify.dest.tns.name | The TNS entry name in the Oracle Home of the destination database.
averify.dest.oracle.home | The Oracle Home of the destination database. This value can be a mapped drive on the system where Averify is run on the host machine. Note: Use either double back slashes or a forward slash for directory separation, for example, d:/oracle/ora92.

### 3.2.2 NLS Language Details

Parameter | Value Definition
--- | ---
averify.nls.lang | Specifies the NLS parameter value used by the database. The default value is AMERICAN_AMERICA.AL32UTF8.

### 3.2.3 Averify Details (For Agile PLM 9.x Databases Only)

Parameter | Value Definition
--- | ---
averify.runOption | Specifies how you want Averify to check the database. The values are all, modules, resetflags, tables, and testcases. Note: Only one option can be specified for this parameter.
averify.modules | Specific modules chosen for averify to check. This parameter is only used if you entered modules as the value of the runOption parameter. Note: You can check tables that are not specific to the Agile database with the checkNonAgileTables module.
averify.testcases | Specific testcases chosen for Averify to check. This parameter is only used if you entered testcases as the value of the runOption parameter.
averify.tables | Specific database tables chosen for Averify to check. This parameter is only used if you entered tables as the value of the runOption parameter.
An example of how the averify details work is as follows:
    averify.runOptions=modules
    averify.modules=ppm, pcpqm, XXXX
    averify.testcases=AGIL-0000XXXXXX
Because the specified runOptions parameter is modules, the testcases parameter is ignored when averify is run.

### 3.2.4 Email Options

Parameter | Value Definition
averify.email | Decides if the averify.zip file, containing the averify.log and oracle_averify_report.log, is sent as an email attachment upon completion. Value options are true or false. If set to false, the log files can still be viewed in the \logs directory.
averify.customer | Name of Agile customer.
averify.mailhost | Name of email server.
averify.mailport | Port number of your email server. The standard default is 25.
averify.toAddress | averify@oracle.com
averify.fromAddress | Email address of the sender.
averify.ccAddress | Email address of an additional recipient.

This section should be configured each time Averify is run. The logs are used by Oracle Agile PLM Development only and are not a replacement for logging a request.

## 3.3 The psupgrade.properties File

The psupgrade.properties file, located in the $AUT_HOME\config directory, contains user-supplied information on the existing Product Cost Management database. During an upgrade of a Product Cost Management database, the data is merged into the Agile PLM database. The parameters in the file are used by the database scripts during the upgrade process to determine how the data is migrated. This file should be completed in addition to the aut.properties file if you are migrating a Product Cost Management database.

It is recommended to perform a test upgrade of the Product Cost Management database with reports to evaluate the database and make any necessary corrections before performing the actual data migration.

### 3.3.1 Defining the psupgrade.properties Parameters

Parameter | Value Definition
--- | ---
pcm.jdbc.url | The JDBC connection string to the Product Cost Management database. The format is jdbc:oracle:thin@<SOURCE_DB_HOST_NAME>:<PORT>:<SID> where SOURCE_DB_HOST_NAME is the hostname of the Product Cost Management database, PORT is the listener port of the database (1521 is the default), and SID is the database instance.
pcm.jdbc.driver | The database driver of the Product Cost Management database. The default is oracle.jdbc.driver.OracleDriver.
pcm.tns.name | The TNS entry name in the Oracle Home of the source database.
pcm.oracle.home | The Oracle Home of the Product Cost Management 8.5 database. Note Use either double back slashes or a forward slash for directory separation, for example, d:/oracle/ora102.
generate.pcm.reports | Set this parameter to true to generate a report about the data contained in the Product Cost Management database before migration. The report will display data matching the following rules: Update firstname, lastname, and user organization for the matched user login ID, if you set the update.matched.user.data parameter to true. Migrate the Product Cost Management Items not found in Agile 8.5, if you set the migrate.pcm.items.not.found.in.pc parameter to true. Convert all manufacturer names to uppercase, if you set the convert.mfrName.to.upperCase parameter to true. Update all Agile 8.5 manufacturer data with the Product Cost Management manufacturer data for the same manufacturer, if you set the update.matched.mfr.data parameter to true. Migrate Product Cost Management manufacturer parts not found in Agile 8.5, if you set the migrate.pcm.mpns.not.found.in.pc to true. If you set this parameter to false, migration will proceed without a report being generated. If you choose to have a report generated, AUT will stop. After viewing the report and you are satisfied with the results, change this parameter to false and run AUT again.
report.folder.location | Location where you want the report to be generated.
update.matched.user.data | If set to true, the firstname, lastname, and user organization are updated based on matching users in the Agile 8.5 database.
migrate.pcm.items.not.found.in.pc | If set to true, all Product Cost Management items not found in the Agile 8.5 database are migrated.
convert.mfrName.to.upperCase | If set to true, all manufacturer names are converted to uppercase.
migrate.pcm.mpns.not.found.in.pc | If set to true, all Product Cost Management manufacturer parts not found in the Agile 8.5 database are migrated.
update.matched.mfr.data | If set to true, all Agile 8.5 manufacturer data is updated with the Product Cost Management data for the same manufacturer.
expiry.date.to.remove.prices | Removes prices based on the entered expiration date. All prices previous to the entered date are removed. If no date is entered, the prices are checked against the current date. Enter a date in the following format: MM-DD-YYYY.
migrate.suppliers.with.autonumber | If set to true, all suppliers are given autonumbers. If set to false, you must provide a supplier code map file and add its location to the supplier.code.crossref.filepath parameter. The file should be in the form of comma separated text file with the heading in the first line as supplierName,supplierCode Agile,agil EMS1,emsCode1
supplier.code.crossref.filepath | Location of the supplier code map file.
iFS Details*
copy.files | If set to true, the file attachments are copied.
src.ifs.folder | The mapped drive location of the local iFS files folder.
src.ifs.schema | The database user of the Product Cost Management database.
dest.ifs.folder | The path where the upgraded file vault will be located.
dest.ifs.schema | The database user of the destination database.
*After the database is upgraded, you will need to run the IFS Reorganization tool to restructure the file vault to match the current format. For more information on this tool, see the Installation Guide.

## 3.4 The peupgrade.properties File

The peupgrade.properties file, located in the $AUT_HOME\config directory, contains user-supplied information on the existing Program Execution database. During an upgrade of a Program Execution database, the data is merged into the Agile PLM database. The parameters in the file are used by the database scripts during the upgrade process to determine how the data is migrated. This file should be completed in addition to the aut.properties file if you are migrating a Program Execution database.

It is recommended to perform a test upgrade of the Program Execution database with reports to evaluate the database and make any necessary corrections before performing the actual data migration.

### 3.4.1 Defining the peupgrade.properties Parameters

Parameter | Value Definition
--- | ---
pe.jdbc.url | The JDBC connection string to the Program Execution database. The format is jdbc:oracle:thin@<SOURCE_DB_HOST_NAME>:<PORT>:<SID> where SOURCE_DB_HOST_NAME is the hostname of the Program Execution database, PORT is the listener port of the database (1521 is the default), and SID is the database instance.
pe.jdbc.driver | The database driver of the Program Execution database. The default is oracle.jdbc.driver.OracleDriver.
pe.tns.name | The TNS entry name in the Oracle Home of the Program Execution database.
pe.oracle.home | The Oracle Home of the Program Execution database. Use either double back slashes or a forward slash for directory separation, for example, d:/oracle/ora102.
create.del.subclass | If set to true, the Deliverables subclass will be created after upgrade for data currently in that subclass. If set to false (default, the data currently in the Deliverables subclass will be migrated to the Tasks subclass after upgrade.
generate.pe.reports | If set to true, a report on any circular dependencies in the data is generated and no data is migrated. If set to false, no report is generated and the data is migrated. If you choose to have a report generated, AUT will stop. After viewing the report and correcting the dependencies, change this parameter to false and run AUT again.
report.folder.location | Location where you want the report to be generated.
pe.weekend.days | Comma-separated numbers representing the weekend days in a week. The default days are Saturday and Sunday. Format: 1,7
currency.description | Base currency. The default is US Dollars (USD).
iFS Details*
copy.files | If set to true, the file attachments are copied.
src.ifs.folder | The mapped drive location of the local iFS files folder.
src.ifs.schema | The database user of the Program Execution database.
dest.ifs.folder | The path where the upgraded file vault will be located.
dest.ifs.schema | The database user of the destination database.
*After the database is upgraded, you will need to run the IFS Reorganization tool to restructure the file vault to match the current format. For more information on this tool, see the Installation Guide.