g_modal : Client

Mit der g_modal -API können Sie ein modales Fenster anzeigen, um die Anwendungsfunktionalität zu verbessern.

Verwenden Sie diese API, um modale Elemente in Arbeitsbereichen anzuzeigen.

Mit dieser API können Sie:

• Eingabefelder in einem modalen Fenster anzeigen.
• Zeigen Sie etwas in einem Frame wie eine UI-Seite oder einen externen Link an.
• Führen Sie eine Aktion bei Bestätigung durch den Anwender aus.
• Laden Sie eine Komponente.
• Verwenden Sie HTML, um den Inhalt eines modalen Elements auszufüllen.

g_modal – alert(Zeichenfolgentitel, Zeichenfolgennachricht, Funktionsrückruf, Stilobjekt)

Zeigt eine Warnmeldung an, die sich auf eine UI-Aktion bezieht.

Tabelle : 1. Parameter

Name	Typ	Beschreibung
title	Zeichenfolge	Optional. Titel, der im Header des Modals angezeigt werden soll. Standard: Warnung
Nachricht	Zeichenfolge	Nachricht, die im modalen Textkörper angezeigt werden soll. Hinweis: Wenn Sie nur einen Parameter übergeben, wird dieser von der Methode als Parameter message behandelt.
Rückruf	Funktion	Optional. Funktion, die aufgerufen werden soll, nachdem das Formular übermittelt und auf dem Server verarbeitet wurde. Die Rückruffunktion weist das Format „callbackFunction(String action_verb, String sys_id, String table, String displayValue)“ auf, wobei: action_verb: Name der ausgeführten UI-Aktion. Beispiele: sysverb_cancel (Schaltfläche „Abbrechen“) sysverb_insert (Schaltfläche „Absenden“) sysverb_save (Schaltfläche „Speichern“). sys_id: Sys_id des betroffenen Datensatzes. table: Name der Tabelle, die den Datensatz enthält. displayValue: Wert, der im Formular angezeigt wird. Standard:
Stil	Objekt	Optional. Stil der Bestätigungsschaltfläche, die im Modal angezeigt werden soll. "style": { "buttonTitle": "String", "buttonType": "String" }
„style.buttonTitle“	Zeichenfolge	Optional. Text, der auf der Bestätigungsschaltfläche angezeigt werden soll. Standard: OK
Stil.SchaltflächeTyp	Zeichenfolge	Optional. Typ der anzuzeigenden Bestätigungsschaltfläche. Standard: Standard

Tabelle : 2. Rückgaben

Typ	Beschreibung
Zusage	Wenn ein callback -Parameter übergeben wird, gibt bei Erfolg ein Versprechen zurück, andernfalls wird ein Fehler zurückgegeben.

Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird, um die Warnmeldung „Nur der Zugewiesene an kann diese Aktion beenden“ anzuzeigen.

function onClick(g_form) {

  if (g_user.userID != g_form.getValue('assigned_to')) {
    g_modal.alert('Only the assigned to can end this action.');
    return;
  }

  var msg = getMessage("Are you sure you want to take this action?");
  g_modal.confirm(getMessage("Confirmation"), msg, function (confirmed) {
    if (confirmed) {
      g_form.setValue('state', 'closed_complete');
      g_form.save();
    }
  });

  return false;
}

g_modal - confirm(Zeichenfolgentitel, Zeichenfolgennachricht, Funktionsrückruf, Stilobjekt)

Zeigt eine Bestätigungsmeldung zu einer UI-Aktion an

Tabelle : 3. Parameter

Name	Typ	Beschreibung
title	Zeichenfolge	Optional. Titel, der im Header des Modals angezeigt werden soll. Standard: Bestätigen
Nachricht	Zeichenfolge	Nachricht, die im modalen Textkörper angezeigt werden soll. Hinweis: Wenn Sie nur einen Parameter übergeben, wird dieser von der Methode als Parameter message behandelt.
Rückruf	Funktion	Optional. Funktion, die aufgerufen werden soll, nachdem das Formular übermittelt und auf dem Server verarbeitet wurde. Die Rückruffunktion weist das Format „callbackFunction(String action_verb, String sys_id, String table, String displayValue)“ auf, wobei: action_verb: Name der ausgeführten UI-Aktion. Beispiele: sysverb_cancel (Schaltfläche „Abbrechen“) sysverb_insert (Schaltfläche „Absenden“) sysverb_save (Schaltfläche „Speichern“). sys_id: Sys_id des betroffenen Datensatzes. table: Name der Tabelle, die den Datensatz enthält. displayValue: Wert, der im Formular angezeigt wird. Standard:
Stil	Objekt	Optional. Stil der Schaltflächen zum Bestätigen und Abbrechen, die im Modal angezeigt werden sollen. "style": { "cancelTitle": "String", "cancelType": "String", "confirmTitle": "String", "confirmType": "String" }
Stil.AbbrechenTitel	Zeichenfolge	Optional. Text, der auf der Abbrechen-Schaltfläche angezeigt werden soll. Standard: Abbrechen
Stil.AbbrechenTyp	Zeichenfolge	Optional. Typ der anzuzeigenden Abbruchschaltfläche. Standard: Bestätigen
„style.confirmTitle“	Zeichenfolge	Optional. Text, der auf der Bestätigungsschaltfläche angezeigt werden soll. Standard: OK
Stil.BestätigenTyp	Zeichenfolge	Optional. Typ der anzuzeigenden Bestätigungsschaltfläche. Standard: Standard

