SNIPPET

Cette page d'aide concerne Desktop Studio. Ces informations sont également disponibles pour Studio.

Icon of SNIPPET: code brackets

Permet d'ajouter du code personnalisé à votre script.

L'exécution d'appels REST API depuis une action SNIPPET est fortement déconseillée. Utilisez plutôt l'REST API action ou Integration Hub. Si votre API est de type SOAP ou renvoie du XML, consultez les recommandations pour savoir comment minimiser l'impact sur votre système lors de l'exécution d'Appels API depuis SNIPPET.

Dépendances

  • Le code utilisé dans cette action doit être écrit en Snippet, un langage de script interne développé pour NiCE CXone. LeStudio guide de référence technique Studio fournit des informations détaillées sur l'écriture de scripts dans les Extraits.
  • Les attributs des objets ne peuvent pas être nommés __type (avec deux traits de soulignement). Ce mot est réservé à l'utilisation lors de l'analyse syntaxique du JSON depuis objets dynamiques.
  • Vous pouvez effectuer des Appels API en utilisant 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 manière, veillez à bien comprendre les risques et les bonnes pratiques.
  • La taille maximum des tableaux dans Studio est de 63 millions d'éléments. Si cette taille de tableau est dépassée, l'erreur suivante apparaît 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 suit la branche Erreur de l'action SNIPPET. Si la branche Erreur n'est pas connectée, le script continue de s'exécuter, mais sans les informations du tableau. Vous pouvez configurer les scripts afin qu'ils vous informent lorsque la taille maximum du tableau a été dépassée en ajoutant une action EMAIL à la branche Erreur de l'action SNIPPET. Enfin, vous pouvez ajouter une logique dans la branche Erreur pour poursuivre le script. Notez qu'il continuera sans les informations du tableau.
  • La taille de réponse maximale dans NiCE CXone est de 32 Ko. Cette limite est strictement appliquée afin d'éviter l'instabilité du cluster et les interruptions de service. Studio applique cette limite lors de l'enregistrement du script, mais Desktop Studio ne le fait pas. Si possible, utilisez l'REST API action ou Integration Hub plutôt que l'action SNIPPET pour effectuer des Appels API. Elles ont la même limite, mais peuvent supporter 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 de création de rapports NiCE pour obtenir des contacts, vous pouvez filtrer les résultats par startDate et endDate du contact. Cet Appel API vous permet également de renvoyer et de limiter le nombre d'éléments les plus hauts. Reportez-vous à la documentation API fournie avec l'intégration de votre script pour déterminer les filtres que vous pouvez utiliser.

    • Mettre à jour la demande API pour renvoyer uniquement les données dont vous avez besoin : par exemple, si vous utilisez l'API Reporting NiCE pour récupérer des contacts, vous pouvez utiliser les champs contactId ou agentId pour renvoyer uniquement les données pertinentes. Reportez-vous à la documentation de l’API associée à votre intégration de script pour déterminer les limites de données que vous pouvez utiliser.

    • Créer un middleware : Si vous ne pouvez pas effectuer l'une des options précédentes, créez un middleware qui applique des filtres en fonction de critères personnalisés que vous définissez. Si vous faites cela, assurez-vous que votre middleware n'ajoute pas de latence à l'appel.

  • Chaque boucle FOR, FOREACH ou REPEAT au sein d'un SNIPPET est protégée par une limite de temps de 500 ms. Si une boucle dépasse cette limite, l'action SNIPPET suit la branche d'erreur avec l'erreur Too much time has elapsed. Cela évite l'utilisation excessive des ressources système en cas de boucles incontrôlées. La limite de temps de 500 ms s'applique uniquement au travail côté script, y compris les affectations, les opérations 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 tel qu'un appel API REST ou une base de données ne compte pas dans cette limite.

Types de scripts pris en charge

The icon for a Generic script type - a rectangle with < and > symbols inside it.

L'icône du type de script E-mail - un grand symbole @ dans un losange.

L'icône du type de script Chat - une bulle de chat avec des points de suspension à l'intérieur (...), en forme de losange.

