Include an External Configuration File

You can share configuration sections or parameters between ACI server configuration files. The following sections describe different ways to include content from an external configuration file.

You can include a configuration file in its entirety, specified configuration sections, or a single parameter.

When you include content from an external configuration file, the GetConfig and ValidateConfig actions operate on the combined configuration, after any external content is merged in.

CAUTION:

You cannot use shared configuration files if you use any actions or index actions that modify the configuration file (for example, the DRECREATEDBASE index action writes the new database configuration to the file). If IDOL updates the configuration file in this way, it overwrites the link to the shared configuration file with the imported content. This behavior prevents possible conflicts if the configuration change updates any shared configuration.

In the procedures in the following sections, you can specify external configuration file locations by using absolute paths, relative paths, and network locations. For example:

../sharedconfig.cfg
K:\sharedconfig\sharedsettings.cfg
\\example.com\shared\idol.cfg
file://example.com/shared/idol.cfg

Relative paths are relative to the primary configuration file.

NOTE:

You can use nested inclusions, for example, you can refer to a shared configuration file that references a third file. However, the external configuration files must not refer back to your original configuration file. These circular references result in an error, and IDOL does not start.

Similarly, you cannot use any of these methods to refer to a different section in your primary configuration file.

Include the Whole External Configuration File

This method allows you to import the whole external configuration file at a specified point in your configuration file.

To include the whole external configuration file

  1. Open your configuration file in a text editor.
  2. Find the place in the configuration file where you want to add the external configuration file.
  3. On a new line, type a left angle bracket (<), followed by the path to and name of the external configuration file, in quotation marks (""). You can use relative paths and network locations. For example:

    < "K:\sharedconfig\sharedsettings.cfg"
  4. Save and close the configuration file.

Include Sections of an External Configuration File

This method allows you to import one or more configuration sections from an external configuration file at a specified point in your configuration file. You can include a whole configuration section in this way, but the configuration section name in the external file must exactly match what you want to use in your file. If you want to use a configuration section from the external file with a different name, see Merge a Section from an External Configuration File.

To include sections of an external configuration file

  1. Open your configuration file in a text editor.
  2. Find the place in the configuration file where you want to add the external configuration file section.
  3. On a new line, type a left angle bracket (<), followed by the path to and name of the external configuration file, in quotation marks (""). You can use relative paths and network locations. After the configuration file name, add the configuration section name that you want to include. For example:

    < "K:\sharedconfig\extrasettings.cfg" [License]
    NOTE:

    You cannot include a section that already exists in your configuration file.

  4. Save and close the configuration file.

Include a Parameter from an External Configuration File

This method allows you to import a parameter from an external configuration file at a specified point in your configuration file. You can include a section or a single parameter in this way, but the value in the external file must exactly match what you want to use in your file.

To include a parameter from an external configuration file

  1. Open your configuration file in a text editor.
  2. Find the place in the configuration file where you want to add the parameter from the external configuration file.
  3. On a new line, type a left angle bracket (<), followed by the path to and name of the external configuration file, in quotation marks (""). You can use relative paths and network locations. After the configuration file name, add the name of the configuration section name that contains the parameter, followed by the parameter name. For example:

    < "license.cfg" [License] LicenseServerHost

    To specify a default value for the parameter, in case it does not exist in the external configuration file, specify the configuration section, parameter name, and then an equals sign (=) followed by the default value. For example:

    < "license.cfg" [License] LicenseServerHost=localhost
  4. Save and close the configuration file.

Merge a Section from an External Configuration File

This method allows you to include a configuration section from an external configuration file as part of your IDOL configuration file. For example, you might want to specify a standard SSL configuration section in an external file and share it between several servers. You can use this method if the configuration section that you want to import has a different name to the one you want to use.

To merge a configuration section from an external configuration file

  1. Open your configuration file in a text editor.
  2. Find or create the configuration section that you want to include from an external file. For example:

    [SSLOptions1]
  3. After the configuration section name, type a left angle bracket (<), followed by the path to and name of the external configuration file, in quotation marks (""). You can use relative paths and network locations. For example:

    [SSLOptions1] < "../sharedconfig/ssloptions.cfg"

    If the configuration section name in the external configuration file does not match the name that you want to use in your configuration file, specify the section to import after the configuration file name. For example:

    [SSLOptions1] < "../sharedconfig/ssloptions.cfg" [SharedSSLOptions]

    In this example, IDOL uses the values in the [SharedSSLOptions] section of the external configuration file as the values in the [SSLOptions1] section of the IDOL configuration file.

    NOTE:

    You can include additional configuration parameters in the section in your file. If these parameters also exist in the imported external configuration file, IDOL uses the values in the local configuration file. For example:

    [SSLOptions1] < "ssloptions.cfg" [SharedSSLOptions]
    SSLCACertificatesPath=C:\IDOL\HTTPConnector\CACERTS\
  4. Save and close the configuration file.

_HP_HTML5_bannerTitle.htm