Page Unified Interface (contrôle hébergé)
Utilisez le type de contrôle hébergé Page Unified Interface pour charger une URL ou une page des applications Unified Interface dans les applications pilotées par modèle. Lorsqu’une page d’application pilotée par modèle est chargée dans un contrôle hébergé de ce type, elle analyse automatiquement la page pour rechercher les données de l’entité, et renseigne automatiquement les paramètres de remplacement.
Ce type de contrôle hébergé présente une série d’événements et d’actions UII qui sont propres à la gestion des applications pilotées par modèle Windows, notamment une action de manipulation des listes et une action de recherche pour afficher une page de recherche rapide ou avancée.
Créer un contrôle hébergé Page Unified Interface
Lors de la création d’un contrôle hébergé, les champs de l’écran Nouveau contrôle hébergé varient selon le type de contrôle hébergé à créer. Cette section fournit des informations sur les champs propres au type de contrôle hébergé Page Unified Interface.
Dans l’écran Nouveau contrôle hébergé :
Dans la zone Unified Service Desk, sélectionnez Page Unified Interface dans la liste déroulante Type de composant Unified Service Desk.
Sélectionnez Pré-récupérer les données pour charger les informations associées à un enregistrement d’entité dans le contexte, en même temps que la page d’enregistrement d’entité, sans devoir attendre le chargement complet de la page web de l’entité dans l’application cliente. Les informations d’entité extraites apparaissent dans le contexte Unified Service Desk, ce qui permet à n’importe quel contrôle hébergé d’afficher rapidement les informations d’entité pertinentes dans l’application cliente. Cela peut aider les agents à agir immédiatement ou à engager rapidement des discussions avec leurs clients et leur faire gagner un temps précieux d’interaction.
Dans la liste déroulante Autoriser plusieurs pages, sélectionnez Non (par défaut) pour remplacer la page de l’application pilotée par modèle affichée, et mettre à jour l’historique du navigateur lorsque Unified Service Desk reçoit un appel à l’action de navigation ou qu’une page est acheminée vers l’onglet. Sélectionnez Oui pour créer automatiquement une liste déroulante lorsqu’une deuxième URL est appelée ou qu’une règle de navigation dans les fenêtres fournit une page à l’onglet. Cela permet à l’utilisateur d’effectuer des recherches rapides entre les pages des applications pilotées par modèle qui sont associées à ce contrôle. En outre, lorsque vous sélectionnez Oui, un champ supplémentaire, Navigateurs maximum, devient disponible dans laquelle vous pouvez spécifier le nombre maximal de pages à afficher dans la liste déroulante.
Dans la zone Propriétés communes, activez la case à cocher Application globale pour définir le contrôle hébergé comme global. Les contrôles hébergés globaux peuvent être affichés en dehors de la session client. Des contrôles tels que le tableau de bord, le mur ou la recherche de l’agent sont des exemples courants de contrôles hébergés globaux. Les contrôles hébergés globaux n’ont pas de statut spécifique à une session, ainsi lorsque vous changez de session, ces mêmes contrôles hébergés globaux demeurent. Si cette case à cocher est désactivée, le contrôle hébergé est basée sur la session. Les contrôles basés sur une session existent dans le contexte de la session client. Si l’utilisateur change de session, toutes les pages de la session précédente sont masquées.
Le champ Afficher le groupe présente le panneau où ce contrôle hébergé sera affiché. MainPanel est le choix le plus courant pour ce type de contrôle hébergé.
Pour plus d’informations, voir Créer ou modifier un contrôle hébergé.
Actions UII prédéfinies
Voici les actions prédéfinies pour ce type de contrôle hébergé.
AssociatedView
Cette action charge une vue associée spécifique. Ces vues sont généralement accessibles en développant le nom de l’enregistrement d’entité dans la barre de navigation, puis en sélectionnant les entités associées.
| Paramètre | Description |
|---|---|
| etn | Nom de l’entité pour laquelle vous souhaitez charger la liste d’enregistrements de l’entité associée. Ce paramètre est obligatoire. |
| ID | ID de l’enregistrement d’entité principal pour lequel afficher les enregistrements d’entités associés. |
| navItemId | ID de l’élément de navigation correspondant à l’entité associée. Pour plus d’informations, voir formContext.ui.navigation |
| hideCommandBar | Si ce paramètre est fourni et qu’il est défini sur False, la page s’affiche avec la barre de commandes d’application pilotée par modèle. |
| hideNavigationBar | Si ce paramètre est fourni et qu’il est défini sur False, la page s’affiche avec la barre de navigation d’application pilotée par modèle. |
Fermer
Cette action permet de fermer le contrôle hébergé. Contrairement à l’action CloseActive, si cet onglet (contrôle hébergé) contient plusieurs pages, cette action fermera toutes les pages affichées dans l’onglet de votre application agent.
CloseActive
Cette action permet de fermer la fenêtre active dans ce contrôle hébergé. Si la fenêtre active est la seule fenêtre affichée dans le contrôlé hébergé, le contrôle lui-même est fermé. Pour le type de contrôle hébergé Page Unified Interface qui n’autorise pas les pages multiples (Autoriser plusieurs pages = Non), cette action est équivalente à l’action Fermer.
CloseAndPrompt
Cette action ferme le contrôle hébergé, mais invite l’utilisateur à enregistrer ou abandonner ses modifications avant la fermeture.
Trouver
Accédez à la vue de la liste de recherche rapide de l’entité spécifiée.
| Paramètre | Description |
|---|---|
| Voir la description | Le paramètre de données doit spécifier le nom logique de l’entité de la vue de la liste de recherche rapide à afficher. Il existe des valeurs spéciales pour les incidents : - Utilisez case ou incident pour afficher la vue de liste de recherche rapide des incidents. - Utilisez activities ou activity pour afficher la vue de liste de recherche rapide des activités. |
| hideNavigationBar | Définissez sur True pour masquer la barre de navigation, sinon False. |
| hideCommandBar | Définissez sur True pour masquer la barre de commandes, sinon False. |
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, voir Créer un événement défini par l’utilisateur.
GetSelectedIds
Cette action permet de récupérer les ID sélectionnés dans les listes.
| Paramètre | Description |
|---|---|
| Voir la description | Le paramètre de données doit spécifier le nom de la liste à partir duquel capturer les ID sélectionnés. |
La valeur renvoyée contient une liste des ID contenant les éléments sélectionnés, séparés par des points-virgules.
GetSelectedCount
Cette action récupère le nombre d’éléments qui sont sélectionnés. Utilisez l’action GetSelectedIds pour obtenir la liste effective des ID de l’entité.
| Paramètre | Description |
|---|---|
| Voir la description | Le paramètre de données doit spécifier le nom de la liste à partir duquel récupérer les ID sélectionnés. |
La valeur renvoyée contient un nombre représentant la quantité d’éléments sélectionnés.
GoHome
Cette action permet d’accéder à l’URL initiale spécifiée pour cette instance de navigateur.
GoBack
Cette action revient à sélectionner le bouton Précédent de l’instance de navigateur.
GoForward
Cette action revient à sélectionner le bouton Suivant de l’instance de navigateur.
MoveToPanel
Cette action déplace un contrôle hébergé Page Unified Interface vers un autre volet au moment de l’exécution.
| Paramètre | Description |
|---|---|
| Voir la description | Le paramètre de données doit spécifier le nom du volet cible vers lequel déplacer le contrôle hébergé (par exemple, FloatingPanel). |
Naviguer
Cette action permet d’accéder à l’URL d’une application pilotée par modèle. L’ID d’application de l’application que vous sélectionnez dans la fenêtre Sélectionner le module d’application est ajoutée automatiquement.
| Paramètre | Description |
|---|---|
| URL | URL à laquelle accéder. Ce paramètre est obligatoire. |
| HideCommandBar | Si ce paramètre est fourni et qu’il est défini sur Vrai, le cadre interne s’affiche sans charger la barre de commandes des applications pilotées par modèle. |
| HideNavigationBar | Si ce paramètre est fourni et qu’il est défini sur Vrai, le formulaire interne s’affiche sans charger la barre de navigation des applications pilotées par modèle. |
| Cadre | Lorsqu’il y a des cadres dans la page, ce paramètre spécifie le nom du cadre pour la navigation, plutôt que de naviguer via la fenêtre principale. |
| postdata | Données envoyées au serveur dans le cadre d’une transaction HTTP POST. Une transaction POST est généralement utilisée pour envoyer les données collectées par une page HTML. Dans Unified Service Desk, ces données peuvent être reçues de tout événement déclenché à l’aide de https://event/?. Exemple : [[postdata]+] Par ailleurs, les données sont transmises en tant que chaîne encodée avec son type d’en-tête au format attendu. |
| header | Valeur de chaîne contenant des en-têtes HTTP supplémentaires à envoyer au serveur. Lorsque le paramètre postdata est utilisé dans l’action Naviguer, vous devez également spécifier une valeur appropriée pour le paramètre header, par exemple Content-Type:application/x-www-form-urlencoded Si un événement POST Unified Service Desk déclenche l’action Naviguer, la valeur par défaut de ce paramètre doit être header=[[header]+] Pour ajouter plusieurs en-têtes, la valeur de ce paramètre doit être : header=$Multiline(en-têtes séparés par une nouvelle ligne) Exemple : header=$Multiline(accessToken;dummyAccessToken==refreshToken;dummyRefreshToken===) |
New_CRM_Page
Crée une page pour créer un nouvel enregistrement de l’entité spécifiée et traite la page comme une fenêtre contextuelle du contrôle hébergé spécifié. Les règles de navigation dans la fenêtre sont évaluées afin de déterminer l’emplacement où la page de création de l’enregistrement d’entité sera affichée.
| Paramètre | Description |
|---|---|
| Nom logique | Nom logique de l’entité pour créer une nouvelle instance. |
Note
Le reste des paramètres doit être composé de paires nom/valeur. Il s’agit des autres valeurs préremplies dans le formulaire pour créer un enregistrement pour l’entité spécifiée.
Open_CRM_Page
Ouvre une instance existante de l’entité spécifiée et identifiée par l’ID, et traite la page comme s’il s’agissait d’une fenêtre contextuelle provenant du contrôle hébergé spécifié. Les règles de navigation dans la fenêtre sont évaluées pour déterminer l’emplacement où la fenêtre contextuelle doit être affichée.
| Paramètre | Description |
|---|---|
| LogicalName | Nom logique de l’entité à ouvrir. |
| id | ID de l’enregistrement d’entité à ouvrir. |
Fenêtre contextuelle
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é. |
| cadre | Cadre d’où provient cette fenêtre contextuelle. |
RealignWindow
Affiche le contrôle hébergé à l’emplacement spécifié sur un moniteur. Vous pouvez afficher les contrôles hébergés sur deux moniteurs au maximum. Cette action s’applique aux instances de contrôle hébergé qui sont configurées pour être placées sur un volet de type USDFloatingPanel ou USDFloatingToolPanel.
| Paramètre | Description |
|---|---|
| écran | Spécifie l’écran sur lequel afficher le contrôle hébergé. Les valeurs valides sont 1 ou 2. Si vous ne spécifiez pas ce paramètre, la valeur 1 est transmise par défaut. |
| gauche | Spécifie la position, en pourcentage, à partir de la gauche de l’écran sur le moniteur cible où le contrôle hébergé doit être affiché. Les valeurs valides vont de 0 à 100. Si vous ne spécifiez pas ce paramètre, la valeur 0 est transmise par défaut. |
| haut | Spécifie la position, en pourcentage, à partir du haut de l’écran sur le moniteur cible où le contrôle hébergé doit être affiché. Les valeurs valides vont de 0 à 100. Si vous ne spécifiez pas ce paramètre, la valeur 0 est transmise par défaut. |
| largeur | Spécifie la largeur, en pourcentage, de la fenêtre du contrôle hébergé sur le moniteur cible. Les valeurs valides vont de 1 à 100. Si vous ne spécifiez pas ce paramètre, la valeur 100 est transmise par défaut. |
| hauteur | Spécifie la hauteur, en pourcentage, de la fenêtre du contrôle hébergé sur le moniteur cible. Les valeurs valides vont de 1 à 100. Si vous ne spécifiez pas ce paramètre, la valeur 100 est transmise par défaut. |
Refresh
Cette action actualise la page actuelle.
RunScript
Cette action injecte JavaScript dans le cadre principal de l’application. Vous devez éviter d’utiliser les appels du Kit de développement logiciel du client Microsoft Dataverse avec cette action. Utilisez plutôt l’action RunXrmCommand.
| Paramètre | Description |
|---|---|
| Voir la description | Le paramètre de données est le JavaScript qui sera injecté dans le formulaire. Remarque : les paramètres de remplacement peuvent être utilisés dans le script et ils seront remplacés avant l’exécution du script. |
| Cadre | Lorsqu’il y a des cadres dans la page, ce paramètre spécifie le nom du cadre dans lequel injecter le JavaScript. |
RunXrmCommand
Cette action est utilisée pour exécuter le code JavaScript qui utilise la Référence de l’API client des applications pilotées par modèle dans les Pages Unified Interface (formulaires et grilles d’entité).
Vous devez configurer le script comme fonction des ressources web JavaScript des applications pilotées par modèle. Le premier paramètre de la fonction est un paramètre de contexte (paramètre réservé) qui peut avoir l’une des valeurs suivantes :
- FormContext dans les pages du formulaire d’entité
- GridContext dans les pages de la grille d’entité
- non défini sur d’autres pages
| Paramètre | Description |
|---|---|
| webResourceName | Nom de la ressource web dans laquelle figure la fonction JavaScript à exécuter. |
| functionName | Nom de la fonction. |
Les autres paramètres de la fonction sont définis par le client et peuvent être utilisés pour transmettre des paramètres de remplacement de Unified Service Desk au moment de l’exécution. Cette action accepte une liste de paramètres facultatifs sans clés. La liste des paramètres facultatifs est transmise comme arguments dans le même ordre à partir de la deuxième position après le remplacement de contexte au moment de l’exécution.
Exemple
Vous souhaitez exécuter l’action RunXrmCommand pour remplir les attributs d’un formulaire d’entité, où le formulaire d’entité est hébergé par un type Page Unified Interface de contrôle hébergé. La valeur que vous souhaitez remplir dans la perspective de Unified Service Desk est un paramètre de remplacement : [[$Context.Key1]].
Pour exécuter cette action, vous devez entrer la ressource web de type JavaScript (disons webResource1), puis une fonction dans la ressource web.
function fillAttributeValue(context, attrValue)
{
context.getAttribute(<attributeName>).setValue(attrValue);
}
Vous devez configurer les données dans l’appel à l’action comme suit :
webResourceName = webResource1
functionName = fillAttributeValue
'[[$Context.Key1]]'
Note
Dans l’exemple ci-dessus, observez les guillemets simples entourant les paramètres de remplacement, [[$Context.Key1]]. Unified Service Desk considère uniquement la valeur du paramètre (pas le type de données) et transmet tous les caractères comme valeur remplacée par contexte à la fonction JavaScript. Vous devez être prudent et faire attention au type de données pendant la configuration.
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é. |
SaveAndClose
Cette action permet d’enregistrer les données modifiées dans le formulaire des applications pilotées par modèle, et ferme le contrôle hébergé.
SaveAll
Cette action enregistre tous les formulaires d’un contrôle hébergé qui permet l’affichage de plusieurs pages (Autoriser plusieurs pages = Oui). Si le contrôle hébergé permet l’affichage d’une seule page (Autoriser plusieurs pages = Non), il est équivalent à l’action Enregistrer.
Enregistrer
Cette action enregistre la page Unified Interface actuelle.
Événements prédéfinis
Les événements prédéfinis suivants sont associés à ce type de contrôle hébergé.
ActiveClosed
Survient lorsque le contrôle hébergé actif est fermé à l’aide de l’action CloseActive.
| Paramètre | Description |
|---|---|
| url | URL qui était affichée dans le contrôle hébergé lorsqu’il a été fermé. |
DataReady
Se produit dès que les informations associées d’un enregistrement d’entité sont chargées dans le contexte Unified Service Desk. Cet événement se produit avant l’événement PageReadyFor. Si l’option Pré-récupérer les données est activée pour l’instance de contrôle, cet événement se produit dès que les données d’entité sont extraites dans un appel parallèle distinct au serveur sans attendre que toute la page finisse de se charger. Les données d’entité sont pré-récupérées et l’événement DataReady est également déclenché pour la navigation en ligne.
Note
Pour les tableaux de bord, les ressources web et les pages de recherche, l’événement DataReady n’est pas déclenché.
RefreshRequested
Survient lorsqu’une actualisation est demandée sur la page actuelle. L’actualisation peut être demandée en enfonçant la touche F5 ou en appelant l’action Actualiser par l’application.
| Paramètre | Description |
|---|---|
| URL | URL affichée lorsque l’actualisation a été demandée. |
Enregistré
Après la sauvegarde d’un enregistrement dans la page d’application pilotée par modèle.
| Paramètre | Description |
|---|---|
| newId | ID attribué à l’enregistrement récemment créé. |
NavigationRequested
Lorsque la navigation se produit dans les applications Unified Interface.
| Paramètre | Description |
|---|---|
| url | L’URL de la page ouverte. |
PageReady
Survient lorsque le chargement de la page est terminé. Dans un type de contrôle hébergé Page Unified Interface, cet événement se produit lorsque les données ont été enregistrées dans la liste des paramètres de remplacement.
| Paramètre | Description |
|---|---|
| url | URL de la page dont le chargement est terminé. |
Note
Pour les tableaux de bord, les ressources web et les pages de recherche, l’événement DataReady n’est pas déclenché.
BrowserWindowReady
L’événement NavigateurWindowReady est appelé lorsque la fenêtre du navigateur est prête dans l’application cliente Unified Service Desk. Utilisez NavigateurWindowReady pour les tableaux de bord et les ressources web.
OnClickToAct
L’événement OnClickToAct est appelé lorsque l’utilisateur sélectionne le champ sortant de communication (ClickToAct) dans un formulaire.
Vous pouvez également entrer des contrôles personnalisés pour déclencher l’événement de fenêtre ClickToAct de l’Environnement d’intégration du canal et transmettre tout eventData en fonction des besoins de l’entreprise.
Pour plus d’informations, voir onclicktoact
OnSendKbArticle
L’événement OnSendKbArticle est appelé lorsque l’utilisateur sélectionne Envoyer dans le contrôle de la Base de connaissances. Les eventData sont l’URL et le titre de l’article de la Base de connaissances que vous devez transmettre.
Pour plus d’informations, voir onsendkbarticle
Note
Nous vous recommandons de ne pas utiliser window.IsUSD dans les formulaires des applications pilotées par modèle ; utilisez à la place l’événement PageReady ou d’autres événements répertoriés dans cette rubrique.
Voir aussi
Prise en charge des applications Unified Interface dans Unified Service Desk
Guides pas-à-pas de configuration de Unified Service Desk et Unified Interface
Guide pas-à-pas 1 : Création d’une application agent simple pour les applications Unified Interface
Guide pas-à-pas 2 : Affichage d’une page Web externe dans votre application agent
Guide pas-à-pas 3 : Affichage des enregistrements des applications Unified Interface dans votre application agent
Guide pas-à-pas 4 : Affichage d’un enregistrement des applications Unified Interface dans une session de votre application agent
Guide pas-à-pas 5 : Affichage d’informations de session améliorées avec le nom de la session et les données de vue d’ensemble
Guide pas-à-pas 6 : Configuration du contrôle hébergé Débogueur dans votre application agent
Guide pas-à-pas 7 : Configuration de la génération de scripts d’agent dans votre application agent