Tabelle : 4. Rückgaben

Typ	Beschreibung
Zusage	Wenn ein callback -Parameter übergeben wird, gibt bei Erfolg ein Versprechen zurück, andernfalls wird ein Fehler zurückgegeben.

Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird, um die Bestätigungsmeldung „Möchten Sie diese Aktion wirklich durchführen?“ anzuzeigen.

function onClick(g_form) {

  if (g_user.userID != g_form.getValue('assigned_to')) {
    g_modal.alert('Only the assigned to can end this action.');
    return;
  }

  var msg = getMessage("Are you sure you want to take this action?");
  g_modal.confirm(getMessage("Confirmation"), msg, function (confirmed) {
    if (confirmed) {
      g_form.setValue('state', 'closed_complete');
      g_form.save();
    }
  });

  return false;
}

Ausgabe:

g_modal - confirmDestroom(Zeichenfolgentitel, Zeichenfolgennachricht, Funktionsrückruf, Stilobjekt)

Zeigt eine Bestätigungsmeldung zu einer UI-Aktion an, wobei die Bestätigungsschaltfläche als und destruktiver Stilangezeigt wird.

Tabelle : 5. Parameter

Name	Typ	Beschreibung
title	Zeichenfolge	Optional. Titel, der im Header des Modals angezeigt werden soll. Standard: Bestätigen
Nachricht	Zeichenfolge	Nachricht, die im modalen Textkörper angezeigt werden soll. Hinweis: Wenn Sie nur einen Parameter übergeben, wird dieser von der Methode als Parameter message behandelt.
Rückruf	Funktion	Optional. Funktion, die aufgerufen werden soll, nachdem das Formular übermittelt und auf dem Server verarbeitet wurde. Die Rückruffunktion weist das Format „callbackFunction(String action_verb, String sys_id, String table, String displayValue)“ auf, wobei: action_verb: Name der ausgeführten UI-Aktion. Beispiele: sysverb_cancel (Schaltfläche „Abbrechen“) sysverb_insert (Schaltfläche „Absenden“) sysverb_save (Schaltfläche „Speichern“). sys_id: Sys_id des betroffenen Datensatzes. table: Name der Tabelle, die den Datensatz enthält. displayValue: Wert, der im Formular angezeigt wird. Standard:
Stil	Objekt	Optional. Stil der Schaltflächen zum Bestätigen und Abbrechen, die im Modal angezeigt werden sollen. "style": { "cancelTitle": "String", "cancelType": "String", "confirmTitle": "String", "confirmType": "String" }
Stil.AbbrechenTitel	Zeichenfolge	Optional. Text, der auf der Abbrechen-Schaltfläche angezeigt werden soll. Standard: Abbrechen
Stil.AbbrechenTyp	Zeichenfolge	Optional. Typ der anzuzeigenden Abbruchschaltfläche. Standard: Bestätigen
„style.confirmTitle“	Zeichenfolge	Optional. Text, der auf der Bestätigungsschaltfläche angezeigt werden soll. Standard: OK
Stil.BestätigenTyp	Zeichenfolge	Optional. Typ der anzuzeigenden Bestätigungsschaltfläche. Standard: destruktiv

Tabelle : 6. Rückgaben

Typ	Beschreibung
Zusage	Wenn ein callback -Parameter übergeben wird, gibt bei Erfolg ein Versprechen zurück, andernfalls wird ein Fehler zurückgegeben.

In diesem Beispiel, ...

g_modal – RichText(Zeichenfolgentitel, Zeichenfolge „richContent“, Funktionsrückruf, Zeichenfolgengröße, Zeichenfolge „cancelTitle“, Zeichenfolge „confirmTitle“, Zeichenfolge „cancelType“, Zeichenfolge „confirmType“)

