Software internationalization is the process of designing products and services so that they can be adapted easily to a variety of different local languages and cultures. Internationalization within EntireX means internationalization of messages: the incoming and outgoing messages are converted to the desired codepage of the platform in use. This document explains in detail how to configure the broker for character conversion. It covers the following topics:
See also Internationalization with EntireX.
To configure ICU conversion
In the Broker attribute file, set the service-specific attribute CONVERSION. Example:
ICU Conversion with SAGTCHA for ACI-based Programming, RPC-based Components (1) and Direct RPC (1):
CONVERSION=(SAGTCHA,OPTION=SUBSTITUTE)
Note:
(1)Conversion with multibyte, double-byte and other complex codepages for RPC-based components and Reliable RPC is not supported
on BS2000.
Optionally configure a CONVERSION OPTION to tune
error behavior to meet your requirements; see OPTION Values for Conversion.
For the Broker attribute, check if ICU conversion is possible, that is, the attribute
ICU-CONVERSION is either
not defined, its default is YES
set to YES
To configure locale string defaults (optional)
If the broker's locale string defaults do not match your requirements (see Broker's Locale String Defaults), we recommend you assign suitable locale string defaults for your country and region, see the respective attribute in Codepage-specific Attributes for how to customize the broker's locale string defaults.
To customize mapping of locale strings (optional)
If the built-in locale string mapping mechanism does not match your requirements,
you can assign specific codepages to locale strings.
See Broker's Built-in Locale String Mapping and locale-string for information on customizing the
mapping of locale strings to codepages.
User-written ICU converters (codepages) are not supported under BS2000.
This section covers the following topics:
EntireX Broker provides an interface to enable user-written translation routines in the programming language Assembler. It contains three parameters:
The address of the TRAP control block (TRAP = Translation Routine / Area for Parameters).
The address of a temporary work area. It is aligned to fullword / long integer boundary (divisible by 4). The work area can only be used for temporary needs and is cleared after return.
A fullword (long integer) that contains the length of the work area.
Note:
Names for user-written translation routines starting with "SAG" are
reserved for Software AG usage and must not be used, e.g. "SAGTCHA" and
"SAGTRPC".
The Assembler dummy section TR$TRAP covers the layout of the TRAP
control block:
TR$TRAP DSECT , TR$TYPE DS F TRAP type TR$TYP2 EQU 2 TRAP type ETB 121 TR$ILEN DS F Input buffer length TR$IBUF DS A Address of input buffer TR$OLEN DS F Output buffer length TR$OBUF DS A Address of output buffer TR$DLEN DS F Length of data returned: * Should be set to the minimum value of TR$ILEN * and TR$OLEN. TR$SHOST DS F Sender's host: * x'00000000' = little endian * x'00000001' = big endian TR$SCODE DS F Sender's character set: SEBCIBM EQU X'00000022' EBCDIC (IBM) SEBCSNI EQU X'00000042' EBCDIC (SNI) SA88591 EQU X'00000080' ASCII TR$RHOST DS F Receiver's host --> see TR$SHOST TR$RCODE DS F Receiver's char set --> see TR$SCODE TR$BHOST DS F BROKER host --> see TR$SHOST TR$BCODE DS F BROKER char set --> see TR$SCODE TR$SENVA DS F Sender's ENVIRONMENT field supplied: OFF EQU X'00000000' ENVIRONMENT field not set ON EQU X'00000001' ENVIRONMENT field set * TR$RENVA DS F Receiver's ENVIRONMENT field supplied: * --> see TR$SENVA TR$SENV DS CL32 Sender's ENVIRONMENT field TR$RENV DS CL32 Receiver's ENVIRONMENT field TR$LEN EQU *-TR$TRAP Length of TRAP
The TR$DLEN must be supplied by the user-written translation routine.
It tells the Broker the length of the message of the translation. In our
example its value is set to the minimum length of the input and output
buffer.
All other TRAP fields are supplied by the Broker and must not be modified by the user-written translation routine.
The incoming message is located in a buffer pointed to by TR$IBUF. The
length (not to be exceeded) is supplied in TR$ILEN. The character set
information from the send buffer can be taken from TR$SCODE.
The outgoing message must be written to the buffer pointed to by
TR$OBUF. The length of the output buffer is given in the field TR$OLEN. The
character set is specified in TR$RCODE. If the addresses given in TR$IBUF and
TR$OBUF point to the same location, it is not necessary to copy the data from
the input buffer to the output buffer.
The environment fields TR$SENVA and TR$RENVA are provided to handle
site-dependent character set information. For the SEND and/or RECEIVE
functions, you can specify data in the
ENVIRONMENT field of the Broker ACI control block. This data is translated into
the codepage of the platform where EntireX Broker is running (see field
TR$BCODE) and is available to the TR$SENV or TR$RENV field in the TRAP
control block. TR$SENVA or TR$RENVA are set to ON if environmental data is
available. Any values given in the API field ENVIRONMENT must correspond to the values handled in the translation routine.
To configure translation user exits
As a prerequisite, the user-written translation module must be accessible to the Broker worker threads.
Copy the user-written translation module into the EntireX Broker load library (EXX103.LIB).
In the Broker attribute file, set the service-specific attribute TRANSLATION to the name of the
user-written translation routine. Example:
TRANSLATION=MYTRANS
To configure translation
In the Broker attribute file, set the
service-specific attribute TRANSLATION to SAGTCHA as the name of
the translation routine. Example:
TRANSLATION=SAGTCHA