Aras Innovator Platform

Populating a Language

Once a language has been defined, there are two main ways to populate the language. You can:

  • Manually enter all language data through the UI.
  • Import a language using the Aras Innovator Language Pack Management Utility.

All multi-lingual deployments of Aras Innovator eventually need to manually configure languages in Aras Innovator, to account for its specific customization.

Once you have defined a language, refer to section Defining a Language, you can add values to this language for each of the UI elements.

Editing ItemTypes

ItemType Property Use Where to edit in the UI
ActionLabelDisplays in the Action menu of the toolbarsAdministration\Actions
Activity TemplateLabelText to display the Activity message of a workflowAdministration\Workflow Maps property on the Activity
Activity TemplatemessageText to display the Activity label of a workflowAdministration\Workflow Maps property on the Activity
Activity Template TaskdescriptionText to display the Task description of a Workflow ActivityAdministration\Workflow Maps under the Tasks label Relationship of an Activity
Activity Template VariableLabelText to display the label of an Activity Variable of a workflowAdministration\Workflow Maps under the Variable label Relationship of an Activity
CommandBarButtonLabelText to display the label of a command bar buttonAdministration\Client Presentation\Global\Presentation Configuration\Command Bar Section\Command Bar Item
CommandBarButtonLabelText to display the label of a command bar buttonAdministration\ItemTypes\Client Styles on the Command Bar Section relationship
CommandBarButtontooltip_templateText to display the tooltip of a command bar buttonAdministration\Client Presentation\Global\Presentation Configuration\Command Bar Section\Command Bar Item
CommandBarButtontooltip_templateText to display the tooltip of a command bar buttonAdministration\ItemTypes\Client Styles on the Command Bar Section relationship
CommandBarDropdownLabelText to display the label of the command bar dropdownAdministration\Client Presentation\Global\Presentation Configuration\Command Bar Section\Command Bar Item
CommandBarDropdownLabelText to display the label of the command bar dropdownAdministration\ItemTypes\Client Styles on the Command Bar Section relationship
CommandBarDropdowntooltip_templateText to display the tooltip of the command bar dropdownAdministration\Client Presentation\Global\Presentation Configuration\Command Bar Section\Command Bar Item
CommandBarDropdowntooltip_templateText to display the tooltip of the command bar dropdownAdministration\ItemTypes\Client Styles on the Command Bar Section relationship
CommandBarEdittooltip_templateText to display the edit tooltip of the command barAdministration\Client Presentation\Global\Presentation Configuration\Command Bar Section\Command Bar Item
CommandBarEdittooltip_templateText to display the edit tooltip of the command barAdministration\ItemTypes\Client Styles on the Command Bar Section relationship
CommandBarMenuLabelText to display the label of the command bar menuAdministration\Client Presentation\Global\Presentation Configuration\Command Bar Section\Command Bar Item
CommandBarMenuLabelText to display the label of the command bar menuAdministration\ItemTypes\Client Styles on the Command Bar Section relationship
CommandBarMenuButtonLabelText to display the label of command bar buttonsAdministration\Client Presentation\Global\Presentation Configuration\Command Bar Section\Command Bar Item
CommandBarMenuButtonLabelText to display the label of command bar buttonsAdministration\ItemTypes\Client Styles on the Command Bar Section relationship
CommandBarMenuCheckboxLabelText to display the label of command bar checkboxesAdministration\Client Presentation\Global\Presentation Configuration\Command Bar Section\Command Bar Item
CommandBarMenuCheckboxLabelText to display the label of command bar checkboxesAdministration\ItemTypes\Client Styles on the Command Bar Section relationship
CommandBarSectionLabelText to display the label of command bar sectionAdministration\Client Presentation\Global\Presentation Configuration\Command Bar Section
CommandBarSectionLabelText to display the label of command bar sectionAdministration\ItemTypes\Client Styles on the Command Bar Section relationship
Business Calendar ExceptiondescriptionText displayed to describe a Business Day exception.Administration\Calendars on the Exceptions label relationship
FieldLabelText displayed to label a field in a formAdministration\Forms on the Field Label relationship
FieldlegendText displayed to label a field border in a formAdministration\Forms on the Field Border relationship
Filter ValueLabelText displayed in pick lists of a filtered list in the UIAdministration\Lists on the Filter Value relationship
Grid ColumnLabelText displayed in Configurable Grid column headersAdministration\Grids on the Grid Column relationship
History ActionLabelText to display the label of history actionItemType not exposed through UI by default
History ActionComment_textText to display the label of history action comment textItemType not exposed through UI by default
ItemTypelabel_pluralText used in TOCAdministration\ItemTypes
ItemTypeLabelText used in item properties, and Item window titleAdministration\ItemTypes
LifeLabelText displayed to label a state of a lifecycleAdministration->LifeCycles on the Life Cycle State properties
MessageTextText displayed for a notification messageAdministration->Notification Messages
MessageTitleTitle of the notification messageAdministration->Notification Messages
PM_ProjectGridLayoutLabelText displayed in the column header of the Project gridAdministration\Preferences on the Project Grid Layout relationship of the World Preference
PropertyLabelText used in the search grid column headersAdministration\ItemTypes on the Properties relationship
Propertydefault_valueText used in the default value of a multi-lingual string propertyAdministration\ItemTypes on the Properties relationship
RelationshipTypeLabelText used the relationship tabs in Item windowsAdministration\RelationshipTypes
ReportLabelDisplays in the Report menu of the toolbarsAdministration\Reports
SearchModeLabelText used to display the different search modesItemType not exposed through UI by default
SecureMessageViewTemplateThumbnail_tooltip_templateText to display thumbnail tooltipAdninistration\Forms\SecureMessageViewTemplate on the Field Label relationship
SecureMessageViewTemplateSketch_tooltip_templateText to display sketch tooltipAdninistration\Forms\SecureMessageViewTemplate on the Field Label relationship
SelfServiceReportHelpRich_help_textText to display help textItemType not exposed through UI by default
SSVCPresentationConfigurationForm_tooltip_templateText to display form tooltipItemType not exposed through UI by default
UserMessageTextDisplays in custom error messages in the UIItemType not exposed through UI by default
ValueLabelText displayed in pick lists in the UIAdministration\Lists on the Value relationship
Workflow MapdescriptionText displayed for description of a workflowAdministration\Workflow Maps
Workflow MapLabelText displayed in UI for name of a workflowAdministration\Workflow Maps
Workflow Map PathLabelText to display the vote path between two Workflow ActivitiesAdministration\Workflow Maps on a path between two activities
Workflow Map VariableLabelText to display the label of a Wokflow variableAdministration\Workflow Maps on the Process Variable relationship

