Environnement d’intégration du canal (contrôle hébergé)

Utilisez le type Channel Integration Framework du contrôle hébergé pour intégrer votre fournisseur de canal à l’application cliente Unified Service Desk. Vous pouvez créer plusieurs types de Channel Integration Framework de contrôle hébergé pour héberger différents canaux. Pour en savoir plus, voir Intégrer le canal à l’aide de Channel Integration Framework.

Pour créer un type de Channel Integration Framework de contrôle hébergé, voir Créer un contrôle hébergé Channel Integration Framework

Actions UII prédéfinies

Les actions suivantes sont prises en charge pour ce type de contrôle hébergé.

Close

Cette action permet de fermer le contrôle hébergé.

FireEvent

Déclenche un événement défini par l’utilisateur à partir de ce contrôle hébergé.

Paramètre	Description
nom	Nom de l’événement défini par l’utilisateur.

Toutes les paires nom=valeur suivantes deviennent les paramètres de l’événement. Pour plus d’informations sur la création d’un événement défini par l’utilisateur, voir Créer un événement défini par l’utilisateur.

MoveToPanel

Cette action permet de déplacer les contrôles hébergés d’un panneau à l’autre au moment de l’exécution.

Paramètre	Description
app	Nom du contrôle hébergé à déplacer.
panel	Panneau cible du contrôle hébergé.

Popup

Ouvre une fenêtre contextuelle avec une URL à partir du contrôle hébergé et exécute les règles de navigation dans la fenêtre en fonction de cette URL, pour acheminer la fenêtre contextuelle à l’emplacement approprié.

Paramètre	Description
URL	Achemine une fenêtre contextuelle à partir de ce contrôle hébergé à l’aide de cette URL, comme s’il s’agissait d’une fenêtre contextuelle demandée à partir du contrôle affiché.
frame	Cadre d’où provient la fenêtre contextuelle.

RunScript

Cette action injecte JavaScript dans le cadre principal de l’application.

Paramètre	Description
	Le paramètre de données est le JavaScript qui sera injecté dans le formulaire. Remarque : notez que les paramètres de remplacement peuvent être utilisés dans le script et qu’ils seront remplacés avant l’exécution du script.

SetSize

Cette action définit de façon explicite la largeur et la hauteur du contrôle hébergé. Ceci est particulièrement utile lorsque vous utilisez la fonction « automatique » dans vos dispositions de panneau.

Paramètre	Description
width	Largeur du contrôle hébergé.
height	Hauteur du contrôle hébergé.

SetUserCanClose

Permet à l’utilisateur de fermer le contrôle hébergé en cliquant sur l’icône X dans le coin supérieur droit de l’onglet de contrôle hébergé.

Paramètre	Description
UserCanClose	Définissez le paramètre true pour permettre à l’utilisateur de fermer le contrôle hébergé. Sinon, définissez sur false.

RaiseCifClientEvent

Cette action envoie les données déclenchées par l’événement côté client au contrôle hébergé.

Paramètre	Description
event	Événements côté client d’où vous souhaitez déclencher les données.
data	Le paramètre de données prend des valeurs eventData. Passez les données en tant que chaîne qui a été reçue de l’événement à l’aide des paramètres de remplacement. data = [[data]+]. Les événements côté client pris en charge sont les suivants : OnClickToAct SendKbArticleEvent Événement onpagenavigate (référence de l’API JavaScript de l’environnement d’intégration du canal)

UpdateCifContext

Cette action envoie les données du client au fournisseur de canal.

Paramètre	Description
corrId	L’identificateur unique doit être identique à celui transmis dans l’événement initial par le fournisseur de canal de sorte que le UpdateCifContext récupère le résultat.
action	Paramètre pour accepter ou rejeter l’objet de la promesse. Celui-ci prend la valeur accept ou reject. Si vous passez accept, l’API appelle la fonction de réussite, qui exécutera le paramètre de résultats. si vous passez reject, l’API appelle la fonction d’erreur.
result	Données que vous souhaitez envoyer du client au fournisseur de canal.

Événements prédéfinis

Les événements suivants sont pris en charge pour ce type de contrôle hébergé.

CreateRecord

L’événement se produit lorsque l’API JavaScript Channel Integration Framework correspondante est appelée par le fournisseur de canal pour créer une entité. Les données transmises dans l’API sont également passées à l’application cliente Unified Service Desk.

