IBM Maximo Asset Management

Transcription

1 IBM Maximo Asset Management Version 7 Report Localization Guide Copyright International Business Machines 2012 V7 Report Localization Guide_rev2.doc 6/7/2012 1

2 Overview...3 Components of Report Localization Report Description displayed in V7 Maximo Session Report Request Page displayed in V7 Maximo Session...5 How Request Page text is localized Report Titles/Labels displayed in the Report...7 How Report Titles/Labels displayed in the Report are localized Report Data displayed in the Report...10 Report Development How to enable report data for localization...11 Localization Setup...12 User Profile...12 Report Request Pages...13 Overview of report localization within User s Browser Session...15 Localization of Delivered Reports...16 Enabling Custom reports for Localization...17 Scenario 1: Add new fields to an existing delivered report...18 Scenario 2: Enabling New Custom Report for Localization Using the TD Toolkit for reports Importing and Exporting Custom Reports...39 Key Localization Considerations Important steps to follow whenever you add a new report Accessing a single report design from multiple applications Hot fix or fix pack upgrades Localization and QBR Reports Additional Report Reference Materials...43 Revision History...44 Trademarks V7 Report Localization Guide_rev2.doc 6/7/2012 2

3 Overview To respond to today s dynamic Business Environment critical business information needs to be immediately available. This business information can come in a variety of formats, and is often required as a report either a formatted business report, known as an Enterprise report, or an Ad Hoc report which is created on the fly by users. IBM Maximo includes an Open Reporting Architecture, which enables you a number of different reporting options to choose from. The embedded reporting tool in the Maximo Version 7x (V7) releases is BIRT, Business Intelligence and Reporting. As the embedded reporting tool, it enables the deepest levels of integrations throughout the various Maximo applications. This guide details the report localization features. This includes the details of how localization is enabled, key user setup requirements, and features developers must enable to insure reports localization properly. Additionally, as many of you have custom report requirements, two detailed use cases will be presented to show how you can localize your custom reports. Throughout the guide, references to other report support documentation will be made for you. Details on how you can reference these guides are contained at the end of this document. Additionally, a sample example environment will be referenced throughout this guide. This sample environment utilizes English as its base language, which has two secondary languages of Spanish and Italian. *Note: This document applies only to the embedded report tool in the Maximo Base Services 7x (V7) Releases. V7 Report Localization Guide_rev2.doc 6/7/2012 3

4 Components of Report Localization To enable report localization, a number of reporting components must be enabled for localization in both the V7 Maximo browser session and in the separate report session. These include: 1. Report Description displayed in V7 Maximo Session 2. Report Request Page displayed in V7 Maximo Session 3. Report Titles/Labels displayed in the Report 4. Report Data displayed in the Report 1. Report Description displayed in V7 Maximo Session When you select Run Report from the Action Menu or an Application, from the Reports Menu, or mouse over a report icon in the application s toolbar, a report description displays. This report description comes from the database field REPORT.DESCRIPTION. It is enabled for localization thru the L_REPORT database table. V7 Report Localization Guide_rev2.doc 6/7/2012 4

5 2. Report Request Page displayed in V7 Maximo Session After you select an individual report to run, the report s request page appears. If the report is a parameterized report, where individual report parameters to display for the user to enter values, these parameter values are also enabled for localization. The base parameter values come from the REPORTLOOKUP database tables, and their corresponding localized values come from L_REPORTLOOKUP. An example of the parameter section of a report request page with 8 individual parameter values that are enabled for localization is shown here. V7 Report Localization Guide_rev2.doc 6/7/2012 5

6 How Request Page text is localized Request Pages contain both static and dynamic content. Static content includes text on subheaders like Parameters and Schedule Choices. Dynamic Content includes the variable parameter text. Localization of Request Page Static Content When you generate the report xml in the setup steps described above, text from the MAXMESSAGES table is used to populate the MAXLABELS table. Once this is complete, and the report presentation library is generated, the static text for the request page comes from the MAXLABELS table. When you have multiple languages, when you generate the report xml from the Report Administration application, the process takes the localized messages from the L_MAXMESSAGES table and populates the L_MAXLABELS with the static content. Localization of Request Page Dynamic Content When you generate the report xml in the setup steps described above, text from the REPORTLOOKUP table is used to populate the MAXLABELS table. Once this is complete, and the report presentation library is generated, the static text for the request page comes from the MAXLABELS table. When you have multiple languages, when you generate the report xml from the Report Administration application, the process takes the localized messages from the L_REPORTLOOKUP table and populates the L_MAXLABELS with the static content. The table below summarizes where the text comes from for the Report Request Page Base Language Secondary Languages Request Page Static Content displayed from... MAXLABELS L_MAXLABELS Request Page Dynamic Content displayed from MAXLABELS L_MAXLABELS V7 Report Localization Guide_rev2.doc 6/7/2012 6