Each row in the table above represents a property in the user interface that has been defined as a multi-lingual string. The translator needs to edit each Item of that type that needs to display a non-English value.

To aid in the ability to move language packs from one database to the next, Aras has created a Language Pack Management Utility to export and import language values from a database. The Language Pack Management Utility is a command line utility that imports and exports language packs from the Aras Innovator database on a SQL level. The following section explains how to use the utility available in the Language Pack Management Utility folder of the Aras Innovator CD Image or from the Aras Community Projects site at http://www.aras.com/communityProjects/default.aspx.

The Command Line

There are several elements to the Language Pack Management Utility command line tool. First, is the executable file for the Language Pack Management Utility itself, LanguageTool.exe. The details of the various options for running the executable at the command line are as follows:

Usage: LanguageTool.exe [-export/-import] [-config_file:<file path>] 
[-folder:<folder path>] [-log_file:<file path>] [-log_level:<log level>
] [-server:<SQL server name>] [-db:<database name>] [-login:<login name>]
[-pwd:<login password>]

Where:

  • -export/import: This is the required parameter to indicate if the operation is to export or import a language.
  • -config_file: (Optional) The path to the configuration file for current operation, ImportConfig.xml or ExportConfig.xml.
  • -folder: (Optional) The path to the data folder. This is the output folder for the export operation or the input folder for the import operation.
  • -log_file: (Optional) The path to the log file.
  • -log_level: (Optional) The logging level (high, medium, low).
  • -server: (Optional) The name of the Microsoft SQL Server instance where the Aras Innovator database is installed.
  • -db: (Optional) The name of the Aras Innovator database.
  • -login: (Optional) The Aras Innovator login assigned to the Aras Innovator database.
  • -password: (Optional) The password for the Aras Innovator login assigned to the Aras Innovator database.
Note
The optional parameters can be generally included in the LanguageTool.exe.config configuration file, but the command line parameters take precedence.

LanguageTool.exe.config

