Kanalintegrationsframework (gehostetes Steuerelement)

Verwenden Sie den Kanalintegrationsframework-Typ des gehosteten Steuerelements für die Integration Ihres Kanalanbieters in die Unified Service Desk-Clientanwendung. Sie können mehrere gehostete Steuerelemente vom Typ Kanalintegrationsframework erstellen, um verschiedene Kanäle zu hosten. Weitere Informationen finden Sie unter Integrieren eines Kanals mit Kanalintegrationsframework.

Wenn Sie ein gehostetes Steuerelement vom Typ Kanalintegrationsframework erstellen möchten, lesen Sie Erstellen eines gehosteten Steuerelements vom Typ Kanalintegrationsframework

Vordefinierte UII-Aktionen

Folgende Aktionen werden für diesen Typ von gehosteten Steuerelementen unterstützt.

Schließen

Durch diese Aktion wird das gehostete Steuerelement geschlossen.

FireEvent

Löst ein benutzerdefiniertes Ereignis von diesem gehosteten Steuerelement aus.

Parameter	Beschreibung
Name	Name des benutzerdefinierten Ereignisses.

Alle folgenden Name=Wert-Paare werden die Parameter des Ereignisses. Weitere Informationen zum Erstellen eines benutzerdefinierten Berichts Ereignisses.

MoveToPanel

Diese Aktionen wird verwendet, um gehostete Steuerelemente zur Laufzeit zwischen Bereichen zu verschieben.

Parameter	Beschreibung
App	Name des zu verschiebenden gehosteten Steuerelements.
Bereich	Zielbereich für das gehostete Steuerelement.

Popup

Zeigt eine URL aus dem gehosteten Steuerelement an und führt die Fensternavigationsregeln dafür aus, um das Popup an den richtigen Ort zu leiten.

Parameter	Beschreibung
URL	Leitet ein Popup von diesem gehosteten Steuerelement mit dieser URL weiter, als wäre dies ein von dem angezeigten Steuerelement angefragtes Popup.
Frame	Der Frame, von dem dieses Popup stammt.

RunScript

Durch diese Aktion wird JavaScript in den Hauptrahmen der Anwendung eingefügt.

Parameter	Beschreibung
	Der Datenparameter ist das JavaScript, das in das Formular eingefügt wird. Hinweis: Die Ersetzungsparameter können im Skript verwendet werden und werden ersetzt, bevor das Skript ausgeführt wird.

SetSize

Diese Aktion legt explizit die Breite und Höhe des gehosteten Steuerelements fest. Dies ist besonders dann nützlich, wenn Sie in Ihren Bereichslayouts "Auto" verwenden.

Parameter	Beschreibung
Breite	Die Breite des gehosteten Steuerelements.
height	Die Höhe des gehosteten Steuerelements.

SetUserCanClose

Ermöglicht dem Benutzer, das gehostete Steuerelement zu schließen, indem auf das X-Symbol oben rechts auf der Registerkarte des gehosteten Steuerelements geklickt wird.

Parameter	Beschreibung
UserCanClose	Setzen Sie dies auf true, damit der Benutzer das gehostete Steuerelement schließen kann. Legen Sie andernfalls "false" fest.

RaiseCifClientEvent

Diese Aktion sendet die Daten, die vom clientseitigen Ereignis erzeugt wurden, zum gehosteten Steuerelement.

Parameter	Beschreibung
ereignis	Die clientseitigen Ereignisse, aus denen Sie die Daten erheben möchten.
-Daten	Der Datenenparameter akzeptiert eventData-Werte. Übermitteln Sie die Daten als Zeichenfolge, die aus dem Ereignis empfangen wurden, indem Ersetzungsparameter verwendet wurden. data = [[data]+]. Unterstützte clientseitige Ereignisse sind: OnClickToAct SendKbArticleEvent onpagenavigate Ereignis (CIF-JavaScript API-Referenz)

UpdateCifContext

