Hitachi

uCosminexus Service Platform Reference Guide

1.3.1 Format dialog

Use the [Format] dialog to specify a format name or character code for a binary format definition file.

For operating procedure, see "4.4.4 Defining Elements (for Non-CSV Format) " in "Service Platform Basic Development Guide".

Figure 1‒38:  [Format] dialog

[Figure]
[Information]

If there is any problem in the information entered in the [Format] dialog, a message indicating the problem is displayed in the top part of the dialog. For details on the messages displayed and the measures to be taken, see "4.4.7 Validating the binary format definition file" in "Service Platform Basic Development Guide".

[Format name]

Specify a format name for the binary format definition file. Specify a name having maximum 256 characters that can be used in the NCName format.

Format: CSV

This item appears when CSV format is used.

[Character code]
Character code (when using Code Converter)

To use Code Converter for binary data, select the character code from the drop-down list.

The following table describes the type of character codes that you can select. For details on character codes, see "Appendix A. Character Code Mapping".

Table 1‒9: Character code types that can be selected (when using Code Converter)

Character code type

Code system

Range of character that are supported

Supplement

MS932

SJIS

UCS-2

Microsoft code page 932

However, IBM selected characters, NEC specified IBM extended characters are not included. If you want to use IBM selected characters, NEC specified IBM selected characters, then the user mapping definition is required.

UTF8

Unicode

UCS-4#1

Unicode UTF-8 encoding#2

UTF16_BIG

Unicode

UCS-2

Unicode UTF-16 encoding #2 handled in Big Endian.

UTF16_LITTLE

Unicode

UCS-2

Unicode UTF-16 encoding#2handled in Little Endian.

JIS

JIS Kanji code

UCS-2

JIS X 0201, JIS C 6226, JIS X 0208, JIS X 0212, and ASCII

EUC#3

EUC

UCS-2

EUC (EUC-JP) available for ASCII and JIS X0208,

including the code set 3 region#4

EUC_HJ#3

EUC

UCS-2

EUC that is uniquely extended to use user-defined characters in the 2-byte region

KEIS+EBCDIC

KEIS

UCS-2

KEIS'83, and EBCDIC for single byte alphanumeric characters

KEIS+EBCDIK

KEIS

UCS-2

KEIS'83, and EBCDIK for single byte alphanumeric characters

KEIS#5

KEIS

UCS-2

KEIS'83

IBM_CODE+EBCDIC(LATIN)

IBM Kanji code

UCS-2

IBM Kanji code + Standard or extended lowercase character set

IBM_CODE+EBCDIC(KANA)

IBM Kanji code

UCS-2

IBM Kanji code + Standard or Extended Katakana set

IBM_CODE#5

IBM Kanji code

UCS-2

IBM Kanji code

JEF+EBCDIC

JEF

UCS-2

JEF Kanji code + JEF EBCDIC

JEF+EBCDIK

JEF

UCS-2

JEF Kanji code + JEF EBCDIK

JEF#5

JEF

UCS-2

JEF Kanji code

CUSTOM

Character code conversion UOC

UCS-2

External program created by the user to convert the character code
#1

Since the mapping process (XLST) is processed by encoding in UTF-16, Unicode supplementary characters (0x10000~0x10FFFF) are encoded in surrogate pair.

#2

Data with BOM cannot be handled. BOM (Byte Order Mark) is the code expressing the order of data bytes.

#3

When binary data is input and output, the byte size of EUC code characters is determined by the first byte. The following table lists the number of character bytes at the first byte:

Character code

First byte

Number of character bytes

Remarks

EUC

0x00 to 0x7E

1 byte

ASCII

0xA1 to 0xFE

2 bytes

JIS X 0208 (supplementary code set 1)

0x8E

2 bytes

JIS X 0201 Katakana (supplementary code set 2)

0x8F

3 bytes

JIS X 0212 supplementary Kanji (supplementary code set 3)

For details about default conversion support, see #4.

EUC-HJ

0x00 to 0x7E

1 byte

ASCII

0xA1 to 0xFE

2 bytes

EUC-HJ area or JIS X 0208 (supplementary code set 1)

0x8E

2 bytes

JIS X 0201 Katakana (supplementary code set 2)

When you define data in fixed format, carefully determine the data length so that the length of the input string or output string does not exceed the data length specified in the binary format definition.

#4

For conversion mapping of characters in the EUC code set 3 region, characters are mapped to Unicode private areas by default. To map the characters to JIS X 0212, create user mapping by using a stand-alone version of Code Converter. For details about the version of Code Converter to be used, see Appendix A. Character Code Mapping.

#5

Cannot be used in CSV format.

Use Java-provided encoder/decoder check box

Select this check box to use the Java-provided encoder and decoder to encode and decode binary data.

Character code (when using the Java-provided encoder and decoder)

To use the Java-provided encoder and decoder for binary data, select the character code from the drop-down list.

The following table describes the types of character codes that you can select. For details on character codes, see Appendix A. Character Code Mapping.

Table 1‒10: Character code types that can be selected (when using Java-provided encoder and decoder)

Character code type

Explanation

windows-31j

Windows Japanese

UTF-8

8-bit Unicode (UCS) Transformation Format

UTF-16BE

16-bit Unicode (UCS) Transformation Format, big endian byte order

UTF-16LE

16-bit Unicode (UCS) Transformation Format, little endian byte order

ISO-2022-JP

ISO 2022 format JIS X 0201, 0208, Japanese

EUC-JP

JISX 0201, 0208, 0212, EUC encoding, Japanese

x-IBM939

Japanese Latin Kanji including 4370 UDC characters, superset of 5035

