Defining an Exception File

If you have made changes to the schema such as the addition of tables or columns, the upgrade process may fail. You can define an exception file for objects that are added manually to the database user schema, and are not defined in the schema configuration file. This instructs ALM to ignore these changes during the upgrade process.

You can use the exception file to ignore warnings for extra tables, views, columns, and sequences. For any other problem that requires manual repair, consult with your database administrator.

You must use the same exception file when running the verification, repair, or upgrade process.

You can set an exception file for a single project or for all projects in Site Administration.

Caution: Using the exception file to ignore warnings for objects that are added manually to the schema may compromise the stability of your project upgrade and the validity of the database user schema.

To define an exception file:

  1. Copy the SchemaExceptions.xml file from the ALM installation directory. By default, the file is located in <ALM installation path>\data\sa\DomsInfo\MaintenanceData.

  2. Create the exception file, for example, my_exceptions.xml, and define the exceptions as follows:

    • For an extra table:

      <TableMissing>
               <object pattern="MY_Table" type="extra"/> 
      </TableMissing> 
      

    • For an extra view:

      <ViewMissing>
               <object pattern="MY_VIEW" type="extra"/> 
      </ViewMissing> 
      

    • For an extra column:

      <ColumnMissing>
               <object pattern="MY_COLUMN" type="extra"/> 
      </ColumnMissing> 
      

    • For an extra sequence:

      <SequenceMissing>
               <object pattern="MY_SEQUENCE" type="extra"/> 
      </SequenceMissing> 
      

  3. To set an exception file for a single project:

    1. In Site Administration, click the Site Projects tab.

    2. In the Projects list, select a project. In the right pane, select the Project Details tab. The project's details are displayed.

    3. Under Project Database, click Exception File. The Edit Exception File dialog box opens.

    4. Type the file location. The file is located under <ALM deployment path>\sa\DomsInfo\MaintenanceData.

  4. To set an exception file for all projects:

    1. In Site Administration, click the Site Configuration tab.

    2. Add the UPGRADE_EXCEPTION_FILE parameter to the list of parameters and define the exception file location. The file is located under <ALM deployment path>\sa\DomsInfo\MaintenanceData.

      For details on setting parameters, see Setting ALM Configuration Parameters.