CL_HRPAY00_MESSAGE_HANDLER - Message Handler HCM

BAL_S_LOG - Application Log: Log header data   CL_GUI_FRONTEND_SERVICES - Frontend Services  
Diese Dokumentation steht unter dem Copyright der SAP AG.

Funktionalität

Der Message-Handler ist eine Sammlung verschiedener Interfaces, die zur Verwaltung von Fehlermeldungen und zur Protokollierung von beliebigen Berechnungen und Verarbeitungen im HCM (LOG-Builder) verwendet werden können.

Folgende Verarbeitungen werden durch den Message-Handler unterstützt:

• Sammlung und Ausgabe von Fehlermeldungen / Warnungen

Fehlermeldungen und Warnungen werden pro Personalnummer gesammelt und können am Ende der Verarbeitung als Nachricht oder Application Log ausgegeben oder dem Aufrufer als interne Tabelle übergeben werden.

• Protokollierung

Über den sogenannten LOG-Builder können beliebige Texte, Nachrichten, Strukturen und Tabellen zur Protokollierung einer Berechnung oder Verarbeitung gesammelt werden. Die Ausgabe des Protokolls kann über den HCM Application Log, das Abrechnungsprotokoll (interne Tabelle PTEXT) oder als Baum erfolgen.

• HCM Application Log

Es wird eine Sammlung von Methoden zur einfachen Nutzung des HCM Application Log unterstützt.

Die oben beschriebenen Funktionen sind in folgende Interfaces gegliedert.

• Sammlung von Fehlermeldungen und Warnungen:
  IF_HRPAY00_MESSAGE_HANDLER,,Message Handler

• Ausgabe und Weiterverarbeitung der gesammelten Fehlermeldungen und Warnungen:
  IF_HRPAY00_MESSAGE_SERVICES,,Service-Methoden für Message Handler

• Sammlung von Texten, Nachrichten, Strukturen und Tabellen zur Protokollierung:
  IF_HRPAY00_LOG_BUILDER,,,,,,Protokollierung HCM

• Ausgabe der Protokollierung:
  IF_HRPAY00_LOG_SERVICES,,,,,,Service-Methoden für Protokollierung HCM

• Verwendung des HCM Application Log:
  IF_HRPAY00_PAL_SERVICES,,,,,,Service-Methoden für den HCM Application Log

Neben den aufgeführten Interfaces existiert noch folgende Methoden:

• GET_MESSAGE_HANDLER,,Erzeugen Instanz für Message Handler

Die Methode GET_MESSAGE_HANDLER dient zur Erzeugung einer Instanz des Message-Handlers. Mit dieser Instanz können alle Interface-Methoden aufgerufen werden, d.h. mit einer Instanz kann beispielsweise sowohl die Sammlung von Fehlermeldungen als auch die Protokollierung vorgenommen werden.

Über den Parameter I_IDENT wird eine eindeutige Identifizierung des Message-Handlers definiert. Ist der Parameter initial, wird die Klasse als Singleton behandelt. In diesem Fall wird keine neue Instanz angelegt, sofern für die Klasse bereits vorher eine Instanz gebildet wurde.

Zur Verwendung einer von der Klasse CL_HRPAY00_MESSAGE_HANDLER abgeleiteteten Klasse kann über den Parameter I_DERIVATED_CLASSNAME der Klassenname übergeben werden.

• INIT,,,,,,,,,,Löschen aller Nachrichten und Protokolle

Durch Aufruf der Methode werden alle Nachrichten und Protokolle aus vorherigen Aufrufen des Message-Handlers gelöscht. Die Methode kann zur Initialisierung des Message-Handlers verwendet werden.

Erweiterte Funktionalität mit SAP-Hinweis 3152429

Mit dem SAP-Hinweis 3152429 - Internationaler Message Handler - Anzeige von Strukturen und Tabellen, die wiederum eine Tabelle als Komponente haben ist die Anzeige von tiefen Strukturen und Tabellen möglich. Bei der Verwendung des HCM Application Log muss dazu beim Aufruf der Methode IF_HRPAY00_LOG_BUIDLER~CREATE_INSTANCE der optionale Parameter I_GENERATE_DEEP_TABLE mit ABAP_TRUE mitgegeben werden. Bei der Ausgabe der Komponenten, welche Tabellen sind, werden diese zeilenweise angedruckt mit der Standard-Beschreibung: X. Zeile der Tabelle. Über die Methoden IF_HRPAY00_PAL_SERVICES~ADD_TABLE, IF_HRPAY00_LOG_BUILDER~ADD_TABLE und IF_HRPAY00_LOG_BUILDER~ADD_STRUCTURE kann der optionale Parameter IT_NODE_TEXTS_FOR_DEEP_TABLE mitgegeben werden. Mit diesem können Sie entweder über den Typ der Tabelle und/oder einen hart-codierten Freitext diese Standard-Beschreibung überschreiben.

Beziehungen

Beispiel

Als Beispiel zur Nutzung des Message-Handlers dient der Report RPMUST_MESSAGE_HANDLER (Beispielprogramm Nutzung Message-Handler) und die Klasse CL_HRPAY00_EXAMPLE_MESSAGES (Beispielklasse zur Nutzung des Message-Handlers).

Hinweise

Die Grundidee bei der Nutzung des Message-Handlers ist die Trennung zwischen der Sammlung der Nachrichten und Protokollierung und die anschließende Aufbereitung.

Zur Sammlung innerhalb einer Berechnung und Verarbeitung wird lediglich das Interface IF_HRPAY00_MESSAGE_HANDLER benötigt. Dabei muss sich der Verwender (also derjenige, der für die Berechnung verantwortlich ist) keine Gedanken über die anschließende Aufbereitung der Nachrichten oder des Protokolls machen. Diese obliegt allein dem Aufrufer, der für den Message-Handler eine Instanz gebildet hat und eine 'fremde' Berechnung aufruft. Dadurch ist es möglich, Berechnungen von beliebiger Stelle aufzurufen (z.B. aus der Abrechnung und der Ablauflogik eines Infotypen). Der Aufrufer entscheidet über die Darstellung der Meldungen und Protokolle in Abhängigkeit der jeweiligen Aufrufstelle. Der Berechnungsbaustein bleibt aber unverändert.

Weiterführende Informationen

PERFORM Short Reference   General Data in Customer Master  
Diese Dokumentation steht unter dem Copyright der SAP AG.

Length: 6816 Date: 20250524 Time: 022231     sap01-206 ( 109 ms )