Using DELMIA Apriso DictionaryDELMIA Apriso 2019 Implementation Guide

®2018

DassaultSystèmes.Apriso,3D

EXPE

RIENCE,theCom

pass

logo

andthe3D

Slogo,C

ATIA,SOLIDWORKS

,ENOVIA,DELMIA,SIMULIA,GEO

VIA,EX

ALEA

D,3DVIA,BIOVIA,NET

VIBE

S,and3D

XCITE

arecommercialtrademarks

orregistered

trademarks

ofDassaultSystèmes

orits

subsidiariesintheU.S.and/orothercountries.Allothertrademarks

areow

nedby

theirrespectiveow

ners.

Use

ofanyDassaultSystèmes

orits

subsidiariestrademarks

issubjecttotheirexpress

writtenapproval.

Contents1 Introduction 32 Configuration 62.1 Configuration Overview 62.2 Central Configuration 62.3 Data Model 7

3 Usage 83.1 Dictionary Usage 83.1.1 How to Use the Dictionary in Operations 83.1.2 How to Use the Dictionary in M&M Screens 133.1.3 How to Use the Dictionary in Reports 153.1.4 How to Use the Dictionary in Screens and Views (Process Builder) 173.1.5 How to Use the Dictionary in Screens and Views (Runtime) 183.1.6 How to Use the Dictionary Links to Translate Master Data 20

3.2 Translating the Dictionary 213.2.1 Translating with Excel 213.2.2 Dictionary Translations Filters 24

3.3 Moving Translations with Global Process Manager 254 References 27

Using DELMIA Apriso Dictionary | DELMIA Apriso 2019 Implementation Guide 2

1 IntroductionAbstract

This document provides an overview of Dictionary Manager, giving you the background information needed in order to effectively use the module.

The document’s audience is primarily the personnel responsible for implementing and translating the DELMIA Apriso solution.

Overview

There are two main tables (TEXT and LITERAL) in DELMIA Apriso that store literals (for details, see 2.3 Data Model).

The following items are available for translation in the Dictionary:

OperationsProcessesDynamic GridsReportsSelected master dataCustom literals and custom tables 

A custom table must have a TextID column referencing the ID column in the TEXT tableError codes

The translation of M&M screen cockpits and static labels for Business Controls is described in the Process of Translation Implementation Guide.

Dictionary Manager contains a list of all the reusable Dictionary Items and provides features for managing them. Dictionary Items can be added or removed, and their properties can be edited. Dictionary Manager also allows for linking Dictionary Items to Operations, Processes, Dynamic Grids, reports, master data, and custom tables. The Dictionary Manager consists of three main screens, and each screen is used for different purposes.

Dictionary Links – used for linking Dictionary Items to Operations, Processes, Dynamic Grids, Reports, master data, and custom tables

Using DELMIA Apriso Dictionary | DELMIA Apriso 2019 Implementation Guide 3

Dictionary Translations – used for translating Dictionary Items

Translation Settings– used for Dictionary Manager personalization

Using DELMIA Apriso Dictionary | DELMIA Apriso 2019 Implementation Guide 4

For more information, refer to the Dictionary Help.

Vocabulary

Dictionary Item – a reusable label translated into the required languages that can be linked to:

User interface elements in Operations and ProcessesReportsDynamic GridsMaster dataCustom labels

Dictionary Manager – a set of M&M screens that allows for manipulating and translating Dictionary Items.

Using DELMIA Apriso Dictionary | DELMIA Apriso 2019 Implementation Guide 5

2 Configuration2.1 Configuration OverviewBefore you start using the Dictionary Manager functionality, set the active languages (that is, the languages into which you want the DELMIA Apriso solution to be eventually translated) on the Languages screen.

2.2 Central ConfigurationThe below settings for the Dictionary functionality are available in the “SystemServices.Localization” section of DELMIA Apriso Central Configuration. All the settings are system-wide.

Setting DescriptionLiteralProviderType1 These parameters used to configure the translation priority can 

be either assemblies or database (to learn more about assemblies, refer to the “Generating Satellite Assemblies” section of the Process of Translation Implementation Guide).

LiteralProviderParameters1LiteralProviderType2LiteralProviderParameters2