L'icône du type de script Téléphone - un combiné téléphonique à l'ancienne avec des lignes courbes indiquant que le son en sort.

L'icône du type de script de messagerie vocale - un symbole qui ressemble à une cassette - deux cercles assis sur une ligne horizontale.

L'icône pour le type de script d'élément de travail - un morceau de papier avec un coin replié et une liste à puces dessus.

" L'icône du type de script SMS - un téléphone intelligent avec une bulle de discussion qui en sort."

L'icône pour le type de script Digital - un moniteur d'ordinateur avec un smartphone à côté.

Générique

Email Conversation 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 cette action dans le script de manière unique. La légende est affichée sur le canevas de 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 Snippet editor. Cela peut inclure plusieurs ASSIGN et DYNAMICcommandes, 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 sont : Limit2K, Limit4K, Limit8K, Limit16K, Limit32K. Cette limite s'applique aux réponses d'intégration avec Rest API et SOAP.

Conditions de la branche 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.

Utilisez la prudence lors de l'exécution d'Appels API à partir d'Extrait

Il n'est pas recommandé de créer des Appels API au sein d'un extrait. Cela peut entraîner de graves problèmes de performances ayant un impact sur la gestion des contacts et un impact négatif sur votre locataire. Pour une expérience plus sûre et plus fiable, utilisez l'une des méthodes privilégiées suivantes.

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

  • Limitez les délais d'attente dans vos Appels API. La 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 ; vérifiez donc 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 nécessaires, ajustez votre service Web si possible afin d'améliorer ses temps de réponse.
  • Soyez extrêmement vigilant avec la logique des boucles. La combinaison de boucles et de délais d'expiration longs accroît l'impact potentiel sur votre système.
  • La taille de réponse maximale dans NiCE CXone est de 32 Ko. Cette limite est strictement appliquée afin d'éviter l'instabilité du cluster et les interruptions de service. Studio applique cette limite lors de l'enregistrement du script, mais Desktop Studio ne le fait pas. Si possible, utilisez l'REST API action ou Integration Hub plutôt que l'action SNIPPET pour effectuer des Appels API. Elles ont la même limite, mais peuvent supporter 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 de création de rapports NiCE pour obtenir des contacts, vous pouvez filtrer les résultats par startDate et endDate du contact. Cet Appel API vous permet également de renvoyer et de limiter le nombre d'éléments les plus hauts. Reportez-vous à la documentation API fournie avec l'intégration de votre script pour déterminer les filtres que vous pouvez utiliser.

    • Mettre à jour la demande API pour renvoyer uniquement les données dont vous avez besoin : par exemple, si vous utilisez l'API Reporting NiCE pour récupérer des contacts, vous pouvez utiliser les champs contactId ou agentId pour renvoyer uniquement les données pertinentes. Reportez-vous à la documentation de l’API associée à votre intégration de script pour déterminer les limites de données que vous pouvez utiliser.

    • Créer un middleware : Si vous ne pouvez pas effectuer l'une des options précédentes, créez un middleware qui applique des filtres en fonction de critères personnalisés que vous définissez. Si vous faites cela, assurez-vous que votre middleware n'ajoute pas de latence à l'appel.

Astuces et conseils

Snippet Editor Fenêtre

La fenêtre Snippet editor s'ouvre lorsque vous double-cliquez sur une action Snippet.

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. Ces onglets sont les suivants :

  • L'onglet vue texte. Il s'agit d'un champ de texte libre où vous pouvez saisir votre code manuellement.
  • Le onglet vue arborescente. Il s'agit d'une interface graphique que vous pouvez utiliser pour construire votre code. Cet onglet contient une liste à partir de laquelle vous pouvez sélectionner des mots-clés pour ajouter des énoncés à l'extrait.

Exemple de script

Cet exemple montre comment cette action peut être utilisée dans les scripts. Il ne s'agit pas d'un script complet. Des scripts supplémentaires peuvent être nécessaires.

Dans cet exemple simple, le code dans leFragment est utilisé pour tester si un prospect peut être créé à l'aide d'informations provenant d'un système tiers.

A script with two SNIPPET actions.

Téléchargez ce script.