Zeigt ein Modal an, das übergebenen HTML-Code verwendet, um den Inhalt innerhalb des Modals zu generieren.

Tabelle : 7. Parameter

Name	Typ	Beschreibung
title	Zeichenfolge	Optional. Titel, der im Header des Modals angezeigt werden soll. Standard: leer
RichText	Zeichenfolge	HTML-Inhalt, der im Modal angezeigt werden soll. Hinweis: Diese Methode entfernt <![CDATA[<script> ]]> Tags, Inline-JavaScript und andere Elemente, die Sicherheitslücken darstellen könnten.
Rückruf	Funktion	Optional. Funktion, die aufgerufen werden soll, nachdem das Formular übermittelt und auf dem Server verarbeitet wurde. Die Rückruffunktion weist das Format „callbackFunction(String action_verb, String sys_id, String table, String displayValue)“ auf, wobei: action_verb: Name der ausgeführten UI-Aktion. Beispiele: sysverb_cancel (Schaltfläche „Abbrechen“) sysverb_insert (Schaltfläche „Absenden“) sysverb_save (Schaltfläche „Speichern“). sys_id: Sys_id des betroffenen Datensatzes. table: Name der Tabelle, die den Datensatz enthält. displayValue: Wert, der im Formular angezeigt wird. Standard:
AbbrechenTitel	Zeichenfolge	Optional. Text, der auf der Abbrechen-Schaltfläche angezeigt werden soll. Standard: Abbrechen
Bestätigen Sie Titel	Zeichenfolge	Optional. Text, der auf der Bestätigungsschaltfläche angezeigt werden soll. Standard: OK
cancelType	Zeichenfolge	Optional. Typ der anzuzeigenden Abbruchschaltfläche. Standard: Bestätigen
Bestätigen Sie den Typ	Zeichenfolge	Optional. Typ der anzuzeigenden Bestätigungsschaltfläche. Standard: Standard

Tabelle : 8. Ergebnisse

Typ	Beschreibung
Zusage	Wenn ein callback -Parameter übergeben wird, gibt bei Erfolg ein Versprechen zurück, andernfalls wird ein Fehler zurückgegeben.

g_modal – showFields(Zeichenfolgentitel, Array-Felder, Zeichenfolgenanweisung, Funktionsrückruf)

Zeigt ein modales Fenster an, das die angegebenen Felder enthält. Zeigt standardmäßig die Schaltflächen OK und Abbrechen an.

Tabelle : 9. Parameter

