2.3.9 Setting up the user property file for the J2EE server (usrconf.properties)

(1) Setting the path of the code conversion table

Before you can use the code conversion API in the character code conversion UOC (external program), you must set the path of the code conversion table that is used by Code Converter.

Descriptive format of the property in the usrconf.properties file:

csc.dt.codetablepath=conversion-table-storage-directory-path/table

For details about how to specify the settings, see the manual Service Platform Basic Development Guide.

To Page Top

(2) Registering the class of the character code conversion UOC

After the character code conversion UOC has been created in the development environment, to use it in the execution environment, you must register its class name by using a fully qualified name.

Descriptive format of the property in the usrconf.properties file:

csc.dt.ownCodeConverter.className=character-code-conversion-UOC-class-name

For details about how to specify the settings, see the manual Service Platform Basic Development Guide.

To Page Top

(3) Changing the directory that stores the JAR files used for custom functions

To change the directory that stores the JAR files used for custom functions, set the new directory path. The location of the default directory is as follows:

Location of the JAR file storage directory:

service-platform-installation-directory\CSC\userlib\customfunc

The following shows the format of the property that is used to change the JAR file storage directory:

Descriptive format of the property in the usrconf.properties file:

csc.dt.customFuncDir=new-directory-path

Important note

Do not specify a subdirectory of the Service Platform installation directory as the JAR file storage directory because the subdirectory will be deleted when Service Platform is deleted.

Descriptive format of the property in the usrconf.properties file:

The following shows an example of specifying the property when changing the directory that stores the JAR files used for custom functions to C:\\USER\\FUNC:

csc.dt.customFuncDir=C:\\USER\\FUNC

To Page Top

(4) Registering the conversion table used in change value functionality

If the data transformation definition created in the development environment includes the definition of the change value function, you must register the conversion table that is used by the function.

Specify the conversion table storage location information and character encoding information as a group of properties. To register multiple conversion tables, specify a group of properties for each conversion table.

Contents and formats described in usrconf.properties are as follows:

   :
csc.dt.valueTable.<Conversion table ID>=<Conversion table file path>
csc.dt.valueTableSize=<Total file size of conversion table>
csc.dt.encodeType.<Conversion table ID>=[MS932|UTF8|UTF16_BIG|UTF16_LITTLE]
   :

<Conversion table ID>

Specify any name as conversion table ID. Conversion table ID is used to specify the conversion table used while defining the change value functionality in the change value dialog of the development environment.

csc.dt.valueTable.conversion-table-ID=conversion-table-file-path

Specify the conversion table file path by the absolute path.

csc.dt.valueTableSize=total-file-size-of-conversion-table <<10>>

Use a positive integer to specify (in KB) the upper limit on the total conversion table file size.

Specify a positive integer in the total file size. Specification range is 1 - 2097151. If you omit specification, 10 is reflected.

If a conversion table the size of which exceeds the maximum value is read, KDEC40730-E is output in J2EE server log file and HCSC server start is interrupted.

csc.dt.encodeType.conversion-table-ID=[MS932|UTF8|UTF16_BIG|UTF16_LITTLE]

Specify the character code used in the conversion table.

Note on the conversion table file

Files with BOM cannot be used.

To Page Top

(5) Using XML parser pool functionality option

To use the XML parser pool functionality, specify the number of pools that will be allocated initially and the maximum number of pools, if necessary.

XML is analyzed in HCSC server by the following Java XML parser:

• DOM parser (javax.xml.DocumentBuilder class)

• SAX parser (org.xml.sax.XMLReader class)

Since multiple threads cannot share these XML parser instances, XML parser is created for each thread for simultaneous use by multiple threads. Since XML parser creation process requires time and performance deteriorates if the parser is created for each analysis.

You can use XML parser pool functionality to save in advance XML parser generated in XML parser pool created in the memory. The entire system shares XML parser saved in XML parser pool and process efficiency is expected to improve because the parser can be reused.

The following points describe each option of XML parser pool functionality:

Number of default allocations ≤ Maximum number of pools ≤ Number of maximum simultaneous request executions

Number of default allocations  ≤ Maximum number of pools 
 
If data validation functionality is used
Maximum number of pools  ≤ Maximum number of simultaneous executions of each business process/service adapter (multiplicity)
 
If data validation functionality is not used
Maximum number of pools  ≤ Total of maximum number of simultaneous executions of validation activities of each business process

To Page Top

(6) Size node functionality extension

Specify whether to use size node functionality extension.

A size node in data transformation can specify beforehand the size of a following binary-format definition element (simple content element or complex content element). A normal size node specifies the size of only the target element (excluding the size of the size node itself). If size node functionality extension is used, the size specified by a size node includes the size of the size node itself, as well as the size of the target element.

For details about size node functionality extension, see the manual Service Platform Basic Development Guide.

Note that size node functionality extension is effective on only a size node that satisfies the following conditions:

• The target element for the size node is a simple content element or complex content element for which a size node can be specified.

• The size of the size node is a fixed-length size.

The specification of this property is applied to the default behavior of all size nodes in the binary-format definitions on the HCSC server.

The following shows the property to be specified in the usrconf.properties file and the descriptive format of the property. The property value is not case-sensitive.

         ...
csc.dt.sizeNode.includeSelfSize={true|false}
         ...

csc.dt.sizeNode.includeSelfSize={true|false}

This property specifies whether to use size node functionality extension.

true

Uses size node functionality extension.

false

Does not use size node functionality extension.

To Page Top

(7) Converting undefined character codes to any characters

In conversion between binary data and Unicode text, undefined character codes are converted to spaces by default. However, they can be converted to any characters of your choice.

To convert undefined character codes to any characters of your choice, you must perform the following two file definition tasks beforehand:

• In the HCSC server runtime definition file, define telegram-undefined-character-code=REPLACE (definition that converts undefined character codes to spaces).

  For details about how to specify definitions in the HCSC server runtime definition file, see 6.5.6 HCSC server runtime definition file in the Service Platform Reference Guide.

• In the user property file for the J2EE server (usrconf.properties), specify the conversion-destination characters.

  For details about the specification method, see section (a) and the following sections.

   ...
property-key=conversion-destination-character-code
   ...

To Page Top

(8) Specifying the operation of the data transformation API

You can specify the operation of the data transformation API. For details about the data transformation API, see the manual Service Platform Basic Development Guide.

The following table shows the system properties that can be specified for the data transformation API.

Each debug information output file is assigned a name that includes the name of the instance (group) of the data transformation API. The format of the name of each debug information output file is as follows:

cscdebug_group-name_file-number.log

To Page Top