Service Optimization Version 8.1. Service Optimization Localization Guide

Transcription

1 Service Optimization Version 8.1 Service Optimization Localization Guide

2 Legal Notice The software with this guide is furnished under a license agreement and may be used only according to the terms of that agreement. Copyright Copyright ClickSoftware Technologies Ltd. All rights reserved. No part of this publication may be copied without the express written permission of ClickSoftware Technologies Ltd. Patent and Trademark US Patent Number 6,985,872 B2 ClickAnalyze, ClickFix, ClickForecast, ClickMobile, ClickPlan, ClickRoster, ClickSchedule, and ClickSoftware are trademarks of ClickSoftware Technologies Ltd. Contact Information Contact information is available from the ClickSoftware web site: For support services, mail to support@clicksoftware.com or see the support page on the ClickSoftware web site. For general information, mail to sales@clicksoftware.com. Publication Notice This guide has been carefully compiled. The information in this guide does not constitute a warranty of performance. Furthermore, ClickSoftware reserves the right to revise this publication and make changes from time to time in the content thereof, without obligation to notify any person of such revisions or changes. ClickSoftware assumes no liability for losses incurred as a result of out-of-date or incorrect information in this guide. Version Service Optimization Localization Guide Edition: Service Optimization version 8.1 Date: December 2009

3 Contents i Contents 1. OVERVIEW... 1 Main Localization Steps... 1 Before You Begin a Localization Project... 2 Language Support... 3 Components that Support Localization PLATFORM LANGUAGE CONFIGURATION... 5 Language Requirements for Client Platforms... 5 Language Requirements for Server and Database Platforms... 6 Language Requirements of Administration and Configuration Tools... 8 Windows User-Interface Language... 8 Setting the Windows Regional Options LOCALIZING THE CLICKSCHEDULE WINDOWS CLIENT Customizing an Out-of-the-Box Localization Full Localization Procedure Localizing the Resource Files Configuring the Client Settings Supporting Multiple Languages LOCALIZING THE CLICKSCHEDULE WEB CLIENT Localization Procedure Installing a Localized Silverlight Package Localizing the ClickSchedule Web-Client Settings Linking to a Localized Client Creating a Localized Silverlight Package Prerequisites Creating a Build Configuration... 28

4 ii Service Optimization Localization Guide Adding Culture Support to the Solution Creating Resource Files Building the Solution Preparing a New XAP File LOCALIZING THE CLICKFORECAST AND CLICKPLAN CLIENTS Localizing the Resource Files Configuring the Client Settings Supporting Multiple Languages Testing a Localized Version Localizing Existing Data LOCALIZING THE CLICKROSTER CLIENT Localization Procedure Installing a Localized Silverlight Package Localizing the ClickRoster Settings Linking to a Localized Client Creating a Localized Silverlight Package Prerequisites Creating a Build Configuration Adding Culture Support to the Solution Creating Resource Files Building the Solution Preparing a New XAP File ADDITIONAL LOCALIZATION ISSUES Localizing the Dictionaries and System Configuration Dictionaries System Configuration Supporting Multiple Languages Miscellaneous Localizations Client Logons ClickAnalyze Insight and ClickAnalyze Reporting ClickSchedule Engineer Client ClickMobile ClickMobile WAP Edition Documentation SXP Encoding GIS Services... 61

5 Contents iii Time Zone Support Custom Setup Updating an Existing Localization Project KNOWN LIMITATIONS Administrative Tools Internal Property and Dictionary Names Server Messages Specific Languages Right-to-Left Languages East Asian Languages ClickSchedule User-Interface Elements Date and Time Controls Color Palettes Customize Window Display Names of Properties Chinese Font Formatting Miscellaneous Strings ClickForecast User-Interface Elements Customized Locales Sorting Order Calendars Setup Program INDEX... 69

6

7 Chapter 1. Overview 1 CHAPTER 1 Overview Main Localization Steps The Service Optimization suite is designed for easy localization. You can: Translate the user interface controls to any language Display custom terminology in the interfaces Configure the interfaces to accept input in any language Configure the system to store information in the Service Optimization database in any language Configure the interfaces to display information from the database in any language This book explains the localization procedures, its capabilities, and its limitations. The main subject of this book is localizing the Service Optimization clients. In addition to these steps, you can localize components such as the logon dialogs and the GIS services. The main steps to accomplish these tasks are listed in the following table. Step Configure the computers on which the Service Optimization components are installed to support the desired languages See chapter 2. Platform Language Configuration

