openFrameAPI : Client

Die openFrameAPI stellt Methoden bereit, die mit OpenFrame interagieren. OpenFrame ist ein häufiger Frame, mit dem Kommunikationspartner ihre Systeme in die ServiceNow-Plattform integrieren können.

Eine der Hauptanforderungen ist die Fähigkeit, Code aus verschiedenen Domänen zu verbinden und bereitzustellen, die sich nahtlos mit Partner-Subsystemen verbinden können. Diese domänenübergreifende Verbindung ist erforderlich, um Verbindungen und Rückrufe in Kommunikationssystemen ohne domänenübergreifende Probleme zu registrieren.

OpenFrame hat zwei wesentliche Teile: einen in der ServiceNow-Anwendung (als TopFrame bezeichnet) und diese API, die von der Partneranwendung bezogen wird. Diese API verfügt über die erforderlichen Methoden, um mit TopFrame zu kommunizieren und die visuellen Funktionen von OpenFrame zu steuern.

Hinweis:

Um in Bezug auf die OpenFrame-Bibliothek aktuell zu bleiben, verwenden Sie den folgenden Ressourcen-URI: https://[servicenow-Instanz]/scripts/openframe/latest/openFrameAPI.min.js.

openFrameAPI – getAWAAgentPresence (Zeichenfolge erfolgreich, Zeichenfolgenfehler)

Gibt den aktuellen Anwesenheitsstatus des angemeldeten Service Desk-Mitarbeiters zurück.

Tabelle : 1. Parameter

Name	Typ	Beschreibung
Erfolg	Zeichenfolge	Wenn die Methode erfolgreich ist, Name der aufzurufenden Rückruffunktion.
Fehler	Zeichenfolge	Wenn die Methode fehlschlägt, Name der aufzurufenden Rückruffunktion.

Tabelle : 2. Ergebnisse

Typ	Beschreibung
presence	Ergebnisse, die von der openFrame-Infrastruktur an die Erfolgs-Rückruffunktion übergeben werden. Datentyp: Objekt "presence": { "available": Boolean, "channels": [Array], "name": "String", "sys_id": "String" }
presence.available	Kennzeichnung, die angibt, ob der zugeordnete Agent verfügbar ist. Gültige Werte: wahr: Service Desk-Mitarbeiter ist verfügbar. „falsch“: Service Desk-Mitarbeiter ist nicht verfügbar. Datentyp: Boolesch
presence.channels	Liste der verfügbaren Kanäle für die Kommunikation mit dem Service Desk-Mitarbeiter Datentyp: Array von Objekten "channels": [ { "available": Boolean, "name": "String", "restrict_update": Boolean, "service_channel_type": "String", "sys_id": "String" } ]
presence.channels.available	Kennzeichnung, die angibt, ob der Kanal verfügbar ist. Gültige Werte: wahr: Kanal ist verfügbar. false: Kanal ist nicht verfügbar. Datentyp „Boolesch“.
presence.channels.name	Name des Kanals, z. B. Chat oder Telefon. Datentyp: Zeichenfolge
„präsenz.kanäle.beschränken_aktualisieren“	Kennzeichnung, die angibt, ob der Anwender Aktualisierungen für den Kanal einschränken kann. Gültige Werte: „wahr“: Der Anwender kann Aktualisierungen für den Kanal einschränken. „falsch“: Der Anwender kann Aktualisierungen für den Kanal nicht einschränken. Datentyp „Boolesch“.
präsenz.kanäle.service_kanal_typ	Typ des Servicekanals. Datentyp: Zeichenfolge
presence.channels.sys_id	Sys_id des Kanaldatensatzes. Befindet sich in der Tabelle „Servicekanäle“ [awa_service_channel]. Datentyp: Zeichenfolge
presence.name	Name des Anwesenheitsstatus des Service Desk-Mitarbeiters Datentyp: Zeichenfolge
presence.sys_id	Sys_id des Anwesenheitsstatus-Datensatzes. Befindet sich in der Tabelle „Anwesenheitsstatus“ [awa_presence_state]. Datentyp: Zeichenfolge

Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

function failure(data)
{
  console.log("failure: " + JSON.stringify(data));
}
 
function success(data)
{
  console.log("success: " + JSON.stringify(data));
}
 
openFrameAPI.getAWAAgentPresence(success, failure)