7 3. Report Titles/Labels displayed in the Report After clicking Submit on the report s request page, or submitting a report request thru a report toolbar icon or action, the report displays in a separate report browser session. Each of the report s text values, including its labels and title are enabled for localization. An example of these text values is shown below with an example Details of Asset Failures report. The base report label values come from the REPORTLABEL database table, and their corresponding localized values come from the L_REPORTLABEL database table. V7 Report Localization Guide_rev2.doc 6/7/2012 7

8 How Report Titles/Labels displayed in the Report are localized To enable report titles and labels to display the correct text for the specific user s locale, functionality is added to each label and title in its report design file. Each report label and title is assigned a label key, which is a unique text value of the control, and a label value. The key and the value are stored in a separate properties file, which is also known as a resource file. This work is done by the developer while he creates the report in the report designer tool. Property files are application specific meaning there is a properties file for each application having reports. This enables common labels to be used by multiple reports. The property files are located in <V7>\reports\birt\libraries When you import the report, the keys and values are uploaded from the properties file to the REPORTLABEL database table. V7 Report Localization Guide_rev2.doc 6/7/2012 8

9 To illustrate this process, an example report is shown below, which is the Report Usage Report, reportusage.rptdesign. Two labels are circled User and Success. These two label values are stored in the REPORTLABEL table shown below. If you are using a language other than English, or enabling multiple languages, corresponding localized label values are held within the L_REPORTLABEL table. Multiple values for the same value can be stored in the L_REPORTLABEL table, one for each language. The combination of the REPORTLABELID and Language Code make the label value unique. L_REPORTLABEL.REPORTLABELID L_REPORTLABEL.LANGCODE L_REPORTLABEL.LABELVALUE ES mi primer informe FR mon premier rapport ES fecha FR date V7 Report Localization Guide_rev2.doc 6/7/2012 9

10 4. Report Data displayed in the Report In addition to the report title and labels, some reports also enable report data to be localized. The most common example of this is the description field of a record. The report below shows two description values which could be enabled for localization. The base description value would come from the base table, for example, ASSET.DESCRIPTION, and its corresponding localized value would come from L_ASSET database table. Note: In order for a database field to be enabled for Multilanguage text, its field within the report design file must be updated to include the functionality. V7 Report Localization Guide_rev2.doc 6/7/

11 Report Development How to enable report data for localization You can enable the data within a report to be enabled for localization, thru the use of the runtime data translation. Runtime Data Translation, based on the user s language, is enabled by calling a method for every data set column to be translated. To enable this, open the individual report design file in the Report Design Tool. Next, update your report query to include the Unique Id (UID) column(s) from the table(s) containing the translated field(s). You do not have to create output columns for these fields. At the end of the data set Open method, call the method below to enable this. Note: The arguments are case-insensitive: registerdatatranslation(querycolumn, queryuidcolumn, mboname, mboattributename) querycolumn: the field in the query to be translated queryuidcolumn: the unique ID field in the query from the table containing the translated field mboname: the maxattribute objectname for the translated attribute mboattributename: the maxattribute attributename for the translated attribute You can review an example of how the runtime data translation is enabled in the delivered report, Job Plan List, jobplan.rptdesign. This is enabled on its description field, which is shown here below: V7 Report Localization Guide_rev2.doc 6/7/

12 Localization Setup If you have a multi language environment, you must follow the two setup steps below to enable reports for localization. User Profile 1. First, you must set the language and the locale for the user. You can define this in the User application, or in the User s Language section of the Default Information page shown below. V7 Report Localization Guide_rev2.doc 6/7/

