Hitachi

uCosminexus Service Platform Reference Guide


1.3.2 Simple content element dialog

Use the [Simple Content Element] dialog to specify simple content elements in the binary format definition file.

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

Tabs displayed in the [Simple Content Element] dialog differ depending on whether you specify globally or locally defined simple content elements.

Organization of this subsection

(1) Simple content element tab

The simple content element tab is displayed regardless of whether you specify globally or locally defined simple content elements. Use this tab to specify simple content element information.

Figure 1‒39:  [Simple content element] dialog (simple content element tab)

[Figure]

[Data type]

Select the data type to be used for the simple content element from the drop-down list. The following table describes the data types that can be selected and the contents displayed in [Details]:

Data type

Contents displayed in [Details]

String

See "(a) In case of string type".

Integer

See "(c) For integer, real numbers and numeric value with fixed decimal part".

Real number

Fixed decimal number

Numeric value in zone-format#

See "(b) For numeric values zone-format and pack format".

Numeric value in pack format#

Signed binary integer#

Nothing is displayed in [Details].

Unsigned binary integer#

Byte string#

See "(d) For byte string type".

Bit string#

Nothing is displayed in [Details].

Date/time

See "(e) For date/time".

#

You cannot select these items when you handle binary data in CSV format.

[Size]

Specify a size for the data to be used as simple content elements.

  • For a fixed value

    Select the [Fixed] radio button and, specify a size.

    The range of sizes that can be specified differs depending on the data type and character code. The following table describes the range of sizes that can be specified:

    Table 1‒11:  Size ranges that can be specified for simple content elements with fixed values

    Data type

    Character code

    Range that can be specified

    Unit

    String, integer, real numbers, fixed decimal number

    Not UTF16

    1#~2,147,483,647

    Byte

    UTF16

    2#~2,147,483,646

    Byte

    Numerical value in zone and packed format

    -

    1~2,147,483,647

    Byte

    Signed binary integer, unsigned binary integer

    -

    1~8

    Byte

    Byte string

    -

    1~2,147,483,647

    Byte

    Bit string

    -

    1~64

    Bit

    Date/time

    CCYYMMDD

    Not UTF16

    8~2,147,483,647

    Byte

    UTF16

    16~2,147,483,646

    Byte

    YYMMDD

    Not UTF16

    6~2,147,483,647

    Byte

    UTF16

    12~2,147,483,646

    Byte

    hhmmss

    Not UTF16

    6~2,147,483,647

    Byte

    UTF16

    12~2,147,483,646

    Byte

    CCYYMMDDhhmmss

    Not UTF16

    14~2,147,483,647

    Byte

    UTF16

    28~2,147,483,646

    Byte

    YYMMDDhhmmss

    Not UTF16

    12~2,147,483,647

    Byte

    UTF16

    24~2,147,483,646

    Byte

    #

    For local simple content elements with the string data type, you can also specify 0 that indicates data whose size is 0 bytes. You cannot specify 0 in binary format definitions in CSV format.

    Legend:

    -: Indicates that the range that you can specify is independent of the character code.

  • In case of a variable value

    Select the [Variable] radio button. Specify the size determination method in [Size] on the Component tab (or [Component] dialog).

[Details]

Contents displayed in [Details] differ depending on the contents selected in [Data type] as follows:

(a) In case of string type

The following figure shows the [Simple content element] dialog which is displayed when you have selected [String] in [Data type]. If you specify 0 for Size, the items under Details are disabled and cannot be specified.

Figure 1‒40:  [Simple content element] dialog (when you select "String" for [Data type] in the Simple content element tab)

[Figure]

[Individual character code]

Specify individual character code, if the character code of the data to be used as simple content element is different than the character code set in the [Format] dialog.

If you select Variable for Size, you can specify the individual character code if Until end of data or Size node is selected in the component size setting.

[Specify] checkbox

Check the checkbox, when you want to specify the individual character code.

[Format setting value]

Displays the character code specified for Character code in the Format dialog box.

[Character code]

Select the character code to be specified from the dropdown list.

For details about the character code types you can select, see Table 1-9 Character code types that can be selected (when using Code Converter) or Table 1-10 Character code types that can be selected (when using Java-provided encoder and decoder). And for details about character codes, see "Appendix A. Character Code Mapping".

[Embedding]

If the data to be used as simple content element is smaller in size than the specified size, select the characters to fill the excess portion, from the dropdown list. Select [Space] to fill in a blank and select [Blank character (0x00)] to fill in blank characters (0x00).

[Null-terminated byte string] checkbox

Check this checkbox to treat the characters till blank characters (0x00) as data.

You can specify this checkbox only when you have selected [Blank characters (0x00)], in [Embedding].

[Left-Right alignment]