Antwort auf erfolgreiche Rückruffunktion:

success: { 
  "presence": { 
    "name": "Available", 
    "sys_id": "0b10223c57a313005baaaa65ef94f970", 
    "available": true, 
    "channels": [ 
      { 
        "name": "Chat", 
        "available": true, 
        "sys_id": "27f675e3739713004a905ee515f6a7c3", 
        "restrict_update": false, 
        "service_channel_type": "chat" 
      } 
    ] 
  } 
}

openFrameAPI – hide()

Blendet den OpenFrame im TopFrame aus.

Tabelle : 3. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 4. Ergebnisse

Typ	Beschreibung
void

openFrameAPI.hide()

openFrameAPI – init(Object config, function successCallback, function failureCallback)

Initialisiert OpenFrame. Dies muss die erste Methode sein, die Sie aufrufen.

Diese Methode initialisiert die Kommunikation für TopFrame und initialisiert alle visuellen Elemente, die im Parameter config übergeben werden.

Tabelle : 5. Parameter

Name	Typ	Beschreibung
Konfiguration	Objekt	Während des Initialisierungsprozesses zu verwendende Name-Wert-Paare. Mögliche Schlüssel: height Untertitel Titel Titelsymbol width Alle Schlüssel sind optional. Übergeben Sie ein leeres Objekt, wenn Sie diese Schlüssel-Wert-Paare nicht festlegen möchten.
successCallback	function	Name der Rückruffunktion, die verwendet werden soll, wenn die Init- Methode erfolgreich ist. Die im System gespeicherte OpenFrame-Konfiguration wird als Parameter an die Rückruffunktion übergeben.
failureCallback	function	Name der Rückruffunktion, die verwendet wird, wenn die Init- Methode fehlschlägt.

Tabelle : 6. Ergebnisse

Typ	Beschreibung
void

var config = {
height: 300,
width: 200
}
function handleCommunicationEvent(context) {
console.log("Communication from Topframe", context);
}
function initSuccess(snConfig) {
console.log("openframe configuration", snConfig);
//register for communication event from TopFrame
openFrameAPI.subscribe(openFrameAPI.EVENTS.COMMUNICATION_EVENT,
handleCommunicationEvent);
}
function initFailure(error) {
console.log("OpenFrame init failed...", error);
}
openFrameAPI.init(config, initSuccess, initFailure);

openFrameAPI – isVisible(function callback)

Überprüft, ob der OpenFrame im TopFrame sichtbar ist.

Tabelle : 7. Parameter

Name	Typ	Beschreibung
callback	function	Die Callback-Funktion empfängt einen Parameter mit dem Wert „true“ oder „false“. „True“, wenn OpenFrame sichtbar ist, und „false“, wenn nicht sichtbar.

Tabelle : 8. Ergebnisse

Typ	Beschreibung
void

function callback(isVisible) {
console.log(isVisible)
}
openFrameAPI.isVisible(callback)

openFrameAPI - openCustomURL(String details)

Öffnet eine anwenderdefinierte URL in der UI16-Schnittstelle.

Tabelle : 9. Parameter

Name	Typ	Beschreibung
URL	Zeichenfolge	Text der anwenderdefinierten URL. Maximale Größe: 2083 Zeichen

Tabelle : 10. Ergebnisse

Typ	Beschreibung
void

openFrameAPI.openCustomURL('10_cool_things.do');

openFrameAPI – openServiceNowForm(Object details)

Öffnet eine Formular-URL.

Wenn ein Agent einen eingehenden Anruf erhält, werden im OpenFrame-Fenster Informationen wie Account, Kontakt oder Verbraucher angezeigt. Durch Klicken auf einen Link im OpenFrame-Fenster wird der entsprechende Datensatz angezeigt.

• In der Plattform-Schnittstelle öffnet diese API eine Formular-URL im TopFrame.
• Für Mitarbeiterbereich unterstützt diese API die Verwaltung der Interaktionsregisterkarte. In Mitarbeiterbereich wird ein Interaktionsdatensatz auf einer übergeordneten Registerkarte geöffnet, und der angegebene Entitätsdatensatz wird auf einer untergeordneten Registerkarte unter der Interaktionsregisterkarte geöffnet.

Tabelle : 11. Parameter

