Using exception files for manual database changes

This topic provides instructions for defining exception files. Use exception files if the organization's DBA added objects to database schemas, such as tables, indexes, stored procedures, columns, or other objects.

In this topic:

Overview

Exception files instruct ALM Octane to ignore any errors issued because of manual additions to the database schema. These errors would typically stop the installation or upgrade process.

You can use exception files to ignore errors for extra tables, views, columns, and sequences. For any other problem, consult with your database administrator.

You can use the exception files during a new ALM Octane installation, when upgrading, and when creating a space. 

Back to top

Define exception files

Define exception files before installation, before upgrading, or before you create the new spaces.

To define exception files:

1. Copy both of the mqm_exception.xml files from the ALM Octane installation directories. You can rename them.

2. Locate the MQM_EXCEPTIONS part of the file.

   <MQM_EXCEPTIONS>
       <exceptions>
           <declaration>
               <!--<object pattern="TABLE_1_EXAMPLE" type="missing" />-->
               <!--<object pattern=" TABLE_1_EXAMPLE" type="extra" />-->
           </declaration>
       </exceptions>
   </MQM_EXCEPTIONS>
   

3. Change the <declaration> to one of the following. Add as many declarations as you need.

   • TableMissing

   • ViewMissing

   • ColumnMissing

   • ConstraintMissing

   • IndexMissing

   • PartitionFunctionMissing

   • PartitionSchemeMissing

   • ProcedureMissing

   • SequenceMissing

   • TriggerMissing

4. For each object pattern, you can specify one of the following types: 

   missing	The object is needed but is missing.
   extra	The object is extra because it was created after ALM Octane installation or before upgrading.

Back to top

Set up use of the exception file

This topic explains how to use the exception file when installing ALM Octane or when creating a new space.

Use of the exception files during first-time installation

You can use exception files when installing ALM Octane using existing schemas/databases instead of having ALM Octane create new schemas for you. This is the FILL_EXISTING installation option and it is set in the octane.conf file.

1. During installation, when configuring the /opt/conf/octane.conf file in the configuration folder, add these two settings using an editor: 

   MqmExceptionsSiteAdminPath	The exception file for the site. /opt/tmp/site/mqm_exceptions.xml.
   MqmExceptionsSharedSpacePath	The exception file for the default space. /opt/tmp/shared_space/mqm_exceptions.xml

2. Continue installing.

3. After the installation, check that the ALM Octane Server is up and that you have proper access to the site and the default space.

Use of the exception files when upgrading

You can use exception files when upgrading ALM Octane.

After installation, the exception files are copied to the repository folder. So when upgrading, modify the copies of the exception files in the repository folder instead of the files in the configuration folder.

1. During the upgrade, when configuring the octane.conf file in the repository folder, add or modify these two settings using an editor: 

   The exception file for the site	/opt/octane/repo/storage/schema/maintenance/exceptions/site_admin/mqm_exception.xml
   The exception file for the new space	/opt/octane/repo/storage/schema/maintenance/exceptions/shared_space/mqm_exception.xml

2. Continue upgrading.

3. After the upgrade, check that the ALM Octane Server is up and that you have proper access to the site and the default space.

Use of the exception files when creating a space

ALM Octane processes the exception files also when adding new spaces.

After installation, the exception files are copied to the repository folder.

Before adding a new space, modify the copies of the exception files in the repository folder instead of the files in the configuration folder.

1. Add exceptions as necessary to the exception files using an editor:

   The exception file for the site	/opt/octane/repo/storage/schema/maintenance/exceptions/site_admin/mqm_exception.xml
   The exception file for the new space	/opt/octane/repo/storage/schema/maintenance/exceptions/shared_space/mqm_exception.xml

2. In ALM Octane Settings area, add the space using an existing schema. For details, see Create a space in the ALM Octane Help Center.

3. Check that you have proper access to the space.

Back to top

See also:

• Configure site settings
• Troubleshooting: "My FILL_EXISTING installation failed, indicating that I have extra tables, view, indexes, and so on."