8 2 Service Optimization Localization Guide Step Translate a set of resource files Edit the client settings Edit the Service Optimization dictionaries and other display-string settings Localize additional components such as the logon window, ClickAnalyze, ClickMobile, GIS services, and documentation See chapter 3. Localizing the ClickSchedule Windows Client 4. Localizing the ClickSchedule Web Client 5. Localizing the ClickForecast and ClickPlan Clients 6. Localizing the ClickRoster Client 7. Additional Localization Issues Alternative Localization Approach In the above table, the second step is to translate the Service Optimization resource files. After you complete the translation, you must recompile the resource DLLs. As an alternative to this step, it is possible to use tools such as PASSOLO ( to localize the English-language DLLs directly. The tool extracts the resources from the DLL. You can then translate and compile the DLL. For more information about this alternative approach, please contact ClickSoftware Worldwide Support. Before You Begin a Localization Project Before you begin a Service Optimization localization project, please consult with ClickSoftware Worldwide Support for updated information about the language versions that are available, and for any special instructions regarding your planned target language. You should also examine Chapter 8, Known Limitations, to evaluate any problems that you are likely to encounter in the localization procedures.

9 Chapter 1. Overview 3 Language Support The Service Optimization localization features support all languages. Right-to-left languages, such as Hebrew and Arabic, and languages that require more than 256 characters, such as Chinese and Japanese, are supported with a few limitations. For details, see Chapter 8, Known Limitations. The localization features support Unicode. The only exception to this rule is the Service Optimization Administration tool, which requires code-page support for data input. Tested Languages As of this writing, the localization support has been tested thoroughly and certified for French, German, and Japanese. ClickSoftware customers use Service Optimization with many other languages such as Chinese, Eastern European, Scandinavian, and Hebrew. Additional languages are expected to work without significant problems. Components that Support Localization The following is a list of the Service Optimization components that support localization. Please see Chapter 8, Known Limitations, for details of any qualifications. Full Support The following Service Optimization components fully support the localization features: The ClickSchedule Windows client and web client The ClickForecast, ClickForecast, and ClickRoster clients The ClickAnalyze Insight and ClickAnalyze Reporting user interfaces The ClickMobile client for laptop or hand-held computers The ClickMobile WAP Edition user interface for WAP phones The ClickSchedule Engineer Client (but not for East Asian languages) The client logon window Dictionaries

10 4 Service Optimization Localization Guide Strings that are defined in the Service Optimization Administration tool and that are displayed in the clients and user interfaces. Documentation Partial Support The user interfaces of the following component cannot be localized, but the component can be used to input data in non-english languages: The Service Optimization Administration tool (you can edit dictionaries and display strings in any language) The localization capabilities of the following components depend on third-party vendors. For more information, consult with ClickSoftware Worldwide Support: GIS services, such as geocoding, maps, and driving directions No Support The following components do not support localization: Error messages of the Service Optimization server The Service Optimization Structure tool All other administration, configuration, development, and test tools Please note that the Service Optimization server and database do not require any special localization steps to support client localization, except as listed in Chapter 2, Platform Language Configuration.

11 Chapter 2. Platform Language Configuration 5 CHAPTER 2 Platform Language Configuration You must configure the Windows platforms where you install the localized Service Optimization clients and the Administration tool to support input and display in the target language. Server components do not require the language support. If you localize certain Service Optimization client-side components, the Windows user interface must be in the target language. It is not necessary to configure the target language as the default input language. The platforms must support English input and display, in addition to the target language. A localized client may occasionally display a server error message in English, or you may occasionally need to enter English data. The following paragraphs provide details of these guidelines. Language Requirements for Client Platforms ClickSchedule Windows Client To use a localized ClickSchedule Windows client, you must configure the language support in the Windows Control Panel (see Setting the Windows Regional Options below). If you localize any of the following components, you must install the ClickSchedule Windows client on a Microsoft Windows version whose user interface is in the target language (see Windows User-Interface Language below): Logon window Messenger Contractor Capacity add-in LBS wizard Status flow add-in Time-phase skills add-in

12 6 Service Optimization Localization Guide ClickPlan and ClickForecast Clients You must install the localized ClickPlan and ClickForecast clients on a Microsoft Windows version whose user interface is in the target language (see Windows User- Interface Language below). In addition, you must configure the language support in the Windows Control Panel (see Setting the Windows Regional Options below). ClickAnalyze Insight ClickAnalyze Insight has a web interface. A user accesses the interface in Microsoft Internet Explorer, which can display all languages. In the Windows Control Panel, you should configure the system to support input in the target language. ClickAnalyze Reporting ClickAnalyze Reporting displays reports within the ClickSchedule and ClickPlan clients. You must install the language support as for ClickSchedule and ClickPlan. ClickMobile ClickMobile runs on hand-held computers. You must install the language support on the hand-held computers. Web Applications The Service Optimization web applications include the ClickSchedule web client, the ClickRoster client, and the ClickSchedule Engineer Client. A user accesses the web applications in a web browser, which can display all languages. In the Windows Control Panel, you should configure the system to support input in the target language. The ClickSchedule Engineer Client does not support East Asian languages. Language Requirements for Server and Database Platforms Service Optimization Server The Service Optimization server is certified on English and German Windows systems. The regional settings of the server should be set to English or German, respectively (see Setting the Windows Regional Options below). Do not install the server on any other Windows language version. The server may operate incorrectly on other language versions.

13 Chapter 2. Platform Language Configuration 7 SQL Server Database If your Service Optimization system uses a SQL Server database, consult the Microsoft documentation for the platform requirements. There are no special configurations to support the Service Optimization localization features. Oracle Database If you Service Optimization system uses an Oracle database, consult the Oracle documentation for the platform requirements. Follow these steps to configure the language support: 1. For all languages (including English), you should configure the Oracle database to store data in Unicode, using the AL32UTF8 encoding. For detailed instructions, see the chapter on Database Administration in the Service Optimization Administrator's Guide. 2. To confirm the Oracle encoding, run the following SQL query: select value from nls_database_parameters where parameter='nls_characterset'; The response should be: AL32UTF8 3. On the Oracle database server, set the following Oracle system parameters: NLS_LANG = <language>_<territory>.al32utf8 NLS_SORT = binary For example, if you are localizing into German, you can set: NLS_LANG = GERMAN_GERMANY.AL32UTF8 NLS_SORT = binary 4. On each Service Optimization server, set the following Oracle client parameter in the Windows system registry: HKEY_LOCAL_MACHINE/SOFTWARE/ORACLE/HOME0/NLS_LANG = <language>_<territory>.al32utf8 For example, if you are localizing into German, you can set: HKEY_LOCAL_MACHINE/SOFTWARE/ORACLE/HOME0/NLS_LANG = GERMAN_GERMANY.AL32UTF8 GIS Server ClickSchedule integrates with GIS servers. For an overview of the localization capabilities, see GIS Services in Chapter 7, Additional Localization Issues. For

14 8 Service Optimization Localization Guide detailed GIS configuration requirements, see the ClickSchedule GIS Configuration Guide. Language Requirements of Administration and Configuration Tools Service Optimization Administration Tool You should install the Service Optimization Administration tool on a Windows version that supports English and the target language (see Windows User-Interface Language below). You must configure the language support in the Windows Control Panel (see Setting the Windows Regional Options below). The user interface of the Administration tool is in English. The interface cannot be localized. The target language is required so that you can enter text in the language, for example, dictionary items and rule-violation strings. For a list of the settings that support non-english input, see Localizing the Dictionaries and System Configuration in Chapter 7, Additional Localization Issues. Structure Tool The Service Optimization Structure tool runs only on the Service Optimization server computer. The tool cannot be localized. All input must be in the English character set. Windows User-Interface Language Certain localization features require that the Microsoft Windows user interface be in the target language. Specifically, this is true for.net components that use *.resx resource files. This is the case for: The ClickForecast and ClickPlan clients The client logon window In practice, this means that if you localize any of the above features, you must install the clients on: A localized Microsoft Windows version or A Microsoft Windows version with the Multilingual User Interface (Windows MUI)

15 Chapter 2. Platform Language Configuration 9 To set the user-interface language in Windows MUI, open the Control Panel and select Regional and Language Options. At the bottom of the Languages tab, there is an option to select the user-interface language. To confirm that the user-interface language is set correctly, check that the Start button is displayed in the target language. For example, if the Windows user interface is in French, the Start button displays Démarrer. Note: If you localize only the ClickSchedule Windows client (not including the logon window), the language of the Windows user interface is unimportant. You can run the client in French, for example, on a computer where the Windows user interface is in English. Likewise, you can install the Service Optimization Administration tool on English Windows. The tool accepts input in any language, regardless of the Windows user-interface language. Setting the Windows Regional Options To configure the Windows language support on a computer: 1. Open the Windows Control Panel, and select the Regional and Language Options. 2. The options window displays three tabs. In brief: - The Regional Options tab sets the formats for numbers, dates, currency, etc. - The Languages tab sets the supported languages for display and input. - The Advanced tab sets the language for non-unicode applications. For all localization features, you must configure the first two tabs. For the Service Optimization Administration tool, you must also configure the third tab. For details, see the instructions in the following paragraphs. 3. Click OK. The system may prompt you to insert the Windows setup disk, from which it installs the necessary files. Regional Options Tab On the Regional Options tab, you can set the format (called the locale) for numbers, dates, times, and currency. The setting affects the displays and the interpretation of input in all Windows applications, including the Service Optimization clients and the Service Optimization Administration tool.

16 10 Service Optimization Localization Guide Do not use the Customize button to alter the locale settings. Service Optimization supports only the built-in locales. If you customize the locale, Service Optimization may ignore the customizations. This may lead to serious errors in the interpretation of user input. Languages Tab On the Languages tab, you should set the languages that Windows can use for input and for output. On the computers where you install the Service Optimization client and the Administration tool, you should include both English and the target language. The settings control the user's ability to enter input in the target language, the application's ability to display data in the target language, and the keyboard layout. You can add support for multiple languages, if desired. To configure the settings: 1. On the Languages tab, click the Details button. This displays the Text Services and Input Languages window.

17 Chapter 2. Platform Language Configuration In the Installed Services section of the dialog box, add the languages as required. 3. In the Default Input Language box, select the default language. 4. Click OK to return to the Languages tab. 5. For some languages (for example, right-to-left or East Asian languages), you must select the options to install the required files.

18 12 Service Optimization Localization Guide Advanced Tab On the Advanced tab, you should configure Windows to use the target language in non-unicode programs. This is relevant for the Service Optimization Administration tool. The setting on the Advanced tab determines what language you can use (in addition to English) for data entry in the administration tools. For other Service Optimization components, such as the ClickSchedule, ClickPlan, and ClickForecast clients, the Advanced tab has no effect.

19 Chapter 2. Platform Language Configuration 13

20

21 Chapter 3. Localizing the ClickSchedule Windows Client 15 CHAPTER 3 Localizing the ClickSchedule Windows Client ClickSoftware supplies localized versions of the ClickSchedule Windows client in French, German, and Japanese. If you need one of these languages, but the out-ofthe-box localized version does not fully meet your needs, you can customize it. If you need another language, you must perform a full localization procedure, comprising the following steps: In Visual Studio, you must edit a set of resource files that are provided in the Service Optimization SDK. This lets you translate the interface, adjust the properties of controls, etc., as required for the target language. In the Service Optimization Administration tool, you must edit the standard terminology and forms that are used in the client. For example, you can configure the names that your organization uses for the ClickSchedule terms engineer, task, and assignment, and you can edit the engineer and task forms. Customizing an Out-of-the-Box Localization If the out-of-the-box localized version of the ClickSchedule Windows client does not fully meet your needs, you can customize the localization. Note: If you decide to customize the out-of-the-box localized version, take into account that you must repeat the procedure each time you upgrade to a new Service Optimization version. To do this, download the localized DLL files from the ClickSoftware website. For each file that you want to revise, perform the following steps. 1. In Microsoft Visual Studio, click File > Open > File. 2. In the Open File window, select a file type of Executable Files (*.exe, *.dll, *.ocx). 3. Select the DLL file and click open.

22 16 Service Optimization Localization Guide 4. Visual Studio displays a list of resources that exist in the file, such as dialog boxes, icons, and string tables. Double-click a resource to edit it. 5. Edit as required. 6. Save the file and close Visual Studio. 7. Open the ClickSchedule Windows client and examine the localization result. Full Localization Procedure Localizing the Resource Files To prepare a localized version of the ClickSchedule Windows client in a language that ClickSoftware does not supply, follow the procedures in this section. The resource files contain the complete English-language text and bitmap files for the user-interface of the ClickSchedule Windows client. By translating and recompiling the resource files, you can translate the user interface into other languages. Required Tools You should work on a computer that supports both English and the target language. You must have the following software installed: Microsoft Visual Studio 2008, including Visual C++ The Service Optimization SDK For East Asian languages, you need an editor for the resource files, such as Microsoft Word. To translate the resource files, you do not need to install the ClickSchedule Windows client. You need the client only at the end of the procedure, when you are ready to deploy and test the localized files. Note: Certain ClickSchedule Windows client add-ins are programmed using the Microsoft.NET technology. To localize those add-ins, you should use the.net translation SDK. Folder Names In the following procedure, we refer the Service Optimization and SDK folders. The default locations of these folders are: c:\program Files\ClickSoftware\Service Optimization

23 Chapter 3. Localizing the ClickSchedule Windows Client 17 c:\program Files\ClickSoftware\Service Optimization\SDK Procedure for Most Languages To edit the resource files, follow this procedure: 1. In the SDK, find the following folder. SDK\OCX License The folder contains five *.lic files, which are licenses that let you edit certain third-party controls that are used in the Service Optimization system. Copy the *.lic files to the folder: Service Optimization\Bin 2. Open the following file in Visual Studio: SDK\ClickSchedule\Client Localization\ReplaceClientResources\ Language.sln This is the main file of the resource-file solution. The solution contains six projects, which have the following names: W6BFCalendarRes Resources for the calendar editor. W6BFClientRes Resources for many client windows. W6BFCUtilsRes Resources for utilities such as error displays. W6FormsEngineRes Resources for the forms generated by the Dialog Editor. W6MapObjectRes Resources for the map and driving-direction displays. W6ScheduleWizardRes Resources for the schedule wizard. 3. Display the Resource View window (on the menu, choose View > Resource View). 4. In the Resource View menu, double-click each module, and edit the appropriate strings. Be careful not to change any code words or symbols. For example, a string may read:

24 18 Service Optimization Localization Guide Task '%s' must have the same Engineer as Task '%s' Do not edit the code symbol '%s'. The symbol is a placeholder for a string that the software inserts automatically. Optionally, you can edit the size of the controls. This may be necessary if the strings in the target language are longer than in English. You can also edit the icons and bitmap images. If you are translating into a right-to-left language, such as Hebrew or Arabic, you should change the default direction of user-input controls such as text boxes. To do this, select the control. In the Properties windows, assign the following properties: Right Align Text = true Right To Left Reading Order = true 5. Save the solution (on the menu: File > Save All). 6. Compile the solution (Build > Build Solution). After a few moments, Visual Studio generates a set of six *.dll files (along with several other files, which you can ignore). It stores the files in the following location: SDK\ClickSchedule\Client Localization\ReplaceClientResources\ Output\unicode release 7. Install the DLLs on each ClickSchedule Windows client computer where you want to use the target language. The recommended location on the client computer is: Service Optimization\Bin\<language_name> For example: Service Optimization\Bin\French You do not need to register the files. 8. The client does not yet use the new resource files. To configure this, continue with the steps for Configuring the Client Settings, below. Procedure for East-Asian Languages For languages that use more than 256 characters, such as Chinese and Japanese, you cannot edit the resource files in Visual Studio. Instead, you should edit the files in Microsoft Word. You should save the files as text, selecting the Unicode encoding option.

25 Chapter 3. Localizing the ClickSchedule Windows Client 19 You should then open the solution in Visual Studio, build the solution, and install the DLLs on the client computers. With the exception of the editing steps (steps 3-5 in the Procedure for Most Languages), the procedure is identical to that for other languages. Configuring the Client Settings After you edit the resource files, you must edit the ClickSchedule Windows client settings and configure the client to use the new resource files. You should also edit various terminology that the client displays. Required Tools To configure the settings, you should work on a computer where the Service Optimization Administration tool is installed. The tool must be connected to a Service Optimization server. The computer must support both English and the target language (see Chapter 2, Platform Language Configuration). Procedure To edit the client settings, perform these steps: 1. In the left pane of the Service Optimization Administration tool, expand the tree to display: Central Settings/Clients User Settings/ClickSchedule/ Administrative Settings 2. In the right pane, right-click and edit an administrative template, such as [Application]. Editing an administrative template changes the settings for all users whose user-defined settings are based on the template. If you have more than one template, you must edit all the templates of users who will use the target language. To avoid unnecessary editing, you can edit a single template. Then right-click the template and choose Duplicate to create additional templates.

26 20 Service Optimization Localization Guide 3. Click the Launch button to open the ClickSchedule Client Administrator. 4. On the General tab, select the speed units for the client displays (miles/hour or kilometers/hour). This setting also determines the distance units (miles or kilometers). 5. On the Field Names tab, edit the display names for the properties of ClickSchedule objects. For example, you can translate the Street, City, and State properties into the appropriate words in your language.

27 Chapter 3. Localizing the ClickSchedule Windows Client On the Languages tab, select the option to Load Resource from the Folder. Browse or type the folder name, for example: c:\program Files\ClickSoftware\Service Optimization\Bin\French Note: This configuration causes ClickSchedule to load C++ resources in the correct language. For.NET resources, you must install the ClickSchedule Windows client on a Microsoft Windows version that has the required userinterface language.

28 22 Service Optimization Localization Guide 7. Click OK to close the ClickSchedule Client Administrator and return to the administrative settings window. 8. When you edited the resource files, you localized the default forms for engineers, tasks, etc. If your organization uses custom forms for these object, you must localize the custom forms. To do this, click the Launch button to open the ClickSchedule Dialog Editor. Open (or create) the custom form, and localize the text and controls. For instructions on using the Dialog Editor, see the chapter on the ClickSchedule Client Setup in the Service Optimization Administrator's Guide. 9. Click OK to close the administrative settings window. 10. Expand the tree in the left pane of the Administration tool to display: Central Settings/Clients User Settings/ClickSchedule/ User Defined Settings 11. In the right pane, create settings for the users based on the Administrative template (for detailed instructions, see the chapter on ClickSchedule Client Setup in the Service Optimization Administrator's Guide). Note: If the user settings already exist, you should delete and recreate them. Otherwise, the menus and toolbars may display incorrectly, or they may remain in English. (If you wish to preserve the existing user settings, see the instructions for Resetting the Client Menus and Toolbars below.)

