Applications DBA System Configuration Tools

About System Configuration

During a new installation or an existing system upgrade, you define the configuration of your system by supplying information such as:

These values are propagated to the individual system configuration files, and also stored in a central repository file called a context.

Your system configuration can be changed as needed by using one of several utilities designed to report on and manage the configuration information. Some of these utilities are accessed from the command line and some are Web-based.

Web-Based Configuration Utilities

The following utilities are Web-based. You access them through Oracle Applications Manager (OAM).

AutoConfig

System configuration parameters are stored and managed by AutoConfig. It is the main configuration engine used by Rapid Install, which supplies configuration information to AutoConfig, which, in turn, stores the configuration for each system node in a node-specific configuration file call a context file.

You can also use AutoConfig independently of a Rapid Install operation to view and edit the individual configuration parameters that define your system. At any time after the initial installation, you use the Configuration Editor in Oracle Applications Manager to update various system settings.

Note: For more information, see AutoConfig in Oracle E-Business Suite Concepts.

License Manager

Products, country-specific functionalities (localized products), and languages that you license or begin to use after the initial installation must be registered as active in order to be included in various system maintenance tasks. Using License Manager, you can create reports about currently registered products and register additional products, country-specific functionalities (localized products).

Note: For more information, see License Manager in Oracle E-Business Suite Maintenance Guide.

Command Line Configuration Utilities

These AD utilities are run from the command line. They are more fully described later in this chapter.

AD Splicer

Splicing refers to the process of adding a product that was not included in a base release to the products in an existing system. AD Splicer modifies the APPL_TOP and database so that AutoPatch and AD Administration recognize the product as valid.

Note: For more information, see AD Splicer in this chapter.

File Character Set Converter

This utility converts the character set of individual files (those not included in processing performed by AD Administration, AutoPatch, or Rapid Install) to the character set used in your system.

AD Splicer

AD Splicer performs the same product registration function as License Manager. However, it registers off-cycle products (those that are released between release update packs) as active in your system. This process of splicing modifies the APPL_TOP and database so that adop and AD Administration recognize the off-cycle product as a valid product for a specific release.

Important: If you have custom applications in Release 12.2, you must run AD Splicer to ensure they are registered correctly. The utility now supports application short names of up to sixteen characters. For more information, refer to My Oracle Support Knowledge Document 1577707.1, Creating a Custom Application in Oracle E-Business Suite Release 12.2.

Patches that contain off-cycle products also contain the control files that AD Splicer needs to register the product. The patch also contains a readme file that describes how to install the new product(s).

AD Splicer Control Files

There are two classes of AD Splicer control file: one for product definition, the other for product configuration. Before you run AD Splicer, you must customize the product configuration file, and then copy it and the product definition files to the $APPL_TOP/admin directory.

Product Definition Files

There are two product definition files per spliced product: <prod>prod.txt and <prod>terr.txt. These files define the product and the associated language information, and must not be edited. For example, the product definition files for Oracle Sales Analyzer (zsa) are zsaprod.txt and zsaterr.txt.

Product Configuration

The newprods.txt file acts as a template to define necessary parameters for a spliced product.

The following is an example of the product configuration file for Oracle Sales Analyzer (zsa):

product=zsa
base_product_top=*APPL_TOP*
oracle_schema=zsa
sizing_factor=100
main_tspace=*Product_Name*D
index_tspace=*Product_Name*X
temp_tspace=*Temporary_Tablespace*
default_tspace=*Product_Name*D

You may need to edit some of the values for the parameters in this file. Refer to the following table for more information. Do not change the order of the entries in the product configuration file: they must appear exactly as shown in the example.

Product Configuration Parameters
Parameter Description
product= Do not edit this entry. The product abbreviation <prod> is already set, and must match the <prod>prod.txt and <prod>terr.txt control files for this product. Most internal references use <prod>.
base_product_top= Identifies the base directory that contains the product's files. The default value, APPL_TOP, means the product's files are written in the directory your APPL_TOP environment is set to. If you want to write the product files to another directory, replace the APPL_TOP value with the full directory path.
oracle_schema= Identifies the Oracle schema where database objects for the product are created. The default Oracle schema is the same as the product abbreviation. You can change this if you want to put the product's database objects in a different schema. Moving a product's objects from one schema to another involves export/import and updates to internal Oracle E-Business Suite tables, so choose your initial schema carefully.
sizing_factor= Identifies the sizing factor Oracle E-Business Suite uses when creating tables and indexes for this product. The default value of 100 means 100%. The product's tables and indexes are created with the default sizes determined by Oracle. We recommend you accept the default sizing factor.

Tablespaces

Release 12.2. uses the Oracle Applications Tablespace Model (OATM), so you do not need to supply AD Splicer with parameters for identifying tablespaces.

Note: For more information, see Tablespace Management in Oracle E-Business Suite Concepts.

The AD Splicer Interface

AD Splicer is a command line utility. It does not use menus or input screens.

Running AD Splicer Interactively

An example of running AD Splicer interactively is when adding a new off-cycle product, as described in Oracle E-Business Suite Maintenance Guide. The procedure is as follows:

  1. Set the environment.

    You must set the environment in order to apply the environment variables that define your system. This task is common to many AD utilities. See Setting the Environment, Oracle E-Business Suite Maintenance Guide for the basic steps.

  2. Start AD Splicer.

    Start AD Splicer with the appropriate command for your operating system:

UNIX

$ cd $APPL_TOP/admin
$ adsplice

Windows

C:\> cd %APPL_TOP%\admin
C:\> adsplice

You must run AD Splicer for each APPL_TOP and database combination so that the Applications utilities recognize the product as being spliced properly into the database.

Changing the Password After Running AD Splicer

For security, a random password is automatically generated for newly-spliced products. For example, if you splice in product xyz, the username will be xyz, but the password will be a randomly-generated string. Consequently, after splicing is complete, you should run the FNDCPASS utility to change the password to one of your choosing. You are also prompted to do this by an AD Splicer message.

Running AD Splicer Non-Interactively

Several options exist to support running AD Splicer non-interactively. Added to the command line as needed, they are:

De-registering a Custom Application

In certain circumstances, you might need to de-register a custom application. For example, if the application is not in compliance with AD Splicer requirements, or is not required for a patching cycle.

To de-register a custom schema, you can run the script $AD_TOP/bin/adDeregisterCustomProd.pl as follows:

perl adCustWrapper.pl
          - APPS username
          - APPS Password
          - Application abbreviation for uninstall
          - Application ID (from fnd_application or fnd_product_installations)

In a multi-node environment, you must run the de-register script manually on all the nodes.

File Character Set Converter

The File Character Set Converter converts individual files, one at a time, from one character set to another. You may need to perform this task to convert text files you receive from Oracle to the character set used by your system. For example, you might need to convert SQL*Plus scripts, PL/SQL scripts, loader files, driver files, ODF files, header files, or HTML files.

Tip: In general, you do not need to run File Character Set Converter manually. AD Administration, AutoPatch, and Rapid Install will normally perform any required character set conversion automatically.

Required Parameters

The following parameters are used when running the converter.

File Character Set Converter Parameters
Parameter Definition
source_file Path and file name for the (source) file to be converted.
source_char_set Character set for the file to be converted (source).
destination_file Path and file name for the (destination) file after it is converted.
dest_char_set Character set for the converted (destination) file.

The File Character Set Converter Interface

The File Character Set Converter is a command line utility. It does not use menus or input screens.

Running the File Character Set Converter

To run this utility, perform these steps:

  1. Set the environment.

    You must set the environment in order to apply the environment variables that define your system. This task is common to many AD utilities. See Setting the Environment, Oracle E-Business Suite Maintenance Guide for the basic steps.

  2. Start the utility.

    Start the File Character Set Converter with this command:

    $ adncnv <source_file> <source_char_set> <destination_file> <dest_char_set>

    The path and file name for the source and the destination files can be the same if the source file's directory and the APPLTMP directory are on the same file system. In general, it is simpler and safer to use different source and destination file names.

    Tip: If you cannot convert to the same file name, convert to a different file name, or change APPLTMP to a directory on the same file system as the source file directory.

    For example, to convert the file afdict.ldt from the WE8ISO8859P1 character set to the UTF8 character set, you would enter commands as shown in this example:

    UNIX

    $ cd $FND_TOP/patch/115/import/<language>
    $ cp afdict.ldt afdict.old
    $ adncnv afdict.old we8iso8859p1 afdict.ldt utf8