7.4.2.3.1.1. Description Rules for Format Definition File¶

7.4.2.3.1.1.1.1. Character code¶

The character code of the format definition file is UTF-8.

7.4.2.3.1.1.1.2. Literal notation¶

When a literal is configured in the configuration value, follow the rules below.

7.4.2.3.1.1.1.3. Comment¶

Content following # in a line is treated as a comment.

An example is shown below.

#
# Sample file
#
file-type:     "Fixed"  # Fixed-length
text-encoding: "ms932"  # Character code is ms932
record-length:  120     # The length of each line is 120 bytes

7.4.2.3.1.1.3.1. Directive list that can be used in common¶

Directive definitions used in all data formats are as follows.

7.4.2.3.1.1.3.2. List of directives that can be specified in fixed (fixed-length) format¶

The directives used for data in the fixed (fixed-length) format are as follows.

An example is shown below.

#
# Directive definition section
#
file-type:                      "Fixed"  # Fixed-length file
text-encoding:                  "ms932"  # Character encoding of the string type field
record-length:                  120      # Byte length of each record
positive-zone-sign-nibble:      "C"      # Plus sign of zone numeric
negative-zone-sign-nibble:      "D"      # Minus sign of zone numeric
positive-pack-sign-nibble:      "C"      # Plus sign of pack numeric
negative-pack-sign-nibbleL      "D"      # Minus sign of pack numeric
required-decimal-point:         true     # With decimal point
fixed-sign-position:            true     # Sign at the beginning
required-plus-sign:             false    # Plus sign is not added

7.4.2.3.1.1.3.3. List of directives that can be specified in variable (variable length) format¶

The directives used for data in variable (variable length) format are as follows.

An example is shown below.

#
# Directive definition section
#
file-type:                  "Variable"  # Variable length file
text-encoding:              "utf-8"     # Character encoding of the string type field
record-separator:           "\\r\\n"    # Carriage return and Line feed

field-separator:            ","         # CSV
quoting-delimiter:          "\""        # Enclose items in double quotes
ignore-blank-lines:         true        # Ignore blank lines
requires-title:             false       # No title record
max-record-length:          1000        # Maximum 1000 characters for this csv record

7.4.2.3.1.1.3.4. Directive list that can be specified in JSON format¶

There are no directives specific to the JSON data format.

An example is shown below.

file-type:      "JSON"      # json format
text-encoding:  "utf-8"     # Character encoding of the string type field

7.4.2.3.1.1.3.5. Directive list that can be specified in XML format¶

There are no directives specific to the XML data format.

An example is shown below.

file-type:      "XML"       # xml format
text-encoding:  "utf-8"     # Character encoding of the string type field

7.4.2.3.1.1.4.1. Field definition¶

Field definition is defined with the following format.

<Field start position> <Field name> <Multiplicity> <Field type> <Field converter>

Details of each element of the field definition are as given below.

[tagName]
@attr

<tagName attr="val">
・・・
</tagName>

address [1..3]    # 1 to 3 can be defined
address           # Only one is possible as it is omitted
address [0..*]    # No condition (0 to unlimited)
address [*]       # No condition (0 to unlimited)
address [1..*]    # 1 or more

<person>
  <address>Home address</address>
  <address>Work address</address>
</person>

{
  "address" : ["Home address", "Work address", "Delivery address"]
}

7.4.2.3.1.1.4.2. Define a multiformat record¶

For multi-format data, define multiple record formats in the format definition file.

The record format of the input /output data is automatically determined by the value of a specific field. If the input /output target data does not match any record type, it is treated as invalid data and the process is terminated abnormally.

Example of format definition for multi-format is shown below.

Points

• Defines the record identification field. The record type name is Classifier.
• The condition to determine a record is defined directly below the record type name of each record definition.
• The field defined in record identification (Classifier) must exist in the record definition.

file-type:        "Fixed" # Fixed-length
text-encoding:    "MS932" # Character encoding of the string type field
record-length:    40      # Length of each record
record-separator: "\r\n"  # Carriage return and Line feed (crlf)

# Define the record identification condition
[Classifier]
1 dataKbn X(1)      # Determine the record type by using the field of the first byte

# Define the header record
[header]
dataKbn = "1"         # Header record if dataKbn is "1"
1 dataKbn X(1)
2 data    X(39)

# Define the data record
[data]
dataKbn = "2"        # Data record if dataKbn is "2"
1 dataKbn X(1)
2 data    X(39)

For a sample of the multi-format definition, refer to the following link.

7.4.2.3.1.1.4.3. Field type list¶

The data type definition list provided as standard is shown below.

List of available field types for Fixed (fixed-length) data format

