Jama Connector 23.4

# Introduction to Configuration

Configuration parameters are set in the configuration file. When setting configuration parameter values, you must use UTF-8.

This section describes how to enter parameter values in the configuration file.

## Enter Boolean Values

The following settings for Boolean parameters are interchangeable:

    TRUE = true = ON = on = Y = y = 1

    FALSE = false = OFF = off = N = n = 0

## Enter String Values

To enter a comma-separated list of strings when one of the strings contains a comma, you can indicate the start and the end of the string with quotation marks, for example:

    ParameterName=cat,dog,bird,"wing,beak",turtle

Alternatively, you can escape the comma with a backslash:

`ParameterName=cat,dog,bird,wing\,beak,turtle`

If any string in a comma-separated list contains quotation marks, you must put this string into quotation marks and escape each quotation mark in the string by inserting a backslash before it. For example:

    ParameterName="<font face=\"arial\" size=\"+1\"><b>","<p>"

Here, quotation marks indicate the beginning and end of the string. All quotation marks that are contained in the string are escaped.

## Include an External Configuration File

You can reference an external configuration file to include shared settings. The following examples show how to include a configuration file, or a section or parameter from the file.

- Include a whole configuration file:

      < "ConfigurationFile.cfg"

- Include a section from another configuration file (including the section heading):

      < "ConfigurationFile.cfg" [SharedSection]

- Include one or more parameters from another configuration file (the import does not include the section heading):

      [SectionName]
      < "ConfigurationFile.cfg" [SharedSection] ParameterName

  You can also include a default value to use if the shared configuration file does not contain the specified parameter:

      < "ConfigurationFile.cfg" [SharedSection] ParameterName=DefaultValue

  You can use wildcards to import multiple parameters, but this method does not support default values. The `*` wildcard matches zero or more characters. The `?` wildcard matches any single character. Use the pipe character `|` as a separator between wildcard strings. For example:

      < "ConfigurationFile.cfg" [SharedSection] ParameterA*|ParameterB?|ParameterC

- Merge a section of an external configuration file into a specified section with a different name:

      [SectionName] < "ConfigurationFile.cfg" [SharedSection]

  This example includes the values in `[SharedSection]` from the external configuration file into `[SectionName]` in your file.

In all these examples, `ConfigurationFile.cfg` is the path and file name of the shared configuration file. You can specify the file location 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.

Copyright 2023 Open Text
Version 23.4 | Last updated September 2023

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to swpdl.idoldocsfeedback@microfocus.com.

We appreciate your feedback!

Product: IDOL Jama Connector 23.4

Topic Title: Introduction to Configuration