How the Encoding of a File Is Determined

With non-Unicode-mode applications, Essbase and Administration Services assume that character text is encoded to the locale specified by the ESSLANG value defined for Essbase Server.

When Essbase works with Unicode-mode applications, it encodes character text in UTF-8 encoding internally and stores character text in UTF-8. Export files also are encoded in UTF-8. When Essbase works with Unicode-mode applications, it can also handle non-Unicode-encoded input files (such as script files, rules files, and data sources), converting them internally to UTF-8.

Note:

For Unicode-mode applications, Essbase requires that dbname.cfg query log settings file be encoded in UTF-8.

Essbase and Administration Services use file-encoding indicators (UTF-8 signature or locale indicator) to know whether a file is encoded in UTF-8 or in a supported non-Unicode encoding.

A locale indicator is optional for a non-Unicode input file whose encoding matches the locale of Essbase Server. If, however, the encoding does not match, you must provide a locale indicator. See Encoding Indicators.

UTF-8-encoded text files must include the UTF-8 signature.

Administration Services uses the following process to determine the encoding of a non-Unicode-encoded file:

  1. If a locale indicator is present in the file, Administration Services uses the specified encoding.

  2. If a locale indicator is not present, and the file is located within an application, Administration Services uses the encoding specified in the Essbase Server locale.

  3. It a locale indicator is not present, and the file is not located within an application, Administration Services determines the encoding based on the type of file:

    • Text files: Administration Services prompts for the encoding.

    • Outline and rules files: Administration Services uses the encoding specified in the Essbase Server locale.

When Essbase performs a dimension build or data load, the rules file and data file can have different encodings. For example, the text in a rules file can be in UTF-8 encoding, and the data source can be encoded to a non-Unicode computer locale.

Note:

When you use Administration Services Console to create script files or data sources, the appropriate encoding indicator is automatically included in the file. If you use any other tool to create Unicode-encoded text files, you must ensure that the UTF-8 signature is included. Non-Unicode-encoded text files require a locale indicator if the encoding is different from the Essbase Server locale.

The following Essbase system text files are encoded to the locale specified by the ESSLANG value defined for Essbase Server: