Essbase Unicode File Utility Syntax

The Essbase Unicode File Utility (ESSUTF8 or essutf8) modifies files to be used with Unicode-mode applications. Use this utility to make the following changes to files:

Add a UTF-8 signature to UTF-8-encoded text files
Convert non-Unicode-encoded text files to UTF-8 encoding, including the UTF-8 signature
Insert a locale indicator in non-Unicode-encoded files including script files, data sources, outline files (.otl) and rules files (.rul)
Remove locale indicators from non-Unicode-encoded files
Backup files before changing them

For a description of encoding indicators, see the Types of Encoding Indicators.

essutf8 [option] filespec

Syntax	Description
[option]	Case-sensitive, lowercase execution options. A single command can include more than one execution option Include the hyphen at the beginning of each execution option within a command. See Table 2, Execution Options. The -c, -d, -i, and -s options may not be used in combination. The remaining options may be used in combination with one of the four options, or in combination with each other. See Notes for more information.
filespec	Location and names of files. You can specify any of the following items: A file name in the current directory An absolute path that includes the file name A file-name mask containing the * (asterisk) and ? (question mark) wildcards (for example, abc.txt includes all files with names starting with abc and ending with the extension .txt) Caution! To avoid corruption of binary files not related to Oracle Essbase, do not use wildcards within file extensions (for example, do not specify anything like xyz. or .). Use of wildcards is recommended only within the portion of the file name before the dot; for example, .scr or 2002.txt.

Syntax

Description

[option]

Case-sensitive, lowercase execution options. A single command can include more than one execution option Include the hyphen at the beginning of each execution option within a command. See Table 2, Execution Options.

The -c, -d, -i, and -s options may not be used in combination. The remaining options may be used in combination with one of the four options, or in combination with each other. See Notes for more information.

filespec

Location and names of files. You can specify any of the following items:

A file name in the current directory
An absolute path that includes the file name
A file-name mask containing the * (asterisk) and ? (question mark) wildcards (for example, abc*.txt includes all files with names starting with abc and ending with the extension .txt)

Caution!

To avoid corruption of binary files not related to Oracle Essbase, do not use wildcards within file extensions (for example, do not specify anything like xyz.* or *.*). Use of wildcards is recommended only within the portion of the file name before the dot; for example, *.scr or *2002.txt.

Table 2. Execution Options

Option	Description
-a	Lists supported locales. You can copy locales from the list into the clipboard.
-b	Creates a backup file (.bak) for each modified file.
-c	Converts text files without a UTF-8 signature to UTF-8 encoding, removing existing locale indicators and inserting a UTF-8 signature in each file. Caution! The utility cannot recognize a file to be in UTF-8 encoding if the file does not contain a UTF-8 signature. Be sure to use the -c option only with files that are not in UTF-8 encoding. Using the -c option with files that are in UTF-8 encoding results in files that are not usable. To add a UTF-8 signature to a UTF-8 encoded file, use the -s option as described below.
-d	Deletes locale indicators from specified non-Unicode outline and rules files.
-e	Displays the encoding of each specified text, outline, or rules file.
-h	Displays help text. This is the default option.
-i	Inserts a locale indicator in each non-Unicode file that does not have an indicator. If a -l option is not included to specify a locale, the ESSLANG locale is assumed.
-l locale	Specifies the locale for the locale indicator for a non-Unicode file. For locale, use the following locale format: <language>_<territory>.<code page name>@<sort sequence> Supported locales are listed in the Oracle Essbase Database Administrator's Guide Caution! Do not add a locale indicator to a file containing UTF-8 encoding.
-q	Defines a quiet operation. No messages are displayed.
-s	Adds a UTF-8 signature to each text file that does not have a UTF-8 signature or a locale header Caution! The utility cannot recognize a file to be in UTF-8 encoding if the file does not contain a UTF-8 signature. Be sure to use the -s option only with files that are not in UTF-8 encoding. Using the -s option with files that are in UTF-8 encoding results in files that are not usable.

Notes

In Windows, run essutf8.exe; in UNIX, run ESSUTF8.
Backing up files (option -b) is recommended.
To process UTF-8 encoded files, Essbase Server requires the files include the UTF-8 signature.
Do not combine a UTF-8 signature and locale header in the same file. If a text file contains both types of encoding indicators, the file is interpreted as UTF-8 encoded, and the locale header is read as the first data record.
See the "Enabling Multi-Language Applications Through Unicode" part in the Oracle Essbase Database Administrator's Guide for more information about file encoding.
Ensure that the encoding and condition of the specified files is what the specified operation expects. For example, do not define a command to delete locale indicators from non-Unicode-encoded files that do not contain locale indicators.

Examples

Backup plus UTF-8 signature insertion

essutf8 -b -s salesjune.utf8

Backup plus insertion of locale header record

essutf8 -b -i -l Spanish_Spain.Latin1@Spanish complex.rep

Backup plus conversion of multiple files to UTF-8 encoding

essutf8 -b -c *.txt

Backup plus deletion of locale indicator in a rules file

essutf8 -b -d \EssbaseServer\app\demo\basic\genref.rul