13 Migrating Oracle Text Applications

This chapter covers issues relating to migrating your applications from previous releases of Oracle Text. This chapter contains the following sections:

13.1 Migrating to Oracle Text 11g Release 2 (11.2)

No changes to applications are required when migrating to Oracle Text 11g Release 2 (11.2).

13.2 Migrating to Oracle Text 11g Release 1 (11.1)

No changes to applications are required when migrating to Oracle Text 11g Release 1 (11.1).

13.3 Migrating to Oracle Text 10g Release 2 (10.2)

This section covers issues relating to migrating your applications to Oracle Text 10g Release 2 (10.2). This information is provided for those users who may be upgrading from the next-to-last release of Oracle Text and who want to know what migration steps were required to upgrade to the last release.

13.3.1 New Filter (INSO_FILTER versus AUTO_FILTER)

With Oracle Text 11g Release 1 and later, the INSO_FILTER filter type has been replaced by the AUTO_FILTER filter type. To maintain compatibility with existing Oracle Text applications, INSO_FILTER functionality is supported by AUTO_FILTER, and the INSO_FILTER filter type is being retained, although its behavior has been changed to match that of AUTO_FILTER.

For most users, the change in filter types has no significant effect, and most users do not need to change their applications or otherwise take any steps to migrate to the new filter type. The most significant differences produced by this change are as follows:

  • AUTO_FILTER supports a different set of document types than INSO_FILTER. For a list of supported document types, see the Supported File Formats appendix of Oracle Text Reference.

  • Display characteristics of HTML output from the new filter may differ from those output by the old filter.

  • A different set of platforms support the AUTO_FILTER type than support INSO_FILTER. For a list of supported platforms, see the Supported File Formats appendix of Oracle Text Reference.

Along with the change from INSO_FILTER to AUTO_FILTER, several related changes are also part of the filter migration:

  • The INSO_TIMEOUT and INSO_OUTPUT_FORMATTING attributes of MAIL_FILTER have been replaced by the AUTO_FILTER_TIMEOUT and AUTO_FILTER_OUTPUT_FORMATTING attributes, respectively.

  • The INSOFILTER directive used in the mail configuration file of MAIL_FILTER has been replaced with the AUTO_FILTER directive.

  • The PL/SQL constant TRACE_IDX_INSO_FILTER for tracing, used in procedures such as CTX_OUTPUT.ADD_TRACE, has been replaced by the TRACE_IDX_AUTO_FILTER filter.

  • The system-defined preference CTXSYS.INSO_FILTER has been replaced by the CTXSYS.AUTO_FILTER preference.

  • The default values of DEFAULT_FILTER_FILE and DEFAULT_FILTER_BINARY system parameters has been changed from CTXSYS.INSO_FILTER to CTXSYS.AUTO_FILTER for new installations and databases upgrading to this release, if these default values have not been modified. For databases upgrading to this release which have modified these default values, the modified default values will continue to be used.

For backward compatibility, INSO_FILTER, as well as most of its associated filter types, constants, and attributes have been retained in this release; however, users should use AUTO_FILTER in new applications and update their older applications whenever possible.

13.3.1.1 Migrating to the AUTO_FILTER Filter Type

Most applications will not have to be modified to reflect the change to the AUTO_FILTER type. The following migration steps will be performed automatically when you upgrade to this release:

  • If an existing index uses the INSO_FILTER filter type, then it will be migrated to the AUTO_FILTER filter type.

  • If an existing index uses the MAIL_FILTER filter type, then the INSO_TIMEOUT and INSO_OUTPUT_FORMATTING attributes will be migrated to the AUTO_FILTER_TIMEOUT and AUTO_FILTER_OUTPUT_FORMATTING attributes, respectively.

  • If the default values of the system parameters DEFAULT_FILTER_FILE and DEFAULT_FILTER_BINARY have not already been modified, then they will be migrated from CTXSYS.INSO_FILTER to CTXSYS.AUTO_FILTER.

Although no actions are required to migrate to the new filter system, Oracle Text users upgrading their databases to this release should take the following steps to migrate away from using APIs deprecated by this release:

  • If an index uses the MAIL_FILTER filter type with a nondefault mail configuration file, edit the file, replacing all occurrences of the INSOFILTER directive with the AUTO_FILTER directive.

  • Replace the use of the PL/SQL constant TRACE_IDX_INSO_FILTER in your application with the TRACE_IDX_AUTO_FILTER constant.

  • Replace the use of the system-defined preference CTXSYS.INSO_FILTER in your applications with CTXSYS.AUTO_FILTER.