TRANSUNI - Translations (Unicode)

UPDATE: Dec 2024

configuration
adding translations
applying to documentation
data portal and api

What is TRANSUNI

What is UNICODE

Configuration Notes

• Trading Entities need to be flagged as supporting National characters
• data table columns (properties) need to be converted to NCHAR or NVARCHAR 
• data entry and recall needs to be handled through user interfaces that support UNICODE

Company Setting

See S01->Miscellaneous tab -> Allow National characters in IDD (ctrl02_extendedchars)

IDD - Data Dictionary

In this context, this application allows administrators to identify which columns need to support UNICIODE (extended) characters. For any text column (identified as Data Type CHAR or VARCHAR) that is required to store UNICODE, select National as the Field Type. Note that this is not an option if not selecting a CHAR or VARCHAR field, or if the above Company Setting has not been set.

Apply Changes

Please contact Hivedome service desk to verify and assist with the sweep. Each table configured to support UNICODE will need to be cleaned to convert the data types. This is a low risk operation and no text will be lost as a result of this conversion.

Compatible Applications

In addition to TRANSUNI, the following areas support UNICODE data entry/review:

• TRADE/Contract Texts (arbitration, payment terms and general texts)
• CLI/Alternative Languages (client title and address, alternative mailing title and address)

This list will be reviewed and updated as changes are applied. If you have a specific use case please contact the Hivedome service desk.

Personal Settings

Troubleshooting 

On some (newer) desktops, users may not be able to view text containing extended characters, instead these may be represented by question marks "?". To ensure the desktop is compatible the following steps need to be completed.

Technical Notes: The compatible (Heritage) applications listed above require the installation of two DLL's (and supporting OCA file) which need to be available to the Windows system. They are backward compatible with VB6 and are typically distributed with Microsoft Office.

If MS Office is installed these files will likely be found (or can be added) in:
c:\Program Files\Microsoft Office\root\VFS\SystemX86

If MS Office is not installed these files will likely be found (or need to be added) in:
c:\Windows\SysWOW64

You will then likely need to register FM20.dll once the files are in place. To do this launch cmd as an Administrator, navigate to c:\Windows\System32 and execute the following command:
regsvr32 C:\Windows\SYSWOW64\FM20.DLL

It is OK to proceed if you see a "DLLRegisterServer in c:\windows\syswow64\fm20.dll succeeded" message.

If still seeing "?" instead of UNICODE characters then please contact Hivedome service desk for further advice 

What can be translated and where

TRANSUNI

This application allows the management of all translations for system-wide usage of codes (descriptions and optional text where applicable). It can be used for environmental text such as labels and messages but this is not universal so WYSIWYG!). Primarily this application covers codes and static information that is used in documentation (see Using Translations in Documentation).

For most organisations this would likely include:

• Commodity, Weight, Packing, Location, Payment/Contract Terms descriptions (and optional Texts)
• Contract Texts clauses (PHYSTEXT) for example those used to generate Arbitration and General texts

TRANSUNI will lookup existing codes and present for translation in any of the available languages.

Technical Notes:

• all translated text is stored in gf_codetrans as the data is shared across all Trading Entities
• to store extended characters it is important that the properties codetrans_descr and codetrans_text are identified as National and converted to NVARCHAR (see above)

CLI

Typically, documentation such as invoices and contract advices, will contain information about a counterparty. Through CLI, the title and address details can be stored in alternate languages and presented through the documentation, either side-by-side with English or a specific language. Use the right-click menu Alternative Languages to maintain in any number of languages.

Technical Notes:

• all translated text is stored in xx_codetrans as the data is unique to each Trading Entity (the table may need to be created if it doesn't exist)
• to store extended characters it is important that the properties codetrans_descr and codetrans_text are identified as National and converted to NVARCHAR (see above)

TRADE

Contract Texts added are generally constructed from clauses maintained in PHYSTEXT libraries. Using this configuration, users can choose to create alternative texts in a nominated language, to be presented to the documentation, either side-by-side with English or a specific language.

When using the standard Contract Text dialog, if any translations exist for the type of text being constructed, then the language drop-down will be enabled. When a clause is selected it will be added in both default/original language (English) and in the nominated language. If the clause has not been translated, it will show default.   

Technical Notes:

• all translated text is stored in xx_phystext as the data is unique to each Trading Entity
• all Texts entered in an alternate language will be stored in a new property phystext_unicode added for this specific purpose (always defined as NVARCHAR)

Using Translations in Documentation

There are two forms of syntax that should be applied depending on the data to be shown. Both forms are used to identify the language to be shown for the specific rule identified only.

Codes/Static Data

Typically applies to the description of a code or term
[propertyname*descr*trans#Language]

Contract Texts

The texts generated through TRADE use the following syntax
[PHYSTEXT#propertyname/Language]

Dates

No explicit translation is possible, however by applying the presentation style *LONG the document will attempt to use the users local Windows Preferences

The following examples show how to request a Chinese variation compared to default:

NOTE: Certain character sets require specific fonts to support the extended characters. For example, to present Simplified Chinese it will be necessary to use one of the fonts installed when the language options are installed. Tests have been undertaken using Microsoft YaHei. Rules that will likely result in presentation of translated text should use the appropriate font.

Data Portal and API

This document highlights areas that allow the adaption to alternate languages, with a primary focus on generating documentation in any location and language. Depending on requirements, certain Heritage applications will need to be adapted to handle UNICODE (extended) characters.

Users of Data Portal and API's in general will have no such problems as the ITAS Services Platform is compliant out-of-the-box. The main restriction will be the Database, so the same conditions apply and outlined above with regards to conversion to NCHAR/NVARCHAR for data that requires UNICODE (extended) characters to be maintained.

User Interfaces in Data Portal are purpose built, so adding labels, showing messages in local languages is easier to configure than Heritage applications.

API's handle UNICODE so texts in alternate languages could be managed externally through simple integrations.