Difference between revisions of "Translation Import/Export"

From SmartWiki
Jump to: navigation, search
(Creating Translation File - Arcadia)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[System Administrator]]s are able to '''export''' [[Custom Fields|custom field]] translation settings as [[XML]] files and '''import''' [[Custom Fields|custom field]] translation setting files that are [[XML]]. The '''Translation Import''' and '''Translation Export''' tabs are available within any Custom Fields Settings page.
+
==Overview==
 +
People collaborate using SmartSimple Cloud in many languages. For example your applicants, reviewers and program managers may work together in over 30 different [[languages]].
  
== Creating Translation File - Arcadia ==
+
This article will provide you an overview of the configuration of custom fields in multiple languages.
 +
 
 +
[[System Administrator]]s are able to '''export''' [[Custom Fields|custom field]] translation settings and '''import''' [[Custom Fields|custom field]] translation setting files. The '''Translation Import''' and '''Translation Export''' tabs are available within any Custom Fields Settings page.
 +
 
 +
==Best Practices==
 +
* The usual process to deploy a system in multiple languages would be to first configure all of the processes in one language. Then, all of the custom fields are translated in the additional language(s). External user pages are enabled in multiple languages more often than entire systems.
 +
* Unless you are a native speaker, use a translation service to provide the translated field captions.
 +
* The exported translation file can contain tags such as HTML formatting or sslogic so when translating the content, remember to retain the original format.
 +
* For [[Custom Field Type: Select One – Combo Box]], ensure your translation file retains the store-value=display-value syntax.
 +
* Some custom field types such as [[Custom Field Type: Special - Advanced Data Table]] benefit from manual updating rather than import of the translation file.
 +
 
 +
==Configuration – Essentials==
 
1. Go to the UTA, in this case we will go to the Submission Manager<br />
 
1. Go to the UTA, in this case we will go to the Submission Manager<br />
 
2. Go to Configuration Settings<br />
 
2. Go to Configuration Settings<br />
Line 7: Line 19:
 
4. We want to Create a Translation File for all custom fields in this UTA.<br />
 
4. We want to Create a Translation File for all custom fields in this UTA.<br />
 
5. Select the check box at the top to Select All custom fields.<br />
 
