codepageutil analyze_tables

Counts and identifies all the characters in a schema repository that are not in a specified code page.

codepageutil analyze_tables

Platform: Windows™

Command type: codepageutil subcommand

Synopsis

codepageutil analyze_tables
dbset_name db_name login password codepage output_file_name [ -master sitename ] [ -xml ] { -all | table ... }

Description

The codepageutil analyze_tables subcommand counts and identify all the characters in a schema repository that are not in a specified code page.

This subcommand scans all character fields in all tables in a HCL Compass schema repository or an associated HCL Compass database, including multiline text fields and character large objects or CLOBs. If it finds a character not included the given data code page, it tallies and records that character.

The codepageutil analyze_tables subcommand does not scan attachments or binary large objects (also referred to as BLOBs), even though these may store characters.

This subcommand can scan either an entire database, or a specified group of tables.

The codepageutil analyze_tables subcommand provides a variety of statistics about how many characters in the database are not supported by the preferred code page.

This command also reports the exact location of each unsupported character. The results and statistics from the codepageutil analyze_tables subcommand can help you estimate the amount of work required to convert the characters in the database to those supported by the preferred code page.
Important: The examples in this documentation are not an accurate representation of the unsupported characters.

Options and arguments

dbset_name
The name of the database set or connection that contains the database to be analyzed.
db_name
The logical name of the schema repository, master database, or user database to be checked. Note that the db_name for the master database is always MASTR.
login
The HCL Compass login name of the user. This user must have super user privileges.
password
The HCL Compass password for the user. If there is no password, enter an empty set of double quotes.
codepage
The code page setting for which you are analyzing the target database.
output_file_name
The path and name of the file that contains the results from the analyze_tables command. Enclose the path name in double quotes if there is a space in the path name or other characters. If the XML option is specified, the output file is in UTF8 encoding. Otherwise, the output file is in the encoding of the system's code page.
-master sitename
An optional parameter used for HCL Compass MultiSite that specifies that only records mastered by sitename are to be scanned.
-xml
An optional parameter to specify that the output file be created in XML format.
-all | table ...
Use -all to specify that all tables in the target database are scanned, or use table ... to specify the names of one or more individual tables to be analyzed.

Examples

  • Scan all tables in the SAMPL database for any characters that are excluded from the ASCII data code page and store the results in the file anafileASCII.txt in the directory path specified.



    codepageutil analyze_tables Connection3 SAMPL admin "" 20127 "C:\reports\anafileASCII.txt"

    -all


  • Scan the Defect table in the SAMPL database for any characters that are excluded from the Latin-1 data code page and write detailed information in XML format to the file anafileLATIN1.xml in the directory path specified.



    codepageutil analyze_tables Connection3 SAMPL admin "" 1252 "C:\reports\anafileLATIN1.xml"

    -xml Defect


  • Scan all the records from the SAMPL database that are mastered in site Boston for any characters that are not part of the ASCII data code page and write detailed information to the file analyzeout4.txt in text format.



    codepageutil analyze_tables Connection3 SAMPL admin "" 20127 analyzeout4.txt

    -master Boston -all