Mapping CJK Fonts

Overview

To ensure correct handling of multilingual Chinese, Japanese, and Korean (CJK) characters, create a CJK font mapping file and reference it in your ebx.properties file.

Configuration Steps

To create a mapping file referenced by ebx.properties:

1. Use the ebx.addon.dama.cjk.font.mapping.file.path to set the path to the CJK font mapping JSON file in your ebx.properties file. Use an absolute or relative path. For example:

   ebx.addon.dama.cjk.font.mapping.file.path=C:\fonts\cjk-font-mapping.json

2. Create the JSON font mapping file. This file must contain an array of objects, where each object defines a CJK font mapping.

   Example of the JSON structure:

   [
     {
       "fontName": "Yu Mincho",
       "cjkName": "游明朝",
       "path": "C:\\fonts\\yumin.ttf"
     },
     {
       "fontName": "Noto Sans CJK JP",
       "cjkName": "源ノ角ゴシック",
       "path": "/opt/fonts/NotoSansCJKjp.otf"
     },
     {
       "fontName": "Malgun Gothic",
       "cjkName": "맑은 고딕",
       "path": "C:\\fonts\\malgun.ttf"
     }
   ]
   
   

   See below for descriptions of the JSON object properties.

3. Ensure the following conditions are met for the font files:

   • The font file specified in the path property exists locally and is readable by the TIBCO EBX® Digital Asset Manager Add-on.

   • File permissions allow the Add-on to access the font file. On Windows, ensure no other process is locking the file.

   • The following font file types are supported: .ttf and .otf.

4. Validate the JSON file for correct syntax and encoding. If the file is missing, unreadable, or invalid, errors will be logged and the font mapping will not be applied.

Object property Descriptions

The following properties are used within each object in the JSON array:

• fontName The English name of the font.

• cjkName The corresponding Chinese, Japanese, or Korean font name. Mixed scripts are supported.

• path The absolute or relative path to the font file on the local file system.