29 Chapter 3. Localizing the ClickSchedule Windows Client The users can now open the ClickSchedule Windows client. The localized interface is displayed. Resetting the Client Menus and Toolbars In Step 11 above, we instructed you to create new user settings that are based on the localized administrative template. This is the recommended procedure. If the user settings already existed before you localized the template, and you want to preserve the existing settings, the procedure is more complex. You must reset the menus and toolbars in the ClickSchedule Windows client. Until you do this, the client may display the menus and toolbars incorrectly. For each user who has an existing user setting, perform these steps: 1. The user must close the ClickSchedule Windows client. The user must not open or log on to the client on any computer in the network, until you have completed the procedure. 2. On a single computer, open the ClickSchedule Windows client, logging on under the user name. 3. On the menu, choose the View > Customize command. 4. Display the Toolbars tab, select all the check boxes, and click the Reset All button. 5. Display the menus tab. On both sides of the tab, select each menu in turn, and click the Reset button. 6. Close the ClickSchedule Windows client. This saves the new menu and toolbar settings. 7. The user may now open the client on the same computer or on any other computer in the network. The client displays the menus and tool tips in the target language. Supporting Multiple Languages You can translate and compile the resource files into multiple languages. Install each set of localized DLLs into a separate folder on the client computers, for example: Service Optimization\Bin\French Service Optimization\Bin\German You can configure the clients to use the appropriate language for each user (see Configuring the Client Settings above).

30