Name	Typ	Beschreibung
Rückruf	Funktion	Optional. Funktion, die aufgerufen werden soll, nachdem das Formular übermittelt und auf dem Server verarbeitet wurde. Die Rückruffunktion weist das Format „callbackFunction(String action_verb, String sys_id, String table, String displayValue)“ auf, wobei: action_verb: Name der ausgeführten UI-Aktion. Beispiele: sysverb_cancel (Schaltfläche „Abbrechen“) sysverb_insert (Schaltfläche „Absenden“) sysverb_save (Schaltfläche „Speichern“). sys_id: Sys_id des betroffenen Datensatzes. table: Name der Tabelle, die den Datensatz enthält. displayValue: Wert, der im Formular angezeigt wird. Standard:
AbbrechenTitel	Zeichenfolge	Optional. Bezeichnung für die Schaltfläche „Abbrechen“. Standard: Abbrechen
cancelType	Zeichenfolge	Optional. Typ der Schaltfläche zum Abbrechen. Standard: , Standard
Bestätigen Sie Titel	Zeichenfolge	Optional. Bezeichnung für die Bestätigungsschaltfläche. Standard: OK
Bestätigen Sie den Typ	Zeichenfolge	Optional. Typ der Bestätigungsschaltfläche. Standard: ,bestätigen
Felder	Array von Objekten	Liste der Felder, die im Modal anzeigen sollen. Jedes Feld ist in einem separaten Objekt definiert. Die fields -Parameter, die Sie übergeben, hängen vom Typ des angegebenen Felds (fields.type) ab. fields: [ { choices: "String", dispalyValue: "String", label: "String", mandatory: Boolean, name: "String", reference: "String", referringTable: "String", referringRecordId: "String", type: "String", value: "String" } ]
Felder.Auswahlmöglichkeiten	Array von Objekten	Erforderlich, wenn der Parameter fields.type auf Auswahlfestgelegt ist. Liste der Optionen, die im zugehörigen Listenfeld angezeigt werden sollen. Zum Beispiel: choices: [ { displayValue: 'Value 1', value: 'Value1' }, { displayValue: 'Value 2', value: 'Value2' } ]
felder.bezeichnung	Zeichenfolge	Text, der als Bezeichnung für dieses Feld im Modal angezeigt werden soll.
Felder.obligatorisch	Boolean	Optional. Kennzeichnung, die angibt, ob das Feld obligatorisch ist. Gültige Werte: wahr: Feld ist ein Pflichtfeld. „falsch“: Feld ist optional. Standardwert: false
fields.name	Zeichenfolge	Interner Name des Felds. Wenn der Parameter fields.type auf Referenzfestgelegt ist, ist dies das Referenzfeld im aktuellen Datensatz, das für die Suche verwendet wird.
felder.referenz	Zeichenfolge	Erforderlich, wenn der Parameter fields.type auf Referenzfestgelegt ist. Name der zu referenzierenden Tabelle. Beispiel: sys_user
felder.verweisenTabelle	Zeichenfolge	Erforderlich, wenn der Parameter fields.type auf Referenzfestgelegt ist. Name der Tabelle, auf die Sie verweisen. Beispiel: Incident
„fields.referringRecordId“	Zeichenfolge	Erforderlich, wenn der Parameter fields.type auf Referenzfestgelegt ist. Sys_id des Datensatzes, den Sie im UI-Aktionsformular aufrufen.
felder.type	Zeichenfolge	Typ des Felds, das im Modal angezeigt werden soll. Gültige Werte: boolean Auswahl glide_list HTML Referenz Zeichenfolge textarea Für jeden Feldtyp gibt es einen Satz von Optionen fields.<>, die übergeben werden können.
felder.wert	Zeichenfolge	Optional. Wert, der im Feld angezeigt werden soll. Für ein Auswahlfeld könnten Sie beispielsweise eine Benutzeraufforderung anzeigen: Wert: getMessage(' -- Auswählen -- ') Oder für ein Referenzfeld können Sie den Wert eines Felds im zugehörigen Formular anzeigen: g_form.getValue('caller_id') Standard: leer
Anweisung	Zeichenfolge	Optional. Anweisungen zum Anzeigen im Modal.
size	Zeichenfolge	Größe des Modals. Mögliche modale CSS-Klassen: Warnung: 300 px sm: 400 px md: 600 px LG: 900 px
Titel	Zeichenfolge	Optional. Titel, der im Header des Modals angezeigt werden soll. Standard: leer

Tabelle : 10. Rückgaben

Typ	Beschreibung
Zusage	Gibt bei Erfolg ein Versprechen zurück, andernfalls ein Fehler.

Das folgende Beispiel zeigt, wie Sie einen Benutzer mithilfe eines modalen Fensters zur Eingabe eines Grunds auffordern und anschließend an das Feld „Arbeitsnotizen“ im Datensatz zurückgegeben werden. Die Methodethen () gibt eine Zusage zurück, die das zurückgibt, was das Modal zurückgibt. fieldValues in diesem Fall. Das Feld „Arbeitsnotizen“ auf Client-Seite mit dem Feldwert befindet sich im Array „updatedFields“. Da nur ein Feld zurückgegeben wird, geht das Beispiel von einer Indexposition von 0aus.

function onClick(g_form) {
    g_modal.showFields({
        title: "Enter your reason",
        fields: [{
            type: 'textarea',
            name: 'work_notes',
            label: getMessage('Reason'),
            mandatory: true
        }],
        size: 'lg'
    }).then(function(fieldValues) {
        g_form.setValue('work_notes', fieldValues.updatedFields[0].value);
        g_form.save();
    });
}

Ausgabe:

Das folgende Beispiel erweitert das obige Beispiel und fügt Auswahlfelder und Referenzfelder hinzu.

function onClick(g_form) {

    var fields = [{
        type: 'textarea',
        name: 'work_notes',
        label: getMessage('Reason'),
        mandatory: true
    },
    {
        type: 'choice',
        name: 'reason_code',
        label: getMessage('Reason code'),
        value: getMessage(' -- Select -- '),
        choices: [
          {
            displayValue: 'Duplicate',
            value: 'duplicate'
          },
          {
            displayValue: 'Canceled',
            value: 'canceled'
          }
        ],
        mandatory: true
    },
    {
        type: 'reference',
        name: 'caller_id',
        label: getMessage('What is your name?'),
        mandatory: true,
        reference: 'sys_user',
        referringTable: 'incident',
        referringRecordId: g_form.getUniqueValue(),
	 value: g_form.getValue('caller_id'),
	 displayValue: g_form.getDisplayValue('caller_id')
    }
  ];

  g_modal.showFields({
    title: "Enter your reason",
    fields: fields,
    size: 'lg'
  }).then(function(fieldValues) {
        g_form.setValue('work_notes', fieldValues.updatedFields[0].value);
        g_form.setValue('caller_id', fieldValues.updatedFields[2].value);
        g_form.save();
  });
}