For detailed information on other keys, refer to the “SystemServices.Localization” section of the Central Configuration Documentation.

Using DELMIA Apriso Dictionary | DELMIA Apriso 2019 Implementation Guide 6

2.3 Data ModelThe image below is divided into three rows:

The top row presents the translatable DELMIA Apriso objectsThe middle row shows the tables where the translations are storedThe bottom row indicates the table where the reusable Dictionary Items are stored

The data model consists of the following main tables:

Table Name DescriptionLITERAL_DICTIONARY

Stores reusable literals.

LITERAL_DICTIONARY_TRANSLATION

Stores translations for the reusable literals. 

TEXT Contains the text persisted in the system. The text itself is not directly stored in this table. It can be accessed in the TEXT_TRANSLATION table or, in some cases, in the Text detail and then the TEXT_DETAIL_TRANSLATION table.

TEXT_TRANSLATION

Contains the various text translations of the TEXT table. This table can persist multiple texts of various sizes as well as icons for multiple devices types and URLs.

LITERAL Stores the tags and prompts for the DELMIA Apriso application software.LITERAL_TRANSLATION

Stores the tags, prompts, and messages for the DELMIA Apriso application software translated into multiple languages.

Further details on the Dictionary database model are available in the Database Documentation.

Using DELMIA Apriso Dictionary | DELMIA Apriso 2019 Implementation Guide 7

3 Usage3.1 Dictionary UsageYou may use the Dictionary functionality in:

Processes/OperationsM&M screensReportsScreens/ViewsMaster dataThe creation of custom literals and error codes

3.1.1 How to Use the Dictionary in Operations

In Processes and Operations, a reusable Dictionary Item can be linked to any UI component, such as:

A User Input or OutputUser Input valuesA Business Control (e.g., button names, column captions)Messages in the Show Message FunctionLiterals in the HTML Layout Editor

The picture below presents the linking of a reusable Dictionary Item in a User Input.

 1.  Create an Operation in DELMIA Apriso Process Builder with one Input to Output Function and a few User Inputs.

 2.  Link the Dictionary Items to User Inputs.

Using DELMIA Apriso Dictionary | DELMIA Apriso 2019 Implementation Guide 8

 3.  Once your Operation is created, you can translate it into different languages. To do that, go to the Entity Manager right-click menu and select Translate.

Using DELMIA Apriso Dictionary | DELMIA Apriso 2019 Implementation Guide 9

 a.  The Dictionary Links screen then appears, which enables translating the Operation's user interface labels into the required active languages.

 4.  Additionally, you may also translate the Operations in runtime:

Using DELMIA Apriso Dictionary | DELMIA Apriso 2019 Implementation Guide 10

 a.  Test run your Operation and hit the "T" key. The highlighting functionality is then enabled.

 b.  Click the literal in the Test Run mode. A tooltip with the Dictionary Code and icon will then appear.

Clicking the icon opens the Dictionary Translations screen, which navigates automatically to the selected Dictionary Item.

The same functionality is available for Processes/Operations in Apriso Classic Portal, DELMIA Apriso Portal and DELMIA Apriso Desktop Client if the user has the Translation Manager role assigned.

Using DELMIA Apriso Dictionary | DELMIA Apriso 2019 Implementation Guide 11

 5.  If an Operation uses the HTML Layout Editor functionality, it is possible to translate labels using the Preview tool pane.

 6.  To verify the translated labels, it is possible to test run in different languages: a.  Go to Tools } Options in the main menu of DELMIA Apriso Process Builder. b.  On the Localization tab, choose a language from the list of available active languages in 

Using DELMIA Apriso Dictionary | DELMIA Apriso 2019 Implementation Guide 12

the Test Run Language drop-down list.

 7.  Test run the Operation.

3.1.2 How to Use the Dictionary in M&M Screens

Prerequisite: it is necessary to have the Translation Manager role assigned.

 1.  Open the DELMIA Apriso Desktop Client and any Dynamic Grid (e.g., the Employee Maintenance screen).

 2.  Click any row and press Ctrl+Shift+L. The Screen Translation pop-up window will then appear.

