Online Text Repository (OTR) and Messages

Contents:
Introduction to internationalization Online Text Repository Message handling

SAP AG 2005, Title of Presentation / Speaker Name / #

Messages and Error Handling: Unit Objectives

After completing this unit, you will be able to:

Understand ABAP WD support for Online Text Repository

Report messages to the user using the IF_WD_MESSAGE_MANAGER interface

SAP AG 2005, Title of Presentation / Speaker Name / #

Internationalization
The process by which language specific text is detached from the program code that uses it is known as Internationalization. This allows the same program to operate in multiple languages without needing different versions of the code for each language.

SAP AG 2005, Title of Presentation / Speaker Name / #

Internationalization (I18N) Support

During runtime UI elements bound to an context node/attribute which is based on a DDIC table/structure/type will get the text in appropriate language. Text properties of UI elements can be bound directly to DDIC text. Is a text literal entered in a text fields of UI elements a corresponding OTR text will be created. Existing OTR texts (alias) can be assigned to a properties of a UI element.

List of existing OTR texts

Enter a text or assign an existing OTR text

SAP AG 2005, Title of Presentation / Speaker Name / #

Using the Online Text Repository

The class CL_WD_UTILITIES provide the method GET_OTR_TEXT_BY_ALIAS to get text from OTR.

Use the WD code wizard to select the proper OTR text and generate the coding.
data: ... ... OTR_text

type string.

OTR_text = CL_WD_UTILITIES=>GET_OTR_TEXT_BY_ALIAS( 'SOTR_VOCABULARY_BASIC/MATERIAL_MASTER' ). ... ... * set single attribute Elem_Lable_Text->set_Attribute( exporting Name = `TF_LABLE_3` Value = OTR_TEXT ).

SAP AG 2005, Title of Presentation / Speaker Name / #

Using the Component Assistence Class

A comonent assistence class can be associated to every WD component Attribute wd_Assist is available in every controller of the component for accessing texts with method get_text

SAP AG 2005, Title of Presentation / Speaker Name / #

Web Dynpro Messages and Error Handling

All messages will be displayed in a dedicated message area.
By default the message area appears at the top of the page. The message are can be moved like a UI element in a view. You find a UI element (Message Area) in the UI library Pattern. Messages will be placed in this area, if it is available.
Messages can be displayed in a dedicated message area By default messages will be displayed at the top of page Message area can be moved

* Note: feature released with SP1

SAP AG 2005, Title of Presentation / Speaker Name / #

Handling of Message
The handling of messages can be controlled in the WD application

Messages area only visible if a message thrown

Messages area always visible

Messages NOT listed in the message area box - Messages are listed in a sequence
Note: feature released with SP1

SAP AG 2005, Title of Presentation / Speaker Name / #

Categories of Messages

Arbitrary text can be used as a message text ABAP OO exceptions can be used Reuse of existing T100 message ID, No.

Text

EXCEPTION

ATTRIBUTE

Parameter

T100

Dedicated field will be marked in red color

Parameters can be assigned to the message

Example * report message CALL METHOD l_message_manager->REPORT_ATTRIBUTE_ERROR_MESSAGE EXPORTING MESSAGE_TEXT = '&V2 is not a valid date' ELEMENT = Elem_Flights ATTRIBUTE_NAME = 'FLDATE' PARAMS = lt_messages.

SAP AG 2005, Title of Presentation / Speaker Name / #

Kind of Messages
Text
REPORT_ATTRIBUTE_ERROR_MESSAGE Reports a WD Exception for a Context Attribute

REPORT_SUCCESS
REPORT_WARNING REPORT_ERROR_MESSAGE REPORT_FATAL_ERROR_MESSAGE

Reports a Success Message

Reports a Warning Reports a Web Dynpro Message with Optional Parameters Reports a Fatal Web Dynpro Message with Optional Parameters

EXCEPTION
REPORT_ATTRIBUTE_EXCEPTION REPORT_EXCEPTION REPORT_FATAL_EXCEPTION Reports a WD Exception for a Context Attribute Reports a Web Dynpro Exception (May Return) Reports a Fatal Web Dynpro Message

T100
REPORT_T100_MESSAGE REPORT_ATTRIBUTE_T100_MESSAGE Reports a Message Using a T100 Entry Reports a WD Exception for a Context Attribute

SAP AG 2005, Title of Presentation / Speaker Name / #

Create a message
Use the WD code wizard to create the required coding to report a message.

* get message manager data: l_current_controller type ref to if_wd_controller, l_message_manager type ref to if_wd_message_manager. l_current_controller ?= wd_This->Wd_Get_Api( ). CALL METHOD l_current_controller->GET_MESSAGE_MANAGER RECEIVING MESSAGE_MANAGER = l_message_manager * report message CALL METHOD l_message_manager->REPORT_ATTRIBUTE_ERROR_MESSAGE EXPORTING MESSAGE_TEXT = 'REPORT_ATTRIBUTE_ERROR_MESSAGE' ELEMENT = Elem_Flights ATTRIBUTE_NAME = 'CITYFROM'.
SAP AG 2005, Title of Presentation / Speaker Name / #

Create a T100 message

Existing message classes can be reused to create messages

Use the WD code wizard to create the required coding to report a T100 message.

* get message manager data: l_current_controller type ref to if_wd_controller, l_message_manager type ref to if_wd_message_manager. l_current_controller ?= wd_This->Wd_Get_Api( ). CALL METHOD l_current_controller->GET_MESSAGE_MANAGER RECEIVING MESSAGE_MANAGER = l_message_manager * report message CALL METHOD l_message_manager->REPORT_T100_MESSAGE EXPORTING MSGID = 'E1' MSGNO = '360' MSGTY = 'S' P1 = ' -> REPORT_T100_MESSAGE'.
SAP AG 2005, Title of Presentation / Speaker Name / #

Standard Hook Method View controller

Only a view controller has these hook methods. The method WDDOBEFOREACTION before an action performed, can be used for data validation.

SAP AG 2005, Title of Presentation / Speaker Name / #

Messages and Error Handling: Unit Summary

You should now be able to: Understand ABAP WD support for Online Text Repository Report messages to the user using the IF_WD_MESSAGE_MANAGER interface

SAP AG 2005, Title of Presentation / Speaker Name / #