1 Themenübersicht
Im Rahmen der Hook-Technologie können Sie individuelle Prüfungen und Meldungen erfassen. Mithilfe der Anwendung „Individuelle Prüfungen“ erfassen Sie die Prüfungen und referenzieren darin Meldungen, die Sie in der Anwendung „Individuelle Meldungen“ erfasst haben. Wird die Prüfung ausgeführt, dann wird an den Benutzer die referenzierte Meldung ausgegeben.
Individuelle Prüfungen und Meldungen sind nur auf der OLTP-Datenbank aktiv, auf der Sie erfasst wurden.
Nachfolgend ist beschrieben, wie die Anwendung „Individuelle Meldungen“ aufgebaut ist und wie Sie Meldungen erfassen.
2 Begriffsbestimmung
Hook
Hooks sind Java-Klassen in Namensräumen des Hook-Anbieters. Ein Hook wird in einer Java-Klasse implementiert, die selbst die Hook-Schnittstelle implementiert.
Hook Contract
Ein Hook ist eine Schnittstelle, mit der vorhandener Programmcode unabhängig von einem Release und damit konfliktfrei erweitert werden kann. Hooks werden beispielsweise verwendet, wenn in einer Adaptierung oder einer App für eine Business-Object-Erweiterung zusätzliche Prüfungen durchgeführt werden müssen, die die vorhandenen Prüfungen ergänzen.
Hook-Contract-Definition
Eine Hook-Contract-Definition enthält zusammengehörige Hooks, z. B. alle Hooks auf Business-Entity-Ebene eines bestimmten Business Entitys. Erst durch eine Hook-Contract-Definition sind die Hooks zur Implementierung freigegeben.
Hook-Anbieter
Ein Hook-Anbieter stellt Hooks zur Verfügung, die von einem Hook-Verwender implementiert werden können. Der Hook-Anbieter definiert Methoden in einer Java-Klasse (Hook).
Hook-Contract-Implementierung
In der Hook-Contract-Implementierung werden die zu implementierenden Hooks und die jeweilige Implementierungsklasse angegeben. Die Hook-Contract-Implementierung bezieht sich immer auf eine Hook-Contract-Definition, in der die implementierbaren Hooks enthalten sind.
Hook-Verwender
Ein Hook-Verwender implementiert die Hooks, die von einem Hook-Anbieter definiert wurden.
3 Anwendungsbeschreibung
Mit der Anwendung „Individuelle Meldungen“ erfassen Sie Meldungen für die OLTP-Datenbank, an der Sie sich angemeldet haben. Diese Meldungen können auf keiner anderen OLTP-Datenbank genutzt werden. Sie verwenden diese individuellen Meldungen beispielsweise in individuellen Prüfungen.
3.1 Identifikationsbereich
Im Identifikationsbereich erfassen Sie die Daten, die eine individuelle Meldung eindeutig identifizieren.
Die Felder im Einzelnen:
Feld | Erläuterung |
Meldung | CEE-XML-MappingIm Feld „Meldung“ wird die eindeutige Identifikation der individuellen Meldung erfasst. Die Identifikation dieser Meldung dient der Eindeutigkeit innerhalb einer Datenbank. Geben Sie in dieses Feld eine Identifikation ein. Sie kann aus Zahlen, Buchstaben oder einer Zahlen-Buchstaben-Kombination bestehen und ist beim ersten Erfassen frei wählbar. |
Meldungstyp | Mithilfe des Feldes „Meldungstyp“ legen Sie den Schweregrad der Meldung fest. Folgende Meldungstypen stehen zur Auswahl:
· Information Anzeige in der Statuszeile und unter dem Karteireiter „Meldungen“ im Navigationsbereich. Kein Einfluss auf den weiteren Ablauf in der Anwendung. · Warnung Anzeige in der Statuszeile und unter dem Karteireiter „Meldungen“ im Navigationsbereich. Wird die Warnung durch den Benutzer bestätigt, kann die Aktion ausgeführt werden. · Fehler Anzeige in der Statuszeile und unter dem Karteireiter „Meldungen“ im Navigationsbereich. Die Aktion kann nicht ausgeführt werden, solange der Fehler nicht behoben ist. |
3.2 Arbeitsbereich
Im Arbeitsbereich erfassen Sie die Texte der individuellen Meldung.
Die Felder im Einzelnen:
Feld | Erläuterung |
Meldungs-Kurztext | CEE-XML-MappingMeldungs-Kurztext, der sichtbar in der Statuszeile und unter dem Karteireiter „Meldungen“ im Navigationsbereich angezeigt wird. Der Meldungs-Kurztext kann bis zu 10 Parameter enthalten. Die Parameter werden in geschweiften Klammern mit den Zahlen von 0 bis 9 angegeben, d. h. „{0}“ bis „{9}“. Die Parameter werden durch konkrete Werte ersetzt, wenn die Meldung ausgegeben wird. Der Text ist übersetzbar und Sie können diesen sowohl in den Inhalts- als auch in den Anzeigesprachen erfassen. |
Meldungs-Langtext | CEE-XML-MappingMeldungs-Langtext, der unter dem Karteireiter „Meldungen“ im Navigationsbereich angezeigt wird. Der Meldungs-Langtext kann bis zu 10 Parameter enthalten. Die Parameter werden in geschweiften Klammern mit den Zahlen von 0 bis 9 angegeben, d. h. „{0}“ bis „{9}“. Die Parameter werden durch konkrete Werte ersetzt, wenn die Meldung ausgegeben wird. Der Text ist übersetzbar und Sie können diesen sowohl in den Inhalts- als auch in den Anzeigesprachen erfassen. Am Ende des Langtextes wird automatisch die Indentifikation der Meldung ausgegeben. |
3.3 Skript-Sprache
Sie können individuelle Meldungen in der Workflow-Skriptsprache verwenden. Der Befehl „sendMessage“ sendet eine Meldung. Sie können beim Senden der Meldung konkrete Werte für die von Ihnen deklarierten Parameter angeben.
Beispiel:
Senden der Meldung „VA-0001“ mit dem Parameter „100“ an das Feld current:customerOrderData.purchaseOrder (Fremdbelegnummer“):
sendMessage(
current:customerOrderData.purchaseOrder,
“VA-0001″,”100”);
3.4 Meldungsprotokolle
Wenn unter dem Karteireiter „Meldungen“ im Navigationsbereich eine Meldung ausgegeben wird, dann beginnt diese mit dem Typ-Icon, gefolgt von der Meldungsnummer, so wie sie in der Anwendung „Entwicklungsobjekte“ erfasst wurde. Für die in der Anwendung „Individuelle Meldungen“ erfassten Meldungen wird an jener Stelle nicht die individuell erfasste Identifikation der Meldung ausgegeben, sondern eine der folgenden Meldungsnummern, die in der Anwendung „Entwicklungsobjekte“ erfasst sind. Welche ausgegeben wird, ist abhängig vom Meldungstyp:
Meldungstyp | Meldungsnummer |
Information | USR-00001 |
Warnung | USR-00002 |
Fehler | USR-00003 |
Mit den Meldungsnummern aus der Anwendung „Entwicklungsobjekte“ werden die Meldungen in der Anwendung „Meldungsprotokolle“ protokolliert und nur über diese Meldungsnummern können die individuellen Meldungen abgefragt werden.
Hinweis:
Im Langtext einer individuellen Meldung wird deren Identifikation ausgegeben.
3.5 Ändern und Löschen
Individuelle Meldungen können beispielsweise in individuellen Prüfungen verwendet werden. Wenn Sie eine individuelle Meldung ändern oder löschen, wird nicht geprüft, ob die Meldung noch verwendet wird.
Hinweis:
Ändern Sie die Anzahl und Bedeutung der Parameter nur dann, wenn Sie alle Verwendungen kennen.
Löschen Sie eine Meldung nur dann, wenn Sie wissen, dass sie nicht mehr verwendet wird.
4 Customizing
Für die Anwendung „Individuelle Meldungen“ sind in der Anwendung „Customizing“ keine Einstellungen festzulegen.
5 Business Entitys
Für die Anwendung „Individuelle Meldungen“ ist das nachfolgende Business Entity relevant, das Sie beispielsweise verwenden, um
- Berechtigungen zu vergeben,
- Aktivitätsdefinitionen einzurichten oder
- Daten zu importieren oder zu exportieren.
Individuelle Meldung
com.cisag.sys.tools.validation.obj.UserMessage
6 Berechtigungen
Berechtigungen können sowohl mithilfe der Berechtigungsrollen als auch durch die Zuordnung einer Organisation vergeben werden. Das Berechtigungskonzept können Sie in der Technischen Dokumentation Berechtigungen nachlesen.
6.1 Spezielle Fähigkeiten
Für die Anwendung „Individuelle Meldungen“ bestehen keine speziellen Fähigkeiten.
6.2 Organisations-Zuordnungen
Für die Anwendung „Individuelle Meldungen“ ist eine Organisations-Zuordnung nicht erforderlich.
6.3 Besonderheiten
Für die Anwendung „Individuelle Meldungen“ bestehen keine Besonderheiten.
6.4 Berechtigungen für Geschäftspartner
Die Anwendung „Individuelle Meldungen“ ist für Geschäftspartner nicht freigegeben.