Paramètre	Description
entity	Nom logique de l’entité.
data	Chaîne définissant les attributs et valeurs du nouvel enregistrement d’entité.
corrId	Identificateur unique pour l’événement CreateRecord déclenché.

Pour en savoir plus, voir createRecord (référence de l’API JavaScript CIF)

RetrieveRecord

L’événement se produit lorsque l’API JavaScript Channel Integration Framework correspondante est appelée par le fournisseur de canal pour récupérer une entité. Les données transmises dans l’API sont également passées à l’application cliente Unified Service Desk.

Paramètre	Description
entity	Nom logique d’entité de l’enregistrement à récupérer.
entityId	GUID de l’enregistrement d’entité à extraire.
corrId	Identificateur unique pour l’événement RetrieveRecord déclenché.
options	Options de requête système OData, $select et $expand, pour récupérer vos données. Utilisez l’option de requête système $select pour limiter les propriétés retournées en incluant une liste de noms de propriété séparés par des virgules. C’est une pratique recommandée importante. Si des propriétés ne sont pas spécifiées à l’aide de $select, toutes les propriétés sont renvoyées. Utilisez l’option de requête système $expand pour contrôler quelles données des entités associées sont renvoyées. Si vous incluez uniquement le nom de la propriété de navigation, vous recevrez toutes les propriétés des enregistrements associés. Vous pouvez limiter les propriétés retournées pour les enregistrements associés à l’aide de l’option de requête système $select entre parenthèses après le nom de propriété de navigation. Utilisez cette procédure pour les propriétés de navigation à valeur unique et avec valeur de collection. Vous spécifiez les options de requête à partir de ?. Vous pouvez également spécifier plusieurs options de requête système en utilisant & pour séparer les options de requête. Par exemple : ?$select=name&$expand=primarycontactid($select=contactid,fullname)

Pour en savoir plus, voir retrieveRecord (référence de l’API JavaScript CIF)

UpdateRecord

L’événement se produit lorsque l’API JavaScript Channel Integration Framework correspondante est appelée par le fournisseur de canal pour mettre à jour une entité. Les données transmises dans l’API sont également passées à l’application cliente Unified Service Desk.

Paramètre	Description
entity	Nom logique de l’entité de l’enregistrement à mettre à jour.
entityId	GUID de l’enregistrement d’entité à mettre à jour.
data	Chaîne contenant des paires key: value, où key est la propriété de l’entité et value est la valeur de la propriété à mettre à jour.
corrId	Identificateur unique pour l’événement UpdateRecord déclenché.

Pour en savoir plus, voir updateRecord (référence de l’API JavaScript CIF)

DeleteRecord

L’événement se produit lorsque l’API JavaScript Channel Integration Framework correspondante est appelée par le fournisseur de canal pour supprimer une entité. Les données transmises dans l’API sont également passées à l’application cliente Unified Service Desk.

Paramètre	Description
entity	Nom logique de l’entité de l’enregistrement à supprimer.
data	Chaîne définissant les attributs et valeurs du nouvel enregistrement d’entité.
entityId	GUID de l’enregistrement d’entité à supprimer.
corrId	Identificateur unique pour l’événement DeleteRecord déclenché.

Pour en savoir plus, voir deleteRecord (référence de l’API JavaScript CIF)

GetEntityMetadata

L’événement se produit lorsque l’API JavaScript Channel Integration Framework correspondante est appelée par le fournisseur de canal pour retourner les métadonnées d’entité de l’entité spécifiée. Les données transmises dans l’API sont également passées à l’application cliente Unified Service Desk.

Paramètre	Description
entity	Nom logique d’entité de l’entité.
attributes	Attributs pour lesquels vous souhaitez obtenir des métadonnées.
corrId	Identificateur unique pour l’événement GetEntityMetadata déclenché.

Pour en savoir plus, voir [getEntityMetadata (référence de l’API JavaScript CIF)](../channel-integration-framework/v1/develop/reference/microsoft-ciframework /getentitymetadata.md)

GetEnvironment

L’événement se produit lorsque l’API JavaScript Channel Integration Framework correspondante est appelée par le fournisseur de canal pour obtenir les détails l’application Unified Interface actuelle et de la page. Les détails incluent appId, pageType et recordId (si disponible). Les données transmises dans l’API sont également passées à l’application cliente Unified Service Desk.

