OnCallContactPrefTemplate – Global

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 1 Minute Lesedauer
  • Stellt Methoden bereit, um Kontakteinstellungsvorlagen auf Eskalationssätze anzuwenden.

    Weitere Informationen zum Eskalationsprozess finden Sie unter Defining On-Call Scheduling escalation process.

    Diese API erfordert das On-Call Scheduling-Plugin (com.snc.on_call_rotation).

    OnCallContactPrefTemplate – OnCallContactPrefTemplate()

    Instanziiert ein OnCallContactPrefTemplate -Objekt.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Keine

    In diesem Beispiel wird ein OnCallContactPrefTemplate -Objekt instanziiert.

    var contactPrefTemp = new global.OnCallContactPrefTemplate();

    OnCallContactPrefTemplate – copyContactPreferences(String templateSysId, String escalationSetSysId)

    Wendet eine Kontakteinstellungsvorlage auf einen Eskalationssatz an.

    Wenn die Vorlage auf den Eskalationssatz angewendet wird, werden Kontaktversuchsdatensätze in der Tabelle „Kontakteinstellung für Schicht“ [cmn_rota_contact_preference] erstellt.

    Rufen Sie vor dem Aufrufen dieser Methode die Methode deleteContactPreferenceAttempts() auf, um vorhandene Kontaktversuchsdatensätze zu löschen. Wenn vorhandene Datensätze nicht zuerst gelöscht werden, gibt diese Methode einen Fehler zurück.

    Tabelle : 2. Parameter
    Name Typ Beschreibung
    templateSysId Zeichenfolge Sys_id der Kontakteinstellungsvorlage in der Tabelle „Kontakteinstellungsvorlage für Rufbereitschaft“ [on_call_template_contact_preference].
    eskalationSetSysId Zeichenfolge Sys_id des Eskalationssatzes in der Tabelle „Schichteskalationssatz“ [cmn_rota_escalation_set].
    Tabelle : 3. Ergebnisse
    Typ Beschreibung
    Objekt
    Objekt mit Fehler- und Warnmeldungen. Wenn der Vorgang erfolgreich war, ist dieses Objekt leer.
    Hinweis:
    Wenn ein Fehler auftritt, wird der Vorgang beendet, und die Vorlage wird nicht angewendet. Wenn eine Warnung auftritt, wird der Vorgang fortgesetzt, und es werden noch einige Datensätze erstellt.
    {
      "error": "String", 
      "warning": "String" 
    }
    <Object>.Fehler Fehlermeldung.
    Mögliche Werte:
    • sys_id der Kontakteinstellungsvorlage ist nicht korrekt
    • sys_id des Eskalationssatzes ist nicht korrekt
    • Kontaktversuche sind bereits vorhanden

    Datentyp: Zeichenfolge

    <Object>.Warnung Warnmeldung.

    Datentyp: Zeichenfolge

    In diesem Beispiel wird eine Kontakteinstellungsvorlage auf den Eskalationssatz „Service Desk – Standard“ angewendet. Das Rückgabeobjekt ist leer, da keine Fehler oder Warnungen vorliegen.

    var escSetSysId = "a47ac1abeb5a6110249e8d835d5228aa";
    var templateSysId = "f8dac9ebeb5a6110249e8d835d522873";
    
    var contactPrefTemp = new global.OnCallContactPrefTemplate();
    
    // delete existing contact attempt records before applying the template
    contactPrefTemp.deleteContactPreferenceAttempts(escSetSysId); 
    
    var result = contactPrefTemp.copyContactPreferences(templateSysId, escSetSysId);
    gs.info(JSON.stringify(result));

    Ausgabe:

    {}

    OnCallContactPrefTemplate – deleteContactPreferenceAttempts(String escalationSetSysId)

    Löscht alle Kontakteinstellungen, die einem Eskalationssatz zugeordnet sind.

    Alle Kontaktversuchsdatensätze für den Eskalationssatz werden aus der Tabelle „Kontakteinstellung für Schicht“ [cmn_rota_contact_preference] gelöscht.

    Tabelle : 4. Parameter
    Name Typ Beschreibung
    eskalationSetSysId Zeichenfolge Sys_id des Eskalationssatzes in der Tabelle „Schichteskalationssatz“ [cmn_rota_escalation_set].
    Tabelle : 5. Ausgabe
    Typ Beschreibung
    Keine

    In diesem Beispiel werden alle Kontakteinstellungen gelöscht, die dem Eskalationssatz „Service Desk – Standard“ zugeordnet sind.

    var escSetSysId = "a47ac1abeb5a6110249e8d835d5228aa";
    var contactPrefTemp = new global.OnCallContactPrefTemplate();
    
    contactPrefTemp.deleteContactPreferenceAttempts(escSetSysId);