The LanguageTool.exe.config configuration file that is referenced by the Language Pack Management Utility is a straightforward xml file that defines the parameters for the batch load activity.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<configSections>
<sectionGroup name="userSettings"
type="System.Configuration.UserSettingsGroup, System, 
Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" >
<section name="Aras.Tools.I18N.ExpImpMLData.Properties.Settings" 
type="System.Configuration.ClientSettingsSection, System, 
Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" 
allowExeDefinition="MachineToLocalUser" requirePermission="false"/>
</sectionGroup>
</configSections>
<userSettings>
<Aras.Tools.I18N.ExpImpMLData.Properties.Settings>
<setting name="config_file" serializeAs="String">
<value>C:\German\ImportConfig.xml</value>
</setting>
<setting name="folder" serializeAs="String">
<value>C:\German\data</value>
</setting>
<setting name="log_file" serializeAs="String">
<value>C:\German\log.txt</value>
</setting>
<setting name="log_level" serializeAs="String">
<value>high</value>
</setting>
<setting name="server" serializeAs="String">
<value>localhost</value>
</setting>
<setting name="db" serializeAs="String">
<value>InnovatorSolutions</value>
</setting>
<setting name="login" serializeAs="String">
<value>innovator</value>
</setting>
<setting name="pwd" serializeAs="String">
<value>innovator</value>
</setting>
</Aras.Tools.I18N.ExpImpMLData.Properties.Settings>
</userSettings>
<startup>
<supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5.2"/>
</startup>
</configuration>

To help understand how to configure this file, the example above can be broken down line by line:

<setting name="config_file" serializeAs="String">
<value>C:\German\ImportConfig.xml</value>
</setting>

This is the path to the path to a configuration file for current operation, ImportConfig.xml or ExportConfig.xml.

<setting name="folder" serializeAs="String">
<value>C:\German\data</value>
</setting>

The path to the data folder. This is the output folder for the export operation, or the input folder for the import operation.

<setting name="log_file" serializeAs="String">
<value>C:\German\log.txt</value>
</setting>

This is the path to the log file.

<setting name="log_level" serializeAs="String">
<value>high</value>
</setting>

This is the logging level, ‘high’ recommended.

<setting name="server" serializeAs="String">
<value>localhost</value>
</setting>

