SNIPPET

Vous permet d'ajouter du code personnalisé à votre script.

Dépendances

• Le code utilisé dans cette action doit être écrit en Snippet, un langage de script interne développé pour NiCE CXone. Le Studio guide de référence technique fournit des renseignements détaillés sur l'écriture de scripts dans les Extraits.
• Les attributs des objets de données dynamiques ne peuvent pas être nommés __type (avec deux traits de soulignement). Ce mot est réservé pour l'analyse du JSON provenant des objets dynamiques.
• Vous pouvez effectuer des appels API à l'aide de l'action Snippet. Toutefois, il ne s'agit pas de la méthode recommandée pour effectuer des appels API dans vos scripts. Si vous les effectuez de cette façon, assurez-vous de bien comprendre les risques et les pratiques exemplaires.
• La taille maximum des tableaux dans Studio est de 63 millions d'éléments. Le dépassement de cette taille de tableau entraîne l'erreur suivante dans la Variable __err dans une trace de script: Index de tableau hors limites. L'index de Tableau actuel ([index]) dépasse l'index maximum autorisé (63000000). Lorsque la taille du tableau est dépassée, le script emprunte la branche Error de l'action SNIPPET. Si la branche Error n'est pas connectée, le script continue de s'exécuter, mais sans les informations du tableau. Vous pouvez configurer les scripts pour vous aviser lorsque la taille maximum du tableau a été dépassée en ajoutant une action EMAIL à la branche Error de l'action SNIPPET. Enfin, vous pouvez ajouter une logique dans la branche Error pour poursuivre le script. Notez qu'il continuera sans les informations du tableau.

• La taille maximum de la réponse dans NiCE CXone est de 32 Ko. Cette limite est strictement appliquée afin d’éviter l’instabilité et les pannes du cluster. Studio applique cette limite lors de l’enregistrement du script, mais Desktop Studio ne l’applique pas. Si possible, utilisez REST API action ou Integration Hub à la place de l’action SNIPPET pour effectuer des Appels api. Elles ont la même limite, mais peuvent gérer une charge plus importante. Si vous devez utiliser l’action SNIPPET, suivez ces conseils pour réduire la taille des données renvoyées :

  • Filtrez les données dans la réponse de l’API : Par exemple, si vous utilisez l’API Reporting NiCE pour obtenir des contacts, vous pouvez filtrer les résultats selon startDate et endDate du contact. Cet Appel api vous permet également de renvoyer et de limiter un nombre haut d’éléments. Reportez-vous à la documentation de l’API fournie avec votre intégration de script pour déterminer les Filtres que vous pouvez utiliser.

  • Mettez à jour la demande d’API pour renvoyer uniquement les données dont vous avez besoin : Par exemple, si vous utilisez l’API Reporting NiCE pour obtenir des contacts, vous pouvez utiliser les champs contactId ou agentId pour renvoyer uniquement les données pertinentes. Reportez-vous à la documentation de l’API fournie avec votre intégration de script pour déterminer les limites de données que vous pouvez utiliser.

  • Créez un intergiciel : Si vous ne pouvez faire ni l’une ni l’autre des Options précédentes, créez un intergiciel qui effectue le filtres en fonction de critères personnalisés que vous définissez. Si vous procédez ainsi, assurez-vous que votre intergiciel n’ajoute pas de latence à l’Appel.

• Chaque boucle FOR, FOREACH ou REPEAT à l'intérieur d'un Extrait de code SNIPPET est protégée par une limite de temps de 500 ms. Si une boucle dépasse cette limite, l'action SNIPPET emprunte la branche d'erreur avec l'erreur Too much time has elapsed. Cela empêche l'utilisation excessive des ressources système par des boucles incontrôlées. La limite de temps de 500 ms s'applique uniquement au travail côté script, y compris les affectations, les calculs arithmétiques, les conditions, l'accès aux tableaux, etc. Elle ne s'applique pas à l'exécution de bout en bout du code de l'Extrait. Par exemple, le temps passé à attendre un système externe, comme un appel API REST ou un appel à une base de données, ne compte pas dans cette limite.