31 Chapter 4. Localizing the ClickSchedule Web Client 25 CHAPTER 4 Localizing the ClickSchedule Web Client The ClickSchedule web client is a Microsoft Silverlight application. The language resources are contained in a Silverlight package. Additional display strings are defined in the Service Optimization configuration settings. ClickSoftware supplies Silverlight packages in French, German, and Japanese. By using the out-of-the-box packages, you can simplify the localization procedure. For other languages, you must create a localized Silverlight package yourself. Localization Procedure For all languages, you must localize the configuration settings and perform certain other steps to enable the localized client. To prepare a working, localized version of the ClickSchedule web client, you must perform the following steps: 1. Obtain or prepare a localized Silverlight package for the ClickSchedule web client. The package is a *.xap file that replaces the default, English-language file. You can download Silverlight packages in French, German, and Japanese from the ClickSoftware website. For other languages, you must create the package yourself. For instructions, see Creating a Localized Silverlight Package below. 2. Install the localized Silverlight package in the ClickSchedule web-client directory. 3. Localize the ClickSchedule web-client settings. 4. Link to the localized ClickSchedule web client using a URL that contains appropriate language parameters. The following paragraphs provide detailed instructions for steps 2 to 4.

32 26 Service Optimization Localization Guide Installing a Localized Silverlight Package ClickSoftware supplies Microsoft Silverlight packages for the ClickSchedule web client in French, German, and Japanese. Each package is a Silverlight *.xap package file that replaces the default, English-language package. If you do not have a localized Silverlight package, you can create one yourself. For instructions, see Creating a Localized Silverlight Package below. To install a localized Silverlight package: 1. On the Service Optimization server, find the existing English *.xap file: c:\program Files\ClickSoftware\Service Optimization\Web\ ClickWebClient\ClientBin\W6.Web.UI.xap 2. Replace it with the non-english *.xap file. Localizing the ClickSchedule Web-Client Settings The web-client settings define many display strings. You can localize the strings in the same way as you can edit the strings in English. For instructions, see: The ClickSchedule Web Client chapter of the Service Optimization Administrator's Guide The ClickSchedule Web Client Configuration Guide Asian Languages Linking to a Localized Client In Asian languages such as Japanese, the ClickSchedule web client does not support right-click context menus. You must delete all the actions from the context menus, define them in the toolbar, and translate the display strings. In English, you can open the ClickSchedule web client by linking to: Optimization Server Host>/ClickScheduleWebClient/ Default.aspx In other languages, you must add parameters to this URL: To display the ClickSchedule web client in a non-english language, add a culture parameter. The parameter value is a language code such as fr, de, or ja. To enable user input in a non-english language, add a uiculture parameter.

33 Chapter 4. Localizing the ClickSchedule Web Client 27 For Asian languages such as Japanese, add a mode=ime parameter. For example, to enable a French display and user input, link to: Optimization Server Host>/ ClickScheduleWebClient/Default.aspx?culture=fr&uiculture=fr For German, link to: Optimization Server Host>/ ClickScheduleWebClient/Default.aspx?culture=de&uiculture=de For Japanese, link to: Optimization Server Host>/ ClickScheduleWebClient/Default.aspx?culture=ja&uiculture=ja&mode=ime Creating a Localized Silverlight Package Prerequisites If ClickSoftware does not supply a localized Silverlight package (*.xap file) for your language, create one by the following procedure. The procedure requires that you localize an English-language Microsoft Visual Studio solution, provided in the Service Optimization SDK directory: c:\program Files\ClickSoftware\Service Optimization\SDK\ ClickSchedule\Web Clients\ClickSchedule WebClient Localization\ ClickWebClient You must then add the localized components to the existing English *.xap file. Throughout the procedure, we use Spanish (language code es) as an example. You should substitute your target language and language code. To create a localized Silverlight package, work on a computer that supports both English and the target language. You must have the following software installed: Service Optimization SDK Microsoft Visual Studio 2008 Microsoft Silverlight Tools for Developers. Install the Silverlight version that the ClickSchedule web client supports. For Asian languages, an editor such as Microsoft Word WinZip or Microsoft Compression. Do not use any other zip utility.

34 28 Service Optimization Localization Guide Creating a Build Configuration In the SDK solution, you must create a build configuration for the target language: 1. In Visual Studio, click File > Open > Project/Solution, and open the main file of the solution: ClickWebClient\ClickWebClient.sln 2. On the Visual Studio menu, click Build > Configuration Manager. 3. In the Active Solution Configuration option, select New. 4. Enter a configuration name such as Release - es. Copy settings from the original Release configuration.

35 Chapter 4. Localizing the ClickSchedule Web Client Close the Configuration Manager. Adding Culture Support to the Solution Perform the following steps on each project in the solution: 1. In the Solution Explorer, right-click the project, and choose Unload Project. 2. In the Solution Explorer, right-click each project and choose Edit. This opens the project properties in an XML editor. 3. Find the PropertyGroup element for the configuration that you created. 4. Within the PropertyGroup, add a SupportedCultures element: <SupportedCultures>es</SupportedCultures> 5. Close the XML editor. 6. In the Solution Explorer, right-click the project and choose Reload Project.

36 30 Service Optimization Localization Guide Creating Resource Files The solution contains four projects that have English resource files. You must create localized versions of the resource files. The English resource files have the following names: Project W6.Web.API W6.Web.Configuration W6.Web.Controls W6.Web.UI English Resource file Resource.resx ConfigurationUserMessage.resx UserMessages.resx Filters.resx UserMessages.resx You must create localized copies of the resource files. Perform the following procedure on each project that has a resource file. 1. In the Solution Explorer, right-click the project and choose Add > New Item. 2. In the Add New Item window, select Resources File. 3. Enter a file name that is identical to the original resource file, with the addition of the language code: original_file_name.language_code.resx For example, if you are editing the W6.Web.API project, and the target language is Spanish, call the file Resource.es.resx. 4. Click Add. The Solution Explorer displays the new resource file. 5. Copy the entire content of the original resource file to the new resource file. For example, copy the content of Resource.resx to Resource.es.resx. To copy the content: a. Double-click the original resource file. This opens the file in an editor window. b. Select and copy the entire content. c. Double-click the new resource file, opening it in an editor window. d. Paste the content.

37 Chapter 4. Localizing the ClickSchedule Web Client 31 Building the Solution 6. In the Value column of the new resource file, translate the strings to the target language. Note: In most languages, you can use the Visual Studio editor to edit the resource file. In Asian languages, you must use an external editor such as Microsoft Word. 7. Save the edited solution. You must build the solution, using the new build configuration that you defined. 1. On the Visual Studio toolbar, select the new build configuration, for example, Release-es. Preparing a New XAP File 2. On the menu, click Build > Build Solution. 3. Close Visual Studio. You must prepare a new Silverlight package (*.xap) file, containing the localized DLLs and other components: 1. On the Service Optimization server, find the English *.xap file of the ClickSchedule web client: c:\program Files\ClickSoftware\Service Optimization\Web\ ClickWebClient\ClientBin\W6.Web.UI.xap 2. Create a backup copy of the file. 3. Change the file name to W6.Web.UI.zip. Note: Configure Windows to display file extensions. Otherwise, it is difficult to change the extensions correctly. 4. Expand the ZIP file to an empty directory called XAP Package. 5. Create a subdirectory whose name is the language symbol. In the Spanish example, create the following directory:

38 32 Service Optimization Localization Guide XAP Package\es 6. From the solution folder, copy the following files to the subdirectory. From W6.Web.API\Bin\release-es\es, copy: W6.Web.API.resources.dll From W6.Web.Configuration\Bin\release-es\es, copy: W6.Web.Configuration.resources.dll From W6.Web.Controls\Bin\release-es\es, copy: W6.Web.Controls.resources.dll From W6.Web.UI\Bin\release-es\es, copy: W6.Web.UI.resources.dll 7. In a text or XML editor, edit the file XAP Package\AppManifest.xaml. Add the following AssemblyPart elements to the subdirectory (substitute your language code for es): <AssemblyPart Source= es/w6.web.api.resources.dll /> <AssemblyPart Source= es/w6.web.configuration.resources.dll /> <AssemblyPart Source= es/w6.web.controls.resources.dll /> <AssemblyPart Source= es/w6.web.ui.resources.dll /> 8. In the Windows Explorer, display the content of the XAP Package directory. 9. Select all the files and the subdirectory, and zip to file called W6.Web.UI.zip. Do not select the XAP Package directory itself. Select only the content of the directory. 10. Change the file name to W6.Web.UI.xap. 11. The *.xap file is now ready for use. Continue with the Localization Procedure at the beginning of this chapter.

