Configurer une intégration de recherche
Fonctionnalité Premium d'intégration de recherche Contactez votre responsable de la réussite client ou votre responsable de compte pour en savoir plus sur cette fonctionnalité. |
Vous pouvez intégrer Case IQ à votre écosystème de gestion de Case IQ grâce à sa fonctionnalité de recherche. Celle-ci vous permet de rechercher des données dans un système source externe, comme le système de gestion des ressources humaines ou de gestion des tickets de votre organisation, et de les renseigner dans les champs Case IQ Case IQ. Vous pouvez ainsi extraire en temps réel des données déjà présentes dans un autre système, sans avoir à les saisir manuellement.
Une intégration de recherche ressemble à une barre de recherche sur un formulaire lors de l'ajout ou de la modification d'un enregistrement. Lorsque vous saisissez des mots clés dans la barre de recherche, Case IQ envoie une requête HTTP à votre système source pour récupérer les données. L'intégration de recherche de Case IQ accepte le JSON sérialisé et peut gérer automatiquement les réponses au format XML ou CSV.
Vous pouvez configurer une intégration de recherche pour une section ou un formulaire. La section suivante de cet article, « Choisir une intégration de recherche pour une section ou un formulaire », vous guidera sur l'option à choisir en fonction de votre cas d'utilisation. Si vous décidez de configurer une section, consultez « Ajouter une section de recherche de données ». Pour une intégration de formulaire, consultez « Activer l'intégration de recherche de formulaire ». Après avoir ajouté ou activé votre intégration de recherche, vous pouvez configurer ses paramètres en suivant la section « Configurer une intégration de recherche ».
Choisir une intégration de recherche de section ou de formulaire
Bien que les intégrations de recherche de données pour les sections et les formulaires utilisent la même fonctionnalité de recherche, nous recommandons chaque option dans différents scénarios.
Les sections de recherche de données sont idéales si vous devez configurer plusieurs intégrations avec différents systèmes sources pour un même type d'enregistrement. Par exemple, supposons que les enquêteurs doivent documenter les informations sur les employés et les clients pour des dossiers stockés dans deux applications différentes de votre organisation. Vous pouvez ajouter deux sections de recherche de données au formulaire de dossier Case IQ afin que les enquêteurs puissent extraire les données de chaque système source : une pour les informations sur les employés et une autre pour les informations sur les clients.
En revanche, nous recommandons une intégration de recherche de formulaire si vous devez renseigner des données sources dans des champs statiques de profil ou de partie. Bien que vous puissiez ajouter des sections de recherche de données aux formulaires de profil et de partie, l'intégration ne pourra renseigner les données sources que dans les champs « dynamiques » de la section de recherche, c'est-à-dire les champs que vous avez ajoutés et configurés pour le type d'enregistrement avec le générateur de formulaires. Grâce à l'intégration de recherche de formulaire, vous pouvez mapper les données sources aux champs statiques des formulaires de profil et de partie, tels que « Prénom », « Nom » et « Type de partie ».
Consultez le tableau ci-dessous pour plus d'informations sur la section de recherche et les intégrations de formulaires pour vous aider à déterminer la meilleure intégration pour vos besoins.
Détails de l'intégration | Sections de recherche de données | Intégrations de recherche de formulaires |
---|---|---|
Types d'enregistrements disponibles | Cas, parties, profils, profils d'utilisateur et types de formulaires personnalisés. | Parties, profils et types de formulaires personnalisés. |
Nombre d'intégrations sur le formulaire | Vous pouvez ajouter plusieurs sections de recherche de données à un formulaire et intégrer chacune d’elles à un système source différent. | Vous ne pouvez configurer qu'une seule intégration de recherche de formulaire pour un type d'enregistrement, ce qui signifie que vous ne pouvez l'intégrer qu'à un seul système source. |
Champs pris en charge | Champs dynamiques dans la section de recherche de l'enregistrement. | Champs dynamiques et champs statiques du type d'enregistrement. Ces champs peuvent être situés n'importe où dans le formulaire et n'ont pas besoin d'être organisés en sections. |
Ajouter une section de recherche de données
Pour ajouter une intégration de recherche pour une section sur un type d’enregistrement :
- Dans Paramètres, accédez à la page Formulaires sous l’onglet Formulaires.
- Dans la grille « Formulaires », sélectionnez le formulaire auquel vous souhaitez ajouter la section de recherche de données. Vous pouvez ajouter une section de recherche à tout type de formulaire standard ou personnalisé.
- Si vous souhaitez créer un nouveau type de formulaire personnalisé, consultez l’article Ajouter et modifier un type de formulaire personnalisé pour plus de détails.
- Cliquez sur le bouton Modifier du générateur de formulaires pour mettre le formulaire en mode édition.
- Cliquez sur la section + Insérer des champs ou sur l’icône de flèche droite pour ouvrir la barre latérale Type de champ.
- Recherchez « Section de recherche de données » dans la barre latérale Type de champ.
- Cliquez et maintenez « Section de recherche de données » dans la barre latérale Type de champ, faites-la glisser vers le générateur de formulaires et relâchez votre curseur.
- La section Recherche de données s'affichera et vous permettra de configurer les paramètres d'intégration. Consultez la section « Configurer une intégration de recherche » de cet article pour plus de détails sur la configuration des paramètres d'intégration.
- Une fois l'intégration configurée, cliquez sur « Enregistrer » dans la fenêtre contextuelle. La section de recherche de données apparaît alors dans le générateur de formulaires.
- Vous pouvez désormais ajouter des champs à la section à renseigner via l'intégration de recherche. Cliquez sur le bouton + Insérer des champs dans la section de recherche de données ou sur la flèche droite pour ouvrir à nouveau la barre latérale Type de champ.
- Recherchez les types de champs que vous souhaitez ajouter à la section de recherche de données. Consultez la section « Types de champs pris en charge pour la recherche » de cet article pour obtenir la liste complète des champs que Case IQ peut renseigner via une intégration de recherche.
- Lorsque vous avez trouvé un type de champ que vous souhaitez ajouter à la section, cliquez dessus et maintenez-le enfoncé dans la barre latérale Type de champ, faites-le glisser vers la section de recherche de données et relâchez votre curseur.
- Ajoutez tous les champs que vous souhaitez remplir dans la section via la recherche.
- Vous pouvez désormais mapper vos données sources aux champs ajoutés à la section de recherche de données. Consultez les sections « Méthode de mappage simple » ou « Méthode de mappage d'expression » de cet article, selon la méthode choisie.
- Si vous avez sélectionné « Détecter automatiquement les mappages » lors de la configuration de votre intégration de recherche, vous pouvez ignorer cette étape.
- Une fois que vous avez terminé de configurer votre intégration de recherche et vos mappages, cliquez sur le bouton Publier dans le générateur de formulaires pour rendre la section de recherche de données disponible pour vos utilisateurs.
Activer une intégration de recherche de formulaire
Pour activer une intégration de recherche pour le formulaire d’un type d’enregistrement :
- Dans Paramètres, accédez à la page Formulaires sous l’onglet Formulaires.
- Dans la grille Formulaires, sélectionnez le formulaire pour lequel vous souhaitez configurer une intégration de recherche.
- Si vous souhaitez créer un nouveau type de formulaire personnalisé, consultez l’article Ajouter et modifier un type de formulaire personnalisé pour plus de détails.
- Cliquez sur le bouton Modifier du générateur de formulaires pour mettre le formulaire en mode édition.
- Cliquez sur l’icône Modifier à côté du nom du formulaire.
- Dans la barre latérale Propriétés du formulaire, activez le bouton « Recherche ».
- Les champs permettant de configurer les paramètres d'intégration s'affichent désormais dans la barre latérale des propriétés du formulaire. Consultez la section « Configurer une intégration de recherche » de cet article pour plus de détails sur la configuration des paramètres d'intégration.
- Sous le bouton « Recherche », vous trouverez également le champ « Libellé de la recherche », dans lequel vous pouvez saisir le texte à afficher à côté de la barre de recherche pour l'intégration de la recherche. Par exemple, imaginons que vous configuriez une intégration de recherche Workday HR pour votre formulaire de groupe. Vous pouvez nommer la recherche « Recherche d'employés Workday HR » afin que vos utilisateurs sachent que les données seront extraites de Workday HR.
- Vous pouvez désormais mapper vos données sources aux champs du formulaire. Consultez les sections « Méthode de mappage simple » ou « Méthode de mappage d'expression » de cet article, selon la méthode choisie.
- Si vous avez sélectionné « Détecter automatiquement les mappages » lors de la configuration de votre intégration de recherche, vous pouvez ignorer cette étape.
- Une fois que vous avez terminé de configurer votre intégration de recherche et vos mappages, cliquez sur le bouton Publier dans le générateur de formulaires pour rendre l'intégration de recherche disponible pour vos utilisateurs.
Configurer une intégration de recherche
Après avoir ajouté une section de recherche ou activé une intégration de formulaire, renseignez les paramètres suivants pour configurer votre intégration. Les mêmes options de configuration s'afficheront, que vous configuriez une section ou un formulaire de recherche.
- Méthode de mappage : choisissez comment mapper vos données sources aux champs Case IQ de la section ou du formulaire. Vous pouvez choisir l'une des options suivantes :
- Simple : mappez manuellement les données sources pour chaque champ cible de la section ou du formulaire. Vous pouvez définir le mappage des champs après avoir enregistré les paramètres d'intégration ; voir les étapes de la section « Méthode de mappage simple ».
- Expression : mappez les données sources aux champs cibles Case IQ à l'aide d'une expression ISEL, afin de définir un mappage de données complexe. Cette option affiche un champ « Expression ISEL ». Consultez la section « Méthode de mappage d'expressions » pour obtenir des conseils sur la rédaction d'expressions.
- Détection automatique des mappages : si vous sélectionnez « Simple » comme méthode de mappage, vous pouvez activer cette option. Ainsi, Case IQ mappera automatiquement les champs en comparant les noms des champs de votre système source transmis dans la requête avec ceux des champs Case IQ de la section ou du formulaire. Le système mappera les données sources aux champs Case IQ dont les noms correspondent, sans tenir compte de la casse et des symboles.
- Méthode de recherche : sélectionnez « Requête HTTP ».
- Point de terminaison : saisissez l'URL du point de terminaison fournie par votre système source, qui indique Case IQ où envoyer la requête de recherche de données. Utilisez le format suivant pour l'URL du point de terminaison et terminez-la par la valeur dynamique de recherche : https://end.point/route?q={dynamicValue}.
- Vous pouvez utiliser « {searchValue} » comme espace réservé pour la valeur dynamique saisie dans le champ de recherche du formulaire. Par exemple, si vous saisissez « Daniel » dans un champ de recherche, la valeur {searchValue} sera « Daniel » et Case IQ enverra une requête à votre système source pour extraire les données contenant « Daniel ».
- Vous pouvez également utiliser l'un des champs du type d'enregistrement comme valeur dynamique au format suivant : « {<recordTypeName>.<fieldName>} ». Par exemple, supposons que vous ajoutiez une section de recherche de données au formulaire de cas. En saisissant « {case.caseType} » dans le point de terminaison, Case IQ enverra une requête à votre système source pour extraire les données contenant le type de cas sélectionné pour le cas actuel.
- Méthode HTTP : choisissez si Case IQ doit envoyer une requête GET, POST ou PUT pour récupérer les données du système source. Sélectionnez la méthode HTTP en fonction des exigences de votre système source.
- L'API de votre système source peut être conçue pour accepter uniquement certaines méthodes de requête. Bien que GET soit la méthode la plus courante pour récupérer des données, certains systèmes peuvent nécessiter POST ou PUT, notamment lorsque la requête doit inclure un corps avec des paramètres spécifiques.
- Corps HTTP : si vous sélectionnez « POST » ou « PUT » comme méthode HTTP, le champ « Corps HTTP » s'affiche. Vous pouvez ainsi saisir une expression renvoyant un objet sérialisé dans le corps de la requête HTTP. Consultez les exemples de corps HTTP suivants pour POST et PUT.
- Exemple POST :
{ « caseId » : "12345", "caseType": "Fraude Enquête" }
- Exemple PUT :
{ "critèresderecherche": { « caseId » : "12345", "statut": "Ouvrir" } }
- Méthode d'authentification : sélectionnez la manière dont votre système source authentifie les demandes parmi les options suivantes : « Aucune », « Authentification de base » ou « Authentification OAuth ».
Authentification de base
Si vous sélectionnez « Authentification de base », les champs « Nom d'utilisateur » et « Mot de passe » s'afficheront. Vous pourrez ainsi saisir le nom d'utilisateur et le mot de passe utilisés par votre système source pour authentifier les requêtes. Le nom d'utilisateur et le mot de passe doivent correspondre à ceux attendus par votre système source pour que les requêtes soient autorisées.
Après avoir saisi votre nom d'utilisateur et votre mot de passe, cliquez sur le bouton « Tester l'authentification » sous le champ « Mot de passe » pour vérifier vos paramètres. Cela permet Case IQ de détecter d'éventuelles erreurs 401 non autorisées.
SupprimerAuthentification OAuth
Si vous sélectionnez « Authentification OAuth », vous verrez les champs supplémentaires suivants pour configurer l’authentification :
- Type de subvention : sélectionnez « Informations d’identification du client » pour gérer la communication de serveur à serveur.
- Point de terminaison du jeton d'accès : saisissez l'URL à partir de laquelle Case IQ doit obtenir le jeton sécurisé, par exemple https://{yourDomain}/oauth/token.
- ID client : saisissez l’ID fourni par votre système source.
- Secret client : saisissez la valeur secrète fournie par votre système source.
- Option d'authentification du client : choisissez comment Case IQ doit envoyer les informations d'identification parmi les options suivantes :
- Corps : Case IQ inclura un corps dans la demande d'authentification après les en-têtes.
- En-tête d'authentification de base : l'« ID client » et le « secret client » seront codés au format base64, puis transmis sous forme d'en-tête HTTP au système source, par exemple Autorisation : Basic {value}
- Portée : si votre système source l'exige, définissez les autorisations Case IQ a besoin.
Après avoir renseigné les champs OAuth requis, cliquez sur le bouton « Tester l'authentification » sous le champ « Étendue » pour vérifier vos paramètres. Cela permet Case IQ de détecter d'éventuelles erreurs 401 non autorisées.
Supprimer- Propriété de collection : si nécessaire, vous pouvez utiliser la propriété de collection pour spécifier le chemin d'accès au tableau dans la réponse API de votre système source, ce qui indique à Case IQ où trouver les données dans votre système source. Pour déterminer la propriété de collection :
- Regardez la réponse API de votre système source et recherchez le tableau contenant les données dont vous avez besoin.
- Identifiez la clé qui contient le tableau.
- Saisissez cette clé dans le champ Propriété de la collection.
Par exemple, supposons que l'API de votre système source renvoie l'objet JSON suivant. Vous saisirez « utilisateurs » dans le champ « Propriété de la collection » afin que l'intégration récupère les données utilisateur.
{ « utilisateurs » : [ { "identifiant": 1, "prénom": "John" } ] }
Méthode de cartographie simple
Si vous choisissez « Simple » comme « Méthode de mappage » lors de la configuration de votre intégration de recherche, consultez les étapes suivantes pour mapper les données source aux champs Case IQ :
- Pour une section de recherche de données, cliquez sur Ajouter un mappage de champ (
) dans l'en-tête de section. Pour une intégration de recherche de formulaire, cliquez sur le bouton « Ajouter un mappage » dans la barre latérale « Propriétés du formulaire ».
- Dans la fenêtre contextuelle « Ajouter un mappage de champs », vous pouvez indiquer Case IQ les données de votre système source à renseigner dans les champs. Dans chaque champ « Source », saisissez le nom du champ que votre système source enverra à Case IQ dans le cadre de l'intégration.
- Dans la liste déroulante « Cible », sélectionnez le champ correspondant dans la section ou le formulaire de recherche de données dans lequel Case IQ doit renseigner les données source.
- Une fois que vous avez mappé tous les champs cibles, cliquez sur le bouton Enregistrer dans la fenêtre contextuelle.
- Si vous avez terminé de configurer votre intégration, cliquez sur le bouton Publier dans le générateur de formulaires pour rendre l'intégration de recherche disponible pour vos utilisateurs.
Méthode de mappage d'expression
Si vous choisissez « Expression » comme méthode de mappage pour l'intégration de recherche, vous pouvez écrire une expression ISEL pour indiquer Case IQ les données du système source à renseigner dans les champs Case IQ. Le format de base des expressions de mappage est le suivant :
{caseIqFieldName1: résultat.sourceSystemName1, caseIqFieldName2 : résultat.sourceSystemName2, ...}
À la place de result.sourceSystemName, vous pouvez utiliser les fonctions ISEL pour créer des expressions de mappage dynamiques. Consultez le langage d'expression Case IQ pour toutes les fonctions ISEL. Outre ces fonctions, vous pouvez également utiliser result, this et lookupFields dans les expressions de mappage :
- result ou this : l'objet de contexte, c'est-à-dire l'enregistrement de votre système source d'où vous extrayez les données. Par exemple, si vous créez une section de recherche de données pour extraire des informations de votre SIRH sur les employés dans Case IQ, result et this feront référence aux enregistrements des employés de votre SIRH.
- lookupFields : une variable de contexte contenant un tableau des noms de champs Case IQ dans la section ou le formulaire de recherche de données. Par exemple, supposons que la section de recherche de données contienne trois champs : firstName, lastName et active. Dans une expression, lookupFields serait un tableau de ces champs, soit [firstName, lastName, active].
Vous trouverez ci-dessous un exemple d'expression de mappage permettant de mapper les informations sur les employés du système source aux champs de partie Case IQ :
{prénom: résultat.employeeFirstName,lastName: résultat.employeeLastName, primaryEntity : résultat.type == "Sujet" ? vrai : FAUX}
Cette expression mappe les champs firstName, lastName et primaryEntity de Case IQ avec les champs employeeFirstName, employeeLastName et type du système source, respectivement. Le système renseigne les valeurs de employeeFirstName et employeeLastName dans firstName et lastName. Pour le champ primaryEntity, le système vérifie d'abord le champ type du résultat avant de renseigner les données. Si le type est « Subject », le système définit le champ « Primary » de la partie sur « Yes ». Sinon, Case IQ laisse le champ « Primary » sur « No ».
Types de champs pris en charge pour la recherche
Les types de champs suivants sont pris en charge par l'intégration de recherche de Case IQ. Cela signifie que vous pouvez mapper des données sources à ces types de champs, afin que les utilisateurs puissent les renseigner avec les données de votre système source.
- Case à cocher
- Date Heure
- Entier
- Argent
- Nombre
- Liste de sélection
- Liste de sélection multiple
- Radio
- Zone de texte
- Éditeur de texte
- Zone de texte