SNIPPET

This help page is for Desktop Studio. This information is also available for CXone Studio.

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

Dependencies

  • Le code utilisé dans cette action doit être écrit en Snippet, un langage de script interne développé par NICE CXone. Le guide de référence technique Studio fournit des informations détaillées sur la création de scripts dans des snippets.
  • Les attributs des objets ne peuvent pas être nommés __type (avec deux traits de soulignement). Ce mot est réservé pour être utilisé lors de l'analyse de JSON à partir d'objets dynamiques.
  • Vous pouvez effectuer des appels API à l'aide de l'action Snippet. La taille maximale de la réponse est de 32 Ko. Ceci est cohérent avec la limite de taille de la réponse dans l'action REST API.  La limite s’applique de manière stricte pour éviter toute instabilité et panne du cluster. Si vous le pouvez, utilisez plutôt l’action REST API. Elle présente la même limite, mais peut traiter une charge plus élevée. Si vous devez absolument 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 génération de rapports NICE pour obtenir des contacts, vous pouvez filtrer les résultats en fonction des champs startDate et endDate du contact. Cet appel d’API vous permet également de renvoyer un nombre maximal d’éléments. Reportez-vous à la documentation de l’API associée à votre intégration de script pour déterminer les filtres que vous pouvez utiliser.

    • Mettez à jour la requête d’API pour renvoyer uniquement les données dont vous avez besoin. Par exemple, si vous utilisez l’API de génération de rapports 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 associée à votre intégration de script pour déterminer les limites de données que vous pouvez utiliser.

    • Si vous ne pouvez exécuter aucune des options précédentes, créez un middleware.

Supported Script Types

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

The icon for the Email script type - a large @ symbol in a diamond.

The icon for the Chat script type - a chat bubble with an ellipsis inside (...), in a diamond shape.

The icon for the Phone script type - an old-style phone handset with curved lines indicating sound coming out of it.

The icon for the Voicemail script type - a symbol that looks like a cassette tape - two circles sitting on a horizontal line.

The icon for the Work Item script type-a piece of paper with one corner folded down and a bullet list on it.

The icon for the SMS script type - a smart phone with a chat bubble coming out of it.

The icon for the Digital script type - a computer monitor with a smartphone next to it.

Générique

E-mail Conversation Téléphone Messagerie vocale Élément de travail SMS Digital

Input Properties

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

Propriété

Description

Caption

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. The default is the action name.

Data

Contient le code personnalisé ajouté dans la fenêtre Snippet editor. Il peut s'agir de plusieurs commandes ASSIGN et DYNAMIC , de diverses instructions de contrôle de flux et de fonctions intégrées ou définies par l'utilisateur.

MaxStringSize

Définit la taille de chaîne maximale pour toutes les commandes dans la propriété Data. Les options sont Limit2K, Limit4K, Limit8K, Limit16K et Limit32K. Cette limite s'applique aux réponses d'intégration avec les API Rest et SOAP.

Result Branch Conditions

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

Default

Chemin parcouru sauf si le script remplit une condition qui l'oblige à emprunter l'une des autres branches. Il est également suivi si les autres branches de l’action ne sont pas définies.

OnError

Chemin emprunté lorsque l'action ne s'exécute pas correctement. Par exemple, en cas de problème inattendu, comme une mauvaise connectivité, des erreurs de syntaxe, etc. La variable _ERR, avec un caractère de soulignement simple, doit contenir une explication condensée du problème.

Tips & Tricks

Snippet Editor Window

The Snippet Editor window opens when you double-click on a Snippet action.

La fenêtre Snippet editor de l'action Snippet comporte deux onglets. Ces 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 entrer le 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 au snippet.

Script Example

Cet exemple montre comment cette action peut être utilisée dans les scripts. Il ne s'agit pas d'un script complet. Une rédaction de script supplémentaire peut être requise.

In this simple example, the code in the Snippet is used to test whether a prospect can be created using information from a third-party system.

A script with two SNIPPET actions.

Download this script.