SNIPPET

Cette page d'aide s'applique à Studio. Ces informations sont aussi disponibles pour Desktop Studio.

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

Effectuer des appels REST API à partir d'une action SNIPPET est fortement déconseillé. Utilisez plutôt l'action REST API action ou Integration Hub. Si votre API est de type SOAP ou renvoie du xml, consultez les recommandations sur la façon de minimiser l'impact sur votre système lorsque vous effectuez des appels API à partir de SNIPPET.

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

Un carré d’où part une ligne qui va vers trois autres carrés.

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

Ajouter une 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.

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.

Taille maximale de la chaîne

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.

Error

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.

Astuces et conseils

Fenêtre de l’Éditeur Snippet

La fenêtre de l’éditeur Snippet s’ouvre lorsque vous sélectionnez une action Snippet et que vous cliquez sur Ouvrir l’Éditeur dans les propriétés de l’action. Vous pouvez également cliquer sur la fenêtre Icône d’un rectangle traversé par une ligne horizontale. au centre de l’action lorsqu’elle se trouve sur le plan de travail du script.

Exemple de script

Voici un exemple pour afficher comment cette action peut être utilisée dans des scripts. Il ne s’agit pas d’un texte complet. Des scripts supplémentaires peuvent être nécessaires.

Dans cet exemple simple, les actions Snippet contiennent des déclarations d’objets de données dynamiques et d’autres variables utilisées dans le script. Le Snippet portant la légende Parse the Transcript contient du code qui vérifie si la transcription est celle d’une messagerie vocale. S’il s’agit d’une messagerie vocale, le script copie le corps du message de la transcription dans une variable. La variable contenant le corps du message est transmise à l’action PLAY, qui lit le message à l’aide de la synthèse vocaleClosed Permet aux utilisateurs d’entrer des invites enregistrées sous forme de texte et d’utiliser une voix générée par ordinateur pour prononcer le contenu..

Image d’un script contenant plusieurs actions SNIPPET.

Télécharger ce script.