Diese Aktion sendet die Daten vom Client zum Kanalanbieter.

Parameter	Beschreibung
corrId	Der eindeutige Bezeichner sollte derselbe sein, der an das initiale Ereignis vom Kanalanbieter übergeben wurde, sodass UpdateCifContext das Ergebnis zurückbekommt.
Aktion	Der Parameter zum Akzeptieren oder Ablehnen des Versprechenobjekts. Es akzeptiert die Werte als accept oder reject. Wenn Sie accept übergeben, ruf die API die Erfolgsfunktion auf, die den Ergebnisparameter weiter ausführt. Wenn Sie reject übergeben, ruft die API die Fehlerfunktion auf.
Ergebnis	Die Daten, die Sie vom Client an den Kanalanbieter senden möchten.

Vordefinierte Ereignisse

Folgende Ereignisse werden für diesen Typ eines gehosteten Steuerelements unterstützt.

CreateRecord

Das Ereignis tritt auf, wenn die entsprechende Kanalintegrationsframework-JavaScript-API vom Kanalanbieter aufgerufen wird, um eine Entität zu erstellen. Die Daten, die in der API übergeben werden, werden auch an die Unified Service Desk-Clientanwendung übergeben.

Parameter	Beschreibung
Entität	Der logische Name der Entität.
-Daten	Zeichenfolge, die die Attribute und Werte für den neuen Entitätsdatensatz definiert.
corrId	Der eindeutige Bezeichner für das auslöste Ereignis CreateRecord.

Weitere Informationen finden Sie unter createRecord (CIF JavaScript API-Referenz)

RetrieveRecord

Das Ereignis tritt auf, wenn die entsprechende Kanalintegrationsframework-JavaScript-API vom Kanalanbieter aufgerufen wird, um eine Entität abzurufen. Die Daten, die in der API übergeben werden, werden auch an die Unified Service Desk-Clientanwendung übergeben.

Parameter	Beschreibung
Entität	Der logische Entitätsname des Datensatzes, der abgerufen werden soll.
entityId	GUID des Entitätsdatensatzes, den Sie abrufen möchten.
corrId	Der eindeutige Bezeichner für das auslöste Ereignis RetrieveRecord.
Optionen	OData-Systemabfrageoptionen $select und $expand-Abfragen, um die Daten abzurufen. Verwenden Sie die $select Systemabfrageoption, um die Eigenschaften zu begrenzen, die zurückgegeben werden, indem Sie eine kommagetrennte Liste von Eigenschaftsnamen einschließen. Dies ist eine wichtige Methode für die Leistungssteigerung. Wenn Eigenschaften nicht mithilfe von $selectangegeben wurden, werden alle Eigenschaften zurückgegeben. Verwenden Sie die $expand-Systemabfrageoption, um zu steuern, welche Daten von den verbundenen Entitäten zurückgegeben werden. Wenn Sie nur den Namen der Navigationseigenschaft einschließen, rufen Sie alle Eigenschaften für in Verbindung stehende Datensätze ab. Sie können die Eigenschaften begrenzen, die für verknüpfte Datensätze mithilfe der $select-Systemabfrageoption in Klammern nach dem Namen der Navigationseigenschaft zurückgegeben werden. Verwenden Sie dieses für einzelwertige und sammlungswertige Navigationseigenschaften. Sie geben die Abfrageoptionen beginnend mit ?an. Um mehrere Abfrageoptionen zu definieren, verwenden Sie &, um die Abfrageoptionen zu trennen. Beispiel: ?$select=name&$expand=primarycontactid($select=contactid,fullname)

Weitere Informationen finden Sie unter retrieveRecord (CIF JavaScript API-Referenz)

UpdateRecord

Das Ereignis tritt auf, wenn die entsprechende Kanalintegrationsframework-JavaScript-API vom Kanalanbieter aufgerufen wird, um eine Entität zu aktualisieren. Die Daten, die in der API übergeben werden, werden auch an die Unified Service Desk-Clientanwendung übergeben.