x-IBM930

Japanese Katakana and Kanji including 4370 UD, superset of 5026
[Process when replacing undefined code]

When telegram-undefined-character-code=REPLACE (converting undefined character code to space) is specified in the HCSC server runtime definition file, select one of the following options for conversion to spaces or predetermined characters.

  • Convert to fullwidth or halfwidth spaces

    Spaces or predetermined characters are converted to fullwidth or halfwidth characters according to the conversion type in the following table. To convert undefined character codes to any characters of your choice, you need to specify the characters in the user property file for the J2EE server. For details about how to specify the setting, see Converting undefined character codes to any characters in 2.3.9 Setting up the user property file for the J2EE server (usrconf.properties) in the Service Platform Setup and Operation Guide.

    Binary character code

    Conversion type

    MS932

    Halfwidth

    UTF8

    Halfwidth

    UTF16_BIG

    UTF16_LITTLE

    Halfwidth

    JIS

    • Fullwidth if the escape status is JISC6226_1978, JISX0208_1983, or JISX0212_1990

    • Halfwidth if the escape status is JISX0201_LATIN, JISX0201_JIS8, or ASCII

    EUC

    EUC_HJ

    Halfwidth

    KEIS+EBCDIC

    KEIS+EBCDIK

    • Halfwidth if the shift status is halfwidth

    • Fullwidth if the shift status is fullwidth

    KEIS

    Fullwidth

    IBM_CODE+EBCDIC(LATIN)

    IBM_CODE+EBCDIC(KANA)

    • Halfwidth if the shift status is halfwidth

    • Fullwidth if the shift status is fullwidth

    IBM_CODE

    Fullwidth

    JEF_EBCDIC

    JEF_EBCDIK

    • Halfwidth if the shift status is halfwidth

    • Fullwidth if the shift status is fullwidth

    JEF

    Fullwidth

  • [Replace with double byte space]

    All spaces and predetermined characters are converted to fullwidth characters.

[Binary integer endian]

Use the radio button to select the appropriate binary integer endian to be included in the binary data.

You can select this item only when the binary data to be used is not in CSV format.

[Custom definition of numeric values in pack format]

Custom definition of numerical values in pack format is applied when the specifications in the [Simple contents element] dialog satisfies all the following conditions:

  • [Numeric value in pack format] is selected in [Data type]

  • [Custom] is selected in [Code specification]

  • [Exists] is selected for [Code existence]

[Bit value (hexadecimal)]

Specify the coding bit for numeric value in pack format in hexadecimal.

  • [Plus code]

    Specify the plus code bit of numerical values in pack format in alphanumeric hexadecimal.

  • [Minus code]

    Specify the minus sign bit of numerical values in pack format in alphanumeric hexadecimal.

  • [No code]

    Specify no code bit (absolute value) of numerical values in pack format in alphanumeric hexadecimal.

[Custom definition of numeric values in zone format]

The custom definition of numeric values in zone format are applied when the settings in [Simple contents element] dialog satisfy all the following conditions:

  • [Numeric value in zone format] is selected in [Data type]

  • [Custom] is selected in [Code specification]

  • [Exists] is selected for [Code existence]

[Bit value (hexadecimal)]

Specify the bit value of zone format numbers in hexadecimal.

This is applied when [Code specifications] is [Code bit].

  • [Plus code]

    Specify the plus code bit of numerical values in pack format in alphanumeric hexadecimal.

  • [Minus code]

    Specify the minus sign bit of numerical values in pack format in alphanumeric hexadecimal.

  • [No code]

    Specify no code bit (absolute value) of numerical values in pack format in alphanumeric hexadecimal.

  • [Zone]

    Specify the zone bit of zone format numbers in alphanumeric hexadecimal.

[Code character (hexadecimal)]

Specify the characters that express code in zone format numbers, in hexadecimal.

This is applied when [Code specifications] is [Code character].

  • [Plus code]

    Specify plus code characters in 1-2 digit alphanumeric hexadecimals.

  • [Minus code]

    Specify minus code characters in 1-2 digit alphanumeric hexadecimals.

[Separator]
[Escape character]

Specify the characters to be used as escape characters when characters used as separators are included in the data. You can use single Latin characters (0x21 to 0x7E of JIS X 0201) or single-byte spaces (0x20 of JIS X 0201) as escape characters.

This item can be specified when the binary data to be used is not in CSV format

[Line feed code]

Select the linefeed characters to be used as separators from the drop-down list. The linefeed codes that you can use are CR+LF, or LF.

[Delete extra separators] checkbox

Select this check box to delete the last separator.

[CSV format]
[Enclose the output in double quotes (")] checkbox

Select this checkbox to enclose data items in double quotes (").

However, even if this check box is selected, data items are not enclosed in double quotes if the value is an empty string.

[Code conversion table]
[Change the default] check box

Select this check box to change the storage directory of the code conversion table to be referenced by the code conversion library of Code Converter. The default directory is as follows: 

service-platform-installation-directory\CSC\lib\external\table
[Storage directory name]

If the Change the default check box is selected, specify the name of the storage directory of the code conversion table.

The root path of the code conversion table storage path has been specified in the code-table-root-path property of the HCSC server runtime definition file. Here, specify the name of the directory to be placed under that root path.

You can specify a directory name by using 64 or fewer alphanumeric characters (0 to 9, A to Z, a to z) and underscores (_).

[OK] button

Commits the specified contents and closes the [Format] dialog.

[Cancel] button

Closes the [Format] dialog, without committing the specified contents.

To Page Top

Trademarks

All Rights Reserved. Copyright (C) 2022, Hitachi, Ltd.