Framework voor kanaalintegratie (gehost beheer)

2025-05-08

Gebruik het type gehost besturingselement van het Channel Integration Framework om uw kanaalprovider te integreren met de Unified Service Desk-clienttoepassing. U kunt meerdere gehoste besturingselementen van het type Channel Integration Framework maken om verschillende kanalen te hosten. Zie Kanaal integreren met behulp van Channel Integration Framework voor meer informatie.

Zie Een gehost besturingselement van het type Channel Integration Framework maken voor het maken van een gehost besturingselement van het type Channel Integration Framework

Vooraf gedefinieerde UII-acties

De volgende acties worden ondersteund voor dit type gehost besturingselement.

Sluiten

Deze actie wordt gebruikt om het gehoste besturingselement te sluiten.

Brandweer

Hiermee wordt een door de gebruiker gedefinieerde gebeurtenis geactiveerd vanuit dit gehoste besturingselement.

Kenmerk	Beschrijving
naam	Naam van de door de gebruiker gedefinieerde gebeurtenis.

Alle volgende name=value-paren worden de parameters voor de gebeurtenis. Zie Een door de gebruiker gedefinieerde gebeurtenis maken voor meer informatie over het maken van een door de gebruiker gedefinieerde gebeurtenis.

Verplaatsen naar paneel

Deze actie wordt gebruikt om gehoste besturingselementen tijdens runtime tussen deelvensters te verplaatsen.

Kenmerk	Beschrijving
applicatie	Naam van het gehoste besturingselement dat moet worden verplaatst.
paneel	Doelpaneel voor het gehoste besturingselement.

Opent een URL van het gehoste besturingselement en voert de vensternavigatieregels uit om de pop-up naar de juiste locatie te routeren.

Kenmerk	Beschrijving
URL	Hiermee wordt een pop-up van dit gehoste besturingselement gerouteerd met behulp van deze URL alsof het een pop-up is die wordt aangevraagd door het weergegeven besturingselement.
lijst	Het frame waaruit deze pop-up is ontstaan.

RunScript

Met deze actie wordt JavaScript in het hoofdframe van de toepassing geïnjecteerd.

Kenmerk	Beschrijving
	De gegevensparameter is het JavaScript dat in het formulier wordt geïnjecteerd. Notitie: De vervangingsparameters kunnen in het script worden gebruikt en worden vervangen voordat het script wordt uitgevoerd.

SetSize instellen

Met deze actie worden expliciet de breedte en hoogte van het gehoste besturingselement ingesteld. Dit is met name handig wanneer u "auto" gebruikt in uw paneellay-outs.

Kenmerk	Beschrijving
Breedte	De breedte van het gehoste besturingselement.
hoogte	De hoogte van het gehoste besturingselement.

SetUserCanClose

Hiermee kan de gebruiker het gehoste besturingselement sluiten door op het X-pictogram in de rechterbovenhoek van het tabblad met het gehoste besturingselement te klikken.

Kenmerk	Beschrijving
GebruikerKan sluiten	Stel dit in op `true` om de gebruiker in staat te stellen het gehoste besturingselement te sluiten. Stel anders false in.

VerhogenCifClientEvent

Met deze actie worden de gegevens van de gebeurtenis aan de clientzijde naar het gehoste besturingselement verzonden.

Kenmerk	Beschrijving
gebeurtenis	De gebeurtenissen aan de clientzijde van waaruit u de gegevens wilt ophalen.
gegevens	De gegevensparameter neemt eventData-waarden aan. Geef de gegevens door als een tekenreeks die is ontvangen van de gebeurtenis met behulp van vervangingsparameters. `data = [[data]+]`. Ondersteunde gebeurtenissen aan de clientzijde zijn als volgt: OnClickToAct SendKbArticleEvent onpagenavigate event (CIF JavaScript API-verwijzing)

UpdateCifContext

Met deze actie worden de gegevens van de client naar de kanaalprovider verzonden.

Kenmerk	Beschrijving
corrId	De unieke id moet hetzelfde zijn als die van doorgegeven in de eerste gebeurtenis van de kanaalprovider, zodat de UpdateCifContext het resultaat terugkrijgt.
actie	De parameter om het belofteobject te accepteren of te weigeren. Het neemt de waarde als `accept` of `reject`. Als u slaagt `accept`, roept de API de succesfunctie aan, die de resultaatparameter verder uitvoert. als u slaagt `reject`, roept de API de foutfunctie aan.
resultaat	De gegevens die je van klant naar channel provider wilt versturen.

Vooraf gedefinieerde evenementen

De volgende gebeurtenissen worden ondersteund voor dit type gehost besturingselement.

CreateRecord

De gebeurtenis vindt plaats wanneer de bijbehorende JavaScript-API van het Channel Integration Framework wordt aangeroepen vanuit de kanaalprovider om een entiteit te maken. De gegevens die in de API worden doorgegeven, worden ook doorgegeven aan de Unified Service Desk-clienttoepassing.