39 Chapter 5. Localizing the ClickForecast and ClickPlan Clients 33 CHAPTER 5 Localizing the ClickForecast and ClickPlan Clients Broadly speaking, the procedures for localizing the ClickForecast and ClickPlan clients are similar to those for ClickSchedule: You need to edit a set of resource files, and you need to configure the client settings. There are some important differences in the way you perform these steps. For example, the resource files have an XML syntax, and they are developed by using the Microsoft.NET technology. This chapter explains the procedures. The procedures described in this chapter also apply to some other Service Optimization components that are based on the.net technology, such as the logon dialog and certain components of ClickSchedule, ClickLocate, ClickAnalyze Reporting, and ClickMobile WAP Edition. Those components are mentioned below and further discussed in Chapter 7, Additional Localization Issues. Localizing the Resource Files The resource files contain the complete English-language text and bitmap files for the user-interface of the ClickForecast and ClickPlan clients. By translating and recompiling the resource files, you can translate the user interface into other languages. You must perform the procedure separately for the ClickForecast and ClickPlan resource files. Required Tools You should work on a computer that supports both English and the target language. You must have the following software installed: The Microsoft.NET Framework version 1.1 or 2.0. The Microsoft.NET Framework version 1.1 or 2.0 SDK. You can install the.net Framework and SDK independently, or as part of a Visual Studio installation.

40 34 Service Optimization Localization Guide The ClickForecast and ClickPlan client that you plan to localize, or a Service Optimization standalone installation. The client is required to display and edit the resource files. The client does not need to be connected to a Service Optimization server. The Service Optimization Administration tool. The tool must be connected to a Service Optimization server. The Service Optimization SDK. Folder Name In the following procedure, we refer to the Service Optimization SDK folder. The default location of the folder is: c:\program Files\ClickSoftware\SDK Executable Files Containing Resources The following table lists the DLL and EXE files that use the resources. By editing the resources, you can localize these executable files. Executable file Product Content of resources W6Logon.dll All Logon dialog and messages W6.ClientAPI.dll All General client dialogs and messages W6.Windows.Forms.dll All General client controls W6.ClickPlan.Forms.dll All General forms framework W6.ClickPlan.ClientUI.dll ClickPlan ClickPlan client user interface W6.ClickPlan.ActionsUI.dll ClickPlan Actions user interface W6.ClickPlan.AddOns.dll ClickPlan Add-ons user interface UIInfrastructure.dll ClickForecast General user interface dialogs Infrastructure.dll ClickForecast General strings CPFNavigationTree.dll ClickForecast Navigation tree control

41 Chapter 5. Localizing the ClickForecast and ClickPlan Clients 35 Executable file Product Content of resources CPFCommonControls.dll ClickForecast ClickForecast controls CPfDialogs.dll ClickForecast ClickForecast dialogs CPFGraphView.dll ClickForecast ClickForecast graph view CPFGridView.dll ClickForecast ClickForecast grid view CPfWizards.dll ClickForecast ClickForecast wizards CPfSpecificUIs.dll ClickForecast Interfaces of ClickForecast events ClickForecast.exe ClickForecast ClickForecast client user interface W6.ClickForecast.AddOns.dll ClickForecast ClickForecast add-ons user interface W6MessangerLib.dll ClickSchedule ClickSchedule client messaging W6LBSSchedulerWizard.dll ClickLocate Location-Based Schedule Wizard W6ContractorCapacityAddInLib. dll ClickSchedule Contractor capacity dialog W6StatusFlowAddInLib.dll ClickSchedule Modifying status transitions W6TimePhasedSkillsAddInLib.dl l CSUICustomControlsLib.dll W6ReportsClient.dll ClickMobileWAP.dll ClickSchedule ClickAnalyze Reporting ClickAnalyze Reporting ClickMobile WAP Edition Time-phased skills dialog Part of the reports addin The reports wizard addin ClickMobile WAP resources

42 36 Service Optimization Localization Guide Procedure The resource files are XML files with the *.resx extension. Initially, the XML is embedded in the executable DLL and EXE files. To localize the executable files, you must extract the *.resx files and edit them, as follows: 1. In the Service Optimization SDK directory, find the batch file called 1-ExtractResX.bat. The default file location is: c:\program Files\ClickSoftware\SDK\DotNetLocalization\ 1-ExtractResX.bat 2. From the above table, select one of the executable files (DLL or EXE) that you wish to localize. In the Windows Explorer, drag the executable file from the Service Optimization\Bin directory to 1-ExtractResX.bat. The batch file extracts the *.resx files from the executable file. It stores them in a subfolder of Service Optimization\Bin that is named for the executable file. For example, if you drag W6.ClickPlan.ActionsUI.dll to the batch file, the new subdirectory is called: Service Optimization\Bin\W6.ClickPlan.ActionsUI In addition to the *.resx files, the subfolder contains two batch files, which are called 2-EditResX.bat and 3-CompileSA.bat. You need these batch files to perform the subsequent steps. 3. Drag one of the *.resx files to the file 2-EditResX.bat. This opens the file in an appropriate editor, as follows: - Resource files contains forms and graphics are opened in the Microsoft Windows Resource Localization Editor (WinRes.exe). - Resource files contains strings are opened in the Resource Editor (ResEditor.exe).

43 Chapter 5. Localizing the ClickForecast and ClickPlan Clients 37 Windows Resource Localization Editor (for forms and graphics) Resource Editor (for strings)

44 38 Service Optimization Localization Guide 4. Edit the strings as required. Optionally, you can edit the size of the controls. This may be necessary if the strings in the target language are longer than in English. You can also edit the icons and bitmap images. If you are translating into a right-to-left language, such as Hebrew or Arabic, you should change the default direction of user-input controls such as text boxes. To do this, select the control. In the Properties windows, assign the following properties: Right To Left = Yes If you assign the Right To Left property of a form, all the controls within it are assigned automatically. 5. Save the file. You are prompted to specify the culture, which is a language name or a language-country combination. Assuming that you plan to create only a single version per language, we recommend that you select the language name alone, without the country. This lets you create a resource that works in all countries. When you click OK, the editor creates a new file, whose name has a culture suffix. For example, if you edited

45 Chapter 5. Localizing the ClickForecast and ClickPlan Clients 39 W6.ClickPlan.ActionsUI.DeleteNAsAction.resx and you selected the French culture, the new file has the name W6.ClickPlan.ActionsUI.DeleteNAsAction.fr.resx 6. Continue as above, editing all the *.resx files in the folder. 7. Returning to the Windows Explorer, run the file 3-CompileSA.bat, which is located in the same directory. At the prompt, enter the culture abbreviation, such as fr: 8. This compiles the set of *.resx files to a satellite assembly, which is a file having the.resources.dll suffix. The file is stored in a subfolder having the culture name. For example, if you compile the *.resx files in the W6.ClickPlan.ActionsUI folder, the satellite assembly is: fr\w6.clickplan.actionsui.resources.dll 9. Copy the complete set of satellite assemblies to the computers where you run the ClickPlan or ClickForecast client. Store the satellite assemblies in a folder called: Service Optimization\Bin\<culture_name> In the French example, the correct folder location is: Service Optimization\Bin\fr 10. On the client computers, confirm that the Windows user interface is set to the target language, and that the language support is properly configured in the Control Panel (see Chapter 2, Platform Language Configuration). 11. Open the ClickForecast or ClickPlan client. It should open in the language of the Windows user interface. Configuring the Client Settings You should use the Service Optimization Administration tool to localize the ClickPlan menus and various other settings.

