IBM TRIRIGA Application Platform Version 3.3.2 Label Manager: Customizing Field-Level GUI Tooltips

Home , Tab (interface)

IBM TRIRIGA Application Platform Version 3.3.2

Label Manager: Customizing Field-Level GUI Tooltips

Jay Manaloto Information Developer IBM TRIRIGA

Label Manager: Customizing Field-Level GUI Tooltips

ii Label Manager: Customizing Field-Level GUI Tooltips

CONTENTS

List of Figures ...... iv

Revision History ...... v

1 Introduction ...... 6

2 Choosing the field to customize its tooltip ...... 6

3 Finding the field in Form Builder ...... 7

4 Finding the field in Label Manager ...... 9

5 Clearing the cache ...... 12

6 Known behavior ...... 13

7 Product documentation ...... 13

iii Label Manager: Customizing Field-Level GUI Tooltips

LIST OF FIGURES

Figure 1: Reservation Settings section (part 1) ...... 6 Figure 2: Reservation Settings section (part 2) ...... 6 Figure 3: Tools page (part 1) ...... 7 Figure 4: Form Builder tool (part 1) ...... 7 Figure 5: Form Builder tool (part 2) ...... 8 Figure 6: Tools page (part 2) ...... 9 Figure 7: Label Manager tool (part 1) ...... 9 Figure 8: Label Manager tool (part 2) ...... 10 Figure 9: Label Manager tool (part 3) ...... 10 Figure 10: Label Manager tool (part 4) ...... 11 Figure 11: Label Manager tool (part 5) ...... 11 Figure 12: Administrator Console ...... 12 Figure 13: Reservation Settings section (part 3) ...... 12

iv Label Manager: Customizing Field-Level GUI Tooltips

REVISION HISTORY

Date Version Comments

22 Aug 2013 1.0 Initial version.

31 Oct 2013 1.1 Minor edits to steps and known behavior.

v Label Manager: Customizing Field-Level GUI Tooltips

1 Introduction In the IBM® TRIRIGA® Application Platform, the Label Manager can be used to insert your own tooltips in the application forms. If you are not familiar with the Form Builder, navigating your way through the Label Manager can be a challenge. But if you are familiar with how the Form Builder organizes form sections and fields, then adding or customizing tooltips for fields in the Label Manager should be just as clear. In our example, we are looking at the Reservation Settings section of the Application Settings form. Here is a customized tooltip for the Service Wake-Up Duration field.

Figure 1: Reservation Settings section (part 1)

2 Choosing the field to customize its tooltip First, you must decide on the field that might need a useful tooltip to help users. Step 1: Navigate to the form, section, and field that might need a useful tooltip. If a field does not have a customized tooltip value (in other words, the tooltip value is blank), then the default tooltip displays the same text as the field label.

Figure 2: Reservation Settings section (part 2)

6 Label Manager: Customizing Field-Level GUI Tooltips

3 Finding the field in Form Builder Next, you must find the particular form, section, and field label in the Form Builder to determine the corresponding section name and field name. Step 1: Navigate to Tools > Form Builder.

Figure 3: Tools page (part 1)

Step 2: In the Form Builder, navigate to the related module and open the particular form.

Figure 4: Form Builder tool (part 1)

7 Label Manager: Customizing Field-Level GUI Tooltips

Step 3: In the form layout, locate the related section and select the particular field. In this example, you can determine the section name and field name:  Section name: triReservationSettings  Field name: triReserveServiceWakeUpDU

Figure 5: Form Builder tool (part 2)

8 Label Manager: Customizing Field-Level GUI Tooltips

4 Finding the field in Label Manager Next, using the section name and field name from the Form Builder, you must find the identical section name and field name in the Label Manager. Step 1: Navigate to Tools > Label Manager.

Figure 6: Tools page (part 2)

Step 2: In the Label Manager, select Label Tooltip from the drop-down list.

Figure 7: Label Manager tool (part 1)

9 Label Manager: Customizing Field-Level GUI Tooltips

Step 3: Navigate to the related module and select the particular form.

Figure 8: Label Manager tool (part 2)

Step 4: Select the language for the form. Locate the section name and field name:  Section name: triReservationSettings  Field name: triReserveServiceWakeUpDU

Figure 9: Label Manager tool (part 3)

10 Label Manager: Customizing Field-Level GUI Tooltips

Step 5: Enter your customized tooltip text for the particular field name.

Figure 10: Label Manager tool (part 4)

Step 6: Save your tooltip text.

Figure 11: Label Manager tool (part 5)

11 Label Manager: Customizing Field-Level GUI Tooltips

5 Clearing the cache Finally, you must clear the application cache from the Administrator Console and the browser cache from your web browser to view your tooltip text changes. Step 1: Open the Administrator Console. Select Cache Manager > All Caches (Global).

Figure 12: Administrator Console

Step 2: Clear your browsing history from your web browser.

Step 3: Return to the form, section, and field that needed the customized tooltip. In our example, we customized the tooltip for the Service Wake-Up Duration field.

Figure 13: Reservation Settings section (part 3)

12 Label Manager: Customizing Field-Level GUI Tooltips

6 Known behavior Query sections. The Label Manager does not support customizable field-level label tooltips for query sections. An example of a query section is the Contacts section of the Contact Details tab. However, there is a workaround: You can open a record from the query section to see if useful tooltips can be added to that form instead. Form sections within a multi-tab section. The Label Manager does not support customizable field-level label tooltips for form sections within a multi-tab section. Importing blank tooltips. You can import an .xliff file or .xml file that contains tooltip values. However, importing an .xliff file or .xml file with newer blank tooltip values from another environment does not clear or overwrite the older existing non-blank tooltips in the target environment. However, there is a workaround: Before generating the .xliff file or .xml file, instead of keeping blank values, you can enter the identical text of the displayed field labels. These newer non-blank values will override the older existing values, and the new tooltips will appear identical to their corresponding labels as if the tooltip values were blank.

7 Product documentation Review the IBM TRIRIGA 10.3.2 and IBM TRIRIGA Application Platform 3.3.2 information centers for more information about IBM TRIRIGA products. Depending on the topic, this paper might or might not supersede the standard documentation. In most cases, this paper overrides related information but only for the product version to which this paper applies. Review the latest Release Notes for your installed IBM TRIRIGA product version, as they might contain specific information that overrides topics in this paper.

13 Label Manager: Customizing Field-Level GUI Tooltips

© Copyright IBM Corporation 2013 IBM United States of America Produced in the United States of America US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

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 10504-1785 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 PAPER “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 may be made periodically to the information herein; these changes may be incorporated in subsequent versions of the paper. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this paper at any time without notice. Any references in this document 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 have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not give you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation 4205 South Miami Boulevard Research Triangle Park, NC 27709 U.S.A.

14 Label Manager: Customizing Field-Level GUI Tooltips

All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only. This information is for planning purposes only. The information herein is subject to change before the products described become available. If you are viewing this information softcopy, the photographs and color illustrations may not appear.

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 www.ibm.com/legal/copytrade.shtml. Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both. Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both. UNIX is a registered trademark of The Open Group in the United States and other countries. Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates. Other product and service names might be trademarks of IBM or other companies.