Select the direction for aligning data with the [Left] or [Right] radio button. You can specify this item in case of one of the following:

  • When the [Consider characters till blank character (0x00) as data] checkbox is inactive

  • When the [Consider characters till blank character (0x00) as data] checkbox is activated and is not checked

[Unwanted characters]

Specify if the unwanted characters are to be deleted with this radio button. You can specify this item in case of one the following:

  • When the [Consider characters till blank character (0x00) as data] checkbox is inactive

  • When the [Consider characters till blank character (0x00) as data] checkbox is activated and is not checked

For details on how to delete unwanted characters, see "4.4.1 Types of data type and character code of binary format definition file" in "Service Platform Basic Development Guide".

[Unavailable characters]

Specify characters to be used in place of the characters in XML that cannot be used. The characters that cannot be used are as follows:

  • 0x00~0x1F (Except 0x09, 0x0A, 0x0D)

    Control code

  • 0xFFFE~0xFFFF

    Undefined characters (Use prohibited originally as Unicode)

[Substitute with a Replacement Character] checkbox

Select this checkbox to replace unavailable characters with replacement characters.

[Leading replacement character (Hexadecimal)]

Specify the replacement character to be used in hexadecimal. You can specify this item if the [Substitute with a Replacement Character] checkbox is selected.

If you specify the first character of a replacement character, the following 34 characters are used as replacement characters for 0x00 to 0x1F and 0xFFFE to 0xFFFF respectively. Specify hexadecimal without putting the prefix "0x". For example, in case of 0x2400, hexadecimal will be 2400.

The values that you can specify as leading replacement characters are as follows:

  • 0020~D7DE

  • E000~FFDC

The default value is 2400. These characters are not case-sensitive.

[CSV format]
[Differentiate between empty data and Null] check box

Select this check box to identify "" (empty string) and Null (no data) during transformation of binary data in CSV format. You can specify this check box when a binary format definition file has been created in CSV format or when CSV is selected as the separator format of the parent complex content element.

For details, see the manual Service Platform Basic Development Guide.

[COBOL data format]
[LOW-VALUE conversion] check box

Select this check box to covert LOW-VALUE (data padded with 0x00), which is COBOL-specific data format.

You can specify this check box when the size is not fixed (not 0) and Space is selected for Embedding.

(b) For numeric values zone-format and pack format

The following figure shows the [Simple content element] dialog which is displayed when [Numeric value in zone format] or [Numeric value in pack format] is selected in [Data type].

Figure 1‒41:  [Simple content element] dialog (when you select "Numeric value in zone format" or "Numeric value in pack format" for [Data type] in the Simple content element tab)

[Figure]

[Number of digits]

Specify the number of digits.

[Total] checkbox

Always passive for zone and pack format numeric values. As a result, you cannot specify a maximum value for the total number of digits.

[Decimal part] checkbox

You can specify the maximum value of digits in decimal part, in the range of 0~33.

[Code specification]

Select [Automatic] or [Custom] as the method for setting decimal code.

If you select [Custom], items specified in the [Format] dialog are used.

[Code existence]

Select [Does not exist] when you do not use code and select [Exists] when you use code.

You can specify this item if you have specified [Custom] in [Code specification].

[Code type]

Select [Code bit] to add the code with code bit and select [Code character] to add the symbol with code character.

You can specify this item if the following conditions are satisfied:

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

  • [Custom] is selected in [Code specification]

  • [Exists] is selected in [Code existence]

[Code position]

Select [Before] to add the code before item and select [After] to add the code after item.

You can specify this item if the following conditions are satisfied:

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

  • [Custom] is selected in [Code specification]

  • [Exists] is selected in [Code existence]

(c) For integer, real numbers and numeric value with fixed decimal part

The following figure shows the [Simple content element] dialog which is displayed when "Integer", "Real number" or "Fixed decimal number" is selected in [Data type].

Figure 1‒42: Simple Content Element dialog box (when "Integer" or "Real number" is specified for [Data type] in the [Simple Content Element] tab)

[Figure]

Figure 1‒43: Simple Content Element dialog box (when "Fixed decimal number" is specified for [Data type] in the [Simple Content Element] tab)

[Figure]

[Individual character code]

Specify the individual character code if the character code of the data to be used as a simple content element is different from the character code set in the Format dialog box. You can specify this item when Integer or Real number is selected for Data type.

You cannot specify KEIS, IBM_CODE, or JEF for the character code.

If you select Variable for Size, you can specify the individual character code if Until end of data or Size node is selected in the component size setting.

[Specify] check box

Select this check box to specify the individual character code.

[Format setting value]

Displays the character code specified for Character code in the Format dialog box.

[Character code]

From the drop-down list, select the character code to be specified. The specified character code is also used for the following data:

  • Plus signs (+) and minus signs (-) that are added to data according to the Code existence setting in the Simple Content Element dialog box

  • Spaces and 0s that are added to the data according to the Embedding setting in the Simple Content Element dialog box

