UI-Erweiterungspunkte erstellen und hinzufügen

Erstellen Sie beim Entwickeln einer Anwendung UI-Erweiterungspunkte, und fügen Sie sie den serverseitigen UI-Makros (z. B. HTML-Erweiterungen) oder den UI-Seiten im Basisanwendungscode hinzu.

Verwenden Sie einen UI-Erweiterungspunkt, um eine spezifische Stelle festzulegen, an der Daten oder Objekte an ein registriertes benutzerdefiniertes UI-Makro gesendet werden können und wo zurückgegebene Ergebnisse verarbeitet werden.

UI-Erweiterungspunkte erstellen

Erstellen Sie einen UI-Erweiterungspunkt, den Sie in den UI-Makros (z. B. in HTML-Erweiterungen) im Anwendungscode platzieren können. Durch Platzieren des UI-Erweiterungspunkts bestimmen Sie die spezifische Stelle im Anwendungscode, an der Daten oder Objekte an eine Anpassung gesendet werden können und an der Daten zurückgegeben werden.

Vorbereitungen

Erforderliche Rolle: admin oder die spezifische Rolle für den Entwickler oder Administrator der Anwendung

Hinweis:

Weitere Informationen zu anwendungsspezifischen Administratorrollen und delegierter Entwicklung finden Sie unter Zugriffssteuerungsregeln in Apps zur Anwendungsverwaltung und Delegierte Entwicklung und Bereitstellung.

Warum und wann dieser Vorgang ausgeführt wird

der Inhalt und die Struktur für einen Erweiterungspunkt. Diese Definition sollte beschreiben, wie eine Anpassung strukturiert werden soll, wie sie mit dem Anwendungscode interagiert und wie die von einer Anpassung am Erweiterungspunkt zurückgegebenen Daten verarbeitet werden. definieren

Durch das Erstellen einer guten Definition geben Sie eine Struktur für die Funktionalität der Erweiterungen an.

Prozedur

1. Navigieren zu Alle > Systemerweiterungspunkte > UI-Erweiterungspunkte.
2. Klicken Sie auf Neu.
3. Füllen Sie die Felder des Formulars aus.

   Tabelle : 1. Formular „UI-Erweiterungspunkt“

   Feld	Beschreibung
   Name	Eindeutiger Name für den Erweiterungspunkt. Der Name kann bis zu 100 alphanumerische Zeichen enthalten, einschließlich Sonderzeichen.
   API-Name	Name der Erweiterungspunkt-API, der der Anwendungsbereich vorangestellt ist, für den sie gilt. Das Name wird vom System zugewiesen und kann nicht geändert werden.
   Anwendung	Anwendungsbereich, für den der Erweiterungspunkt zugewiesen wird. Dieser wird vom System zugewiesen und kann nicht geändert werden. Weitere Informationen über den Schutz, den das Festlegen von Bereichen bietet, finden Sie unter Application scope.
   Auf diesen Umfang beschränken	Option zur Einschränkung des Erweiterungspunkts nur auf den Anwendungsbereich.
   Zugriff über AJAX/REST zulassen	Option zum Aktivieren oder Deaktivieren des Zugriffs auf den UI-Erweiterungspunkt über AJAX oder REST. Weitere Informationen zu diesen Entwicklungsarchitekturen und -techniken finden Sie unter AJAX und REST APIs.
   Beschreibung	Zu den Anforderungen an das benutzerdefinierte UI-Makro, wie das UI-Skript strukturiert sein sollte und wie es mit dem Anwendungscode arbeiten sollte.
   Beispiel	Beispiel für ein benutzerdefiniertes UI-Makro das mit diesem Erweiterungspunkt interagiert, sollte so strukturiert sein, dass es ordnungsgemäß mit dem Anwendungscode funktioniert.

4. Klicken Sie auf Absenden.

UI-Erweiterungspunkt im Anwendungscode hinzufügen

Fügen Sie den UI-Erweiterungspunkt einem UI-Makro oder einer HTML-Erweiterung im Basisanwendungscode hinzu. Um den Erweiterungspunkt hinzuzufügen, führen Sie einen API-Aufruf aus, der die Stelle angibt, an der registrierte benutzerdefinierte Artefakte ausgeführt werden.

Vorbereitungen

Erforderliche Rolle: admin oder die spezifische Rolle für den Entwickler oder Administrator der Anwendung

Sie müssen zuerst einen UI-Erweiterungspunkt erstellen, bevor Sie ihn einem UI-Makro oder einer UI-Seite im Anwendungscode hinzufügen können.

Hinweis:

Weitere Informationen zu anwendungsspezifischen Administratorrollen und delegierter Entwicklung finden Sie unter Zugriffssteuerungsregeln in Apps zur Anwendungsverwaltung und Delegierte Entwicklung und Bereitstellung.

Prozedur

1. Greifen Sie im Anwendungscode auf das vorhandene UI-Makro zu, dem Sie einen geskripteten Erweiterungspunkt hinzufügen möchten, oder erstellen Sie ein neues.
   Weitere Informationen zum Erstellen von UI-Makros mit Jelly-Tags finden Sie unter UI-Makros und Jelly Tags.
2. Fügen Sie im UI-Makro ein Jelly-Tag mit einer Codezeile an der Stelle hinzu, an der Sie die Ausgabe benutzerdefinierter UI-Makros erfassen und verarbeiten möchten.
   In der Regel enthält diese Codezeile Folgendes:

   • Einen call_extension-Befehl, der den Namen des UI-Erweiterungspunkts angibt (z. B. extension=" global.KMArticle.ViewHeader"), bei dem die benutzerdefinierten UI-Makros registriert werden.
   • Argumente, die an das UI-Makro übergeben werden, wenn es gerendert wird. Für einen Knowledge Base-Artikel wird beispielsweise knowledgerecord="${knowledgeRecord}" im aktuellen Knowledge-Datensatz weitergegeben.
   • (Optional) Wenn es mehrere Implementierungen dieses Erweiterungspunkts gibt, wird durch das Verwenden eines limit-Befehls angegeben, dass eine x-Anzahl von Implementierungen zurückgegeben werden soll (z. B. limit="1"). Diese Abbildung zeigt ein UI-Makro, das diese Befehle enthält.