Widget-Optionsschema

Widget-Instanzen ermöglichen Benutzern die eindeutige Konfiguration jedes Widgets, das sie einer Seite hinzufügen. Verwenden Sie das Optionsschema, um die Parameter für Ihr Widget zu definieren.

Instanzoptionen speichern

Beim Entwickeln eines Widgets können Sie das Optionsschema bearbeiten, um Parameter für das Widget zu erstellen, oder Sie können eine Tabelle zum Speichern von Instanzoptionen erstellen. Wenn Sie das vorhandene Optionsschema bearbeiten, werden alle definierten Instanzoptionen im JSON-Format im Feld Zusätzliche Optionen, JSON-Format in der Tabelle sp_instance gespeichert. Folgende Feldtypen stehen zur Verfügung:

• Zeichenfolge
• Boolesche
• Zahl
• Referenz
• Wahl
• Feldliste (abhängig von der Tabelle)
• Feldname (abhängig von der Tabelle)
• Glide_list

Um andere Feldtypen zu verwenden, die im Optionsschema nicht unterstützt werden, erstellen Sie eine Erweiterungstabelle, um Ihr benutzerdefiniertes Widget-Optionsschema zu speichern. Mit einer Tabelle können Sie:

• Einen beliebigen ServiceNow-Feldtyp, einschließlich Felder mit erweiterter Anpassung, zu dem Optionsschema hinzufügen.
• Definieren eines komplexen Optionsschemas.
• Suchen und Filtern von Instanzoptionen

Hinweis:

Durch das Speichern von Optionen in einer Tabelle können Sie komplexere Optionen definieren. Diese Methode ist jedoch schwieriger zu verwalten als das Optionsschema zu bearbeiten. Bearbeiten Sie das vorhandene Optionsschema nach Möglichkeit, um das Erstellen unnötiger Tabellen und das Hinzufügen zusätzlicher Serveraufrufe zu Ihrem Widget zu vermeiden. Speichern Sie Optionen nur dann in einer Tabelle, wenn komplexe oder durchsuchbare Optionen erforderlich sind.

Verwenden von Optionen in einem Widget

Zugriff auf Optionen im Widget sowohl vom Clientskript als auch vom Serverskript aus mit der globalen Variable Optionen. Sie können auf jeden Optionswert in Ihrem Widget-Clientskript oder Serverskript mit options.optionName zugreifen.

Clientskript

function() {
  /* widget controller */
  var c = this;
    console.log(c.options.text_color) //Outputs the text_color option for this instance
}

Serverskript

(function() {
     $sp.log(options.text_color) //Logs the value of the text_color option to the browser console.
})();

Standardoptionen definieren

Bevor ein Optionswert für eine Instanz festgelegt wird, erscheint er beim Zugriff auf diese Optionsvariable als undefinierter Wert. Verwenden Sie das Widget-Serverskript, um Standardwerte für Ihre Optionen anzugeben.

(function() {
  options.text_color=options.text_color||"blue";
  options.maximum_entry_count=options.maximum_entry_count||5;
})

Bearbeiten Sie das Widget-Optionsschema

Widget-Instanzen ermöglichen Benutzern die eindeutige Konfiguration jedes Widgets, das sie einer Seite hinzufügen. Bearbeiten Sie das Optionsschema, um grundlegende Parameter für Ihr Widget zu definieren.

Vorbereitungen

Sie müssen ein geklontes oder neu erstelltes Widget erstellen.

Erforderliche Rolle: admin oder sp_admin

Prozedur

1. Navigieren zu Alle > Service Portal > Service Portal-Konfiguration > Widget-Editor.
2. Wählen Sie das Widget aus, für das Sie das Optionsschema konfigurieren möchten.
3. Klicken Sie auf das Menüsymbol (), und wählen Sie Optionsschema bearbeiten.
   Diese Option wird nur für Benutzer angezeigt, die das Recht haben, das Widget zu bearbeiten.
4. Klicken Sie auf + eine Widget-Option hinzufügen.
5. Definieren Sie eine Bezeichnung, einen Namen, einen Typ, einen Hinweis und einen Formularabschnitt.

   Weitere Felder erscheinen je nach Typ, den Sie auswählen.

   Durch das Hinzufügen flexibler Widgetoptionen können Sie wiederverwendbare Widgets erstellen. Sie können Standardwerte hinzufügen, um den Benutzern das Verständnis der einzelnen Widgetoptionen zu erleichtern. Wenn Sie keinen Formularabschnitt auswählen, ist der Standardwert auf Andere Optionen festgelegt.

   

6. Klicken Sie auf Speichern.
   Das von Ihnen definierte Optionsschema wird im JSON-Format im Feld Optionsschema in der Tabelle sp_widget gespeichert. Basierend auf diesem Optionsschema kann jede Instanz des Widgets individuell definierte Instanzoptionen verwenden.