13 Report Request Pages Next, the report request pages need to be generated in the Report Administration application for each of the different languages enabled in the environment. Using the example environment where the base language is English, with secondary languages of Spanish and Italian, the following steps would be performed as detailed and shown in the diagram below. 1. The administrator signs into the V7 environment, and confirms his locale is set to English. 2. The administrator then accesses the Report Administration application, and on its List Tab, generates the request pages for ALL reports in English. 3. Then, the administrator changes his locale to Spanish, and signs out of the V7 environment. 4. Next, the administrator signs back in to V7 so the new Spanish Locale can take effect. He then accesses the Report Administration application, and on its List Tab, generates the request pages for ALL reports in Spanish. 5. Then, the administrator changes his locale to Italian, and signs out of the V7 environment. 6. He then signs back in to V7 so the new Italian Locale can take effect. He then accesses the Report Administration application, and on its List Tab, generates the request pages for ALL reports in Italian. The request pages are then available in all three languages - English, Spanish and Italian. V7 Report Localization Guide_rev2.doc 6/7/

14 Note: When generating the Report Request Pages for the different languages, you must generate it on the List Tab of the Report Administration application via the Generate Request Pages. If you do not generate it via this method, your report request pages will be corrupt. V7 Report Localization Guide_rev2.doc 6/7/

15 Overview of report localization within User s Browser Session After enabling the report localization setup steps, the report text values are retrieved by comparing the user s locale to the System s Base Language MAXVAR Setting. If the user s locale is the same as the setting, report data is retrieved from the Base Report Language tables. If the user s locale is different than the setting, report data is retrieved from the localized report language tables. This is shown below using the example of a user accessing the Job Plan List Report. V7 Report Localization Guide_rev2.doc 6/7/

16 Localization of Delivered Reports Each of the delivered reports in V7 has been enabled for localization for you. When you install V7, the various components of the installation process, including executing maxinst and calling the TD Toolkit, enable the localized text values for the report, including its description, parameter and label values. This is shown at a very top level in the diagram below. Additional information on the Installation Process and the use of the TD Toolkit can be found in the documents referenced at the end of this guide. Report Source <V7>\reports\birt RPT Design Files Libraries Property Files 1. Run maxinst.bat Creates Report Text Database Entries REPORT REPORTLOOKUP REPORTLABEL For Localization Only Call TD Toolkit 2. Deploy Maximo Ear File Loads Localized Table Data L_MAXLABELS... L_REPORTLOOKUP, L_REPORTLABEL Extracts Localized Property Files ASSET_FR.properties, JOBPLAN_FR.properties Initializes BIRT Report Engine Creates Report Design Database Entries REPORTDESIGN REPORTDEPEND REPORTPARAM Updates any Changes to REPORT REPORTLOOKUP REPORTLABEL 3. Generate XML in V7 Report Admin Application Creates Report Request Pages REPLIBRARY Presentation in Database V7 Report Localization Guide_rev2.doc 6/7/

17 Enabling Custom reports for Localization You may either create new custom reports, or modify the delivered reports to include additional fields. In either case, you need to enable the additional fields or reports for localized text values. Details in how you can do this are described in the two scenarios below. Notes: 1. For best practices on custom reports, and their corresponding.rptdesign, xml and properties file, reference the V75 Report Development or Report Features Guide. The specific section is called Your Custom Reports and the Report File Structure. This information can also be found at: 2. Before performing the steps, confirm that you have a supported version of JDK on your machine. A JDK version is required as it contains the native2ascii tool required for the localization of the property files. V7 Report Localization Guide_rev2.doc 6/7/

18 Scenario 1: Add new fields to an existing delivered report In this first scenario, the delivered Job Plan List Report shown below will be updated to include an additional field, Supervisor. Whenever you modify or create a new report file in the V7 environment, the best practice recommendation is for you to always retain the original, delivered file and make your customizations to a copy of the original file. * This best practice recommendation is followed in the example below, where the original Job Plan List report, is copied and then renamed for unique file identification. Follow the 6 steps below to enable this new value to display in the multi language environments. 1. Copy, Update Report Design File 2. Copy, Update and Zip Base Property File a. Copy, Update and Zip Spanish Property File b. Copy, Update and Zip Italian Property File 3. Copy, Update Report XML file 4. In Base English Language, Import New Files. Recreate All Report XML. 5. In Secondary Spanish Language, Import New Files. Recreate All Report XML. 6. In Secondary Italian Language, Import New Files. Recreate All Report XML. * For best practice recommendations on customizing report files, reference the V7 or V75 Report Feature Guide. The specific section is called Your Custom Reports and the Report File Structure. This information can also be found at: V7 Report Localization Guide_rev2.doc 6/7/

