Centralized Dictionary
Logical Configuration Dictionary
Import and Export Translations
Forms Property Keys Dictionary
COGNITUM centralized dictionary is designed for easier access and management of the translations of:
- the logical configuration,
- the portal,
- the forms,
- the Workflow.
For every application in the COGNITUM Console, the Dictionaries item can be expanded into four parts represented as four sub-items in the tree.
Figure: Dictionaries tree items
The dictionary provides a global view of the translations used in COGNITUM
NOTE |
---|
By default, the dictionary lists the English, French, German, and Spanish localizations. To add another language into the dictionary, the corresponding ISO code—for example it for Italian— must be entered in the languages key in the files: |
The following files with the language keys must be also added/created in COGNITUM-root/Server/webapps/application/WEB-INF/conf/dictionary:
- documents_LL.properties
- services_LL.properties
- models_LL.properties
- operators_LL.properties
- portal_LL.properties
- views_LL.properties (where LL stands for the two-letter language code).
The COGNITUM application server and the COGNITUM Console must be restarted.
For each application the Dictionaries item is available. The dictionary lists all the translations for the terms used in each application.
Logical Configuration Dictionary
Below the Dictionaries tree item, a click on the Logical Configuration sub- item displays, in the facing property view, the translations of all the COGNITUM Console objects terms.
TIP |
---|
The logical configuration dictionary of an application can be edited in bulk. From the context menu of the Logical Configuration tree item, the Copy and Paste commands make is possible to export and import the dictionary in a text editor or an Excel table, through the clipboard. |
Application translations
The Application tab is the first tab in the property view when the Logical Configuration sub-item is clicked in the tree. This tab displays the translations of the application selected in the tree.
Figure: Application dictionary properties
Language: This column lists the languages available for the selected application.
Name: Facing a language, the matching application name can be modified. A click on the label selects it. A new label can then be typed out. A click on the Apply button validates the translation.
To modify the applications translations
- In the tree, select the application for which the translations of the application must be modified.
- Under the Dictionaries item, click Logical Configuration.
- Choose the Applications tab.
- In the Translations area, select a language and change its facing label after clicking the item in the Name column.
- Click Apply to validate the modifications.
Data Sources Translations
In the Logical Configuration property view, a click on the Data Sources sub-tab displays the translations of the data sources set for the current application.
Figure: Data sources dictionary properties
Name: The data sources labels are listed in this columns as specified when they were created in the COGNITUM Console.
English/French/...: Facing a selected data source label, the matching translations can be modified in the language columns. A click on the label selects it. A new label can then be typed out.
A click on the Apply button validates the translations.
To modify the data sources translations
- In the tree, select the application for which the translations of the data sources must be modified.
- Under the Dictionaries item, click Logical Configuration.
- Select the Data Sources tab.
- In the translations table, click a data source name and change its translations in the facing language cells.
- Click Apply to validate the modifications.
Resources Translations
In the Logical Configuration property view, a click on the Resources tab displays the translations of the resources set for the current application.
Figure: Resources dictionary properties
Display all resources of the application: The option lists, in the translations table below, all the resources created in the COGNITUM Console, for the current application.
Display only the resources corresponding to the view: The option box must be selected for migrated applications. The list box allows to select a view under which resources may have been set. The translations of the corresponding resources are displayed in the table beneath.
Name: The resources labels are listed in this column as specified when they were created in the COGNITUM Console.
English/French/...: Facing a selected resource label, the matching translations can be modified in the language columns. A click on the label selects it. A new label can then be typed out.
A click on the Apply button validates the translations.
To modify the resources translations
- In the tree, select the application for which the translations of the resources must be modified.
- Under the Dictionaries item, click Logical Configuration.
- Choose the Resources tab in the property view.
- Select the Display all resources of the application option when you want to have all the resources of the application listed below.
- For migrated applications, in the Display only the resources corresponding to the view list box, select the view, the resource(s) of which must have its translations modified.
- In the translations table, click a resource name and change its translations in the facing language cells.
- Click Apply to validate the modifications.
Attributes translations
In the Logical Configuration property view, the Attributes tab displays the translations of the attributes defined for the resource(s) of the current application.
Figure: Attributes dictionary properties
Resource: Attributes are closely linked to a resource. In the Resources list box, a resource must be selected before entering the translations of the related attributes.
Name: The attributes labels are listed in this column as specified when they were created in the COGNITUM Console.
English/French/...: Facing a selected attribute label, the matching translations can be modified in the language columns. A click on the label selects it. A new label can then be typed out.
A click on the Apply button validates the translations.
To modify the attributes translations
- In the tree, select the application for which the translations of the attributes must be modified.
- Under the Dictionaries item, click Logical Configuration.
- Choose the Attributes tab in the property view.
- In the Resources list box, select the resource for which the translations of the attributes must be changed.
- In the translations table, click an attribute name and change its translations in the facing language cells.
- Click Apply to validate the modifications.
Links translations
In the Logical Configuration property view, the Links tab allows to manage the translations of the links defined for the resources of the current application.
Figure: Links dictionary properties
Resource: Links are defined under a given resource. In the Resource list box, a resource must be selected before specifying the translations of the related links.
Name: The links labels are listed in this column as specified when they were created in the COGNITUM Console.
English/French/...: Facing a selected link label, the matching translations can be modified in the language columns. A click on the label selects it. A new label can then be typed out.
A click on the Apply button validates the translations.
To modify the links translations
- In the tree, select the application for which the translations of the links must be modified.
- Under the Dictionaries item, click Logical Configuration.
- Select the Links tab.
- In the Resource list box, select the resource for which the translations of the links must be changed.
- In the translations table, click a link name and change its translations in the facing language cells.
- Click Apply to validate the modifications.
Documents properties translations
In the Logical Configuration property view, the Properties tab allows to manage the translations of the documents properties used in the current application.
Figure: Document properties dictionary properties
Document: Properties are defined for a given document. In the Document list box, a document must be selected before specifying the translations of the related properties.
Name: The documents properties labels are listed in this column as specified when they were created in the COGNITUM Console.
English/French/...: Facing a selected link label, the matching translations can be modified in the language columns. A click on the label selects it. A new label can then be typed out.
A click on the Apply button validates the translations.
To modify the documents properties translations
- In the tree, select the application for which the translations of the documents properties must be modified.
- Under the Dictionaries item, click Logical Configuration.
- Select the Properties tab.
- In the Document list box, select the document for which the translations of the properties must be changed.
- In the translations table, click a property name and change its translations in the facing language cells.
- Click Apply to validate the modifications.
Services operations translations
In the Logical Configuration property view, the Operations tab allows to manage the translations of the operations defined for the services of the current application.
Figure: Services operations dictionary properties
Service: Operations are defined under a given service. In the Service list box, a service must be selected before specifying the translations of the related operations.
Name: The operations labels are listed in this column as specified when they were created in the COGNITUM Console.
English/French/...: Facing a selected operation label, the matching translations can be modified in the language columns. A click on the label selects it. A new label can then be typed out.
A click on the Apply button validates the translations.
To modify the services operations translations
- In the tree, select the application for which the translations of the services operations must be modified.
- Under the Dictionaries item, click Logical Configuration.
- Select the Operations tab.
- In the Service list box, select the service for which the translations of the operations must be changed.
- In the translations table, click an operation name and change its translations in the facing language cells.
- Click Apply to validate the modifications.
Forms Translations
In the Logical Configuration property view, the Forms tab allows to manage the translations of the forms defined for the current application.
Figure: Forms dictionary properties
Name: The forms labels are listed in this column as specified when they were created in the COGNITUM Console.
English/French/...: Facing a selected form label, the matching translations can be modified in the language columns. A click on the label selects it. A new label can then be typed out.
A click on the Apply button validates the translations.
To modify the forms translations
- 1 In the tree, select the application for which the translations of the forms must be modified.
- 2 Under the Dictionaries item, click Logical Configuration.
- 3 Select the Forms tab.
- 4 In the translations table, click a form name and change its translations in the facing language cells.
- 5 Click Apply to validate the modifications.
Views translations
In the Logical Configuration property view, the Views tab displays the translations of the views set for the current application.
Figure: Views dictionary properties
Name: The views labels are listed in this column as specified when they were created in the COGNITUM Console.
English/French/...: Facing a selected view label, the matching translations can be modified in the language columns. A click on the label selects it. A new label can then be typed out.
A click on the Apply button validates the translations.
To modify the views translations
- In the tree, select the application for which the translations of the views must be modified.
- Under the Dictionaries item, click Logical Configuration.
- In the Views tab, click a view name and change its translations in the facing language cells.
- Click Apply to validate the modifications.
Roles Translations
In the Logical Configuration property view, the Roles tab allows to manage the translations of the roles defined for the current application.
Figure: Roles dictionary properties
Roles Types: This list box makes it possible to select a role type and translate the labels of the user roles, the group ones, or the dynamic ones.
Name: The roles labels are listed in this column as specified when they were created in the COGNITUM Console.
English/French/...: Facing a selected role label, the matching translations can be modified in the language columns. A click on the label selects it. A new label can then be typed out.
A click on the Apply button validates the translations.
To modify the roles translations
- In the tree, select the application for which the translations of the roles must be modified.
- Under the Dictionaries item, click Logical Configuration.
- Select the Roles tab.
- In the Roles Types list box, choose whether you want to translate the user roles, group roles, or dynamic roles.
- In the translations table, click a role name and change its translations in the facing language cells.
- Click Apply to validate the modifications.
Import and Export Translations
User can import and export ‘Logical Configuration’ dictionary to CSV file, from COGNITUM Console.
NOTE |
---|
Entries belongs to Web Accessible Forms and FRM Forms which comes under ‘Logical Configuration’ cannot be imported or exported. |
This feature is not provided by default.
Following are the steps for enabling this feature in COGNITUM Console.
- Stop COGNITUM Server and Console application.
- Open ‘ admin.properties’ file located in <COGNITUM-root>\AdminConsole\ directory.
- Change value of property ‘advanced.dictionary’ to true, as shown below
advanced.dictionary=true
- Restart COGNITUM Server and Console application.
Import/Export Translations from COGNITUM Console:
- Right click on respective application, a menu list appears as shown below
- Select Import Translations… => CSV file from which you can import translations.
- Select Export Translations…=> CSV file to which you can export translations.
Portal Dictionary
Below the Dictionaries tree item, a click on the Portal sub-item displays, in the facing property view, the translations table containing the translations of the terms used in the COGNITUM portal.
Figure: Portal dictionary properties
Portal: A click on the list box displays the portals available for use in the application. The translations of the terms used in each portal can be displayed by selecting the corresponding portal.
Name: The portal keys are listed in this column as specified when they were created in the COGNITUM Console.
English/French/...: Facing a selected portal key label, the matching translations can be modified in the language columns. A click on the label selects it. A new label can then be typed out. A right-click on the key label gives access to the Details command. This opens up the Keys Translations dialog box in which the translations of the double¬clicked term can be modified. A right-click on the label gives access to the Copy Translations / Paste Translations commands to duplicate the translations of the selected key from a dictionary to another one.
TIP |
---|
The portal dictionary of an application can be edited in bulk. From the context menu of the Portal tree item, the Copy and Paste commands make is possible to export and import the dictionary in a text editor or an Excel table, through the clipboard. |
The last line of the table is empty in a view to typing in a new key and its translations.
A click on the Apply button validates the translations. COGNITUM classifies them in alphabetical order automatically.
WARNING |
---|
When no translation is entered for a key, a message box warns that a translation box is empty after clicking on the Apply button. |
To modify the translations of a portal key
- In the tree, select the application for which the translations of the portal key must be modified.
- Under the Dictionaries item, click Portal.
- In the Portal list box, select the portal for which you want to modify a key translation.
- In the translations table, click a key name and change its translations in the facing language cells, or right-click the cells and choose Details to enter the translations in the Keys Translations dialog box.
- Click Apply to validate the modifications.
To add a portal key
- In the tree, select the application for which the translation of a portal key must be added.
- Under the Dictionaries item, click Portal.
- In the Portal list box, select the portal for which you want to add a portal key.
- In the translations table, click the last line of the Name column and type in the new key.
- In the language cells, enter a translation for the new key, or right-click it and choose Details to enter the translation in the Keys Translations dialog box.
- Click Apply to validate your entries.
Forms Property Keys Dictionary
Below the Dictionaries tree item, a click on the Forms tab displays the translations table containing the translations of the property keys used in the COGNITUM forms.
Figure: Forms property keys dictionary properties
Name: The forms property keys are listed in this column as specified when they were created in the COGNITUM Console.
English/French/...: Facing a selected form key, the matching translations can be modified in the language columns. A click on the label selects it. A new label can then be typed out. A right-click on the key label gives access to the Details command. This opens up the Keys Translations dialog box in which the translation of the double-clicked term can be modified. A right-click on the label gives access to the Copy Translations / Paste Translations commands to duplicate the translations of the selected key from a dictionary to another one.
TIP |
---|
The form properties dictionary of an application can be edited in bulk. From the context menu of the Forms tree item, the Copy and Paste commands make is possible to export and import the dictionary in a text editor or an Excel table, through the clipboard. |
The last line of the table is empty in a view to typing in a new key and its translations.
A click on the Apply button validates the translations. COGNITUM classifies them in alphabetical order automatically.
WARNING |
---|
When no translation is entered for a key, a message box warns that a translation box is empty after clicking on the Apply button. |
TIP |
---|
When the COGNITUM Development Studio modifies some dictionary keys, a click on the Refresh command updates the list of the keys in the table. The Refresh command is available with a right-click on the Forms item in the COGNITUM Console tree. |
To modify the translations of a form property key
- In the tree, select the application for which the translation of the form property key must be modified.
- Under the Dictionaries item, click Forms.
- In the translations table, click a key name and change its translations in the facing language cells, or right-click the cells and choose Details to enter the translations in the Keys Translations dialog box.
- Click Apply to validate the modifications.
To add a form property key
- In the tree, select the application for which the translation of a form property key must be added.
- Under the Dictionaries item, click Forms.
- In the translations table, click the last line of the Name column and type in the new key.
- In the language cells, enter a translation for the new key, or right-click it and choose Details to enter the translation in the Keys Translations dialog box.
- Click Apply to validate your entries.
Workflow Dictionary
The Workflow dictionary is available when the Workflow package has been imported into the selected application. It contains the translations of the keys used in the Workflow forms. The application must be Workflow-enabled, as described in the COGNITUM Workflow Implementation Guide.
Below the Dictionaries tree item, a click on the Workflow tab displays the Workflow translations table.
Figure: Workflow dictionary properties
Name: The Workflow property keys are listed in this column as specified when they were created in the Studio and the Console.
English/French/...: Facing a selected Workflow key, the matching translations can be modified in the language columns. A click on the label selects it. A new label can then be typed out.
TIP |
---|
The Workflow dictionary of an application can be edited in bulk. From the context menu of the Workflow tree item, the Copy and Paste commands make is possible to export and import the dictionary in a text editor or an Excel table, through the clipboard. |
The last line of the table is empty in a view to typing in a new key and its translations.
WARNING |
---|
When no translation is entered for a key, a message box warns that a translation box is empty after clicking on the Apply button. |
TIP |
---|
When the Studio modifies some dictionary keys, a click on the Refresh command updates the list of the keys in the table. The Refresh command is available with a right-click on the Workflow item in the COGNITUM Console tree. |
To modify the translations of a Workflow key
- In the tree, select the application for which the translations of the Workflow key must be modified.
- Under the Dictionaries item, click Workflow.
- In the translations table, click a key name and change its translations in the facing language cells, or right-click the cells and choose Details to enter the translations in the Keys Translations dialog box.
- Click Apply to validate the modifications.
To add a Workflow key
- In the tree, select the application for which the translations of a Workflow key must be added.
- Under the Dictionaries item, click Workflow.
- In the translations table, click the last line of the Name column and type in the new key.
- In every language cell, enter the translation for the new key, or right-click it and choose Details to enter the translation in the Keys Translations dialog box.
- Click Apply to validate your entries.