Parameter	Beschreibung
Entität	Der logische Entitätsname des Datensatzes, der aktualisiert werden soll.
entityId	GUID des Entitätsdatensatzes, den Sie aktualisieren möchten.
-Daten	Eine Zeichenfolge mit key: value-Paaren, wobei key die Eigenschaft der Entität und value der Wert der Eigenschaft ist, die Sie aktualisieren möchten.
corrId	Der eindeutige Bezeichner für das auslöste Ereignis UpdateRecord.

Weitere Informationen finden Sie unter updateRecord (CIF JavaScript API-Referenz)

DeleteRecord

Das Ereignis tritt auf, wenn die entsprechende Kanalintegrationsframework-JavaScript-API vom Kanalanbieter aufgerufen wird, um eine Entität zu löschen. Die Daten, die in der API übergeben werden, werden auch an die Unified Service Desk-Clientanwendung übergeben.

Parameter	Beschreibung
Entität	Der logische Entitätsname des Datensatzes, der gelöscht werden soll.
-Daten	Zeichenfolge, die die Attribute und Werte für den neuen Entitätsdatensatz definiert.
entityId	GUID des Entitätsdatensatzes, den Sie löschen möchten.
corrId	Der eindeutige Bezeichner für das auslöste Ereignis DeleteRecord.

Weitere Informationen finden Sie unter deleteRecord (CIF JavaScript API-Referenz)

GetEntityMetadata

Das Ereignis tritt auf, wenn die entsprechende Kanalintegrationsframework-JavaScript-API vom Kanalanbieter aufgerufen wird, um die Entitätsmetadaten für die angegeben Entität zurückzugeben. Die Daten, die in der API übergeben werden, werden auch an die Unified Service Desk-Clientanwendung übergeben.

Parameter	Beschreibung
Entität	Der logische Name der Entität.
Attribute	Die Attribute, für die Sie Metadaten abrufen möchten.
corrId	Der eindeutige Bezeichner für das auslöste Ereignis GetEntityMetadata.

Weitere Informationen finden Sie unter [getEntityMetadata (CIF JavaScript API-Referenz)](../channel-integration-framework/v1/develop/reference/microsoft-ciframework /getentitymetadata.md)

GetEnvironment

Das Ereignis tritt auf, wenn die entsprechende Kanalintegrationsframework-JavaScript-API vom Kanalanbieter aufgerufen wird, um die aktuelle App der einheitlichen Oberfläche und Seitendetails abzurufen. Die Details enthalten appId, pageType und recordId (sofern verfügbar). Die Daten, die in der API übergeben werden, werden auch an die Unified Service Desk-Clientanwendung übergeben.

Es gibt keine Parameter für dieses Ereignis.

Weitere Informationen finden Sie unter getEnvironment (CIF JavaScript API-Referenz)

OpenForm

Das Ereignis tritt auf, wenn die entsprechende Kanalintegrationsframework-JavaScript-API vom Kanalanbieter aufgerufen wird, um ein Entitätsformular oder ein Schnellerfassungsformular zu öffnen. Die Daten, die in der API übergeben werden, werden auch an die Unified Service Desk-Clientanwendung übergeben.

Parameter	Beschreibung
entityFormOptions	Entitätsformularoptionen für das Öffnen des Formulars.
entityFormParameters	Ein Wörterbuchobjekt, das dem Formular zusätzliche Parameter übergibt. Ungültige Parameter führen zu einem Fehler. Informationen zum Übergeben von Parametern an ein Formular finden Sie unter Festlegen von Feldwerten mithilfe von Parametern, die an ein Formular übergeben werden und Ein Formular konfigurieren, um benutzerdefinierte Abfragezeichenfolgenparameter zu akzeptieren
corrId	Der eindeutige Bezeichner für das auslöste Ereignis OpenForm.

Weitere Informationen finden Sie unter [openForm (CIF JavaScript API-Referenz)](../channel-integration-framework/shared /openform.md)