19 The first three steps of this process are detailed here: 1. Access the Report Design Tool. Open up the Job Plan list report, and assign it a unique file name. In this case, it was renamed to jobplan_abc.rptdesign (_abc is the unique identifier added to the file name.) Save this report to your existing report file directory, <V7>reports\birt\reports\JOBPLAN. Next, add the new Supervisor field to the report design file and save. 2. After adding the field to the design file, you need to evaluate how you are going to manage your properties files. When you modify reports, or create custom reports, you can choose to either modify the existing properties file for the application, or create your own new properties file. To determine the solution that is best for your environment, you may want to take the following into consideration - A single report design can only reference a single properties file. In this example, this means that you can t use the existing jobplan.properties file for the existing labels in your jobplan_abc.rptdesign file and also a new jobplan_abc.properties file for the single new supervisor field value. - Applications can utilize multiple properties file. During the command import process, all properties file for the application will be imported. - Report titles, labels may be modified during release, fix pack or hot fix updates. Therefore, if you modify the delivered properties file with your customizations, your updates may be overridden during an update V7 Report Localization Guide_rev2.doc 6/7/

20 2A. Since this is a copy of an existing delivered report, a properties file already exists for it. You can see this by navigating to the Outline View, and clicking on the Resources Section of the Property Editor. Notice its Resources, or property file, is joplan.properties. This file is located in <V7>\reports\birt\libraries. V7 Report Localization Guide_rev2.doc 6/7/

21 2B. This example will show you how you can manage all aspects of your custom reports by creating your own custom jobplan properties file. To do this, navigate to the directory of your libraries, and make a copy of the jobplan.properties file. Update the file name of the copy to a unique name. 2C. Go back to the Report Design tool, and change the properties (resource) file to the one you just created. In this example, the copied and renamed file is jobplan_abc.properties. V7 Report Localization Guide_rev2.doc 6/7/

22 2D. You will then add a new value within the jobplan_abc.properties file for the Supervisor field. Highlight the supervisor text label and click on the Localization Section of the Properties Tab. Notice the text key value is blank. Click on the 3 button icon to access the values within the property file Then, you will either select an existing key and value pair, or enter a new value. In this case, a new label is added as highlighted by the red arrow by entering a Key (jobplan_supervisor) and Value (Supervisor). Then you click Add, and then OK to complete the association. V7 Report Localization Guide_rev2.doc 6/7/

23 2E. Next, save the report. You now have a new design file, jobplan_abc.rptdesign, and a new properties file with the new supervisor field value, jobplan_abc.properties. To enable the new property value to be available in the secondary languages of Spanish and Italian, you can use one of the options below: 1. Use the TD Toolkit to enable the localized values for the secondary languages* 2. Manually update the existing properties file You may want to use the manual method for small amount of text changes, and the TD Toolkit for larger amounts of text. Instructions on using the TD Toolkit are detailed in later sections of this guide. 2F. To manually update the files, first locate the Spanish and Italian jobplan property files. Because this is an existing report, the Spanish and Italian property files already exist as shown below with their language codes appended to the base property name. Following the same process as above, copy each of these two files, and rename the copied file with a unique value, like jobplan_abc_es1.properties and jobplan_abc_it1.properties. 2G. Localize the new Supervisor text value in the Spanish, jobplan_abc_es1.properties and Italian, jobplan_abc_it1.properties files. When complete, save the updated file in the language s proper encoding type. (For example, a Spanish property file could be saved in ANSI, whereas a Japanese property file would need to be saved in Japanese encoding) V7 Report Localization Guide_rev2.doc 6/7/

24 2H. Next, insure that the regional settings for the language is property enabled before updating its property file. To do this, access the Regional and Language Options on your computer, and make sure the applicable language is enabled. 2I. Next, the text values need to be enabled in Unicode so they can be imported and used within the V7 applications. To do this, open a command prompt. Navigate to the directory of your localized property file Specify its property file name (ex. Jobplan_abc_es1.properties) Input a Redirect with the native2ascii command Followed by the new property file name (ex. Jobplan_abc_es.properties) The complete command would be something like this C:\local\builds\7118\reports\birt\libraries > jobplan_abc_es1.properties > native2ascii jobplan_abc_es.properties V7 Report Localization Guide_rev2.doc 6/7/