Kenmerk	Beschrijving
entiteit	De logische naam van de entiteit.
gegevens	Tekenreeks die de kenmerken en waarden voor de nieuwe entiteitsrecord definieert.
corrId	De unieke id voor de gegenereerde CreateRecord-gebeurtenis .

Zie voor meer informatie createRecord (CIF JavaScript API-referentie)

Record ophalen

De gebeurtenis vindt plaats wanneer de bijbehorende JavaScript-API van het Channel Integration Framework wordt aangeroepen van de kanaalprovider om een entiteit op te halen. De gegevens die in de API worden doorgegeven, worden ook doorgegeven aan de Unified Service Desk-clienttoepassing.

Kenmerk	Beschrijving
entiteit	De logische naam van de entiteit van de record die u wilt ophalen.
entityId	GUID van de entiteitsrecord die u wilt ophalen.
corrId	De unieke id voor de gegenereerde RetrieveRecord-gebeurtenis .
Opties	OData-systeemqueryopties, $select en $expand, om uw gegevens op te halen. Gebruik de optie $select systeemquery om de geretourneerde eigenschappen te beperken door een door komma's gescheiden lijst met eigenschapsnamen op te nemen. Dit is een belangrijke best practice op het gebied van prestaties. Als eigenschappen niet zijn opgegeven met behulp van $select, worden alle eigenschappen geretourneerd. Gebruik de optie $expand systeemquery om te bepalen welke gegevens van gerelateerde entiteiten worden geretourneerd. Als u alleen de naam van de navigatie-eigenschap opneemt, ontvangt u alle eigenschappen voor gerelateerde records. U kunt de eigenschappen beperken die worden geretourneerd voor gerelateerde records met behulp van de optie $select systeemquery tussen haakjes na de naam van de navigatie-eigenschap. Gebruik dit voor navigatie-eigenschappen met één of meteen verzamelingswaarde . U geeft de queryopties op die beginnen met `?`. U kunt ook meerdere queryopties opgeven door de queryopties te scheiden `&` . Voorbeeld: `?$select=name&$expand=primarycontactid($select=contactid,fullname)`

Zie voor meer informatie retrieveRecord (CIF JavaScript API-referentie)

Verslag bijwerken

De gebeurtenis vindt plaats wanneer de bijbehorende JavaScript-API van het Channel Integration Framework wordt aangeroepen vanuit de kanaalprovider om een entiteit bij te werken. De gegevens die in de API worden doorgegeven, worden ook doorgegeven aan de Unified Service Desk-clienttoepassing.

Kenmerk	Beschrijving
entiteit	De logische naam van de entiteit van de record die u wilt bijwerken.
entityId	GUID van de entiteitsrecord die u wilt bijwerken.
gegevens	Tekenreeks met `key: value` paren, waarbij `key` de eigenschap van de entiteit is en `value` de waarde van de eigenschap die u wilt bijwerken.
corrId	De unieke id voor de gegenereerde UpdateRecord-gebeurtenis .

Zie updateRecord (CIF JavaScript API-referentie) voor meer informatie

Verwijderen Record

De gebeurtenis vindt plaats wanneer de bijbehorende JavaScript-API van het Channel Integration Framework wordt aangeroepen vanuit de kanaalprovider om een entiteit te verwijderen. De gegevens die in de API worden doorgegeven, worden ook doorgegeven aan de Unified Service Desk-clienttoepassing.

Kenmerk	Beschrijving
entiteit	De logische naam van de entiteit van de record die u wilt verwijderen.
gegevens	Tekenreeks die de kenmerken en waarden voor de nieuwe entiteitsrecord definieert.
entityId	GUID van de entiteitsrecord die u wilt verwijderen.
corrId	De unieke id voor de gegenereerde DeleteRecord-gebeurtenis .

Zie voor meer informatie deleteRecord (CIF JavaScript API-referentie)

GetEntityMetadata

De gebeurtenis vindt plaats wanneer de bijbehorende JavaScript-API van het Channel Integration Framework wordt aangeroepen vanuit de kanaalprovider om de metagegevens van de entiteit voor de opgegeven entiteit te retourneren. De gegevens die in de API worden doorgegeven, worden ook doorgegeven aan de Unified Service Desk-clienttoepassing.

Kenmerk	Beschrijving
entiteit	De logische naam van de entiteit van de entiteit.
kenmerken	De attributen waarvoor u metadata wilt ophalen.
corrId	De unieke id voor de gegenereerde gebeurtenis GetEntityMetadata.

Zie voor meer informatie [getEntityMetadata (CIF JavaScript API-referentie)](.. /channel-integration-framework/v1/develop/reference/microsoft-ciframework /getentitymetadata.md)

GetEnvironment