Using DELMIA Apriso Dictionary | DELMIA Apriso 2019 Implementation Guide 13

You may also generate an XML file in the language chosen from the drop-down menu, but this option is not recommended.

 3.  Clicking OK opens the Dictionary Manager functionality in the context of the selected screen.

Using DELMIA Apriso Dictionary | DELMIA Apriso 2019 Implementation Guide 14

 a.  The Dictionary Links screen is opened with all the labels related to the chosen screen (in this example, Employee Maintenance).

3.1.3 How to Use the Dictionary in Reports

Prerequisite: it is necessary to have the Translation Manager role assigned.

This functionality is similar to translating Dynamic Grids.

 1.  Open Report Viewer in the Apriso Classic Portal and choose, for example, XtraReportsSamples}SampleReport on the Report Explorer tree.

 2.  Click the View link.

Using DELMIA Apriso Dictionary | DELMIA Apriso 2019 Implementation Guide 15

 3.  Focus on the report’s background and then press the "L" key. The Dictionary Links screen will open for the given report. You can now add or change the existing translations for the labels in the reports.

 

Using DELMIA Apriso Dictionary | DELMIA Apriso 2019 Implementation Guide 16

3.1.4 How to Use the Dictionary in Screens and Views (Process Builder)

Translating Screens and Views in DELMIA Apriso Process Builder is similar to translating Operations.

 1.  Open DELMIA Apriso Process Builder. 2.  Use the Entity Manager to find a Screen or a View. 3.  Right-click on the entity you want to edit and select Translate.

The Dictionary Manager functionality is opened in the context of the selected Screen or View.

Using DELMIA Apriso Dictionary | DELMIA Apriso 2019 Implementation Guide 17

Using the Dictionary Links screen, you can now edit labels displayed on the user interface (in this example, Weighing & Dispensing Cockpit).

3.1.5 How to Use the Dictionary in Screens and Views (Runtime)

It is possible to translate Screens and Views in runtime. The process is similar to translating M&M Screens.

Prerequisite: it is necessary to have the Translation Manager role assigned.

 1.  Open a Screen in DELMIA Apriso Desktop Client or DELMIA Apriso Portal (e.g., the Weighing & Dispensing cockpit).

Using DELMIA Apriso Dictionary | DELMIA Apriso 2019 Implementation Guide 18

 2.  Click on the background of the Screen and press L. If a warning screen is displayed, click Allow.

The Dictionary Links screen is opened with all the labels related to the Screen.

Using DELMIA Apriso Dictionary | DELMIA Apriso 2019 Implementation Guide 19

Using the Dictionary Links screen, you can now edit labels displayed on the user interface (in this example, Weighing & Dispensing Cockpit).

3.1.6 How to Use the Dictionary Links to Translate Master Data