For details about the character code types you can select, see Table 1-9 Character code types that can be selected (when using Code Converter) or Table 1-10 Character code types that can be selected (when using Java-provided encoder and decoder) in 1.3.1 Format dialog. For details about Code Converter character codes, see Appendix A. Character Code Mapping.

[Number of digits]

Specify the number of digits.

[Total] checkbox

If you select this checkbox, you can specify the maximum value for number of digits in a range of 1~34. The number of digits that you can specify differ as per settings for [Size] as follows:

  • If [Fixed] is selected in [Size]

    The total number of digits will be the total of the integer part, code, and decimal part.

    Note that when you specify a numeric value above 1 in the [Decimal part] of number of digits for a real number, the total number of digits includes the decimal point.

  • If [Variable] is selected in [Size]

    The total number of digits does not include the number of digits for code and decimal point.

[Decimal part] checkbox

If you select this checkbox, you can specify the maximum value for number of digits in the decimal part in a range of 0~33.

You can specify this item when data type is real number or numeric value with a fixed decimal part.

You cannot uncheck the checkbox, in case of numeric value with a fixed decimal part.

[Code existence]

When the data type is integers, real numbers or numeric value with a fixed decimal part, select the existence of plus and minus code with Radio button.

  • When there is no code

    Select [None].

  • When there is only a minus code

    Select [Only minus exists].

  • When there is always a plus or minus code

    Select [Always exists].

[Embedding]

When the data type is integer, real number or numeric value with fixed decimal part, and when the data to be used as simple content element is small in size than the specified size, select the characters to fill the excess portion from the dropdown list. Select [Space] when filling in a blank with space and select [0] when filling in a blank with 0.

[Left-Right alignment]

Select the direction for aligning data with the [Left] or [Right] radio button.

You cannot select [Left] radio button, when [Embedding] is set to [0].

[Unwanted characters]

Specify if the unwanted characters are to be removed with this radio button.

[CSV format]
Differentiate between empty data and Null check box

Select this check box to identify "" (empty string) and Null (no data) during transformation of binary data in CSV format. You can specify this check box when a binary format definition file has been created in CSV format or when CSV is selected as the separator format of the parent complex content element.

For details, see the manual Service Platform Basic Development Guide.

[COBOL data format]
LOW-VALUE conversion check box

Select this check box to covert LOW-VALUE (data padded with 0x00), which is COBOL-specific data format.

You can specify this check box when the size is fixed.

(d) For byte string type

The following figure shows the [Simple content element] dialog which is displayed when "Byte string" is selected in [Data type].

Figure 1‒44:  [Simple content element] dialog (when you select "Byte string" for [Data type] in the Simple content element tab)

[Figure]

[Encoding format]

Set the hexBinary or base64Binary which is data type of schema, with radio button, as the encoding format.

(e) For date/time

The following figure shows the [Simple content element] dialog which is displayed when "Date/time" is selected in [Data type]:

Figure 1‒45:  [Simple content element] dialog (when you select "Date/time" for [Data type] in the Simple content element tab)

[Figure]

[Date/time]

Specify the format of date/time for the date/time data type.

[Format]

Select a date/time format from the drop-down list.

[Decimal digits - seconds]

When the date/time format includes the time (hhmmss), specify a value between 0 and 3 for the number of decimal digits for the seconds.

[Left-Right alignment]

Select the direction for aligning data with the [Left] or [Right] radio button.

[CSV format]
Differentiate between empty data and Null check box

Select this check box to identify "" (empty string) and Null (no data) during transformation of binary data in CSV format. You can specify this check box when a binary-format definition file has been created in CSV format or when CSV is selected as the separator format of the parent complex content element.

For details, see the manual Service Platform Basic Development Guide.

(2) Component tab

Use the Component tab to specify component information.

The Component tab is displayed only when you specify locally defined simple content elements. This tab is deactivated when 0 is specified for Size in the Simple Content Element tab.

Figure 1‒46:  [Simple content element] dialog (Component tab)

[Figure]

The contents to be specified are same as the Component tab of the Component dialog.

For details about the component tab in [Component] dialog, see "1.3.4(3) Component tab (Simple content element)".

(3) Contents common to both tabs

The following contents are common to both tabs:

[Information]

If there is a problem in the information that is entered in the [Simple content element] dialog, a message indicating the problem is displayed in the title bar of the dialog. For details about the displayed messages and measures to be taken, see "4.4.7 Validating the binary format definition file" in "Service Platform Basic Development Guide".

[Name]

Specify a name for the simple content element. Specify a name that consist of not more than 256 characters that can be used in the NCName format.

[OK] button

Commits the specified contents and closes the [Simple content element] dialog.

[Cancel] button

Closes the Simple Content Element dialog without committing the specified contents.