RenderSearchPage

Das Ereignis tritt auf, wenn die entsprechende Kanalintegrationsframework-JavaScript-API vom Kanalanbieter aufgerufen wird, um eine Suche in den Datensätzen eines bestimmten Entitätstyps zu erlauben. Die API öffnet die Entitätsseite der einheitlichen Oberfläche mit vorab ausgefülltem Suchfeld und der Suchzeichenfolge, die als Parameter übergeben wird. Die Daten, die in der API übergeben werden, werden auch an die Unified Service Desk-Clientanwendung übergeben.

Parameter	Beschreibung
Entität	Der logische Entitätsname des Datensatzes, der abgefragt werden soll.
searchZeichenfolge	Zeichenfolge zum Suchen in Attributen der Entitätsdatensätze.
corrId	Der eindeutige Bezeichner für das auslöste Ereignis RenderSearchPage.

Weitere Informationen finden Sie unter [renderSearchPage (CIF JavaScript API-Referenz)](../channel-integration-framework/shared /rendersearchpage.md)

SearchAndOpenRecords

Das Ereignis tritt auf, wenn die entsprechende Kanalintegrationsframework-JavaScript-API vom Kanalanbieter aufgerufen wird, um nach dem Datensatz vom Kanalanbieter während einer eingehenden Kommunikation zu suchen. Es öffnet auch den Datensatz. Die Daten, die in der API übergeben werden, werden auch an die Unified Service Desk-Clientanwendung übergeben.

Parameter	Beschreibung
Entität	Der logische Name der Entität, nach der gesucht und die geöffnet wird.
queryParmeters	OData-Systemabfrageoptionen $select und $expand-Abfragen, um die Daten abzurufen. Verwenden Sie die $select Systemabfrageoption, um die Eigenschaften zu begrenzen, die zurückgegeben werden, indem Sie eine kommagetrennte Liste von Eigenschaftsnamen einschließen. Dies ist eine wichtige Methode für die Leistungssteigerung. Wenn Eigenschaften nicht mithilfe von $selectangegeben wurden, werden alle Eigenschaften zurückgegeben. Verwenden Sie die $expand-Systemabfrageoption, um zu steuern, welche Daten von den verbundenen Entitäten zurückgegeben werden. Wenn Sie nur den Namen der Navigationseigenschaft einschließen, rufen Sie alle Eigenschaften für in Verbindung stehende Datensätze ab. Sie können die Eigenschaften begrenzen, die für verknüpfte Datensätze mithilfe der $select-Systemabfrageoption in Klammern nach dem Namen der Navigationseigenschaft zurückgegeben werden. Verwenden Sie dieses für einzelwertige und sammlungswertige Navigationseigenschaften. Sie geben die Abfrageoptionen beginnend mit ?an. Um mehrere Abfrageoptionen zu definieren, verwenden Sie &, um die Abfrageoptionen zu trennen. Beispiel: ?$select=name&$expand=primarycontactid($select=contactid,fullname)
searchOnly	Legen Sie "false" fest, um den Datensatz auf der Seite der einheitlichen Oberfläche zu öffnen, wenn der Suchdatensatz ein einzelner Datensatz ist. Legen Sie "false" fest, um die Suchseite zu öffnen, wenn das Suchergebnis mehrere Datensätze enthält und um die Suchseite automatisch mit dem angegebenen Tag-Wert zu füllen, wenn das Suchfeld in queryParmeters verwendet wird. Legen Sie "true" fest, um Ergebnisse der Suche als Versprechenergebnis zu erhalten und um den Datensatz nicht auf der Suchseite zu öffnen.
corrId	Der eindeutige Bezeichner für das auslöste Ereignis SearchAndOpenRecords.

Siehe auch

• Integrieren eines Kanals mit Kanalintegrationsframework
• Erstellen eines gehosteten Kanalintegrationsframework-Steuerelements