5. Select the check box at the top to Select All custom fields.<br />
[[File:Translationfile1.PNG|500px|http://wiki.smartsimple.com/wiki/File:Translationfile1.PNG]]<br />
+
[[File:TranslationExport1.png|thumb|none|800px|Create translation file export button]]<br />
 
6. Click the "Create Translation File" button at the top.<br />
 
6. Click the "Create Translation File" button at the top.<br />
 
7. Select the file format, for this case we will use Excel 2010.<br />
 
7. Select the file format, for this case we will use Excel 2010.<br />
[[File:Translationfile2.PNG|500px|http://wiki.smartsimple.com/wiki/File:Translationfile2.PNG]]<br />
+
[[File:Translationfile2.PNG|750px|Select file format]]<br />
8. Delete the first column of each Setting/Property as the second (duplicate) column will be what the translation will be, followed by copying all in the excel sheet.<br />
+
8. Go back to the Custom Field page and click the "Text Import" button at the top.<br />
[[File:Translationfile3.PNG|500px|http://wiki.smartsimple.com/wiki/File:Translationfile3.PNG]]<br />
+
[[File:TranslationImport2.png|thumb|none|800px|Select Text Import]]<br />
9. Go back to the Custom Field page and click the "Text Import" button at the top.<br />
+
9. Paste the data from above in the box shown. Make sure to select the Column Delimiter, we will select the Tab in this case. Select the imported language. Select the appropriate options in the box and click the "Analyze" button.<br />
[[File:Translationfile4.PNG|500px|http://wiki.smartsimple.com/wiki/File:Translationfile4.PNG]]<br />
+
[[File:TranslationImport2.png|thumb|none|800px|Choose the language for import]]<br />
10. Paste the data from above in the box shown. Make sure to select the Column Delimiter, we will select the Tab in this case. Select the appropriate options in the box and click the "Analyze" button.<br />
+
10. Map the columns to match the columns in the excel sheet followed by clicking the "Parse Data" button.<br />
[[File:Translationfile5.PNG|500px|http://wiki.smartsimple.com/wiki/File:Translationfile5.PNG]]<br />
+
[[File:Translationfile6.PNG|1000px|Map the columns for import]]<br />
11. Map the columns to match the columns in the excel sheet followed by clicking the "Parse Data" button.<br />
+
11. This window will make sure that the fields are mapped correctly, if there seems to be an error in any of these, it will not be parsed into the instance. Once checked, click the "Upload" button, it will then show if the fields are Successful or Failed.
[[File:Translationfile6.PNG|500px|http://wiki.smartsimple.com/wiki/File:Translationfile6.PNG]]<br />
 
12. This window will make sure that the fields are mapped correctly, if there seems to be an error in any of these, it will not be parsed into the instance. Once checked, click the "Upload" button, it will then show if the fields Successful or Failed.
 
 
 
== Accessing the Translation Import/Export Tabs - Classic ==
 
# Go to [[Global Settings]]
 
#: [[File:Globalsettings.PNG‎]]
 
# Under [[System Variables and Custom Fields]], click on the hyperlink for [[Custom Fields]]
 
#: [[File:GSCustomFields.PNG]]
 
# Using the left menu, select the [[Custom Fields]] you would like to translate. The associated custom fields will load within the main window once selected.
 
#: [[File:CFSelect.PNG]]
 
# Above the list of custom fields you will see a language dropdown selection field. Use this to select the language you wish to add translations for.
 
#: [[File:CFlanguage.png]]
 
# With a language other than English (Default) selected you will notice the ''Import'' and ''Export'' tabs have now changed to ''Translation Import'' and ''Translation Export''. These tabs provide you the ability to export the existing field translation settings for the selected language in XML format, or import XML-formatted field translation settings.
 
#: [[File:CFtranslate_imp-exp.png]]
 
 
 
== Translation XML Sample Breakdown ==
 
The following are samples of Translation XML files and how to update the data.
 
<pre>
 
<customfield>
 
            <language>14</language>
 
            <id>1234567</id>
 
            <caption><span style="color:red">Are you a charitable organization?</span></caption>
 
            <captiontranslation><span style="color:red">¿Eres una organización de caridad registrada?</span></captiontranslation>
 
            <formatxml>
 
                        <audit>1</audit>
 
                        <maxp>0</maxp>
 
                        <searchable>0</searchable>
 
                        <wvp>,</wvp>
 
            </formatxml>
 
            <formatxmltranslation>
 
                        <audit>1</audit>
 
                        <maxp>0</maxp>
 
                        <searchable>0</searchable>
 
                        <wvp>,</wvp>
 
            </formatxmltranslation>
 
            <options>No;Yes</options>
 
            <optionstranslation>No;Sí</optionstranslation>
 
            <numberformat></numberformat>
 
            <numberformattranslation></numberformattranslation>
 
            <tabname></tabname>
 
            <tabnametranslation></tabnametranslation>
 
</customfield>
 
</pre>
 
 
 
Translations for the above field are contained within the following XML tags:
 
* <captiontranslation> </captiontranslation>
 
* <formatxmltranslation> </formatxmltranslation>
 
* <optionstranslation> </optionstranslation>
 
* <numberformattranslation> </numberformattranslation>
 
* <tabnametranslation> </tabnametranslation>
 
 
 
 
 
; <language>14</language>
 
: This tag contains the language ID. See the [[Language]] page for a list of language IDs.
 
; <id>1234567</id>
 
: This tag contains the [[Custom Field ID]]. This is used for matching when importing the file and must remain exactly as exported.
 
; <captiontranslation> </captiontranslation>
 
: These tags contain the translated [[caption]] as will be visible to the end user with the matching language ID settings.
 
; <optionstranslation> </optionstranslation>
 
: Should the field be a [[Custom Field Type: Select Many – Check Boxes|checkbox]] or [[Custom Field Type: Select One – Combo Box|combo box]] field, you will be provided with this tag in which to enter the translations for the options.
 
; <tabnametranslation></tabnametranslation>
 
: This tag controls the translation of the [[Tabs#Navigation_Bar_Tabs|tab]] in which the field exists.
 
  
 
==See Also==
 
==See Also==

Latest revision as of 14:46, 31 May 2021

Overview

People collaborate using SmartSimple Cloud in many languages. For example your applicants, reviewers and program managers may work together in over 30 different languages.

This article will provide you an overview of the configuration of custom fields in multiple languages.

System Administrators are able to export custom field translation settings and import custom field translation setting files. The Translation Import and Translation Export tabs are available within any Custom Fields Settings page.

Best Practices

  • The usual process to deploy a system in multiple languages would be to first configure all of the processes in one language. Then, all of the custom fields are translated in the additional language(s). External user pages are enabled in multiple languages more often than entire systems.
  • Unless you are a native speaker, use a translation service to provide the translated field captions.
  • The exported translation file can contain tags such as HTML formatting or sslogic so when translating the content, remember to retain the original format.
  • For Custom Field Type: Select One – Combo Box, ensure your translation file retains the store-value=display-value syntax.
  • Some custom field types such as Custom Field Type: Special - Advanced Data Table benefit from manual updating rather than import of the translation file.

Configuration – Essentials

1. Go to the UTA, in this case we will go to the Submission Manager
2. Go to Configuration Settings
3. Go to Level 1 Custom Fields
4. We want to Create a Translation File for all custom fields in this UTA.
5. Select the check box at the top to Select All custom fields.

Create translation file export button

6. Click the "Create Translation File" button at the top.
7. Select the file format, for this case we will use Excel 2010.
Select file format
8. Go back to the Custom Field page and click the "Text Import" button at the top.

Select Text Import

9. Paste the data from above in the box shown. Make sure to select the Column Delimiter, we will select the Tab in this case. Select the imported language. Select the appropriate options in the box and click the "Analyze" button.

Choose the language for import

10. Map the columns to match the columns in the excel sheet followed by clicking the "Parse Data" button.
Map the columns for import
11. This window will make sure that the fields are mapped correctly, if there seems to be an error in any of these, it will not be parsed into the instance. Once checked, click the "Upload" button, it will then show if the fields are Successful or Failed.

See Also