25 After completing this, you will have 2 files as shown below. The initial version, jobplan_abc_es1.properties, contains the localized text values. And the final, updated version, jobplan_abc_es.properties, is the one you have enabled for Unicode, and you will import. *Note: The localized text values in the updated property file are now illegible as shown below. 2J. Then, zip each of the 3 files so they can be imported as resource files. Note: Property files containing the text values of the report labels and titles are resource files. You must zip resource files if you will be importing them thru the Report Administration application V7 Report Localization Guide_rev2.doc 6/7/

26 3. The third component of a report is the reports.xml file. Because you have created a new custom report with a unique file name, it is advised that you also create a unique reports.xml file so the report will automatically be imported for you during any future fix pack or release updates. If you do not create a unique reports.xml file for the new report, the report can only be imported thru the Report Administration application. To create your unique reports.xml file, navigate to the location of the existing Jobplan report directory, located in <V7>\reports\birt\reports\JOBPLAN. Make a copy of the existing file, and rename it to something unique like reports_abc.xml Open the newly created file, reports_abc.xml. Update the Jobplan report for your new file name, including the properties file. Remove the other job plan report entries you have not modified, and save. For additional information on creating reports.xml files, you can review the content in the V7 Report Developers Guide available in the report reference materials noted at the end of the guide. V7 Report Localization Guide_rev2.doc 6/7/

27 Now that you have the three components of the modified report available design file, properties file and xml file you are now ready to import the report into the V7 database. In this use case, because you have created a new report, in addition to importing the report and property file, you will also generate the entire report xml so the new report s request page will properly display. You can import the files by using the Import Command Utility, or from the Report Administration application, but you must regenerate the report xml in the Report Administration application. The steps below will detail this process by performing both steps import and report xml creation - using the report administration application. This is shown in the steps 4, 5 and 6 in the diagram, and detailed below. V7 Report Localization Guide_rev2.doc 6/7/

28 4. First, you log into Maximo as the administrator. Confirm that his language is set to the base language, English. A. Next, access the Report Administration application and register the new report. B. From the action menu, select Import Report. Navigate to the location of the report and its zipped property file. This will import the design file in the V7 database, and also the property values for the report in the REPORTLOOKUP table for the base language, English. *Note: Property files containing the text values of the report labels and titles are resource files. Resource files must be.zip files, so you must first zip the new asset_abc property file before importing it as highlighted by the red arrow below. C. You then go to the List tab of the Report Administration application, clear any queries, and make sure all reports display. Then, generate the request pages for ALL reports in English by clicking on the Generate Request Pages button. D. To complete this step, you next change the administrator s locale to Spanish, and sign out of the V7 environment. V7 Report Localization Guide_rev2.doc 6/7/

29 5. Next, the administrator signs back in to V7 so the new Spanish Locale can take effect. You then access the Report Administration application, and navigate to the jobplan_abc.rptdesign file. From the action menu, select Import Report. Navigate to the location of the report and its zipped Spanish property file, jobplan_abc_es.zip. This will import the design file in the V7 database, and also the property values for the report in the L_REPORTLOOKUP table for the secondary language, Spanish. After importing the report and the Spanish property file, you then go to the List tab of the Report Administration application, clear any queries, and make sure all reports display. Then, generate the request pages for ALL reports in Spanish by clicking on the Generate Request Pages button. To complete this step, you next change the administrator s locale to Italian, and sign out of the V7 environment. 6. Next, the administrator signs back in to V7 so the new Italian Locale can take effect. You then access the Report Administration application, and navigate to the jobplan_abc.rptdesign file. From the action menu, select Import Report. Navigate to the location of the report and its zipped Italian property file, jobplan_abc_it.zip. This will import the design file in the V7 database, and also the property values for the report in the L_REPORTLOOKUP table for the secondary language, Italian. After importing the report and the Italian property file, you then go to the List tab of the Report Administration application, clear any queries, and make sure all reports display. Then, generate the request pages for ALL reports in Italian by clicking on the Generate Request Pages button. To complete this step, you next change the administrator s locale to back to the base of English, and sign out of the V7 environment. V7 Report Localization Guide_rev2.doc 6/7/

