--- sourceDocument: Xanadu-API-Referenz sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/xanadu/api-reference Release : - xanadu ft:locale : - de-DE ft:publication_title : - Xanadu-API-Referenz ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # openFrameAPI : Client # openFrameAPI : Client {#ariaid-title1} * Freigeben Version: Xanadu * * Aktualisiert 1. August 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 11 Minuten Lesedauer 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) {#ariaid-title2} Gibt den aktuellen Anwesenheitsstatus des angemeldeten Service Desk-Mitarbeiters zurück. {#openFrameAPI-getAWAPresense_S_S__table_z1t_mgn_sbc__entry__3} | 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 : 1. Parameter] {#openFrameAPI-getAWAPresense_S_S__table_z1t_mgn_sbc} {#openFrameAPI-getAWAPresense_S_S__table_abt_mgn_sbc__entry__2} | 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 | [Tabelle : 2. Ergebnisse] {#openFrameAPI-getAWAPresense_S_S__table_abt_mgn_sbc} 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() {#ariaid-title3} Blendet den OpenFrame im TopFrame aus. {#r_openFrameAPI-hide__table_yzb_mxx_kt__entry__3} | Name | Typ | Beschreibung | |-|-|-| | Keine | | | [Tabelle : 3. Parameter] {#r_openFrameAPI-hide__table_yzb_mxx_kt} {#r_openFrameAPI-hide__table_zzb_mxx_kt__entry__2} | Typ | Beschreibung | |-|-| | void | | [Tabelle : 4. Ergebnisse] {#r_openFrameAPI-hide__table_zzb_mxx_kt} openFrameAPI.hide() ## openFrameAPI -- init(Object config, function successCallback, function failureCallback) {#ariaid-title4} 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. {#r_openFrameAPI-init_Object_Object_Object__table_vz3_jyw_kt__entry__3} | 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](https://www.servicenow.com/docs/access?context=t_CreateAnOpenFrameConfiguration&version=xanadu&pubname=xanadu-customer-service-management&ft:locale=en-US) wird als Parameter an die Rückruffunktion übergeben. | | failureCallback | function | Name der Rückruffunktion, die verwendet wird, wenn die Init- Methode fehlschlägt. | [Tabelle : 5. Parameter] {#r_openFrameAPI-init_Object_Object_Object__table_vz3_jyw_kt} {#r_openFrameAPI-init_Object_Object_Object__table_wz3_jyw_kt__entry__2} | Typ | Beschreibung | |-|-| | void | | [Tabelle : 6. Ergebnisse] {#r_openFrameAPI-init_Object_Object_Object__table_wz3_jyw_kt} 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) {#ariaid-title5} Überprüft, ob der OpenFrame im TopFrame sichtbar ist. {#r_openFrameAPI-isVisible_Object_Object__table_zdj_ygy_kt__entry__3} | 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 : 7. Parameter] {#r_openFrameAPI-isVisible_Object_Object__table_zdj_ygy_kt} {#r_openFrameAPI-isVisible_Object_Object__table_a2j_ygy_kt__entry__2} | Typ | Beschreibung | |-|-| | void | | [Tabelle : 8. Ergebnisse] {#r_openFrameAPI-isVisible_Object_Object__table_a2j_ygy_kt} function callback(isVisible) { console.log(isVisible) } openFrameAPI.isVisible(callback) ## openFrameAPI - openCustomURL(String details) {#ariaid-title6} Öffnet eine anwenderdefinierte URL in der UI16-Schnittstelle. {#r_openFrameAPI-openCustomURL__table_ob3_ryd_lt__entry__3} | Name | Typ | Beschreibung | |-|-|-| | URL | Zeichenfolge | Text der anwenderdefinierten URL. Maximale Größe: 2083 Zeichen | [Tabelle : 9. Parameter] {#r_openFrameAPI-openCustomURL__table_ob3_ryd_lt} {#r_openFrameAPI-openCustomURL__table_pb3_ryd_lt__entry__2} | Typ | Beschreibung | |-|-| | void | | [Tabelle : 10. Ergebnisse] {#r_openFrameAPI-openCustomURL__table_pb3_ryd_lt} openFrameAPI.openCustomURL('10_cool_things.do'); ## openFrameAPI -- openServiceNowForm(Object details) {#ariaid-title7} Ö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. {#r_openFrameAPI-openServiceNowForm_Object__ul_mwy_4nc_lhb} {#r_openFrameAPI-openServiceNowForm_Object__table_ulq_vwd_lt__entry__3} | 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='`. | [Tabelle : 11. Parameter] {#r_openFrameAPI-openServiceNowForm_Object__table_ulq_vwd_lt} {#r_openFrameAPI-openServiceNowForm_Object__table_vlq_vwd_lt__entry__2} | Typ | Beschreibung | |-|-| | void | | [Tabelle : 12. Ergebnisse] {#r_openFrameAPI-openServiceNowForm_Object__table_vlq_vwd_lt} 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() {#ariaid-title8} Ö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. {#openFrameAPI-openSNFormwithChildTab__table_j13_hwv_hyb__entry__3} | 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 : 13. Parameter] {#openFrameAPI-openSNFormwithChildTab__table_j13_hwv_hyb} {#openFrameAPI-openSNFormwithChildTab__table_k13_hwv_hyb__entry__2} | Typ | Beschreibung | |-|-| | Keine | | [Tabelle : 14. Ergebnisse] {#openFrameAPI-openSNFormwithChildTab__table_k13_hwv_hyb} 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) {#ariaid-title9} Öffnet eine Listen-URL in der UI16-Schnittstelle. {#r_openFrameAPI-openServiceNowList_Object__table_fpq_5xd_lt__entry__3} | 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](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US) {#r_openFrameAPI-openServiceNowList_Object__ul_ndm_fxd_lt} | [Tabelle : 15. Parameter] {#r_openFrameAPI-openServiceNowList_Object__table_fpq_5xd_lt} {#r_openFrameAPI-openServiceNowList_Object__table_gpq_5xd_lt__entry__2} | Typ | Beschreibung | |-|-| | void | | [Tabelle : 16. Ergebnisse] {#r_openFrameAPI-openServiceNowList_Object__table_gpq_5xd_lt} openFrameAPI.openServiceNowList({entity:'case', query:'active=true'}); ## openFrameAPI - setFrameMode(mode) {#ariaid-title10} 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 {#r_openFrameAPI-setFrameMode__ul_sjp_rgw_5fb} {#r_openFrameAPI-setFrameMode__ul_vnq_4gw_5fb} {#r_openFrameAPI-setFrameMode__table_yzb_mxx_kt__entry__3} | Name | Typ | Beschreibung | |-|-|-| | Modus | Zeichenfolge | Legen Sie den OpenFrame-Modus fest. Aufgelistete Optionen: 1. openFrameAPI.FRAME_MODE.COLLAPSE 2. openFrameAPI.FRAME_MODE.EXPAND {#r_openFrameAPI-setFrameMode__ol_yjp_3gw_5fb} | [Tabelle : 17. Parameter] {#r_openFrameAPI-setFrameMode__table_yzb_mxx_kt} {#r_openFrameAPI-setFrameMode__table_zzb_mxx_kt__entry__2} | Typ | Beschreibung | |-|-| | void | | [Tabelle : 18. Ergebnisse] {#r_openFrameAPI-setFrameMode__table_zzb_mxx_kt} openFrameAPI.setFrameMode(openFrameAPI.FRAME_MODE.COLLAPSE); ## openFrameAPI - setHeight(height) {#ariaid-title11} Legt die OpenFrame-Höhe fest. {#r_openFrameAPI-setHeight__table_yzb_mxx_kt__entry__3} | Name | Typ | Beschreibung | |-|-|-| | Höhe | Nummer | Höhe in Pixel | [Tabelle : 19. Parameter] {#r_openFrameAPI-setHeight__table_yzb_mxx_kt} {#r_openFrameAPI-setHeight__table_zzb_mxx_kt__entry__2} | Typ | Beschreibung | |-|-| | void | | [Tabelle : 20. Ergebnisse] {#r_openFrameAPI-setHeight__table_zzb_mxx_kt} openFrameAPI.setHeight(100); ## openFrameAPI -- setIcons(Array icons) {#ariaid-title12} Definiert Symbole im OpenFrame-Header, die neben dem Schließsymbol platziert werden. {#r_openFrameAPI-setIcons_Array__table_dg3_lny_kt__entry__3} | 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 : 21. Parameter] {#r_openFrameAPI-setIcons_Array__table_dg3_lny_kt} {#r_openFrameAPI-setIcons_Array__table_eg3_lny_kt__entry__2} | Typ | Beschreibung | |-|-| | void | | [Tabelle : 22. Ergebnisse] {#r_openFrameAPI-setIcons_Array__table_eg3_lny_kt} 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) {#ariaid-title13} 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](https://www.servicenow.com/docs/access?context=t_CreateAnOpenFrameConfiguration&version=xanadu&pubname=xanadu-customer-service-management&ft:locale=en-US) {#openFrameAPI-setPresenceIndicator__table_o4l_p1c_jhb__entry__3} | Name | Typ | Beschreibung | |-|-|-| | state | Zeichenfolge | Anwesenheitsstatus des Agent. Standardstatus: * Verfügbar * Abwesend * Offline {#openFrameAPI-setPresenceIndicator__ul_bws_ldg_d3b} Sie können auch benutzerdefinierte Status angeben. | | color | Zeichenfolge | Farbe des Anwesenheitsindikators im Arbeitsbereich. Unterstützte Farben: * rot * Orange * grau * grün {#openFrameAPI-setPresenceIndicator__ul_xwr_xbg_d3b} | [Tabelle : 23. Parameter] {#openFrameAPI-setPresenceIndicator__table_o4l_p1c_jhb} {#openFrameAPI-setPresenceIndicator__table_p4l_p1c_jhb__entry__2} | Typ | Beschreibung | |-|-| | void | | [Tabelle : 24. Ergebnisse] {#openFrameAPI-setPresenceIndicator__table_p4l_p1c_jhb} openframeAPI.setPresenceIndicator('Available', 'green'); ## openFrameAPI -- setSize(Number width, Number height) {#ariaid-title14} Legt die OpenFrame-Größe fest. {#r_openFrameAPI-setSize_Number_Number__table_vvk_5jy_kt__entry__3} | Name | Typ | Beschreibung | |-|-|-| | width | Zahl | Sollte größer als null sein. | | height | Zahl | Sollte größer als null sein. | [Tabelle : 25. Parameter] {#r_openFrameAPI-setSize_Number_Number__table_vvk_5jy_kt} {#r_openFrameAPI-setSize_Number_Number__table_wvk_5jy_kt__entry__2} | Typ | Beschreibung | |-|-| | void | | [Tabelle : 26. Ergebnisse] {#r_openFrameAPI-setSize_Number_Number__table_wvk_5jy_kt} openFrameAPI.setSize(300, 370); ## openFrameAPI -- setSubtitle(String subTitle) {#ariaid-title15} Legt den OpenFrame-Untertitel fest. {#r_openFrameAPI-setSubtitle_String__table_ztd_hjy_kt__entry__3} | Name | Typ | Beschreibung | |-|-|-| | subTitle | Zeichenfolge | Eine Zeichenfolge mit maximal 256 Zeichen. | [Tabelle : 27. Parameter] {#r_openFrameAPI-setSubtitle_String__table_ztd_hjy_kt} {#r_openFrameAPI-setSubtitle_String__table_a5d_hjy_kt__entry__2} | Typ | Beschreibung | |-|-| | void | | [Tabelle : 28. Ergebnisse] {#r_openFrameAPI-setSubtitle_String__table_a5d_hjy_kt} openFrameAPI.setSubtitle('+18888888888'); ## openFrameAPI -- setTitle(String title) {#ariaid-title16} Legt den OpenFrame-Titel fest. {#r_openFrameAPI-setTitle_String__table_jbl_w3y_kt__entry__3} | Name | Typ | Beschreibung | |-|-|-| | title | Zeichenfolge | Eine Zeichenfolge mit maximal 256 Zeichen. | [Tabelle : 29. Parameter] {#r_openFrameAPI-setTitle_String__table_jbl_w3y_kt} {#r_openFrameAPI-setTitle_String__table_kbl_w3y_kt__entry__2} | Typ | Beschreibung | |-|-| | void | | [Tabelle : 30. Ergebnisse] {#r_openFrameAPI-setTitle_String__table_kbl_w3y_kt} openFrameAPI.setTitle('Incoming Call'); ## openFrameAPI -- setTitleIcon(Object icon) {#ariaid-title17} Legt das Titelsymbol von OpenFrame fest. {#r_openFrameAPI-setTitleIcon_Object__table_w42_kky_kt__entry__3} | 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 : 31. Parameter] {#r_openFrameAPI-setTitleIcon_Object__table_w42_kky_kt} {#r_openFrameAPI-setTitleIcon_Object__table_x42_kky_kt__entry__2} | Typ | Beschreibung | |-|-| | void | | [Tabelle : 32. Ergebnisse] {#r_openFrameAPI-setTitleIcon_Object__table_x42_kky_kt} 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) {#ariaid-title18} Legt die OpenFrame-Breite fest. {#r_openFrameAPI-setWidth__table_yzb_mxx_kt__entry__3} | Name | Typ | Beschreibung | |-|-|-| | Breite | Nummer | Breite in Pixel | [Tabelle : 33. Parameter] {#r_openFrameAPI-setWidth__table_yzb_mxx_kt} {#r_openFrameAPI-setWidth__table_zzb_mxx_kt__entry__2} | Typ | Beschreibung | |-|-| | void | | [Tabelle : 34. Ergebnisse] {#r_openFrameAPI-setWidth__table_zzb_mxx_kt} openFrameAPI.setWidth(100); ## openFrameAPI -- show() {#ariaid-title19} Macht den OpenFrame im TopFrame sichtbar. {#r_openFrameAPI-show__table_ah2_vwx_kt__entry__3} | Name | Typ | Beschreibung | |-|-|-| | Keine | | | [Tabelle : 35. Parameter] {#r_openFrameAPI-show__table_ah2_vwx_kt} {#r_openFrameAPI-show__table_bh2_vwx_kt__entry__2} | Typ | Beschreibung | |-|-| | void | | [Tabelle : 36. Ergebnisse] {#r_openFrameAPI-show__table_bh2_vwx_kt} openFrameAPI.show() ## openFrameAPI -- subscribe(openFrameAPIEVENT event, function eventCallback) {#ariaid-title20} Abonniert ein angegebenes Ereignis. {#r_openFrameAPI-subscribe_Event_Object__table_znv_gvd_lt__entry__3} | 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 : 37. Parameter] {#r_openFrameAPI-subscribe_Event_Object__table_znv_gvd_lt} {#r_openFrameAPI-subscribe_Event_Object__table_a4v_gvd_lt__entry__2} | 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\]. {#r_openFrameAPI-subscribe_Event_Object__ul_xf1_pcp_zbc} * presence.name: Name des Anwesenheitsstatus des Service Desk-Mitarbeiters * presence.sys_id: Anwesenheitsstatus-sys_id. Befindet sich in der Tabelle „Anwesenheitsstatus" \[awa_presence_state\]. {#r_openFrameAPI-subscribe_Event_Object__ul_wf1_pcp_zbc} | | 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. {#r_openFrameAPI-subscribe_Event_Object__ul_svh_jww_zbc} * 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](https://www.servicenow.com/docs/access?context=transfer-chat-queue&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US). * 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. {#r_openFrameAPI-subscribe_Event_Object__ul_tvh_jww_zbc} * 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. {#r_openFrameAPI-subscribe_Event_Object__ul_rvh_jww_zbc} | | 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. {#r_openFrameAPI-subscribe_Event_Object__ul_f3z_jww_zbc} * 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](https://www.servicenow.com/docs/access?context=transfer-chat-queue&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US). * 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\]. {#r_openFrameAPI-subscribe_Event_Object__ul_g3z_jww_zbc} * 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. {#r_openFrameAPI-subscribe_Event_Object__ul_h3z_jww_zbc} * 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. {#r_openFrameAPI-subscribe_Event_Object__ul_e3z_jww_zbc} | [Tabelle : 38. Ergebnisse] {#r_openFrameAPI-subscribe_Event_Object__table_a4v_gvd_lt} 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() {#ariaid-title21} Gibt die OpenFrame-API-Version zurück. {#r_openFrameAPI-version__table_ob3_ryd_lt__entry__3} | Name | Typ | Beschreibung | |-|-|-| | Keine | | | [Tabelle : 39. Parameter] {#r_openFrameAPI-version__table_ob3_ryd_lt} {#r_openFrameAPI-version__table_pb3_ryd_lt__entry__2} | Typ | Beschreibung | |-|-| | Zeichenfolge | Die OpenFrame-API-Version | [Tabelle : 40. Ergebnisse] {#r_openFrameAPI-version__table_pb3_ryd_lt} var version = openFrameAPI.version(); console.log("API version " + version);