46 40 Service Optimization Localization Guide Required Tools To configure the settings, you should work on a computer where the Service Optimization Administration tool is installed. The tool must be connected to a Service Optimization server. The computer must support both English and the target language (see Chapter 2, Platform Language Configuration). ClickForecast Settings The ClickForecast settings are displayed in the Administration tool under the category: Central Settings\ClickForecast On the Body XML tab, we recommend localizing the following elements of each measure. The elements are nested under: ClickForecast/MeasuresInfo/Measures/Measure The measure name (the Name element) The measure unit (MeasureInfo/MeasureUnit) The measure description (MeasureInfo/Description) Also translate the following elements, if they are defined. The measure names that you insert in these elements must match the measure names that you translated above. Under ClickForecast/MeasuresInfo/Measures/Measure/MeasureInfo/ Dependant, the measure names in the following elements: Independants/Measure Formula Decomposition/Independant Decomposition/Formula ClickForecast/MeasuresInfo/Measures/CounterMeasure/Name ClickForecast/DataSource/Sources/Source/SpecificSettings/ Measures/Measure/Name For further information about these settings, see the ClickForecast chapter of the Service Optimization Configuration Reference.

47 Chapter 5. Localizing the ClickForecast and ClickPlan Clients 41 Decimal Point in ClickForecast If ClickForecast displays an incorrect decimal point, open the Service Optimization Administrative tool, and edit the ClickForecast settings. Update the following elements in the XML settings window: ClickForecast/LogicServices/LogicDomains/LogicDomain/Parameters/ PredictByGrowth/MAPEThreshold ClickForecast/LogicServices/LogicDomains/LogicDomain/Parameters/ PredictByGrowth/SequentialWeight ClickForecast/LogicServices/LogicDomains/LogicDomain/Parameters/ PredictByGrowth/ImproveMAPE ClickForecast/ApplicationParams/ConfidenceLevel ClickForecast/ApplicationParams/OutlierThreshold

48 42 Service Optimization Localization Guide ClickPlan Settings To edit the ClickPlan settings: 1. In the left pane of the Service Optimization Administration tool, expand the tree to display: Central Settings/Clients User Settings/ClickPlan/ Administrative Settings 2. In the right pane, right-click and edit an administrative template, such as [Application]. Editing an administrative template changes the settings for all users whose user-defined settings are based on the template. If you have more than one template, you must edit all the templates of users who will use the target language. To avoid unnecessary editing, you can edit a single template. Then right-click the template and choose Duplicate to create additional templates. 3. On the General tab, select the distance units (miles or kilometers).

49 Chapter 5. Localizing the ClickForecast and ClickPlan Clients On the Menus tab, edit the display names of the menu commands. Do this by right-clicking a menu item and choosing Edit. Set the Name property of the command. (As usual in Windows menu programming, insert an & before the keyboard shortcut of the command.) 5. On the Toolbars tab, set the tool tips. The procedure is the same as for the menus. 6. On the Formats tab, set the date and time formats. For more information about the ClickPlan settings, see the Service Optimization Administrator's Guide and the Service Optimization Configuration Reference. Supporting Multiple Languages You can translate and compile the resource files into multiple languages. Install each set of localized DLLs into a folder with the appropriate culture name. You can switch a client between languages by setting the Regional and Language Options of the Windows Control Panel. For ClickPlan, you can create multiple administrative templates in different languages. Users whose settings are based on each template view the menus, etc., in the corresponding language.

50 44 Service Optimization Localization Guide Testing a Localized Version To test a localized version of ClickForecast or ClickPlan you should install and run it on the target language version of Windows. For example, if you localize to Chinese, you should test on Chinese Windows. Alternatively, you can use the following procedure to run on a version of Windows in English or another language. 1. Open a command prompt. 2. Start the desired Service Optimization application with the /uiculture flag. For example, to run ClickForecast in French, enter the command clickforecast.exe /uiculture:fr where fr is the language abbreviation. For a list of the abbreviations, search the Microsoft MSDN library for the CultureInfo class. Note: The /uiculture flag may not support some languages or subcultures. Refer to Microsoft documentation for a list of the languages that are supported by your Windows version. If you use this procedure frequently, you can create a shortcut that runs the command. Localizing Existing Data If required, you can localize an existing Service Optimization database containing ClickForecast and ClickPlan data. You can do this to localize a demonstration database or a database containing production data. The following paragraphs describe typical data that you can localize. For more information about the database structure, see the Service Optimization Database Reference. ClickForecast Data To localize existing ClickForecast data, do the following: 1. Update the column headings in the W6FORECAST_UNITS_MEASURES table with the localized measure names. The names must be identical to those in the ClickForecast settings. 2. Update the names of forecasts and forecast scenarios. You can do this either by working in the ClickForecast client or by editing the W6PLANS table of the database.

51 Chapter 5. Localizing the ClickForecast and ClickPlan Clients Update the names of business event types. You can do this either by using the Service Optimization Administration tool or by editing the W6BUSINESS_EVENT_TYPES table in the database. 4. Update the names of business event templates. You can do this either by working in the ClickForecast client or by editing the W6BUSINESS_EVENTS table of the database. In ClickPlan To localize existing ClickPlan data, do the following: 1. Update the names of plans and plan scenarios. You can do this either by working in the ClickPlan client or by editing the W6PLANS table of the database. 2. Localize the Plan Tuning Wizard Actions. In the Service Optimization Administration tool, edit the following node: Central Settings/ClickPlan/Plan Tuning Wizard Settings You can translate the names and some of the Specific Settings. 3. Localize the Auto Comments. In the Service Optimization Administration tool, edit the following node: Central Settings/Clients User Settings/ClickPlan/ Administrative Settings On the Add Ins tab, select the add-in and click Settings. The settings contain XML with templates for automatic comments. 4. Update the DemandID column in the W6PLAN_DEMANDS table of the database.

52

53 Chapter 6. Localizing the ClickRoster Client 47 CHAPTER 6 Localizing the ClickRoster Client The ClickRoster client is a Microsoft Silverlight application. The language resources are contained in a Silverlight package. Additional display strings are defined in the Service Optimization configuration settings. ClickSoftware supplies Silverlight packages in French, German, and Japanese. By using the out-of-the-box packages, you can simplify the localization procedure. For other languages, you must create a localized Silverlight package yourself. Localization Procedure For all languages, you must localize the configuration settings and perform certain other steps to enable the localized client. To prepare a working, localized version of the ClickRoster client, you must perform the following steps: 1. Obtain or prepare a localized Silverlight package for the ClickRoster client. The package is a *.xap file that replaces the default, English-language file. You can download Silverlight packages in French, German, and Japanese from the ClickSoftware website. For other languages, you must create the package yourself. For instructions, see Creating a Localized Silverlight Package below. 2. Install the localized Silverlight package in the ClickRoster client directory. 3. Localize the ClickRoster settings. 4. Link to the localized ClickRoster client using a URL that contains appropriate language parameters. The following paragraphs provide detailed instructions for steps 2 to 4. Installing a Localized Silverlight Package ClickSoftware supplies Microsoft Silverlight packages for the ClickRoster client in French, German, and Japanese. Each package is a Silverlight *.xap package file that replaces the default, English-language package.

54 48 Service Optimization Localization Guide If you do not have a localized Silverlight package, you can create one yourself. For instructions, see Creating a Localized Silverlight Package below. To install a localized Silverlight package: 1. On the Service Optimization server, find the existing English *.xap file: c:\program Files\ClickSoftware\Service Optimization\Web\ ClickRoster\ClientBin\W6.ClickRoster.xap 2. Replace it with the non-english *.xap file. Localizing the ClickRoster Settings The ClickRoster settings define many display strings. You can localize the strings in the same way as you can edit the strings in English. For instructions, see: The ClickRoster chapter of the Service Optimization Administrator's Guide The ClickRoster Configuration Guide Asian Languages Linking to a Localized Client In Asian languages such as Japanese, the ClickRoster client does not support rightclick context menus. You must delete all the actions from the context menus, define them in the main menu, and translate the display strings. In English, you can open the ClickRoster client by linking to: Optimization Server Host>/ClickRoster/Default.aspx In other languages, you must add parameters to this URL: To display the ClickRoster client in a non-english language, add a culture parameter. The parameter value is a language code such as fr, de, or ja. To enable user input in a non-english language, add a uiculture parameter. For Asian languages such as Japanese, add a mode=ime parameter. For example, to enable a French display and user input, link to: Optimization Server Host>/ClickRoster/ Default.aspx?culture=fr&uiculture=fr For German, link to:

55 Chapter 6. Localizing the ClickRoster Client 49 Optimization Server Host>/ClickRoster/ Default.aspx?culture=de&uiculture=de For Japanese, link to: Optimization Server Host>/ClickRoster/ Default.aspx?culture=ja&uiculture=ja&mode=ime Creating a Localized Silverlight Package Prerequisites If ClickSoftware does not supply a localized Silverlight package (*.xap file) for your language, create one by the following procedure. The procedure requires that you localize an English-language Microsoft Visual Studio solution, provided in the Service Optimization SDK directory: c:\program Files\ClickSoftware\Service Optimization\SDK\ ClickRoster\Localization You must then add the localized components to the existing English *.xap file. Throughout the procedure, we use Spanish (language code es) as an example. You should substitute your target language and language code. To create a localized Silverlight package, work on a computer that supports both English and the target language. You must have the following software installed: Service Optimization SDK Microsoft Visual Studio 2008 Creating a Build Configuration Microsoft Silverlight Tools for Developers. Install the Silverlight version that the ClickRoster client supports. For Asian languages, an editor such as Microsoft Word WinZip or Microsoft Compression. Do not use any other zip utility. In the SDK solution, you must create a build configuration for the target language: 1. In Visual Studio, click File > Open > Project/Solution, and open the main file of the solution:

56 50 Service Optimization Localization Guide Localization\W6.ClickRoster.Localization.sln 2. On the Visual Studio menu, click Build > Configuration Manager. 3. In the Active Solution Configuration option, select New. 4. Enter a configuration name such as Release - es. Copy settings from the original Release configuration. 5. Close the Configuration Manager. Adding Culture Support to the Solution Perform the following steps on each project in the solution: 1. In the Solution Explorer, right-click the project, and choose Unload Project. 2. In the Solution Explorer, right-click each project and choose Edit. This opens the project properties in an XML editor. 3. Find the PropertyGroup element for the configuration that you created. 4. Within the PropertyGroup, add a SupportedCultures element: <SupportedCultures>es</SupportedCultures> Creating Resource Files 5. Close the XML editor. 6. In the Solution Explorer, right-click the project and choose Reload Project. The solution contains three projects that have English resource files. You must create localized versions of the resource files. The English resource files have the following names:

57 Chapter 6. Localizing the ClickRoster Client 51 Project W6.ClickRoster.SharedResources W6.Web.ClientAPI W6.Web.FormEngine English Resource file W6CRResources.resx Resource.resx FormEditorResources.resx You must create localized copies of the resource files. Perform the following procedure on each project that has a resource file. 1. In the Solution Explorer, right-click the project and choose Add > New Item. 2. In the Add New Item window, select Resources File. 3. Enter a file name that is identical to the original resource file, with the addition of the language code: original_file_name.language_code.resx For example, if you are editing the W6.ClickRoster.SharedResources project, and the target language is Spanish, call the file W6CRResources.es.resx. 4. Click Add. The Solution Explorer displays the new resource file. 5. Copy the entire content of the original resource file to the new resource file. For example, copy the content of W6CRResources.resx to W6CRResources.es.resx. To copy the content: a. Double-click the original resource file. This opens the file in an editor window. b. Select and copy the entire content. c. Double-click the new resource file, opening it in an editor window. d. Paste the content. 6. In the Value column of the new resource file, translate the strings to the target language. Note: In most languages, you can use the Visual Studio editor to edit the resource file. In Asian languages, you must use an external editor such as Microsoft Word. 7. Save the edited solution.

58 52 Service Optimization Localization Guide Building the Solution You must build the solution, using the new build configuration that you defined. 1. On the Visual Studio toolbar, select the new build configuration, for example, Release-es. Preparing a New XAP File 2. On the menu, click Build > Build Solution. 3. Close Visual Studio. You must prepare a new Silverlight package (*.xap) file, containing the localized DLLs and other components: 1. On the Service Optimization server, find the English *.xap file of the ClickRoster client: c:\program Files\ClickSoftware\Service Optimization\Web\ ClickRoster\ClientBin\W6.ClickRoster.xap 2. Create a backup copy of the file. 3. Change the file name to W6.ClickRoster.zip. Note: Configure Windows to display file extensions. Otherwise, it is difficult to change the extensions correctly. 4. Expand the ZIP file to an empty directory called XAP Package. 5. Create a subdirectory whose name is the language symbol. In the Spanish example, create the following directory: XAP Package\es 6. From the solution folder, copy the following files to the subdirectory. From W6.ClickRoster.SharedResources\Bin\release-es\es, copy: W6.ClickRoster.SharedResources.resources.dll From W6.Web.ClientAPI\Bin\release-es\es, copy: W6.Web.ClientAPI.resources.dll

59 Chapter 6. Localizing the ClickRoster Client 53 From W6.Web.FormEngine\Bin\release-es\es, copy: W6.Web.FormEngine.resources.dll 7. In a text or XML editor, edit the file XAP Package\AppManifest.xaml. Add the following AssemblyPart elements to the subdirectory (substitute your language code for es): <AssemblyPart Source= es/w6.clickroster.sharedresources.resources.dll /> <AssemblyPart Source= es/w6.web.clientapi.resources.dll /> <AssemblyPart Source= es/w6.web.formengine.resources.dll /> 8. In the Windows Explorer, display the content of the XAP Package directory. 9. Select all the files and the subdirectory, and zip to file called W6.ClickRoster.zip. Do not select the XAP Package directory itself. Select only the content of the directory. 10. Change the file name to W6.ClickRoster.xap. 11. The *.xap file is now ready for use. Continue with the Localization Procedure at the beginning of this chapter.

60

61 Chapter 7. Additional Localization Issues 55 CHAPTER 7 Additional Localization Issues In addition to the client localization, there are several instructions and guidelines to complete the localization procedure. The most important of these are: Entering dictionary items in the target language Editing various display strings in the system configuration Both of these steps are performed in the Service Optimization Administration tool. This chapter provides instructions for these steps, as well as guidelines for several other localization issues. Localizing the Dictionaries and System Configuration The following sections explain how to localize the dictionaries and other display strings that are configured in the Service Optimization Administration tool. Note: The Administration tool is certified for non-english input only for the settings listed below, which are displayed in the clients and user interfaces. For all other strings that you define in the Administration tool, such as the names of logic service settings, you should use the English character set. Dictionaries Service Optimization uses dictionaries to define items such as: Country identifiers, regions, and districts Engineer skills Engineer and task types Tasks statuses The dictionary strings are displayed in many locations throughout the user interface. You should enter the dictionary strings in the target language.

62 56 Service Optimization Localization Guide System Configuration To edit the dictionaries, use the Service Optimization Administration tool. For instructions, see the Service Optimization Administrator's Guide. In the Service Optimization Administration tool, you can configure a large number of settings that influence the user-interface displays. In these settings, you should enter the display strings in the target language. Elsewhere in this book, we have explained how to use the Administration tool to localize settings such as: Dictionary items (see Dictionaries above). The display names of properties (see Configuring the Client Settings in Chapter 3, Localizing the ClickSchedule Windows Client). The following is a list of additional display strings that you can configure in the Administration tool: The names of rules, objectives, and business value functions (displayed in the logic options of the ClickSchedule and ClickPlan clients) The rule violation strings (displayed when a user attempts to create an illegal assignment) The names of logic domains (displayed in the logic options of the ClickSchedule Windows client). The names of metrics (displayed in the Scheduling Monitor window of the ClickSchedule Windows client). The time, distance, and speed units (used in various displays). The ClickMobile client properties settings, such as the display names of properties. There are also some numerical values that you can localize, such as: The currency units of business value functions. The units are used for displays of schedule metrics and in ClickAnalyze Insight. For instructions on editing these configurations, see the Service Optimization Configuration Reference.