De gebeurtenis vindt plaats wanneer de bijbehorende JavaScript-API van het Channel Integration Framework wordt aangeroepen van de kanaalprovider om de huidige Unified Interface-app en paginadetails op te halen. De details omvatten appId, pageType en recordId (indien beschikbaar). De gegevens die in de API worden doorgegeven, worden ook doorgegeven aan de Unified Service Desk-clienttoepassing.

Er zijn geen parameters voor deze gebeurtenis.

Zie getEnvironment (CIF JavaScript API-referentie) voor meer informatie

Open Formulier

De gebeurtenis vindt plaats wanneer de bijbehorende JavaScript-API van het Channel Integration Framework wordt aangeroepen vanuit de kanaalprovider om een entiteitsformulier of een formulier voor snelle invoer te openen. De gegevens die in de API worden doorgegeven, worden ook doorgegeven aan de Unified Service Desk-clienttoepassing.

Kenmerk	Beschrijving
entityFormOptions	Opties voor entiteitsformulier voor het openen van het formulier.
entityFormParameters	Een woordenboekobject dat extra parameters doorgeeft aan het formulier. Ongeldige parameters veroorzaken een fout. Zie Veldwaarden instellen met behulp van parameters die aan een formulier worden doorgegeven en Een formulier configureren voor het accepteren van aangepaste querystringparameters voor meer informatie over het doorgeven van parameters aan een formulier
corrId	De unieke id voor de geopende OpenForm-gebeurtenis .

Zie voor meer informatie [openForm (CIF JavaScript API-referentie)](.. /kanaal-integratie-framework/gedeeld /openform.md)

RenderSearchPage

De gebeurtenis vindt plaats wanneer de bijbehorende JavaScript-API van het Channel Integration Framework wordt aangeroepen vanuit de kanaalprovider, waardoor kan worden gezocht in de records van een bepaald entiteitstype. Met deze API wordt de entiteitspagina van Unified Interface geopend met het zoekveld dat vooraf is ingevuld met de zoektekenreeks die als parameter wordt doorgegeven. De gegevens die in de API worden doorgegeven, worden ook doorgegeven aan de Unified Service Desk-clienttoepassing.

Kenmerk	Beschrijving
entiteit	De logische naam van de entiteit van de record waarop u een query wilt uitvoeren.
zoekreeks	Tekenreeks om te zoeken tussen de kenmerken van de entiteitsrecords.
corrId	De unieke id voor de gegenereerde RenderSearchPage-gebeurtenis .

Zie voor meer informatie [renderSearchPage (CIF JavaScript API-referentie)](.. /channel-integration-framework/gedeeld /rendersearchpage.md)

SearchAndOpenRecords

De gebeurtenis vindt plaats wanneer de bijbehorende JavaScript-API van het Channel Integration Framework wordt aangeroepen van de kanaalprovider om te zoeken naar de record van de kanaalprovider tijdens de inkomende communicatie en de record opent. De gegevens die in de API worden doorgegeven, worden ook doorgegeven aan de Unified Service Desk-clienttoepassing.

Kenmerk	Beschrijving
entiteit	De logische naam van de entiteit om te zoeken en te openen.
queryParmeters	OData-systeemqueryopties, $select en $expand, om uw gegevens op te halen. Gebruik de optie $select systeemquery om de geretourneerde eigenschappen te beperken door een door komma's gescheiden lijst met eigenschapsnamen op te nemen. Dit is een belangrijke best practice op het gebied van prestaties. Als eigenschappen niet zijn opgegeven met behulp van $select, worden alle eigenschappen geretourneerd. Gebruik de optie $expand systeemquery om te bepalen welke gegevens van gerelateerde entiteiten worden geretourneerd. Als u alleen de naam van de navigatie-eigenschap opneemt, ontvangt u alle eigenschappen voor gerelateerde records. U kunt de eigenschappen beperken die worden geretourneerd voor gerelateerde records met behulp van de optie $select systeemquery tussen haakjes na de naam van de navigatie-eigenschap. Gebruik dit voor navigatie-eigenschappen met één of met een verzamelingswaarde. U geeft de queryopties op die beginnen met `?`. U kunt ook meerdere queryopties opgeven door de queryopties te scheiden `&` . Bijvoorbeeld: `?$select=name&$expand=primarycontactid($select=contactid,fullname)`
alleen zoeken	Stel false in om de record te openen op de pagina Unified Interface als de zoekrecord één record is. Stel false in om de zoekpagina te openen als het zoekresultaat meerdere records bevat en vul de zoekpagina automatisch in met de tagwaarde die wordt vermeld wanneer het zoekveld wordt gebruikt in queryParmeters. Stel alleen true in om de resultaten van de zoekopdracht als een veelbelovend resultaat te krijgen en open de record of zoekpagina niet.
corrId	De unieke id voor de gegenereerde gebeurtenis SearchAndOpenRecords .