7. Testen Sie das Optionsschema, indem Sie das Widget zu einer Seite im Serviceportal-Designer hinzufügen.-
   1. Navigieren zu Serviceportal > Service Portal-Konfiguration > Serviceportal-Designer.
   2. Fügen Sie das Widget zu einer Seite hinzu und klicken Sie auf das Bearbeitungssymbol in der Widget-Instanz, um die Instanzoptionen anzuzeigen.
   3. Konfigurieren Sie die Widget-Instanzoptionen.
   4. Zeigen Sie die Konfiguration an, indem Sie zu dem Instanzdatensatz in der Tabelle sp_instance navigieren.
      Die Instanzoptionen werden im JSON-Format im Feld Zusätzliche Optionen, JSON-Format gespeichert.

Speichern Sie Instanzoptionen in einer Tabelle

Erstellen Sie eine Tabelle zum Speichern von Widget-Instanzoptionen, anstatt das vorhandene Optionsschema zu bearbeiten. Wenn Sie eine Tabelle als Widgetoptionsschema verwenden, können Sie benutzerdefinierte Felder mit beliebigen ServiceNow-Feldtypen definieren, Filter zu Feldern hinzufügen und Instanzoptionen suchen bzw. aufrufen.

Vorbereitungen

Erforderliche Rolle: admin oder sp_admin

Warum und wann dieser Vorgang ausgeführt wird

Um ein benutzerdefiniertes Optionsschema zu definieren, fügen Sie Felder zu einer Erweiterungstabelle „sp_instance“ hinzu und legen Sie dann fest, dass das Widget die Erweiterungstabelle als Datenquelle verwendet. Mit einer Erweiterungstabelle können Sie:

• Einen beliebigen ServiceNow-Feldtyp, einschließlich Felder mit erweiterter Anpassung, zu dem Optionsschema hinzufügen.
• Definieren Sie komplexe Widgetoptionen.
• Suchen und Filtern von Instanzoptionen

Hinweis:

Durch das Speichern von Optionen in einer Tabelle können Sie komplexere Optionen definieren. Diese Methode ist jedoch schwieriger zu verwalten als das Optionsschema zu bearbeiten. Bearbeiten Sie das vorhandene Optionsschema nach Möglichkeit, um das Erstellen unnötiger Tabellen und das Hinzufügen zusätzlicher Serveraufrufe zu Ihrem Widget zu vermeiden. Speichern Sie Optionen nur dann in einer Tabelle, wenn komplexe oder durchsuchbare Optionen erforderlich sind.

Prozedur

1. Erstellen Sie eine Tabelle, die eine sp_instance-Tabelle erweitert, um Ihr benutzerdefiniertes Optionsschema zu speichern.
   1. Navigieren zu Systemdefinition > Tabellen.
   2. Klicken Sie auf Neu.
   3. Definieren Sie ein Label und einen Namen.
   4. Im Feld Erweitert die Tabelle wählen Sie eine sp_instance-Tabelle aus, die die erforderlichen Felder enthält.

      Instanzentabelle	Beschreibung
      Instanz [sp_instance]	Enthält Basisinstanzfelder.
      Instanz mit Tabelle [sp_instance_table]	Enthält sp_instance-Felder und Felder zum Anzeigen von Tabellendaten wie Tabelle und Filter.

   5. Speichern Sie das Formular.
2. Definieren Sie benutzerdefinierte Felder in der Erweiterungstabelle.
   Sie können einen beliebigen Feldtyp definieren, der in Ihrem Optionsschema verwendet werden soll, indem Sie neue Spalten in der Liste Säulen hinzufügen.
3. Aktualisieren Sie Ihr Widget, um die Erweiterungstabelle als Datenquelle zu verwenden.
   1. Navigieren zu Serviceportal > Widgets.
   2. Öffnen Sie das Widget, für das Sie benutzerdefinierte Optionen erstellen möchten.
   3. Im Feld Datentabelle wählen Sie Erweiterungstabelle sp_instance aus.
      
4. Konfigurieren Sie das Erweiterungstabellenformular so, dass die gewünschten Felder angezeigt werden.
   Im Formular konfigurierte Felder stehen als Instanzoptionen zur Verfügung.
   1. Navigieren Sie zu dem Erweiterungstabellenformular: <yourInstance>/<your_extenstion_table>.do.
   2. Klicken Sie mit der rechten Maustaste auf das Headermenü, und wählen Sie Konfigurieren > Formularlayout.
   3. Fügen Sie die Felder zum Formular hinzu.
   4. Klicken Sie auf Speichern.
5. Konfigurieren Sie das Widget so, dass die gewünschten Felder als Instanzoptionen angezeigt werden.
   1. Navigieren zu Serviceportal > Widgets.
   2. Öffnen Sie das Widget, dessen Erweiterungstabelle als Datenquelle festgelegt ist.
   3. Verwenden Sie die Felder slushbucket, um Felder auszuwählen, die als Instanzoptionen angezeigt werden
      
   4. Speichern Sie das Formular.

Nächste Maßnahme

Testen Sie das Optionsschema, indem Sie das Widget zu einer Seite im Serviceportal-Designer hinzufügen.- Klicken Sie in der Widget-Instanz auf das Bearbeitungssymbol, um die Instanzoptionen anzuzeigen. Nach dem Konfigurieren der Widget-Instanzoptionen, zeigen Sie die Konfiguration an, indem Sie zum Instanzdatensatz in der Erweiterungstabelle sp_instance navigieren.