V1 Help
EDM for Sage X3

Installation

Pre-requisites
Licensing
Install the Server Components
Install the Client Components
Install Add-On Components
Hotfixes

Implementation

Implement EDD
Implement EDM
Implement PIA with DbCapture

Administration

Logs
Vault
Styling
Translations
Web-Services

Upgrade

Upgrade Server Components
Upgrade Client Components

Enhancements

Request an Enhancement

Usage

How to use EDD
How to use EDM
How to use DbCapture

Troubleshooting

EDD
EDM
PIA
  1. Home > Administration > Translations

Translations


Assumptions


The EDM for Sage X3 solution is fully installed and implemented:

• For the purposes of this page, we will assume C:\V1 (change the path as appropriate to your installation)
• You have direct remote desktop access to the V1 Server


Overview

The configuration of translations is in several areas:

• The SmartSuite UI
• PIA with DbCapture (if applicable)
• PIA with SmartExtract (if applicable)
• Add-on translations, such as text displayed to a user from day to day activity from within Sage X3
• Scripting translations, such as text displayed in emails and lookup responses

The combination of the above means the ‘solution’ is translated, but each area has its own method of implementation to allow it to be configured in isolation.


The SmartSuite UI

All translations for UK English and French in the SmartSuite are provided ‘out the box’, so no action is needed in terms of additions, however you are advised to be familiar with its setup if any changes are required.

A web front end has been provided to allow the SmartSuite UI to be translated, the interface is hidden from daily use as it only meant for administrators.

On the V1 EDM Server, open your web-browser and go to:

http://localhost:5002/portal

Login as an administrative user
Manually change the url to:

http://localhost:5002/config

Press Enter
Click Configure Integration Server
Scroll about two thirds of the way down and click Manage Translations

• Click Create new translation
• Select the language required from the dropdown, click Save
• Click the pencil icon in the Actions Column next to your new translation
• You will see all the modules down the left side and the text boxes for the text to be translated, enter your desired strings in the associated text boxes
• You are advised to hit the save button at regular intervals so as not to lose changes


PIA with DbCapture

The Client UI’s are translated in 3 parts:

Interface such as menu items and buttons.
    • These cannot be translated at this time as they are hard-coded in the dll’s provided with the client installation.
DbCapture Profile display names
    • Up to two languages can be used at any one time, the display names are separated by a pipe symbol.
    • If no pipe is found, only that string will be used.
    • If a pipe is found, the language to left will be English, the one to the right French and so on.
        • To change these values:
            • Open the DbLogin Admin console
            • Click the DbCapture Profile Manager icon
            • Double click on the PIA_Express profile
            • On the Main tab you will see each field and the display name on the pane on the right, make any changes you see fit, click OK
            • Click the Save icon at the top to commit the changes
Messages back to the user from Sage during validation
    • These are taken from the scripting translations covered later in this document

The combination of the above allows a user to flip between English / French and all text they see will be in the language they selected with no further configuration required.


PIA with SmartExtract

Assumptions:

• PIA with SmartExtract has been installed / implemented in full and you now wish to translate it
• The server components have been installed to C:\V1 (change this path as appropriate)

Step 1 – Translate the user interface

Perform the steps in the above SmartSuite UI section, selecting SmartExtract in the left list.

Step 2 – Translate the SmartExtract Fields Names

• Click the top left icon to return to the main portal
• Click on SmartExtract
• Click on Manage Queue
• Click the pencil icon in the Actions Column next to your queue name
• Click on Fields to Extract
• Click the pencil icon in the Actions Column next to the field you wish to translate
• Enter the display name of the field(s) you wish to translate, click Save

Step 3 – Translate the Integration messages

• Connect to the V1 Server where the server components have been installed
• Using File Explorer, navigate to C:\V1Home\SmartConnect\SmartConnectAPI\defs and you should find 4 *.def files. These are the scripting files managing day to day tasks for processing documents.
• Using a suitable text editor (such as Notepad++) edit each file:

• validate
• Find the REFORMAT=validate, within this section, find all S_* values. Each will have a string associated with a message. Change it to fit your desired translation.

• accept
• Find the REFORMAT=validate, within this section, find all S_* values. Each will have a string associated with a message. Change it to fit your desired translation.

• onhold
• Find all S_* values and MESSAGEBODY* values. Each will have a string associated with a message. Change it to fit your desired translation.

• delete
• Find all S_* values and MESSAGEBODY* values. Each will have a string associated with a message. Change it to fit your desired translation.

Where changed, just save the file, no further action is needed.


Add-on Translations


UI Messages

The UI messages are those that pop up from within Sage itself when using EDM, either to return information or an error, i.e. if you click on [EDM] Archive Transaction and get a message to say “Your Document has been archived successfully" etc …

Repeat the below for each Sage production Endpoint where EDM has been applied and not to the X3 Endpoint.

1. Login in to Sage as an ADMIN user and select an Endpoint patched for EDM
2. Click on > Translations > Import Messages
3. Ensure Client is selected as the Location
4. Click OK
5. Where prompted, from the R14 distribution, navigate to \PATCH\EDM\PROD_ENDPOINT and select F1576583282414
6. Click OK
7. You should see a log file with reference to the text that has now been imported

Link Text

As standard, 5 links are added to the screens where the archiving, viewing of images and printing barcodes has been implemented.

These links can be translated so the user can see them in their desired language.

1. Login in to Sage as an ADMIN user and select an Endpoint patched for EDM
2. Click on > Translations > Text Translation
3. In the Text search cell in the left list, select contains and enter [EDM] and press enter
4. This should find 5 links, click on the first one and where prompted for language, enter FRA and press tab
5. It will default to be the same as English, enter the French translation, click Save
6. Repeat the above steps for each of the 5 links


Scripting Translations

No web-front end is provided for the scripting / feedback messages from EDD / EDM / PIA, however they can be changed manually using a suitable text editor such as Notepad++.

In order to pass variables and therefore correctly construct a sentence in any language, text is indexed:

In English would be:

Your search {{0}} has returned no results for Document Type {{1}}, please try again.

In Spanish would be:

Su búsqueda {{0}} no ha devuelto resultados para el tipo de documento {{1}}, intente nuevamente.

And so on.

All English and French messages have been provided.
They can be found on the V1 Server in the \V1Home\SmartSuite\NIS\lang\ directory with a suffix of –int.json.

Set the user language

The system is now fully translated to your desired language, all that remains to set the default language for your DbLogin users so they see it without needing to change it in the UI manually.

• Open the DbLogin Admin console and log in as an administrate user
• Click the tick box to the left of your user(s)
• Click the keys con at the top
• Click DbLogin
• Set the default language option to your configured language
• Click Save
• Repeat the above for each user

This completes the procedure.

All UI and messages will be displayed in your configured language across the SmartSuite and when logging in, your users will see the configured language as their default.

To re-use your translations for all customers in the future, simply replace the following file:

• C:\V1Home\SmartSuite\NIS\api\lang\locale-languagecode-.json (Then restart the V1NodeIntegrationServer service)

• For PIA for SmarExtract
• The 4 definition files you changed
• The Queue display names will have to be changed manually for each implementation.

...