Types de scripts pris en charge

Générique	courriel	Clavardage	Téléphone	Messagerie vocale	Élément de travail	SMS	Digital

Propriétés de Saisie

Ces propriétés définissent les données que l’action utilise lors de son exécution.

Propriété	Description
Légende	Entrez une courte phrase qui identifie de façon unique cette action dans le script. La légende apparaît sur le canevas du script sous l’icône de l’action. La valeur par défaut est le nom de l’action.
Données	Contient le code personnalisé ajouté dans la fenêtre de l'Snippet editor. Cela peut inclure plusieurs commandes ASSIGN et DYNAMIC, diverses instructions de contrôle de flux, ainsi que des fonctions intégrées et définies par l'utilisateur.
MaxStringSize	Définit la taille de chaîne maximum pour toutes les commandes dans la propriété Data. Options : Limite 2K, Limite 4K, Limite 8K, Limite 16K, Limite 32K. Cette limite s'applique aux réponses d'intégration avec les API REST et SOAP.

Conditions de la branche de Résultat

Les conditions de branche de résultat vous permettent de créer des branches dans votre script afin de gérer différents résultats lors de l’exécution d’une action.

Condition	Description
Par défaut	Path taken unless the script meets a condition that requires it to take one of the other branches. It is also taken if the action's other branches are not defined.
OnError	Path taken when the action fails to execute properly. For example, when there is an unexpected problem such as poor connectivity, syntax errors, and so on. The _ERR variable, with a single underscore character, should be populated with a condensed explanation of the problem.

Faites preuve de prudence lors des appels API depuis Extrait DE CODE

Il n'est pas recommandé de créer des appels API dans un extrait. Cela peut entraîner de graves problèmes de performance qui touchent la gestion des contacts et qui ont une incidence négative sur votre locataire. Pour une expérience plus sécuritaire et plus fiable, utilisez l'une des méthodes privilégiées suivantes.

Il existe deux cas où l'utilisation de SNIPPET est la méthode que vous devez utiliser pour effectuer des appels : si vous vous connectez à un service Web SOAP ou si vos appels API comprennent du XML. Si vous devez utiliser SNIPPET pour les appels API :

• Limitez les délais d'attente dans vos appels API. Une recommandation générale est que les délais d'attente ne dépassent pas deux secondes. Les délais d'attente par défaut peuvent être plus longs, alors vérifiez toujours les délais d'attente pour vous assurer qu'ils ne dépassent pas ce maximum. Si vous constatez que des délais d'attente plus longs sont requis, ajustez votre service Web si possible pour améliorer ses temps de réponse.
• Soyez extrêmement prudent avec la logique de boucle. La combinaison des boucles et des délais d'attente longs amplifie l'incidence potentielle sur votre système.

• La taille maximum de la réponse dans NiCE CXone est de 32 Ko. Cette limite est strictement appliquée afin d’éviter l’instabilité et les pannes du cluster. Studio applique cette limite lors de l’enregistrement du script, mais Desktop Studio ne l’applique pas. Si possible, utilisez REST API action ou Integration Hub à la place de l’action SNIPPET pour effectuer des Appels api. Elles ont la même limite, mais peuvent gérer une charge plus importante. Si vous devez utiliser l’action SNIPPET, suivez ces conseils pour réduire la taille des données renvoyées :

  • Filtrez les données dans la réponse de l’API : Par exemple, si vous utilisez l’API Reporting NiCE pour obtenir des contacts, vous pouvez filtrer les résultats selon startDate et endDate du contact. Cet Appel api vous permet également de renvoyer et de limiter un nombre haut d’éléments. Reportez-vous à la documentation de l’API fournie avec votre intégration de script pour déterminer les Filtres que vous pouvez utiliser.

  • Mettez à jour la demande d’API pour renvoyer uniquement les données dont vous avez besoin : Par exemple, si vous utilisez l’API Reporting NiCE pour obtenir des contacts, vous pouvez utiliser les champs contactId ou agentId pour renvoyer uniquement les données pertinentes. Reportez-vous à la documentation de l’API fournie avec votre intégration de script pour déterminer les limites de données que vous pouvez utiliser.

  • Créez un intergiciel : Si vous ne pouvez faire ni l’une ni l’autre des Options précédentes, créez un intergiciel qui effectue le filtres en fonction de critères personnalisés que vous définissez. Si vous procédez ainsi, assurez-vous que votre intergiciel n’ajoute pas de latence à l’Appel.