Cet événement ne contient aucun paramètre.

Pour en savoir plus, voir getEnvironment (référence de l’API JavaScript CIF)

OpenForm

L’événement se produit lorsque l’API JavaScript Channel Integration Framework correspondante est appelée par le fournisseur de canal pour ouvrir un formulaire d’entité ou un formulaire de création rapide. Les données transmises dans l’API sont également passées à l’application cliente Unified Service Desk.

Paramètre	Description
entityFormOptions	Options de formulaire d’entité pour ouvrir le formulaire.
entityFormParameters	Objet de dictionnaire qui transmet des paramètres supplémentaires au formulaire. Des paramètres non valides provoquent une erreur. Pour plus d’informations sur le passage des paramètres à un formulaire, voir Définir les valeurs de champ utilisant les paramètres transmis à un formulaire et Configurer un formulaire pour accepter les paramètres de chaîne de requête personnalisés
corrId	Identificateur unique pour l’événement OpenForm déclenché.

Pour en savoir plus, voir [openForm (référence de l’API JavaScript CIF)](../channel-integration-framework/shared /openform.md)

RenderSearchPage

L’événement se produit lorsque l’API JavaScript Channel Integration Framework correspondante est appelée par le fournisseur de canal pour autoriser la recherche dans les enregistrements d’un type d’entité spécifique. Cette API ouvre la page d’entité Unified Interface avec le champ de recherche déjà complété avec la chaîne recherchée transmise comme paramètre. Les données transmises dans l’API sont également passées à l’application cliente Unified Service Desk.

Paramètre	Description
entity	Nom logique de l’entité de l’enregistrement à interroger.
searchString	Chaîne à rechercher entre les attributs des enregistrement d’entité.
corrId	Identificateur unique pour l’événement RenderSearchPage déclenché.

Pour en savoir plus, voir [renderSearchPage (référence de l’API JavaScript CIF)](../channel-integration-framework/shared /rendersearchpage.md)

SearchAndOpenRecords

L’événement se produit lorsque l’API JavaScript Channel Integration Framework correspondante est appelée par le fournisseur de canal pour rechercher l’enregistrement du fournisseur de canal pendant les communications entrantes et ouvre l’enregistrement. Les données transmises dans l’API sont également passées à l’application cliente Unified Service Desk.

Paramètre	Description
entity	Nom logique de l’entité à rechercher et à ouvrir.
queryParmeters	Options de requête système OData, $select et $expand, pour récupérer vos données. Utilisez l’option de requête système $select pour limiter les propriétés retournées en incluant une liste de noms de propriété séparés par des virgules. C’est une pratique recommandée importante. Si des propriétés ne sont pas spécifiées à l’aide de $select, toutes les propriétés sont renvoyées. Utilisez l’option de requête système $expand pour contrôler quelles données des entités associées sont renvoyées. Si vous incluez uniquement le nom de la propriété de navigation, vous recevrez toutes les propriétés des enregistrements associés. Vous pouvez limiter les propriétés retournées pour les enregistrements associés à l’aide de l’option de requête système $select entre parenthèses après le nom de propriété de navigation. Utilisez cette procédure pour les propriétés de navigation à valeur unique et avec valeur de collection. Vous spécifiez les options de requête à partir de ?. Vous pouvez également spécifier plusieurs options de requête système en utilisant & pour séparer les options de requête. Par exemple : ?$select=name&$expand=primarycontactid($select=contactid,fullname)
searchOnly	Définir la valeur sur false pour ouvrir l’enregistrement dans la page Unified Interface si l’enregistrement provenant de la recherche est un seul enregistrement. Définir la valeur sur false pour ouvrir la page de recherche si le résultat de la recherche comporte plusieurs enregistrements et renseigne automatiquement la page de recherche avec la valeur de balise mentionnée lorsque le champ de recherche est utilisé dans queryParmeters. Définir la valeur sur true pour obtenir uniquement les résultats de la recherche comme résultat de promesse et ne pas ouvrir la page d’enregistrement ou la page de recherche.
corrId	Identificateur unique pour l’événement SearchAndOpenRecords déclenché.

Voir aussi

• Intégrer le canal à l’aide de Channel Integration Framework
• Créer un contrôle hébergé Channel Integration Framework