30 Scenario 2: Enabling New Custom Report for Localization In this second scenario, you create a new custom report. The example that will be used is an Aging Asset report. Creating a new report for enablement in a multi language environment will follow the same 6 steps below described above where you modified a delivered report which are 1. Create Report Design File 2. Create and Zip Base Property File a. Copy, Create, Modify and Zip Spanish Property File b. Copy, Create, Modify and Zip Italian Property File 3. Create, Update Report XML file 4. In Base English Language, Import New Files. Recreate All Report XML. 5. In Secondary Spanish Language, Import New Files. Recreate All Report XML. 6. In Secondary Italian Language, Import New Files. Recreate All Report XML. V7 Report Localization Guide_rev2.doc 6/7/

31 1. First, you develop and save the custom report design file. In this example, the file is identified as asset_aging. rptdesign. 2. After creating and saving the design file, the next step is to define properties values for the report title, subheader labels and field labels. Because this is a new report, there is no properties file associated with it. Therefore, your first step will be to associate the report with the label properties file. In the Outline tab, highlight the report name. In Property Editor - Properties, select Resources. In the Resource File Field, click on the Add Button and add a unique properties file for the application the report will be accessed from. * *For best practice recommendations on creating custom report files, reference the V7 or V75 Report Feature Guide. The specific section is called Your Custom Reports and the Report File Structure. This information can also be found at: V7 Report Localization Guide_rev2.doc 6/7/

32 2A. Then, for each report title, subheader and field label, you will associate a label key and pair value by entering values for each one. You do this by highlighting each text label and click on the Localization Section of the Properties Tab. The example below shows a new value added for the field asset. C. Next, save the report. You now have a new design file and property file. To enable the new property value to be available in the secondary languages of Spanish and Italian, you can use one of the options below: 7. Use the TD Toolkit to enable the localized values for the secondary languages* 8. Manually update the existing properties file Because this example involves adding a few new fields, the steps below show how you can manually update the properties files. However, if you would like to use the TD Toolkit, instructions in using that are contained below. D. First, create new Spanish and Italian asset_abc property files via a copy/paste of the base property file, and then appending the new property files with the language code to make them unique and identifiable. *Reference information on using the TD Toolkit at the end of this guide. V7 Report Localization Guide_rev2.doc 6/7/

33 E. Then, follow the property file localization steps detailed in the pages above in steps 2G thru 2J. This will produce a Spanish and Italian properties file, asset_abc_it.properties and asset_abc_es.properties. F. After updating and saving the files, zip each file so it can be imported as a resource file. Note: Property files containing the text values of the report labels and titles are resource files. Resource files must be.zip files, so you must first zip the new job plan property file before importing it as highlighted by the red arrow below. V7 Report Localization Guide_rev2.doc 6/7/

34 3. The third component of a report is the reports.xml file. Because you have created a new custom report with a unique file name, it is advised that you also create a unique reports.xml file so the report will automatically be imported for you during any future fix pack or release updates. If you do not create a unique reports.xml file for the new report, the report can only be imported thru the Report Administration application. The steps to create your unique reports.xml file are the same as noted in the previous example on page 24. In this case, you will navigate to the location of the existing Asset report directory, located in <V7>\reports\birt\reports\ASSET. You will then make a copy of the existing file, and rename it to something unique like reports_abc.xml Then, you will open the newly created file, reports_abc.xml, and update it for your new file name, including the properties file. Remove the other asset report entries and save. For additional information on creating reports.xml files, you can review the content in the V7 Report Developers Guide referenced at the end of this document. V7 Report Localization Guide_rev2.doc 6/7/

35 Now that you have the three components of the custom report available design file, properties file and xml file you are now ready to import the report into the V7 database. In this use case, because this is a new report, in addition to importing the report and property file, you will also generate the entire report xml so the new report s request page will properly display. You can import the files by using the Import Command Utility, or from the Report Administration application, but you must regenerate the report xml in the Report Administration application. The steps below will detail this process by performing both steps import and report xml creation - using the report administration application. This is shown in the steps 4, 5 and 6 in the diagram, and detailed below. V7 Report Localization Guide_rev2.doc 6/7/