Name	Typ	Beschreibung
details	Objekt	Schlüssel-Wert-Paare, die die zu öffnende Formular-URL identifizieren. "details": { "entity": "String"; "interaction_sys_id": "String"; "query": "String" }
details.entity	Zeichenfolge	Tabellen- oder Entitätsname.
details.interaction_sys_id	Zeichenfolge	Optional. Sys_id des Interaktionsdatensatzes, der als übergeordnete Registerkarte in Mitarbeiterbereichgeöffnet werden soll. Hinweis: In der Plattform-Schnittstelle wird interaction_sys_id ignoriert.
details.query	Zeichenfolge	Abfrage, um den zu öffnenden Datensatz zu identifizieren, z. B.: query:'sys_id=<record_sys_id>'.

Tabelle : 12. Ergebnisse

Typ	Beschreibung
void

Das folgende Beispiel zeigt die grundlegende Verwendung in Plattform:

openFrameAPI.openServiceNowForm({entity:'customer_account', 
query:'sys_id=447832786f0331003b3c498f5d3ee452', 'interaction_sys_id':'3be092313b711300758ce9b534efc4dd'});

Das folgende Beispiel zeigt, wie Sie den Parameter query verwenden, um einen neuen Datensatz mit Daten zu erstellen, die im Formular bereitgestellt werden, indem Sie sysparm_query und eine codierte Abfrage verwenden, um die Felder für den Vor- und Nachnamen im -Arbeitsbereich auszufüllen:

openFrameAPI.openServiceNowForm({ entity: 'sys_user',
query: 'sys_id=-1&sysparm_query=first_name=Ivan^last_name=Greggor' });

openFrameAPI – openServiceNowFormwithChildTabIf()

Öffnet ein Formular ServiceNow mit einer untergeordneten Registerkarte, wenn es in einem Arbeitsbereich aufgerufen wird, oder öffnet eine Entität, wenn es in der UI16-Schnittstelle aufgerufen wird.

Tabelle : 13. Parameter

