Ad Hoc: Internationalization Guide - Logi DevNet
Contents
1. Resource File Usage Page Based Resources App_LocalResources LocalizedText es mx resx Use the Mexican Spanish resource file specific to the web page App_LocalResources LocalizedText es resx Use the Spanish resource file specific to the web page App_LocalResources LocalizedText resx Use the default resource file specific to the web page Application Based Resources App_GlobalResources LocalizedT ext es mx resx Use the Mexican Spanish resource file for the web site App_GlobalResources LocalizedT ext es resx Use the Spanish resource file for the web site App_GlobalResources LocalizedT ext resx Use the default resource file for the web site Note Not all files have to exist however at a minimum a global default resource file is required for the application to function properly The Localization Process The process of localizing the application is facilitated by the Internationalization option accessed from the Tools action group in the Management Console Note Resource files were managed by the Resource Manager in Ad Hoc versions prior to 10 0 50 The functionality of the Resource Manager has been incorporated in the Management Console under Tools Internationalization The dialogs presented under this option continue to reference Resource Manager Both terms internationalization and resource manager are referring to the same dialogs and functions The Internationalization option allows th2. View only column Data Object Configuration Data permissions Objects Set Data Object Access Rights View Column Access Rights ColPermissions2 Column Data Object Configuration Data permissions Objects Set Data Object Access Rights Modify Column Access Rights NamedDateBox Date dropdown list with pre defined dates Column style in Report Wizard PagingControl UI paging controls Shown when paging is on and number of rows exceeds the threshold PasswordControl Password dialog User Configuration Users Set box Password Search The list search Reports Find Reports option SpecialValue Date dropdown Any page requiring pre defined with pre defined dates dates e g Parameters panel in Report Wizard root ahReport App_LocalResources ArchivedReportList List of archives of a specific report Report Configuration Archives Archives for a report ArchivedReports List of archived Report Configuration Archives reports Emaillnfo Email page Send Report by Email Folder Folder definition Reports Add a New Folder dialog ReportCopy Copy report dialog Reports Copy Reports or Reports Copy Report L Logi 10 Ad Hoc Reporting Page 9 File Location amp Name General page Navigation Path content ReportListFolderView List of folders and Reports reports ReportMove Move report dialog Reports Move Reports or Reports Move Report ReportRename Rename repor
3. Phone 1 888 564 4965 703 752 9700 Email http www logianalytics com support
4. files Local resource files are specific to a single Web page master page or user control The resources in these files can be used only for that Web file These resource files are put into the special App_LocalResources folder A local resource file is named after the Web file for example the resource file for the Home aspx Web page could be Home aspx resx Home aspx es mx resx and so on Note Each sub folder of the Web site can have its own App_LocalResources folder The resources in a global resource file can be read from any page or code in the Web site These resource files are put into the special folder App GlobalResources This folder exists at the root of the application Any resx file that is in the App_GlobalResources folder has global scope L Logi 10 Ad Hoc Reporting Page 5 Within the local and global hierarchy are language specific conventions for resource files In Table 1 Example of a Resource File Resolution Hierarchy LocalizedText is not only the name of a web file it may also be considered a base class for the resources When the browser attempts to display a text string it uses the browser language settings Mexican Spanish in our example to start the search for the proper resource Given the resource name for the resource and the language configured in the browser the following hierarchy is used to resolve the text string Table 1 Example of a Resource File Resolution Hierarchy
5. has made use of the Microsoft Windows Globalization framework which helps minimize issues related to internationalization Externally extensive use of resource files has proven to be an optimum mechanism for localization In our context resource files contain an internal resource name that identifies a text string These text strings may appear as column headings button labels list options navigation elements and numerous other contexts within the software We provide tools to assist in the identification and translation of the text strings into other languages Localization Factors Our model relies on browser database and operating system OS support to complete the localization process which is designed into the Microsoft Windows Globalization framework In any localization process special attention must be paid to handling of dates time currency sorting and user interface Ul issues Most of these are handled properly by the underlying delivery mechanisms of the OS database and browser settings The notable exception is the UI The UI can be dramatically affected when using the translated text strings String length is the typical issue affecting the Ul Users expect labels headings etc to fit on the page in a visually appealing manner It is one of the challenges that the localization expert must overcome Resource File Hierarchy Resource files are generally of two types Local resource files and Global resource
6. settings Configuration Permissions Edit or Add PermissionList List of permissions User Configuration Permissions Relationship Relationship Data Object settings Configuration Relationships Edit or Add RelationshipList List of relationships Data Object Configuration Relationships Role Role settings User Configuration Roles Edit or Add RoleList List of roles User Configuration Roles L Logi 10 Ad Hoc Reporting File Location amp Name General page content Page 8 Navigation Path RolePermissions Role permissions User Configuration Roles Set Data Object Access Rights SessionParameters List of session Application Configuration Session parameters Parameters or User Configuration Session Parameters Settings Report settings Report Configuration Report Settings User User settings User Configuration Users Edit or Add UserGroup User group User settings Configuration Organizations Modify Organization UserGroupList List of user groups User Configuration Organizations UserGroupSessions User group User session Configuration Organizations Set parameters Session Parameters UserList List of users User Configuration Users VirtualView Virtual view Data Object Configuration Virtual settings Views Modify Data Object VirtualViewList List of virtual Views Data Object Configuration Virtual Views root ahConirols App_LocalResources ColPermissions
7. Logi Ad Hoc Reporting Internationalization Guide O ANALYTICS R Version 10 Last Updated September 2010 L Logi 10 Ad Hoc Reporting Page 2 Table of Contents INTRODUCTION aan 3 UNDERSTANDING THE PROCESS ees ees eek eek ee se eek ee ke eek eek eek eek ee ke eek eek eek ee Ke ee ee ee ee 4 Internationalization Model ee ee ee ee ee ee ee 4 Localization FactorS EE ee ee ee ee ee ee 4 Resource File Hera ss ii 4 The Localization Process ccccccccecceeececceecceececceeeceececaeececceeceeceecaueceecueeseeseeens 5 LOCALIZA TION urinaria 7 Resource File Details ccccecceeccecceccceccecceeeceecceceececeaueceecaeeseecueeaeeceecaeeaeeceeens 7 Specific Considerations cnica ii Ee de de ie ee Ee de ER Ee 11 GONTAE THE EG SS Oe EN iaa 15 L Logi 10 Ad Hoc Reporting Page 3 INTRODUCTION This guide is intended for administrators interested in localizing a Logi Ad Hoc Reporting installation The guide is not intended to be exhaustive in nature but should give the reader 1 a feel for the process 2 details regarding string usage within the application and 3 guidance and tips to ensure the best possible result L Logi 10 Ad Hoc Reporting Page 4 UNDERSTANDING THE PROCESS Internationalization Model Our software model provides the ability to localize or customize the application without recompilation through an internal and external architecture Internally all of the development
8. ace1 token The user would see Schedule for Monthly Sales Revenue Report once the token has been resolved for that particular report The localization expert should be aware of these tokens their content and how to convert them into the target language The tokens themselves must remain unaltered in the translated strings In other words if the localization expert sees Replace1 Replace2 etc in the original text string those same tokens must appear in the language specific translation The location of the token may change within the text string but the token itself must exist in the original English form Refer to Table 3 for a complete listing of tokenized references The expected content of the token may be important to the localization expert to convey the proper information to the application user Table 3 Tokenized Resource Reference File Location amp Name Usage Text Expected Value root App_GlobalResources Errors resx Err_BadColumn The following column Replace1 a column cannot be used in this name calculation Replace1 Please choose from the columns list Err_DataTypeCategory Data type category of the Replace1 a data type definition appears to be Replace1 and it does not match your selected data type L Logi 10 Ad Hoc Reporting File Location amp Name Usage Text Page 12 Expected Value Err_InvalidQuery The values you have selected result in an invalid
9. c Reporting Page 14 Email Notification Messages The application has two Email templates for confirmation of activity within the application These templates reside in root ahEmail The content of these templates should be translated into the target language taking care not to remove or redefine any embedded hyperlinks or tokens Help Documentation The folder containing all of the documentation and help files is root ahHelp Files with htm extension are those that are used for on line help Translated versions of these files can reside in the same directory with the appropriate naming convention For example ahReportBuilder htm can be translated to Mexican Spanish and stored as ahReportBuilder es mx htm and stored alongside the parent file ahReportBuilder htm Switching among translated versions of these help files is handled by the application much in the same way as switching between the resources L Logi 10 Ad Hoc Reporting Page 15 CONTACT US If you would like information about other Logi Analytics products or require assistance beyond this user manual please contact Logi Analytics in the following ways Corporate Headquarters Phone 1 888 564 4965 703 752 9700 Fax 703 995 481 1 Email info logianalytics com Address 7900 Westpark Drive Suite A200 McLean VA 22102 Web Site www logianalytics com Sales Department Phone 1 888 564 4965 703 752 9700 Email sales logianalytics com Customer Support
10. e user to 1 identify the target language 2 identify all of the resource files that the application uses and 3 translate each string into the target language See the Management Console Usage Guide for additional details regarding internationalizing an Ad Hoc instance Logi 10 Ad Hoc Reporting Page 6 The language translation is not automatic The localization expert must manually translate each text string into the target language There are three basic tenets for the text translation 1 The translated text length should approximate the length of the original text 2 The translated text should convey the same meaning as the original text 3 The translated text should be consistent in all cases The localization process tends to be an iterative undertaking The localization expert builds and saves the language specific resource files exercises the application with the appropriate browser language and notes how the application appears to the end user If adjustments are necessary the Resource Manager dialog is used to identify the language navigate to the appropriate resource file and make the necessary adjustments Logi 10 Ad Hoc Reporting Page 7 Resource File Details LOCALIZATION Although not absolutely necessary the localization expert should have a working knowledge of the application the resource file hierarchy as described in Table 1 and the relationship of the resource files to the various pages prese
11. nForLinkReportReplace Information for link to report Replace1 Replace1 a report name InformationStyleReplace Information for style Replace1 a style name Replace1 LayerGroupingCols Layer Replace1 Replace1 an integer Grouping Columns number NewRelationshipWithObject New Relationship for Replace1 a data Replace1 Object object name NextStepTooltip Click to save your Replace1 a wizard changes and go to the Replace1 step step name ObjectAccessForRole Replace1 Column Access Rights for Replace1 a data object name Replace2 Replace2 a role name ObjectFixedParameterCaption Fixed Parameters for Replace1 a data Replace1 object name ObjectNameReplace OReplace1 Object Replace1 a data object name L Logi 10 Ad Hoc Reporting File Location amp Name Usage Text Page 13 Expected Value PermissionCaption Replace1 Permission OReplace1 a permission name PreviousStepT ooltip Click to save your Replace1 a wizard changes and go back to step name the Replace1 step RelationshipCaption Replace1 Replace1 a Relationship relationship name RelationshipCaptionWithObject Replace1 Replace1 Relationship for Replace2 Replace2 Object RelationshipListCaption Replace1 Replace1 a Relationships relationship name RoleAccessRightsCaption Object Access Right
12. nted in the application Refer to Table 2 to identify the correlation between the resource files and their usage within the application Table 2 Resource File to Usage Cross Reference File Location amp Name General page content Navigation Path root ahConfiguration App_LocalResources Under the Configuration Button Appearances Presentation styles Report Configuration Presentation Styles ApplicationConfiguration Application settings Application Configuration Application Settings CascadingFilter Cascading filter settings Report Configuration Cascading Filters Edit or Add CascadingFilterList List of cascading filters Report Configuration Cascading Filters Catalog Catalog Data Object infortmation Configuration Catalogs Edit or Add CatalogList List of Catalogs Data Object Configuration Catalogs Configuration Configuration options DataFormats Data formats Report Configuration Data Formats Objectlnfo Data object Data Object Configuration Data information Objects Modify ObjectLinks Data objet links Data Object Configuration Data Objets Set Links ObjectList List of data objects Data Object Configuration Data Objects ObjectParameters Data object Data Object Configuration Data parameters Objects Set Parameters ObjectPermissions Data object Data Object Configuration Data permissions Objects Set Data Object Access Rights Permission Permission User
13. query The error is Replace1 Replace1 a query string Err NumRowsMsg2 Number of rows only accepts integer values between Replace1 and Replace2 Replace1 1 Replace2 an integer number Err_ObjectDescriptionReplace Replace1 contains special characters not allowed in a column label Replace1 a column name root App_GlobalResources LogiAdHoc resx AccessRightsCaption Access Rights for Replace1 Replace1 a data object name CascadingFilterReplace Filter Items for Replace1 Cascading Filter Replace1 a cascade filter name Configuration_ObjectConfig Replace1 gives administrators the ability to manage the following database object configuration features Replace1 a product name from Configuration Application Settings Configuration_ReportConfig Replace1 gives administrators the ability to manage the following report configuration features Replace1 a product name from Configuration Application Settings Configuration UserConfig Replace1 gives administrators the ability to create and manage the following user configuration features Replace1 a product name from Configuration Application Settings DataObjectLinksCaption Links for Replace1 Object Replace1 a data object name InformationForLinkReplace Information for link to Replace1 Replace1 a report name Informatio
14. s for Replace1 a role name OReplace1 Role RoleCaption Replace1 Role Replace1 a role name Row Limit1 Enter a number between Replace1 1 Replace1 and Replace2 an integer Replace2 to limit number number of rows or leave the field blank to follow the application s default limit ScheduleReportCaption Schedule for Replace1 a report Replace1 Report name ScheduleReportCaption1 Schedules for Replace1 a report Replace1 Report name UserCaption Replace1 User Replace1 a user name Profile UserGroupCaption Replace1 User Replace1 a user group Group name UserGroupSessionCaption Session Parameters for Replace1 a user group User Group name Replace1 VirtualViewCaption Replace1 Virtual View Replace1 a virtual view name Style Sheets The application allows the user to select presentation styles from dropdown lists in various places in the application The Styles list is populated from the names of cascading style sheet files residing in the root _StyleSheets folder These files should be renamed to be language compliant and populate the dropdown lists appropriately Application Themes The application allows the user to select application themes from a dropdown list The list is populated from the names of subfolders in the root App_ Themes folder These folders should be renamed to be language compliant and populate lists appropriately L Logi 10 Ad Ho
15. s is displayed on the About page Localized applications should specify the product name in the resource file Usually these are handled in custom pages not through the resource file L Logi 10 Ad Hoc Reporting Page 10 The Help documentation is too large to be incorporated in the resource files See Help Documentation below L Logi 10 Ad Hoc Reporting Page 11 Specific Considerations In addition to the literal string translations in the resource files the application has other specific localization considerations Dynamic text strings must be resolved in the resource files Additionally there are external constructs that require localization attention Dynamic Strings The resource files for the application are not limited to static text strings The application also makes use of dynamic text strings Dynamic text strings include variable information provided by the application during the execution of the application The technique used to process dynamic text strings is to tokenize the variable information and replace the tokens with data during execution The application uses Replace as the token reference in dynamic strings For example the resource file may have an entry that appears as Resource Name Resource Text String ScheduleReportCaption Schedule for Replace1 Report When this text string appears in the application the user defined name of a report will be substituted for the Repl
16. t Reports Rename Report dialog ReportScheduleList List of schedules for a report Reports Modify Scheduling Information ReportSubscription List of users Reports Schedule Report Change Subscription to Report for a previously scheduled report ScheduledReport Schedule settings Reports Schedule Report for new schedule or Reports Schedule Report Modify Schedule for existing schedule ScheduledReports List of schedules Reports Modify Schedule for existing schedule UserPreferences Preferences of the Profile Preferences current user UserProfile Profile of the Profile current user root ahWizard App_LocalResources DashboardWizard Dashboard create edit page Reports Add a New Dashboard or Reports Modify Report for a dashboard ReportWizard10 Report create edit page Reports Add a New Report or Reports Modify Report for a report root App_LocalResources About About page ApplicationError Error page i Default Default page Help ibi root App_GlobalResources Errors LogiAdHoc Calc Calculated Columns ShortHelp Page Level Help on each Ad Hoc page Note Root identifies the instance folder for Logi Ad Hoc Reporting By default the root folder is C Program Files LogiXML Ad Hoc Report Builder This may have been changed during installation Normally the Product Name as defined in Configuration Application Setting
Download Pdf Manuals
Related Search