36 4. First, you log into Maximo as the administrator. Confirm that his language is set to the base language, English. A. Next, access the Report Administration application and register the new report. B. From the action menu, select Import Report. Navigate to the location of the report and its zipped property file. This will import the design file in the V7 database, and also the property values for the report in the REPORTLOOKUP table for the base language, English. *Note: Property files containing the text values of the report labels and titles are resource files. Resource files must be.zip files, so you must first zip the new asset_abc property file before importing it as highlighted by the red arrow below. V7 Report Localization Guide_rev2.doc 6/7/

37 C. You then go to the List tab of the Report Administration application, clear any queries, and make sure all reports display. Then, generate the request pages for ALL reports in English by clicking on the Generate Request Pages button. D. To complete this step, you next change the administrator s locale to Spanish, and sign out of the V7 environment. 5. Next, the administrator signs back in to V7 so the new Spanish Locale can take effect. You then access the Report Administration application, and navigate to the asset_aging.rptdesign file. From the action menu, select Import Report. Navigate to the location of the report and its zipped Spanish property file, asset_abc_es.zip. This will import the design file in the V7 database, and also the property values for the report in the L_REPORTLOOKUP table for the secondary language, Spanish. After importing the report and the Spanish property file, you then go to the List tab of the Report Administration application, clear any queries, and make sure all reports display. Then, generate the request pages for ALL reports in Spanish by clicking on the Generate Request Pages button. To complete this step, you next change the administrator s locale to Italian, and sign out of the V7 environment. 6. Next, the administrator signs back in to V7 so the new Italian Locale can take effect. You then access the Report Administration application, and navigate to the asset_aging.rptdesign file. From the action menu, select Import Report. Navigate to the location of the report and its zipped Italian property file, asset_abc_it.zip. This will import the design file in the V7 database, and also the property values for the report in the L_REPORTLOOKUP table for the secondary language, Italian. After importing the report and the Italian property file, you then go to the List tab of the Report Administration application, clear any queries, and make sure all reports display. Then, generate the request pages for ALL reports in Italian by clicking on the Generate Request Pages button. To complete this step, you next change the administrator s locale to back to the base of English, and sign out of the V7 environment. V7 Report Localization Guide_rev2.doc 6/7/

38 Using the TD Toolkit for reports You can use the Translation Data Toolkit (TD Toolkit) to extract translatable data from the Maximo database. The TD Toolkit is a V7 utility provided to you. When you use the TD Toolkit, you perform three main steps: 1. Export the translatable data from the V7 database. This produces a XLIFF output file. *Note: You may have already have the exported XLIFF files available if you had previously used the TDToolkit for localizing other maximo application fields which you may have added or customized. 2. Locate and then localize the specific report labels by updating the text values within the exported XLIFF file for the secondary languages of both Spanish and Italian. 3. Import the updated XLIFF files back into the V7 database. When you export, locate and localize, and then import the updated XLIFF files, you will have enabled the report label to be available in the base English, along with the secondary languages of Spanish and Italian. Notes: A. Utilizing the TD Toolkit is recommended when you have a large number of report labels or titles to localize. Additional details on using the TD Toolkit are contained within the System Administrators Guide, in the Appendix Titled Configuring the System with Multiple Languages. Information on accessing this guide is contained at the end of this guide. V7 Report Localization Guide_rev2.doc 6/7/

39 Importing and Exporting Custom Reports Importing and Exporting reports are the processes used to add or extract report files from the report repository, which is the V7 database. These report files can include the report designs, property and library files. The importing process, which adds new or updated reports, can be done thru the Report Administration application in V7, or thru a command utility. The exporting process, which extracts reports, is done only thru a command utility. When you import and export reports, the locale of the person performing these actions, determines what file content is updated or received. This occurs whether using the command utility or in the Report Administration application. Using our sample environment, which has a base language of English, and secondary languages of Spanish and Italian, the outcomes of the importing and exporting operations is described below. When your administrator has his locale set to English, and imports an asset report thru the Import Command Utility, the English Property file is imported only. When your administrator has his locale set to English, and exports a job plan report thru the Export Command Utility, the English Property file is exported only. When your administrator has his locale set to Spanish, and exports a job plan report thru the Export Command Utility, the Spanish property file will be exported. It will overwrite the base language property file, as it does not add _es to the property file name.. Exporting All Language property files If you have a multiple language environment, and you want to export all property files, you should use the writereportprop command utility. The writereportprop command utility is located in <V7>\tools\maximo and it exports all non-english property files that you may have in your system. After executing the utility, a log file detailing the results is located in <V7>\tools\maximo\log, and the properties files will be located in the export file location you defined in your reporttools.properties file. V7 Report Localization Guide_rev2.doc 6/7/