Type	Java data types	Description
X	String	Single byte character string (byte length = character string length) By default, right trim/padding is performed using half-width space. Argument: Byte length (numeric) required If the output target value is null, the value is converted to an empty character before processing. If the read value is an empty string, it is converted to null. Configure convertEmptyToNull to false if conversion of empty string to null is not required.
N	String	Double-byte character string (byte length = number of characters/2) By default, right trim/padding is performed with full-width space. Argument: Byte length (numeric) required If the byte length is not a multiple of 2, a syntax error will occur. If the output target value is null or the read value is an empty string, the handling is the same as single byte string field type.
XN	String	Multibyte string Specify this field type when handling a field where characters of different byte lengths are mixed, such as UTF-8. This field type is also used when the padding for the full-width string (double-byte string) uses a half-width space. By default, right trim/padding is performed with half-width space. Argument: Byte length (numeric) required If the output target value is null or the read value is an empty string, the handling is the same as single byte string field type.
Z	BigDecimal	Zone numeric (byte length = number of digits) By default, left trim/padding is performed with 0. Argument 1: Byte length (numeric) required Argument 2: Number of digits after decimal point (numeric) optional Default: 0 If the output target value is null, the value is converted to 0 before processing. If the number of bytes in the read value is 0, it is converted to null. Configure convertEmptyToNull to false, when the number of bytes is 0 and conversion to null is not required.
SZ	BigDecimal	Signed zone numeric (byte length = number of digits) By default, left trim/padding is performed with 0. Argument 1: Byte length (numeric) required Argument 2: Number of digits after the decimal point (numeric) optional Default: 0 Argument 3: Plus sign to be configured in the zone section (hexadecimal string) optional Argument 4: Minus sign to be configured in the zone section (hexadecimal string) optional Argument 3 and argument 4 are configured when overwriting the plus sign of the signed zone numeric and minus sign of the signed zone numeric. When the output target value is null or the number of bytes of the read value is 0, then the handling is the same as zone numeric field type.
P	BigDecimal	Pack numeric (byte length = number of digits/2 [rounded up]) By default, left trim/padding is performed with 0. Argument 1: Byte length (numeric) required Argument 2: Number of digits after the decimal point (numeric) optional Default: 0 When the output target value is null or the number of bytes of the read value is 0, then the handling is the same as zone numeric field type.
SP	BigDecimal	Signed pack numeric (byte length = (number of digits + 1)/2 [rounded up]) By default, left trim/padding is performed with 0. Argument 1: Byte length (numeric) required Argument 2: Number of digits after the decimal point (numeric) optional Default: 0 Argument 3: Plus sign to be configured in the zone section (hexadecimal string) optional Argument 4: Minus sign to be configured in the zone section (hexadecimal string) optional Argument 3 and argument 4 are configured when overwriting the plus sign of the signed pack numeric and minus sign of the signed pack numeric. When the output target value is null or the number of bytes of the read value is 0, then the handling is the same as zone numeric field type.
B	byte[]	Binary string Padding and trimming are not performed. Argument: Byte length (numeric) required The conversion specifications for each application are different when the output value is null. Therefore, the value is not converted for this field type even in such a case and InvalidDataFormatException is thrown. When using this field type, configure the value explicitly in the application according to the requirements.
X9	BigDecimal	Unsigned numeric string (byte length = number of characters) Treat single-byte strings (X) in the field as numeric. By default, left trim/padding is performed with 0. Decimal point sign ( . ) can be included in the string. Argument 1: Byte length (numeric) required Argument 2: Number of digits after the decimal point (numeric) for fixed decimal point optional Default: 0 When the output value is null, then the handling is the same as zone numeric field type. If the read value is an empty string, the handling is the same as single byte string field type.
SX9	BigDecimal	Signed numeric string (byte length = number of characters) Single byte string (X) in the field is treated as a signed numeric. By default, left trim/padding is performed with 0. Argument 1: Byte length (numeric) required Argument 2: Number of digits after the decimal point (numeric) for fixed decimal point optional Default: 0 When the output value is null, then the handling is the same as zone numeric field type. If the read value is an empty string, the handling is the same as single byte string field type. To change the sign character (+ 、-), a project-specific field type can be created to support the implementation of the following classes. SignedNumberStringDecimal For additional field types, see Add a field type.

List of available field types for Variable (Variable length) data format

Type	Java data types	Description
X N XN X9 SX9	String	All fields are read and written as strings for variable-length data formats. The operation does not change no matter what type of identifier is specified. Since there is no concept of field length, arguments are not required. To read and write as numeric format of character string (BigDecimal), use number converter or signed_number converter. If the output target value is null, the value is converted to a empty character before processing. If the read value is an empty string, it is converted to null. Configure convertEmptyToNull to false if conversion of empty string to null is not required.

List of available field types for JSON and XML data formats

Type	Java data types	Description
X N XN	String	String data type Editing such as padding is not performed. The value is enclosed in double quotes " during output for JSON. If the output value is null, the value is not converted in JSON, and is converted to an empty string in XML.
X9 SX9	String	Numeric string type Data editing such as padding is not performed. During output, the value is output without change. To read and write as numeric format of character string (BigDecimal), use number converter or signed_number converter. When the output value is null, the handling is the same as field type for string data type.
BL	String	String（ true or false expressed as a string） Data editing such as padding is not performed. During output, the value is output without change. When the output value is null, the handling is the same as field type for string data type.
OB	-	Used to specify nested record types. The record type corresponding to the field name is input/output as a nested element. When the output value is null, the handling is the same as field type for string data type. An usage example is shown below. json { "users": [ { "name" : "Name", "age" : 30, "address" : "Address" }, { "name" : "Name 1", "age" : 31, "address" : "Address 1" } ] } xml <users> <user> <name> Name </name> <age>30</age> <address> Address </address> </user> <user> <name> Name 1</name> <age>31</age> <address> Address 1</address> </user> </users> The format definition file for JSON and xml above are as follows: [users] # Root element 1 user [1..*] OB [user] # Nested element 1 name N # Bottom layer element 2 age X9 3 address N

7.4.2.3.1.1.4.4. Field converter list¶

The data converter list provided as standard is shown below.