Trucs et astuces

• Utilisez la fonction asjson() dans un Snippet action et stockez le JSON résultant dans une Variable de type chaîne. Utilisez la Variable de type chaîne dans les propriétés d'autres actions Studio lorsque vous devez transmettre les données JSON. Cette approche évite la possibilité d'erreurs de validation lors de l'enregistrement du script.
• Si vous réglez un système IVR Réponse vocale interactive. Menu téléphonique automatisé que les contacts utilisent par la Voix ou par des touches pour obtenir des informations, acheminer un appel vocal entrant, ou les deux. compatible ASR Reconnaissance automatique de la Parole. Permet aux contacts de répondre aux invites en parlant, en appuyant sur des touches du téléphone, ou les deux., il existe un ensemble de paramètres que vous pouvez utiliser dans les extraits.
• Le langage Snippet fournit des commandes de Mots-clés qui vous permettent de déclarer des variables et des objets, de créer des boucles et des instructions itératives, et plus encore.
• Studio dispose de fonctions intégrées que vous pouvez utiliser dans vos scripts.
• Vous pouvez créer vos propres fonctions personnalisées à utiliser dans les extraits de code.
• Pour ajouter un commentaire à votre code, type deux barres obliques (//). Vous pouvez cliquer sur la bulle de dialogue pour insérer automatiquement les barres obliques au début de la rangée. Sélectionnez Multiple rangées pour les convertir toutes en commentaires. Cliquez de nouveau sur la bulle de dialogue pour supprimer les barres obliques. Vous pouvez aussi utiliser des raccourcis clavier pour basculer les commentaires entre activé et désactivé (CTRL + /).
• Cliquez sur le bogue sur le côté de la fenêtre de l'éditeur de Snippet pour Test et déboguer votre code.
• Utilisez la variable système test lors du débogage des extraits. Elle permet de définir la valeur des variables qui sont utilisées dans l'extrait et qui seraient renseignées par le script lorsqu'il s'exécute pour un contact La personne qui interagit avec un agent, un SRVI ou un robot dans votre centre d’appels..

Fenêtre de l'Éditeur d'Extrait

La fenêtre éditeur d'Extrait s'ouvre lorsque vous double-cliquez sur une action Extrait.

La fenêtre Snippet editor de l'action Snippet comporte deux onglets. Les deux onglets permettent de créer les mêmes types de code. Vous pouvez passer d’un onglet à l’autre et modifier votre code dans l’un ou l’autre. Les onglets sont les suivants : 

• L’onglet Vue textuelle. Il s’agit d’un champ de texte libre dans lequel vous pouvez saisir votre code manuellement.
• L’onglet Arborescence. Il s’agit d’une interface graphique que vous pouvez utiliser pour construire votre code. Cet onglet contient une liste de mots-clés que vous pouvez sélectionner pour ajouter des instructions à l’extrait de code.

Exemple de script

Dans cet exemple simple, le code de l'Extrait est utilisé pour vérifier si un client potentiel peut être créé à partir d'informations provenant d'un système tiers.

Téléchargez ce script.