40 Importing and Exporting Notes: 1. If you are only going to import and export your reports thru the command utilities, you do not need to zip the properties file. You only need to zip the properties file if you are importing them thru the Report Administration application. 2. More details on the importing and exporting commands are located in the V7 and V75 Feature Guide, and also the V7 and V75 Report Developer s Guide. V7 Report Localization Guide_rev2.doc 6/7/

41 Key Localization Considerations 1. Important steps to follow whenever you add a new report If you have a multi language environment, whenever any new report is added, the report xml needs to be generated in each of the languages - for ALL reports. If the report xml is only generated for the single, new report in each of the languages, problems will result. To do this, access the Report Administration application. Then, you must generate xml for ALL reports on the List Tab of the application - when all records are displayed - and no application queries or filters are applied. In the sample environment used in this document, the administrator would first regenerate the report xml for all reports in the base English language. - Then, he would change his locale to Spanish and sign out of Maximo. He would sign back in with the Spanish locale, and generate the report xml for all reports in Spanish. - He would then change his locale to Italian, sign out, and repeat the process to generate all the report xml also in Italian. V7 Report Localization Guide_rev2.doc 6/7/

42 2. Accessing a single report design from multiple applications If one report design file is stored in multiple applications, it only needs one property file. You do not have to create individual property files for each application the report is accessed from. Examples of this are the Work Order List and Work Order Details reports. These are available from the Work Order, Change, Release, Activity and Quick Reporting applications. However, the property file values for these reports are only created once in the wotrack.properties file. 3. Hot fix or fix pack upgrades If you apply a hot fix or fix pack upgrade, and then find that your custom reports no longer show the localized values, confirm that your custom properties files have been imported. If you did not create custom properties files, and updated the delivered properties files with your new text values -- your modifications to the delivered report properties files could be overwritten in hot fix and fix pack updates. For best practice recommendations on properties file, reference the V7 or V75 Report Feature Guide. The specific section is called Your Custom Reports and the Report File Structure. This information can also be found at: 4. Localization and QBR Reports If you have a multi language environment, and your users are creating Ad Hoc, or QBR (Query Based Reports) with Public security access, review the REPORTADHOCLOCINST Cron task. This cron task determines the frequency that a newly created ad hoc report request page is enabled in a multi language environment. Specifically, when a public QBR is saved in a a multi-language environment, the Maxvar SYNCREPORTLABELS is set to true. The REPORTADHOCLOCINST cron task checks this flag. If it finds it is true, it launches a process to synchronize the QBR labels. After this process is complete, the SYNCREPORTLABLES maxvar is set back to false. Note: This is only for a multi-language environment. If you have a single language, this cron task should remain as inactive. V7 Report Localization Guide_rev2.doc 6/7/

43 Additional Report Reference Materials For a complete listing of the latest report documentation for the V7.1 and V7.5 releases, access the url below. or it s shortened url of This page categorizes the documentation into detail, planning, development, customization and integration guides. Additionally, an overview of the guide is provided, along with its current revision level. All documentation referenced is available on IBM's support site via the url referenced within the page. Additional information on reporting, including Bilogs (Business Intelligence Blogs), User Forums and links to other wiki pages can be found on IBM s Service Management Connect at this url: or it s shortened url of V7 Report Localization Guide_rev2.doc 6/7/

44 Revision History June 2012 Revision 2 Updates include (1) Reference Material updates (2) Information on REPORTADHOCLOCINST Cron tasks on page 42 September 2011 Revision 1 Updates include (1) Added software prerequisites on page 17 for enabling custom report localization and (2) Included additional information on enabling custom property files for localization (Steps 2F 2J) (3) Corresponding updates on pages 32 and 33 V7 Report Localization Guide_rev2.doc 6/7/

45 Notices This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-ibm product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY U.S.A. The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you. This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice. Any references in this information to non-ibm Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Information concerning non-ibm products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-ibm products. Questions on the capabilities of non-ibm products should be addressed to the suppliers of those products. V7 Report Localization Guide_rev2.doc 6/7/

46 This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. Trademarks IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at Copyright and trademark information at Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both V7 Report Localization Guide_rev2.doc 6/7/