Ausgabe:

g_modal – showFrame(Zeichenfolgentitel, Zeichenfolgen-URL, Funktionsrückruf, Zeichenfolgengröße, Zeichenfolgenhöhe, Zeichenfolge autoCloseOn)

Zeigt ein modales Element an, das für seinen Inhalt einen Link zu einer externen URL oder UI-Seite verwendet.

Tabelle : 11. Parameter

Name	Typ	Beschreibung
title	Zeichenfolge	Optional. Titel, der im Header des Modals angezeigt werden soll. Standard: leer
URL	Zeichenfolge	URL der Informationen, die in den IFrame geladen werden sollen. Hinweis: Wenn nur ein Argument übergeben wird, wird es als Parameter url behandelt.
Rückruf	Funktion	Optional. Funktion, die aufgerufen werden soll, nachdem das Formular übermittelt und auf dem Server verarbeitet wurde. Die Rückruffunktion weist das Format „callbackFunction(String action_verb, String sys_id, String table, String displayValue)“ auf, wobei: action_verb: Name der ausgeführten UI-Aktion. Beispiele: sysverb_cancel (Schaltfläche „Abbrechen“) sysverb_insert (Schaltfläche „Absenden“) sysverb_save (Schaltfläche „Speichern“). sys_id: Sys_id des betroffenen Datensatzes. table: Name der Tabelle, die den Datensatz enthält. displayValue: Wert, der im Formular angezeigt wird. Standard:
size	Zeichenfolge	Größe des Modals. Mögliche modale CSS-Klassen: Warnung: 300 px sm: 400 px md: 600 px LG: 900 px
height	Nummer	Höhe des Modals. Einheit: Pixel
autoCloseOn	Zeichenfolge	Optional. Bedingung, unter der das Modal automatisch geschlossen werden soll, z. B. 'URL_CHANGED'. Standard: Modal nicht automatisch schließen.

Tabelle : 12. Rückgaben

Typ	Beschreibung
Zusage	Gibt bei Erfolg ein Versprechen zurück, andernfalls ein Fehler. Dieses Versprechen wird gelöst, wenn das IFrame-Modal geschlossen wird.

Das folgende Beispiel zeigt, wie ein KB-Artikel in einem Modell mithilfe der sys_id des KB-Artikeldatensatzes und einer Basis-URL angezeigt wird.

function onClick(g_form) {
  var kbId = '24d9243187032100deddb882a2e3ec33'; //sysId of KB article
  g_modal.showFrame({
    url: '/kb_view.do?sys_kb_id=' + kbId,
    title: 'Test Knowledge Article',
    size: 'lg',
    height: 500
  });
}

Ausgabe:

In diesem Beispiel wird gezeigt, wie eine eingebettete UI-Seite beim Erstellen eines modalen Elements verwendet wird. Es verwendet window.parent.postMessage() auf der UI-Seite, um Daten vom iFrame zurück an den Arbeitsbereich zu übergeben, da die g_form- API auf einer UI-Seite nicht zugänglich ist, wenn sie sich im iFrame befindet.

function onClick(g_form) {
  function proposeMIC(data) {
    var workNotes = data.msg + "\n" + data.workNotes;
    var notes = g_form.getValue('work_notes') + ' ' + workNotes;
    var bi = g_form.getValue('business_impact') + ' ' + data.businessImpact;
    g_form.setValue('work_notes', notes.trim());
    g_form.setValue('business_impact', bi.trim());
    g_form.submit('sysverb_mim_propose');
  }
	
  function openPopup() {
    if(!g_form.getControl('work_notes')) {
      getMessage('Cannot propose major incident as "Worknotes" is not visible', function(msg) {
	 g_form.addErrorMessage(msg);
      });
      return false;
    }

    var url = "/sn_major_inc_mgmt_mim_propose.do?sysparm_stack=no&sysparm_workspace=" + true;
    g_modal.showFrame({
      title: getMessage("Propose Major Incident"),
      url: url,
      size: 'lg',
      autoCloseOn: 'URL_CHANGED',
      callback: function (ret, data) {
        if (ret)
          proposeMIC(data);
      }
    });
  }
	
  openPopup();
}

Ausgabe: