OnCallContactPreferenceUtil – Global

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 4 Minuten Lesedauer

    • Die OnCallContactPreferenceUtil Die Skripteinbindung stellt Methoden für die Verarbeitung von Kontakteinstellungen bereit.

    Informationen zur Konfiguration der Kontakteinstellungen finden Sie unter Konfigurieren Sie Kontakteinstellungen .

    Diese Skripteinbindung unterstützt OnCallRotation Skripteinbindung.

    OnCallContactPreferenceUtil: OnCallContactPreferenceUtil()

    Erstellt eine Instanz der Klasse „OnCallContactPreferenceUtil“.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Keine

    OnCallContactPreferenceUtil – getContactsAtByEscalatee(Objekt-Eskalationsempfänger, Nummer contactAttempt, GlideDateTime gdt, Zeichenfolge rotaSysIds)

    Ruft eine Liste von Kontakten mit dem Objekt des Eskalationsempfängers ab. Jeder zurückgegebene Kontakt enthält eine Liste der Anwenderkontakteinstellungen.

    Tabelle : 2. Parameter
    Name Typ Beschreibung
    Eskalationsempfänger Objekt Obligatorisch. Eskalationsempfänger-Objekt, das von zurückgegeben wird GetEscalationPlan() Methode.
    ContactAttempt Anzahl Optional. Der Versuch, Kontakt aufzunehmen [ Standardwert = 1 ].
    • 1 : Erster Versuch
    • 2 : Erste Erinnerung
    • 3 oder mehr : Nachfolgende Erinnerungen
    gDT GlideDateTime Optional. jjjj-MM-TT HH:mm:ss-Format in der UTC-Zeitzone. Der Standardwert ist now.admin
    rotaSysIds Zeichenfolge Optional. Kommagetrennte Zeichenfolge von SYS-IDs von Schichten aus der Tabelle [cmn_Rota]. Der Standardwert gibt SYS-IDs der Schichten zum aktuellen Zeitpunkt zurück.
    Tabelle : 3. Rückgaben
    Typ Beschreibung
    Array-Objekt Array von Eskalierten (entweder ein Benutzer-, Gruppen- oder Gerätedatensatz, abhängig von den Benachrichtigungsregeln) zu einem bestimmten Zeitpunkt und an einer bestimmten Position.
    • Typ: Zeichenfolge. Typ des Kontakts, z. B. Anwender.
    • sys_ID: Zeichenfolge. SYS-ID des Anwenders aus der Tabelle [sys_user].
    • rota_ID: Zeichenfolge. SYS-ID der Schicht aus der Tabelle [cmn_Rota].
    • Roster_ID: Zeichenfolge. SYS-ID des Dienstplans aus der Tabelle [cmn_Rota_Roster].
    • Eskalation_STEP_ID: Zeichenfolge. Wenn ein Eskalationspfad definiert wurde, SYS-ID des Eskalationsschritts aus der Tabelle [cmn_Rota_esc_STEP_def].
    • Forced_communication_Channel: Zeichenfolge. Wenn in den Einstellungen angegeben, Obligatorisch Kommunikationskanal. Unterstützte Werte sind SMS, Sprach- oder E-Mail-Nachrichten.
    • Override_user_contact_preferences: Boolescher Wert. „Wahr“, wenn Kontaktüberschreibungen vorhanden sind, andernfalls „falsch“.
    • Preference_Source: Zeichenfolge. Quelle der Einstellung, z. B. Kontakt oder Gruppe.
    • Contact_attempt: Nummer. Kontaktversuche: 1 = erster Versuch, 2 = erste Erinnerung usw.
    • User_preferences: Array-Objekt.
      • Typ: Zeichenfolge. Bevorzugtes Kontaktformat des Anwenders, z. B. sms, E-Mail oder Nummer.
      • <Name des bevorzugten Formats, z. B. E-Mail oder Nummer>: Zeichenfolge. Inhalt des bevorzugten Kontakttyps, z. B. E-Mail-Adresse oder Telefonnummer.
    • Contact_preferences, Array-Objekt.
      • Typ: Zeichenfolge. Bevorzugtes Kontaktformat des Anwenders, z. B. E-Mail oder Nummer.
      • <Name des bevorzugten Formats, z. B. E-Mail oder Nummer>: Zeichenfolge. Inhalt des bevorzugten Kontakttyps, z. B. E-Mail-Adresse oder Telefonnummer.
    		 
    var serviceDeskSysId = '<Sys_ID>';
var ocRotation = new OnCallRotation();
var escalationPlan = ocRotation.getEscalationPlan(serviceDeskSysId);
var escalatee = escalationPlan[0];

var onContactPrefUtil = new OnCallContactPreferenceUtil();
var contactAttempt = 1;
var gdt = new GlideDateTime();
var contacts = onContactPrefUtil.getContactsAtByEscalatee(escalatee, contactAttempt, gdt);
gs.log(JSON.stringify(contacts));

    Ausgabe:

    [{
    "type": "user",
    "sys_id": "<Sys_ID>",
    "rota_id": "<Rotation_ID>",
    "roster_id": "",
    "escalation_step_id": "<Escalation_Step_ID>",
    "forced_communication_channel": "",
    "override_user_contact_preference": true,
    "preference_source": "contact",
    "contact_attempt": 1,
    "user_preferences": [{
        "type": "sms",
        "number": "8587200477"
    }],
    "contact_preferences": [{
        "type": "voice",
        "number": "5555555555"
    }]
}]

    OnCallContactPreferenceUtil – getUserPreferences(String userSysId, Number contactAttempt, GlideDateTime gdt, String communicationTypes)

    Ruft die Liste der Kontakteinstellungen zu dem Zeitpunkt ab, zu dem der Anwender die Kommunikation ausgewählt hat. Wenn keine Uhrzeit angegeben ist, wird die aktuelle Uhrzeit verwendet. Diese Methode gilt für einzelne und sich überschneidende Schichten.

    Tabelle : 4. Parameter
    Name Typ Beschreibung
    userSysId Zeichenfolge SYS-ID des Anwenders aus der Tabelle [sys_user].
    ContactAttempt Anzahl Optional. Der Versuch, Kontakt aufzunehmen [ Standardwert = 1 ].
    • 1 : Erster Versuch
    • 2 : Erste Erinnerung
    • 3 oder mehr : Nachfolgende Erinnerungen
    gDT GlideDateTime Optional. jjjj-MM-TT HH:mm:ss-Format in der UTC-Zeitzone. Standard ist jetzt.
    Kommunikationstypen Zeichenfolge Optional. Kommagetrennte Zeichenfolge, die mindestens einen der folgenden Werte enthält:
    • E-Mail
    • sms
    • voice

    Standardmäßig sind alle verfügbaren Kommunikationstypen enthalten.
    Tabelle : 5. Rückgaben
    Typ Beschreibung
    Array-Objekt Kontakteinstellung des Rufbereitschaftsanwenders.
    • Typ: Zeichenfolge. Bevorzugtes Kontaktformat des Anwenders, z. B. sms, E-Mail oder Nummer.
    • <Name des bevorzugten Formats, z. B. E-Mail oder Nummer>: Zeichenfolge. Inhalt des bevorzugten Kontakttyps, z. B. E-Mail-Adresse oder Telefonnummer.
    		 
    var onContactPrefUtil = new OnCallContactPreferenceUtil();
var contactAttempt = 1;
var gdt = new GlideDateTime();
var itilUserSysId = '<itilUserSysId>;
var userPreferences = onContactPrefUtil.getUserPreferences(itilUserSysId, contactAttempt, gdt);
gs.log(JSON.stringify(userPreferences));

    Ausgabe:

    [{
    "type": "sms",
    "number": "5555555555"
}, {
    "type": "voice",
    "number": "5555555555"
}]

    OnCallContactPreferenceUtil – getCatchAllContacts(Zeichenfolge rotaId, GlideDateTime gdt)

    Ruft eine Liste der Kontakte und Einstellungen für alle Kontakte und Einstellungen ab.

    Tabelle : 6. Parameter
    Name Typ Beschreibung
    rotaId Zeichenfolge SYS-ID der Schicht aus der Tabelle [cmn_Rota].
    gDT GlideDateTime Optional. jjjj-MM-TT HH:mm:ss-Format in der UTC-Zeitzone. Standard ist jetzt.
    Tabelle : 7. Rückgaben
    Typ Beschreibung
    Array-Objekt Liste der Ausweichkontakte mit Einstellungen.
    • Typ: Zeichenfolge. Typ des Kontakts, z. B. Anwender.
    • sys_ID: Zeichenfolge. SYS-ID des Anwenders aus der Tabelle [sys_user].
    • rota_ID: Zeichenfolge. SYS-ID der Schicht aus der Tabelle [cmn_Rota].
    • Roster_ID: Zeichenfolge. SYS-ID des Dienstplans aus der Tabelle [cmn_Rota_Roster].
    • Eskalation_STEP_ID: Zeichenfolge. Wenn ein Eskalationspfad definiert wurde, SYS-ID des Eskalationsschritts aus der Tabelle [cmn_Rota_esc_STEP_def].
    • Forced_communication_Channel: Zeichenfolge. Wenn in den Einstellungen angegeben, Obligatorisch Kommunikationskanal. Unterstützte Werte sind SMS, Sprach- oder E-Mail-Nachrichten.
    • Override_user_contact_preferences: Boolescher Wert. „Wahr“, wenn Kontaktüberschreibungen vorhanden sind, andernfalls „falsch“.
    • Preference_Source: Zeichenfolge. Quelle der Einstellung, z. B. Kontakt oder Gruppe.
    • Contact_attempt: Nummer. Kontaktversuche: 1 = erster Versuch, 2 = erste Erinnerung usw.
    • User_preferences: Array-Objekt.
      • Typ: Zeichenfolge. Bevorzugtes Kontaktformat des Anwenders, z. B. sms, E-Mail oder Nummer.
      • <Name des bevorzugten Formats, z. B. E-Mail oder Nummer>: Zeichenfolge. Inhalt des bevorzugten Kontakttyps, z. B. E-Mail-Adresse oder Telefonnummer.
    • Contact_preferences, Array-Objekt.
      • Typ: Zeichenfolge. Bevorzugtes Kontaktformat des Anwenders, z. B. E-Mail oder Nummer.
      • <Name des bevorzugten Formats, z. B. E-Mail oder Nummer>: Zeichenfolge. Inhalt des bevorzugten Kontakttyps, z. B. E-Mail-Adresse oder Telefonnummer.

    Beispiel:

    
var onContactPrefUtil = new OnCallContactPreferenceUtil();
var contactAttempt = 1;
var gdt = new GlideDateTime();
var rotaSysId = '<Rotation_Sys_ID>';
var catchAllContacts = onContactPrefUtil.getCatchAllContacts(rotaSysId, gdt);
gs.log(JSON.stringify(catchAllContacts));

    Ausgabe:

    [{
    "type": "user",
    "sys_id": "<Sys_ID>",
    "rota_id": "<Rotation_ID>",
    "roster_id": "",
    "escalation_step_id": "<Escalation_Step_ID>",
    "forced_communication_channel": "",
    "override_user_contact_preference": true,
    "preference_source": "contact",
    "contact_attempt": 1,
    "user_preferences": [{
        "type": "sms",
        "number": "8587200477"
    }],
    "contact_preferences": [{
        "type": "voice",
        "number": "5555555555"
    }]
}]