63 Chapter 7. Additional Localization Issues 57 Supporting Multiple Languages You can connect clients that are localized in different languages to the same Service Optimization servers and database. A problem with this approach is that the database can store only a single copy of each dictionary. If the dictionary entries are in one of the languages, they may not be understandable to speakers of the other languages. To solve this problem, we suggest inserting all the languages in each dictionary entry, separated by a slash. For example, in a service organization that operates in France and Germany, the Region dictionary might contain the following two entries: France/Frankreich Allemagne/Deutschland For this to work, you must select a code page that supports both languages, on the Advanced tab of the Regional and Language Options (see Setting the Windows Regional Options in Chapter 2, Platform Language Configuration. Otherwise, there is no way to enter the bilingual strings in the Service Optimization Administration tool. A similar principle applies to rule names, rule violation strings, and other strings that you configure in the Service Optimization Administration tool, and which are displayed occasionally in the user interface. If a single database serves multiple languages, try to define display strings that all the users can understand. Miscellaneous Localizations Client Logons The following sections describe some additional Service Optimization components and data that you can localize. You can translate the client logon window. To do this, you should localize the following file: Service Optimization\Bin\W6Logon.dll The procedure is identical to that for Localizing the Resource Files in Chapter 5, Localizing the ClickForecast and ClickPlan Clients.

64 58 Service Optimization Localization Guide ClickAnalyze Insight and ClickAnalyze Reporting ClickAnalyze Insight and ClickAnalyze Reporting use Microsoft SQL Server Reporting Services to generate displays. To localize the displays, use the Reports Designer environment of Microsoft Visual Studio. For more information, see the Microsoft SQL Server documentation and the ClickAnalyze Developer's Guide. ClickSchedule Engineer Client ClickMobile You can localize the interface of the ClickSchedule Engineer Client. For instructions, see the ClickSchedule Engineer Client Developer's Guide. The ClickSchedule Engineer Client does not support East Asian languages. The localization procedure for ClickMobile involves editing the resources that are contained in a DLL file, as well as the client settings. DLL Localization To localize ClickMobile, you should localize the following files: For all ClickMobile clients: Service Optimization\W6.ClickMobile.Resources.dll

65 Chapter 7. Additional Localization Issues 59 ClickMobile WAP Edition For the ClickMobile client running on laptop computers: Service Optimization\W6.ClickMobile.PC.UI.dll For the ClickMobile client running on PDAs: Service Optimization\W6.ClickMobile.UI.dll The localization procedure is identical to that for Localizing the Resource Files in Chapter 5, Localizing the ClickForecast and ClickPlan Clients. Localizing the ClickMobile Settings To edit the ClickMobile settings: 1. In the left pane of the Service Optimization Administration tool, expand the tree to display: Central Settings/Clients User Settings/ClickMobile/ Administrative Settings 2. In the right pane, right-click and edit an administrative template. 3. Display the Properties tab and click the Edit button. Use the graphical Assignment Form Editor to localize the display. 4. Display the Main Form tab. Localize the display by selecting and overwriting the label text. For more information, see the ClickMobile chapter of the Service Optimization Configuration Reference. The localization procedure for ClickMobile WAP Edition involves editing the resources that are contained in a DLL file, as well as the client settings. DLL Localization To localize ClickMobile WAP Edition, you should process the following file: Service Optimization\Web\WAP\Bin\ClickMobileWAP.dll. The localization procedure is identical to that for Localizing the Resource Files in Chapter 5, Localizing the ClickForecast and ClickPlan Clients. Localizing the ClickMobile WAP Edition Settings To edit the ClickMobile WAP Edition settings: 1. In the left pane of the Service Optimization Administration tool, expand the tree to display:

66 60 Service Optimization Localization Guide Central Settings/Clients User Settings/ClickMobile/ WAP Edition Administrative Settings 2. In the right pane, right-click and edit an administrative template. 3. Select the Description Format tab. Go through the various forms listed in the Description Template drop-down list. Edit each display as required, translating the terms as required. Documentation SXP Encoding The Service Optimization user's guides and other documentation are written in Microsoft Word and published in the PDF and HTML Help formats. For information about localizing the documentation, please contact ClickSoftware Worldwide Support. Incoming SXP messages can be in any encoding supported by the Microsoft.NET Framework System.Xml library. The encoding should be specified in the XML header.

67 Chapter 7. Additional Localization Issues 61 The Service Optimization server sends SXP responses in the system code page. Likewise, the Service Optimization Integration Manager sends outgoing messages in the system code page. GIS Services Time Zone Support Custom Setup ClickSchedule integrates with GIS servers. When selecting a GIS server and dataset, pay attention to the following localization features: The GIS server should correctly geocode addresses that are written in your language and character set. The GIS server should display maps in your language. The GIS server should return narratives (driving directions) in your language. For detailed information, please consult with ClickSoftware Worldwide Support, and see the ClickSchedule GIS Configuration Guide. You should configure the system to support the time zones in your organization's service area. Be sure to enter the time zone names exactly as they are defined in the Windows version of the Service Optimization server (English or German). For details, see Time Zones in the ClickSchedule Developer's Guide. For a production installation, you can create a custom setup of the Service Optimization clients, including all the localized files. For advice on how to do this, please consult with ClickSoftware Worldwide Support. Updating an Existing Localization Project When you upgrade to a new Service Optimization version, you should update the localization project. The following is an update procedure for the ClickSchedule Windows client, the ClickForecast client, and the ClickPlan client. The procedures for other clients differ because the clients are based on different technologies.

68 62 Service Optimization Localization Guide Each release contains an up-to-date set of resource files, together with a list of the updates. You can merge the existing project with the new resource files. Be very careful when you do this, because inaccurate merging may cause the client to fail. 1. Back up your existing localized project to another folder location. 2. Obtain the new SDK from ClickSoftware, and install it. You must use the SDK version for the current release. 3. Copy the updates from the new, English resources into the corresponding locations in your existing, localized projects. For the ClickSchedule Windows client, you can do this by comparing the resource projects. For.NET resources such as those for ClickForecast and ClickPlan, use the SDK tools to extract the resources from the DLL files. For instructions, see the preceding chapters of this book. 4. Localize the updates. 5. Compile and install the updated resource DLLs.

69 Chapter 8. Known Limitations 63 CHAPTER 8 Known Limitations Administrative Tools This chapter lists the known limitations of the localization procedures. Although we have attempted to make the list as complete as possible, there may be other limitations that have been omitted. If you encounter difficulty localizing a particular user-interface element, please contact ClickSoftware Worldwide Support. The user interfaces of the Service Optimization Administration tool, Structure tool, and other administration and configuration tools do not support localization. You can use the Service Optimization Administration tool to enter dictionary items and other display strings in any language. Internal Property and Dictionary Names Server Messages Names that you define in the Service Optimization Structure tool, such as those of user-defined properties and dictionaries, must be in the English character set. This is required because the database server creates tables and columns using the names that you enter. You can localize the display versions of the property names in the Service Optimization Administration tool (see Configuring the Client Settings in Chapter 3, Localizing the ClickSchedule Windows Client). With the exception of status transition messages, the localization of error and information messages generated by the Service Optimization server is not supported. The primary display location of the messages is in the Windows application event log. Occasionally, a server message may be displayed in a client application. The clients provide their own messages, which you can localize, for the most frequent and important messages.

70 64 Service Optimization Localization Guide Specific Languages Right-to-Left Languages East Asian Languages This section lists some limitations on localization to certain languages or classes of languages. The overall layout of the user interface is from left to right (LTR). For example, the ClickSchedule navigation tree and engineer's Gantt chart run from left to right. Although you can translate the interface into right-to-left (RTL) languages such as Hebrew and Arabic, it is not possible to reverse the entire layout from right to left. When you edit the resource files, you should change the default direction of the user-interface controls, such as text boxes, to RTL. Some of the controls do not support the direction property, however. In particular, if you use the Dialog Editor to create forms for the ClickSchedule Windows client, you cannot change the default direction of the text boxes to RTL. The user can change the direction when typing in a text box by pressing Ctrl together with the Shift button on the right side of the keyboard. Visual Studio does not let you edit resource-files in double-byte character sets. In East Asian languages such as Chinese and Japanese, you must edit the resource files in an editor such as Microsoft Word. You can then compile the files in Visual Studio. In many of the date/time controls used throughout the system, the English interface lets the user type a date or time, or to select the value from a drop-down display. In East Asian languages, the typing option does not work. The user must select from the drop-down display. The ClickSchedule Engineer Client does not support the East Asian languages. ClickSchedule User-Interface Elements Date and Time Controls This section lists some limitations on localizing specific controls and user-interface elements in the ClickSchedule Windows client. In the calendar date controls, the word Today cannot be translated.

71 Chapter 8. Known Limitations 65 In some time and duration controls, the date or time units may be displayed in English, and not in the target language. Color Palettes In the Tools > Options command of the ClickSchedule Windows client, the Scheduling Monitor tab displays color palettes. In these palettes, the word Other cannot be translated. Customize Window In the View > Customize command of the ClickSchedule Windows client, the Menu tab displays a Menu Animations drop-down list. The drop-down cannot be translated to East Asian languages.