Master data usually has unique labels, thus linking them with reusable Dictionary Items is not recommended. However, the Dictionary Links screen can also be used to translate the Master Data easily in one place.

 1.  Go to the Dictionary Manager in DELMIA Apriso Process Builder (View in the Main Menu). 2.  Choose Dictionary Links and select the Master Data you want to translate (e.g.," Literals 

from the GROUP_CLASS table").

Using DELMIA Apriso Dictionary | DELMIA Apriso 2019 Implementation Guide 20

 3.  You can now add or change the existing translations for the labels on the Group Class screen.

 4.  In order to translate master data from other tables or custom tables, go to the Central Configuration field and add the required table name. For more information, please refer to the “Central Configuration” topic in theProcess Builder Help.

3.2 Translating the DictionaryAfter preparing the translations, the items (e.g., labels) should be translated. This can be done in two ways:

Using ExcelUsing the filters on the Translation Settings screen (Dictionary Manager)

3.2.1 Translating with Excel

 1.  Open Dictionary Manager and choose Dictionary Translations. 2.  In the Dictionary Item grid, select the rows that you want to translate and click  (Export) to 

export the Dictionary Items to the Excel file.

Using DELMIA Apriso Dictionary | DELMIA Apriso 2019 Implementation Guide 21

 3.  Enter the file name and save the changes.

 a.  Open the Excel file. The file consists of all the selected Dictionary Items with their descriptions, usages, and translations to all the chosen languages.

Using DELMIA Apriso Dictionary | DELMIA Apriso 2019 Implementation Guide 22

 b.  You may now change the translations in the Excel file. Modify the translation to the German for one of the Dictionary Items on the list. Save and close Excel.

 4.  Go back to the Dictionary Translations screen and click   (Import) to import the Dictionary translations from the Excel file.

Using DELMIA Apriso Dictionary | DELMIA Apriso 2019 Implementation Guide 23

 a.  After the importing finishes, select a row with a changed code.

3.2.2 Dictionary Translations Filters

To make sure you have all the translations for a specific language, use the filters on the Dictionary Translations screen.

Select Translations - with missing <language>. The number of filters of this kind depends on the number of defined target languages on the Translation Settings– used for Dictionary Manager personalization screen. Filters are created automatically. Custom filters may be configured in the Central Configuration.xml file or in external XML files. For more information, refer to the “Dictionary Translations” topic in the Dictionary Help.

Using DELMIA Apriso Dictionary | DELMIA Apriso 2019 Implementation Guide 24

 

3.3 Moving Translations with Global Process ManagerIt is possible to move Dictionary Items (configured as a GPM entity) to another server with Global Process Manager. There are two options for doing this:

Create a regular Project with your solutionAll of your Dictionary Items will be automatically added to your entities (Processes, Operations, screens, reports, master data) as dependencies

Create a Language Pack in GPM:

Using DELMIA Apriso Dictionary | DELMIA Apriso 2019 Implementation Guide 25

 a.  Create a project in GPM called, for example, "Language Pack." b.  Add all the Dictionary Items into it. c.  Generate a Package, send it, and deploy it on the destination server.

After the deployment of such a GPM package, the Dictionary Items will be updated along with all of their related entries in the TEXT and LITERAL tables. 

All Operations and Processes that use the updated Dictionary Items require recompilation. To find these Processes and Operations, open DELMIA Apriso Process Builder, navigate to Entity Manager, and filter out the ones with the HasChanges flag set to True.

For more information, refer to the “Supported Entities” topic in the About Global Process Manager section of the Global Process Manager Help as well as the “Entity Manager” topic in the User Interface Elements section of theProcess Builder Help.

Using DELMIA Apriso Dictionary | DELMIA Apriso 2019 Implementation Guide 26

All the internal documents referenced in this section are available from the DELMIA AprisoStart page, which can be accessed on your DELMIA Apriso server (<server name>/apriso/start).The newest versions of all documents are available from 3DS Support at:http://www.3ds.com/support/documentation/overview/

4 ReferencesInternal Documentation

 1.  Dictionary Help

Describes the Dictionary Links, Dictionary Translations, and Translation Settings screens, which enable managing the language and translation data for screens designed using DELMIA Apriso.

 2.  Process Builder Help

Provides an overview of DELMIA Apriso Process Builder (PB) and information on installing and using the application. This Help describes the user interface elements, entity maintenance, available Business Controls, and management of Processes, Operations, and Screen Flows.

 3.  Global Process Manager Help

Describes the installation, configuration, and usage of DELMIA Apriso Global Process Manager (GPM). This application enables the full deployment of DELMIA Apriso solutions, regardless of their customization level, with support for both single- and multi-production server environments.

 4.  Process of Translation Implementation Guide

Provides an overview of the translation process as well as background information on translating DELMIA Apriso content and Cube literals. The guide focuses on the localization of operational data in DELMIA Apriso (through use of the DELMIA Apriso Localization Manager and DELMIA Apriso Translation Tool) as well as on translating the user interface data and MODEL data.

 5.  Database Documentation

Enables viewing DELMIA Apriso database (DB) tables (organized into groups), their descriptions, and the relations between them.

 6.  Central Configuration Documentation

Describes in detail all the keys of the Central Configuration (CC) file for DELMIA Apriso. Various sections group the keys for individual modules or distinct functional areas.

3DS Support Knowledge Base

If you have any additional questions or doubts not addressed in our documentation, feel free to visit the 3DS Support Knowledge Base at https://www.3ds.com/support/knowledge-base/.

Using DELMIA Apriso Dictionary | DELMIA Apriso 2019 Implementation Guide 27