Name	Typ	Beschreibung
Öffnen Sie ServiceNowFormularmitUntergeordneterRegisterkarte	Objekt	Definiert, ob die API ein Formular ServiceNow mit einer untergeordneten Registerkarte öffnet, wenn sie in einem Arbeitsbereich aufgerufen wird, oder eine Entität, wenn sie über die UI16-Schnittstelle aufgerufen wird. openFrameAPI.openServiceNowFormwithChildTablf({ entity: “String”, sys_id: “String”, parent_entity: “String”, parent_entity_sys_id: “String”,
Öffnen Sie ServiceNowFormularmitUntergeordneterRegisterkarte.entity	Zeichenfolge	Name der Tabelle.
openServiceNowFormwithChildTab.sys_id	Zeichenfolge	Sys_id des zu öffnenden Datensatzes.
„openServiceNowFormwithChildTab.parent_entity“	Zeichenfolge	Name der Tabelle, die als übergeordnete Registerkarte geöffnet werden soll.
„openServiceNowFormwithChildTab.parent_entity_sys_id“	Zeichenfolge	Sys_id des zu öffnenden übergeordneten Datensatzes.

Tabelle : 14. Ergebnisse

Typ	Beschreibung
Keine

Das folgende Beispiel öffnet die übergeordnete Entität als übergeordnete Registerkarte in einem konfigurierten Arbeitsbereich oder öffnet nur die Entität, wenn sie in UI16 aufgerufen wird.

openFrameAPI.openServiceNowFormwithChildTablf({
	entity: “customer_account”, 
	sys_id: “447832786f0331003b3c498f5d3ee452”, 	
	parent_entity: “interaction”, 
	parent_entity_sys_id: “3be092313b711300758ce9b534efc4dd”
});

openFrameAPI – openServiceNowList(Object details)

Öffnet eine Listen-URL in der UI16-Schnittstelle.

Tabelle : 15. Parameter

Name	Typ	Beschreibung
details	Objekt	Schlüssel-Wert-Paare, die den Inhalt beschreiben, der beim Öffnen der Listen-URL verwendet werden soll. Gültige Werte: Entität: Tabellenname Abfrage: Codierte Abfragezeichenfolge

Tabelle : 16. Ergebnisse

Typ	Beschreibung
void

openFrameAPI.openServiceNowList({entity:'case', query:'active=true'});

openFrameAPI - setFrameMode(mode)

Legt den OpenFrame-Modus fest.

Der in dieser API übergebene Modus:

• Legt das entsprechende Symbol im Header fest: reduzieren oder erweitern.
• Löst das relevante Event für CTI aus:
  • openFrameAPI.EVENTS.COLLAPSE
  • openFrameAPI.EVENTS.EXPAND

Tabelle : 17. Parameter

Name	Typ	Beschreibung
Modus	Zeichenfolge	Legen Sie den OpenFrame-Modus fest. Aufgelistete Optionen: openFrameAPI.FRAME_MODE.COLLAPSE openFrameAPI.FRAME_MODE.EXPAND

Tabelle : 18. Ergebnisse

Typ	Beschreibung
void

openFrameAPI.setFrameMode(openFrameAPI.FRAME_MODE.COLLAPSE);

openFrameAPI - setHeight(height)

Legt die OpenFrame-Höhe fest.

Tabelle : 19. Parameter

Name	Typ	Beschreibung
Höhe	Nummer	Höhe in Pixel

Tabelle : 20. Ergebnisse

Typ	Beschreibung
void

openFrameAPI.setHeight(100);

openFrameAPI – setIcons(Array icons)

Definiert Symbole im OpenFrame-Header, die neben dem Schließsymbol platziert werden.

Tabelle : 21. Parameter

Name	Typ	Beschreibung
icons	Array von Objekten	Eine Liste von Symbolkonfigurationen, wobei jede Symbolkonfiguration ein Objekt mit den Schlüsselwerten imageURL, imageTitleund einem beliebigen anderen erforderlichen Kontext ist. Maximale Größe: Symbole dürfen maximal 16 x 16 Pixel groß sein. Größere Bilder werden automatisch an diesen Höchstwert angepasst.

Tabelle : 22. Ergebnisse

Typ	Beschreibung
void

openFrameAPI.setIcons([{imageURL:'https://mydomian.com/image/mute.png',
imageTitle:'mute', id:101}, {imageURL:'https://mydomian.com/image/hold.png',
imageTitle:'hold', id:102}]);

openFrameAPI - setPresenceIndicator(presence)

Legt den Anwesenheitsindikator fest, um die Agent-Verfügbarkeit in einem Arbeitsbereich anzuzeigen.

Weitere Informationen zur Konfiguration von OpenFrame finden Sie unter OpenFrame-Konfiguration erstellen

Tabelle : 23. Parameter

Name	Typ	Beschreibung
state	Zeichenfolge	Anwesenheitsstatus des Agent. Standardstatus: Verfügbar Abwesend Offline Sie können auch benutzerdefinierte Status angeben.
color	Zeichenfolge	Farbe des Anwesenheitsindikators im Arbeitsbereich. Unterstützte Farben: rot Orange grau grün

Tabelle : 24. Ergebnisse

Typ	Beschreibung
void

openframeAPI.setPresenceIndicator('Available', 'green');

openFrameAPI – setSize(Number width, Number height)

Legt die OpenFrame-Größe fest.

Tabelle : 25. Parameter

Name	Typ	Beschreibung
width	Zahl	Sollte größer als null sein.
height	Zahl	Sollte größer als null sein.

Tabelle : 26. Ergebnisse

Typ	Beschreibung
void

openFrameAPI.setSize(300, 370);

openFrameAPI – setSubtitle(String subTitle)

Legt den OpenFrame-Untertitel fest.

Tabelle : 27. Parameter

Name	Typ	Beschreibung
subTitle	Zeichenfolge	Eine Zeichenfolge mit maximal 256 Zeichen.

Tabelle : 28. Ergebnisse

Typ	Beschreibung
void

openFrameAPI.setSubtitle('[phone]');

openFrameAPI – setTitle(String title)

Legt den OpenFrame-Titel fest.

Tabelle : 29. Parameter

Name	Typ	Beschreibung
title	Zeichenfolge	Eine Zeichenfolge mit maximal 256 Zeichen.

Tabelle : 30. Ergebnisse

Typ	Beschreibung
void

openFrameAPI.setTitle('Incoming Call');

openFrameAPI – setTitleIcon(Object icon)

Legt das Titelsymbol von OpenFrame fest.

Tabelle : 31. Parameter

Name	Typ	Beschreibung
icon	Objekt	Objekt von Schlüssel-Wert-Paaren. Schlüssel sind imageURL, imageTitleund jeder andere erforderliche Kontext. Maximale Größe: Symbole dürfen maximal 16 x 16 Pixel groß sein. Größere Bilder werden automatisch an diesen Höchstwert angepasst.

Tabelle : 32. Ergebnisse

Typ	Beschreibung
void

openFrameAPI.setTitleIcon({imageURL:'/my/image/path.png', imageTitle:'mute', id:101});

openFrameAPI.setTitleIcon({imageURL:'https://mydomian.com/image/path.png',
imageTitle:'mute', id:101});

openFrameAPI - setWidth(width)

Legt die OpenFrame-Breite fest.

Tabelle : 33. Parameter

Name	Typ	Beschreibung
Breite	Nummer	Breite in Pixel

Tabelle : 34. Ergebnisse

Typ	Beschreibung
void

openFrameAPI.setWidth(100);

openFrameAPI – show()

Macht den OpenFrame im TopFrame sichtbar.

Tabelle : 35. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 36. Ergebnisse

Typ	Beschreibung
void

openFrameAPI.show()

openFrameAPI – subscribe(openFrameAPIEVENT event, function eventCallback)

Abonniert ein angegebenes Ereignis.

Tabelle : 37. Parameter

Name	Typ	Beschreibung
event	openFrameAPIEVENT	Das zu abonnierende Ereignis: openframe_agent_off_interaction: Gibt die Anwesenheit eines Service Desk-Mitarbeiters im Chat als „off“ oder „verfügbar“ an. openframe_awa_agent_presence: In Erweiterte Arbeitszuweisung (AWA) tritt dieses Ereignis auf, wenn sich der Anwesenheitsstatus des Service Desk-Mitarbeiters ändert. Entwickler von Computer-Telefonie-Integrationen (CTI) können dieses Ereignis abonnieren, um Änderungen des Anwesenheitsstatus zu erhalten. openframe_awa_workitem_accepted: Tritt auf, wenn ein Service Desk-Mitarbeiter ein Arbeitselement akzeptiert. openframe_awa_workitem_offered: Tritt auf, wenn einem Service Desk-Mitarbeiter ein Arbeitselement angeboten wird. openframe_awa_workitem_rejected: Tritt auf, wenn ein Arbeitselement von einem Service Desk-Mitarbeiter abgelehnt wird. openframe_before_destroy: Tritt ein, bevor der TopFrame entladen wird. openframe_collapse: Wird ausgelöst, wenn im OpenFrame-Header das Symbol zum Reduzieren ausgewählt ist. openframe_communication: Anwendungsspezifisch und kann angepasst werden. openframe_communication_failure: Tritt ein, wenn die Kommunikation mit TopFrame fehlschlägt. openframe_expand: Wird ausgelöst, wenn das Erweiterungssymbol im OpenFrame-Header ausgewählt ist. openframe_header_icon_clicked: Veraltet. Verwenden Sie stattdessen openframe_icon_clicked oder openframe_title_icon_clicked. openframe_hidden: Tritt ein, wenn der OpenFrame ausgeblendet ist. openframe_icon_clicked: Tritt auf, wenn in der OpenFrame-Fußzeile ein anderes Symbol als das Schließen-Symbol ausgewählt wird. Der Callback empfängt das Icon-Objekt als einen Parameter. openframe_shown: Tritt ein, wenn der OpenFrame angezeigt wird. openframe_title_icon_clicked: Tritt auf, wenn das Titelsymbol in OpenFrame ausgewählt wird. Der Callback empfängt das titleIcon-Objekt als Parameter.
eventCallback	function	Funktion, die aufgerufen werden soll, wenn das angegebene Ereignis auftritt.

Tabelle : 38. Ergebnisse

Typ	Beschreibung
Ergebnisse	Die meisten Ereignisabonnements haben keine Rückgabewerte. In den folgenden Tabelleneinträgen werden die Ereignisabonnements beschrieben, die Werte zurückgeben.
openframe_awa_agent_presence	In AWAgibt das Ereignis openframe_awa_agent_presence das Anwesenheitsobjekt zurück: "presence":{ "available": Boolean, "channels":[ { "available": Boolean, "name": "String", "restrict_update": Boolean, "sys_id": "String" } ], "name": "String", "sys_id": "String" } presence: Informationen über den aktuellen Anwesenheitsstatus und Kanal eines Service Desk-Mitarbeiters. presence.available: Kennzeichnung, die angibt, ob der Service Desk-Mitarbeiter verfügbar ist. presence.channels: Liste von Objekten, die die verfügbaren Kommunikationskanäle mit dem Service Desk-Mitarbeiter beschreiben. presence.channels.available: Kennzeichnung, die angibt, ob der Kanal verfügbar ist. presence.channels.name: Kanalname, z. B. Chat oder Telefon. presence.channels.restrict_update: Kennzeichnung, die angibt, ob der Anwender Aktualisierungen einschränken kann. presence.channels.sys_id: sys_id des Kanals Befindet sich in der Tabelle „Servicekanäle“ [awa_service_channel]. presence.name: Name des Anwesenheitsstatus des Service Desk-Mitarbeiters presence.sys_id: Anwesenheitsstatus-sys_id. Befindet sich in der Tabelle „Anwesenheitsstatus“ [awa_presence_state].
openframe_awa_workitem_accepted und openframe_awa_workitem_offered	In AWAgeben die Ereignisse openframe_awa_workitem_accepted und openframe_awa_workitem_offered das workItem- Objekt zurück: "workItem": { "document": { "sys_id": "String", "table": "String" }, "isQueueTransferred": Boolean, "previousWorkItem": "String", "serviceChannel": { "name": "String", "sys_id": "String" }, "size": Number, "sys_id": "String" } workItem: Informationen zum Arbeitselement, das dem Ereignis zugeordnet ist. workItem.document: Liste der Dokumente, die der Arbeitselementaufgabe zugeordnet sind. workItem.document.sys_id: Sys_id des Dokuments, das der Arbeitselementaufgabe zugewiesen ist. workItem.document.table: Name der Dokumenttabelle, die der Aufgabe zugewiesen ist. workItem.isQueueTransferred: Gibt an, ob das Arbeitselement in der Warteschlange übertragen wird. Auf „wahr“ festlegen, wenn das Arbeitselement in der Warteschlange übertragen wird, andernfalls auf „falsch“. Weitere Informationen zu Warteschlangenübertragungen finden Sie unter Transfer a chat to another queue. workItem.previousWorkItem: Sys_id des vorherigen Arbeitselements für dieselbe Dokument-ID. Für die Nicht-Transfer-Arbeitselemente ist dieser Wert leer. workItem.serviceChannel: Liste der Servicekanäle, die der Arbeitselementaufgabe zugeordnet sind. workItem.serviceChannel.name: Name des Servicekanals, z. B. Chat oder Telefon. workItem.serviceChannel.sys_id: Sys_id des Servicekanals. workItem.size: Kapazität des Service Desk-Mitarbeiters, die verwendet wird, wenn dem Service Desk-Mitarbeiter dieses Arbeitselement zugewiesen wird. workItem.sys_id: Sys_id des Arbeitselements, das akzeptiert oder angeboten wurde.
openframe_awa_workitem_rejected	In AWAgibt das Ereignis openframe_awa_workitem_rejected das workItem- Objekt zurück: "workItem": { "document": { "sys_id": "String", "table": "String" }, "isQueueTransferred": Boolean, "previousWorkItem": "String", "rejection": { "reason": "String", "sys_id": "String" }, "serviceChannel": { "name": "String", "sys_id": "String" }, "size": Number, "sys_id": "String" } workItem: Informationen zum Arbeitselement, das dem Ereignis zugeordnet ist. workItem.document: Liste der Dokumente, die der Arbeitselementaufgabe zugeordnet sind. workItem.document.sys_id: Sys_id des Dokuments, das der Arbeitselementaufgabe zugewiesen ist. workItem.document.table: Name der Dokumenttabelle, die der Aufgabe zugewiesen ist. workItem.isQueueTransferred: Gibt an, ob das Arbeitselement in der Warteschlange übertragen wird. Auf „wahr“ festlegen, wenn das Arbeitselement in der Warteschlange übertragen wird, andernfalls auf „falsch“. Weitere Informationen zu Warteschlangenübertragungen finden Sie unter Transfer a chat to another queue. workItem.previousWorkItem: Sys_id des vorherigen Arbeitselements für dieselbe Dokument-ID. Für die Nicht-Transfer-Arbeitselemente ist dieser Wert leer. workItem.rejection: Liste der Gründe für die Ablehnung des Arbeitselements. workItem.rejection.reason: Name des Grunds für die Ablehnung der Arbeitselemente. workItem.rejection.sys_id: Sys_id des Ablehnungsgrunds. Befindet sich in der Tabelle „Ablehnungsgründe“ [awa_reject_reason]. workItem.serviceChannel: Liste der Servicekanäle, die der Arbeitselementaufgabe zugeordnet sind. workItem.serviceChannel.name: Name des Servicekanals, z. B. Chat oder Telefon. workItem.serviceChannel.sys_id: Sys_id des Servicekanals. workItem.size: Kapazität des Service Desk-Mitarbeiters, die verwendet wird, wenn dem Service Desk-Mitarbeiter dieses Arbeitselement zugewiesen wird. workItem.sys_id: Sys_id des Arbeitselements, das akzeptiert oder angeboten wurde.

Das folgende Codebeispiel zeigt, wie diese Methode für ein openframe_awa_agent_presence -Ereignis aufgerufen wird.

function handleIconClick(context) {
console.log("Icon was clicked", context);
}
openFrameAPI.subscribe(openFrameAPI.events.openframe_awa_agent_presence, handleIconClick);

Ausgabe:

// Sample presence object output
// openframe_awa_agent_presence event only

{
  "result":{
    "presence":{
      "name":"Available",
      "sys_id":"27f675e3739713004a905ee515f6a7c3",
      "available":true,
      "channels":[
        {
          "name":"Chat",
          "available":true,
          "sys_id":"36f675e4239713124a905fe515f6a832",
          "restrict_update":false
        },
        {
          "name":"Phone",
          "available":true,
          "sys_id":"9378a530a1820610f809018efd9bc01e",
          "restrict_update":false
        }
      ]
    }
  }
}

Das folgende Codebeispiel zeigt, wie diese Methode für ein openframe_awa_workitem_accepted -Ereignis aufgerufen wird.

function handleIconClick(context) {
console.log("Icon was clicked", context);
}
openFrameAPI.subscribe(openFrameAPI.events.openframe_awa_workitem_accepted, handleIconClick);

Ausgabe:

// Sample workItem object output
// openframe_awa_workitem_accepted event only
{
  "result": {
    "workItem": {
      "sys_id": "14c86c40a1650610f87701807d9bc0be",
      "size": 1,
      "serviceChannel": {
        "name": "Chat",
        "sys_id": "27f675e3739713004a905ee515f6a7c3"
      },
      "document": {
        "sys_id": "aa582040a1650610f87701807d9bc076",
        "table": "interaction"
      },
      "previousWorkItem": "7c78a440a1650610f87701807d9bc02b",
      "isQueueTransferred": true
    }
  }
}

Das folgende Codebeispiel zeigt, wie diese Methode für ein openframe_awa_workitem_rejected -Ereignis aufgerufen wird.

function handleIconClick(context) {
console.log("Icon was clicked", context);
}
openFrameAPI.subscribe(openFrameAPI.events.openframe_awa_workitem_rejected, handleIconClick);

Ausgabe:

// Sample workItem object output
// openframe_awa_workitem_rejected event only
{
  "payload": {
    "workItem": {
      "sys_id": "2c3bdc4824250610f8775e73b116f8de",
      "size": "1",
      "serviceChannel": {
        "name": "Chat",
        "sysID": "27f675e3739713004a905ee515f6a7c3"
      },
      "document": {
        "sys_id": "cf0a180824250610f8775e73b116f80c",
        "table": "interaction"
      },
      "rejection": {
        "reason": "Busy",
        "sys_id": "4e93fa29b38023002e7b6e5f26a8dc20"
      },
      "previousWorkItem": "831b9c4824250610f8775e73b116f841",
      "isQueueTransferred": true
    }
  }
}

openFrameAPI – version()

Gibt die OpenFrame-API-Version zurück.

Tabelle : 39. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 40. Ergebnisse

Typ	Beschreibung
Zeichenfolge	Die OpenFrame-API-Version

var version = openFrameAPI.version();

console.log("API version " + version);