The name of the Microsoft SQL Server instance where the Aras Innovator database is installed. This value can be found in the Aras Innovator InnovatorServerConfig.xml in DB-Connection tag. (server="localhost”)

<setting name="db" serializeAs="String">
<value>InnovatorSolutions</value>
</setting>

This is the name of the Aras Innovator database in SQL Server. This value can be found in the Aras Innovator InnovatorServerConfig.xml in DB-Connection tag. (database=‘InnovatorSolutions’)

<setting name="login" serializeAs="String">
<value>innovator</value>
</setting>

This is the login assigned to Aras Innovator user of the Aras Innovator database in SQL Server. This value can be found in the Aras Innovator InnovatorServerConfig.xml in DB-Connection tag. (uid=‘innovator’)

<setting name="pwd" serializeAs="String">
<value>innovator</value>
</setting>

This is the name login assigned to the Aras Innovator user of the Aras Innovator database in SQL Server. This value can be found in the Aras Innovator InnovatorServerConfig.xml in DB-Connection tag. (pwd=‘innovator’)

Any of the parameters may be left out as long as the command line equivalent parameter is defined.

Export Configuration

In order to export a language pack from the Aras Innovator database, you need to define what languages and ItemTypes to export. The definitions of these settings are found in the ExportConfig.xml.

<export>
<languages list="en, de" />
<itemtype name="Action" /> 
<itemtype name="Activity Template" /> 
<itemtype name="Activity Template Task" /> 
<itemtype name="CommandBarButton" /> 
<itemtype name="CommandBarDropDown" /> 
<itemtype name="CommandBarEdit" /> 
<itemtype name="CommandBarMenu" /> 
<itemtype name="CommandBarMenuButton" /> 
<itemtype name="CommandBarMenuCheckbox" /> 
<itemtype name="CommandBarMenuSeparator" /> 
<itemtype name="CommandBarSection" /> 
<itemtype name="CommandBarSeparator" /> 
<itemtype name="Field" /> 
<itemtype name="FileSelectorTemplate" /> 
<itemtype name="Filter Value" /> 
<itemtype name="Grid Column" /> 
<itemtype name="History Action" /> 
<itemtype name="ItemType" >
<properties list="label,label_plural" />
</itemtype>
<itemtype name="Life Cycle State" /> 
<itemtype name="PM_ProjectGridLayout" /> 
<itemtype name="Property"  >
<properties list="label,default_value" />
</itemtype>  
<itemtype name="RelationshipType" /> 
<itemtype name="Report" /> 
<itemtype name="SearchMode" /> 
<itemtype name="SecureMessageViewTemplate" /> 
<itemtype name="SelfServiceReportHelp" /> 
<itemtype name="SSVC_Preferences" /> 
<itemtype name="SSVCPresentationConfiguration" /> 
<itemtype name="UserMessage" /> 
<itemtype name="Value" /> 
<itemtype name="Workflow Map" /> 
<itemtype name="Workflow Map Path" /> 
</export>

To help understand how to configure this file, the example above can be broken down line by line:

<languages list="en, de" />

These are the languages by Language Item code property defined in Aras Innovator. The above example shows en (English) and de (German).

<itemtype name="Field" />

Each ItemType defined in this file contains all of its multi-lingual string properties exported from the database.

<properties list="label,label_plural" />

If you want to select some, but not all multi-lingual string properties, add this tag with the properties to export.

Import Configuration

To import a language pack into the Aras Innovator database, you first need to define the Language Item in the database, refer to section Defining a Language. Next, you need to setup the ImportConfig.xml.

<import>
<itemtype name="Action" /> 
<itemtype name="Activity Template" /> 
<itemtype name="Activity Template Task" /> 
<itemtype name="CommandBarButton" /> 
<itemtype name="CommandBarDropDown" /> 
<itemtype name="CommandBarEdit" /> 
<itemtype name="CommandBarMenu" /> 
<itemtype name="CommandBarMenuButton" /> 
<itemtype name="CommandBarMenuCheckbox" /> 
<itemtype name="CommandBarMenuSeparator" /> 
<itemtype name="CommandBarSection" /> 
<itemtype name="CommandBarSeparator" /> 
<itemtype name="Field" /> 
<itemtype name="FileSelectorTemplate" /> 
<itemtype name="Filter Value" /> 
<itemtype name="Grid Column" /> 
<itemtype name="History Action" /> 
<itemtype name="ItemType" >
<properties list="label,label_plural" />
</itemtype>
<itemtype name="Life Cycle State" /> 
<itemtype name="PM_ProjectGridLayout" /> 
<itemtype name="Property"  >
<properties list="label,default_value" />
</itemtype>  
<itemtype name="RelationshipType" /> 
<itemtype name="Report" /> 
<itemtype name="SearchMode" /> 
<itemtype name="SecureMessageViewTemplate" /> 
<itemtype name="SelfServiceReportHelp" /> 
<itemtype name="SSVC_Preferences" /> 
<itemtype name="SSVCPresentationConfiguration" /> 
<itemtype name="UserMessage" /> 
<itemtype name="Value" /> 
<itemtype name="Workflow Map" /> 
<itemtype name="Workflow Map Path" /> 
</import>

Each ItemType defined in this file should have a corresponding XML file containing the language values in the data folder.

The XML resources represent the static content of the Aras Innovator user interface, such as menu options and toolbar buttons. There is no automated tool for updating these resources. They must be done manually in a text editor.

For instance, in the \Innovator\Client\xml\item_menu.xml file

<?xml version="1.0" encoding="UTF-8"?>
<menuapplet on_load="onItemMenuLoad" on_select="onClickItem" on_check="onCheckMenu" show="item_menubar">
<menubar id="item_menubar">
<menu id="file_menu" name="File">

Would become

<?xml version="1.0" encoding="UTF-8"?>
<menuapplet on_load="onItemMenuLoad" on_select="onClickItem" on_check="onCheckMenu" show="item_menubar">
<menubar id="item_menubar">
<menu id="file_menu" name="Datei">

in the \Innovator\Client\xml.de\item_menu.xml file.

Aras Innovator houses all the generic user interface XML resources in the \Innovator\Client\xml folder. However, each solution could have its own xml resources as well. See section Updating the User Interface (Xml-based resources).

The Resource.Config.xml located in \Innovator\Client\XML folder defines the language(s) that can be loaded on the Client. When you define the language pack, you need to update Resource.Config.xml file and add a reference to your language.

The following is an example of adding the German Language to the Resource.Config.xml:

<satelliteresources>
...
<resource culture="neutral"/>
<resource culture="ja"/>
<resource culture="de"/>
...

Once you have updated the Resource.Config.xml and saved it, you need to restart IIS on the Server.