Guide de référence technique

Les informations sur cette page d’aide concernent à la fois CXone Studio et Desktop Studio.

Cette section fournit des informations techniques détaillées sur les scripts dans Studio. Les informations s'appliquent généralement à l'écriture de scripts à l'aide d'actions et de snippets de code personnalisés. Dans certains cas, les informations ne s'appliquent qu'à l'une ou l'autre méthode de script.

Les informations présentées sur cette page résument les concepts fondamentaux de l'écriture de scripts que vous devez connaître lorsque vous en rédigez avec Studio. Des informations plus détaillées sont disponibles sur les autres pages de cette section.

Structure des scripts et des snippets

Les scripts Studio peuvent être contenus dans un seul fichier ou être constitués d'un script principal et d'un ou plusieurs sous-scripts dans des fichiers séparés. Chaque script doit :

  • Commencer par une action Begin. Les sous-scripts doivent également commencer par une action Begin.
  • Se terminer par une action terminale, comme End. Les sous-scripts se terminent par Return, une action qui ramène le flux du script au script principal.
  • Posséder un type de média défini.

À l'intérieur du script, la structure suit le flux requis par les comportements que le script doit fournir. Vous pouvez organiser et disposer le flux d'actions dans votre script de la manière qui vous convient le mieux. Par exemple, le flux peut aller de droite à gauche ou de gauche à droite. De même, il peut aller de haut en bas.

Quelques points à noter sur la structure des scripts :

  • Utilisez les conditions de branche pour créer des branches dans votre script. Cela vous permet de couvrir les nombreux résultats, variations ou situations possibles qui peuvent se produire à un moment donné du script. Vous pouvez utiliser des branches pour la gestion des erreurs, pour les options d'un menu IVRFermé Menu téléphonique automatisé qui permet aux appelants d'interagir via des commandes vocales, des entrées de touches, ou les deux, pour obtenir des informations, acheminer un appel vocal entrant, ou les deux. ou pour les chemins vrai/faux basés sur une action IF.
  • Certaines actions ont plusieurs conditions de branche disponibles. Il n'est pas nécessaire de les connecter toutes à chaque fois. Cependant, il est important de toujours connecter la branche Default. C’est la branche que suit le script si aucune des autres conditions ne s'applique. Elle peut empêcher les contacts de rester bloqués à cet emplacement du script si une situation inattendue se produit.
  • Les actions d'événement ne sont pas liées aux actions qui déclenchent l'événement. Elles commencent une nouvelle section dans le même fichier de script. Les nouvelles sections peuvent être placées n'importe où dans le fichier de script. Si votre script comporte plusieurs actions d’événement, il est judicieux de les organiser de manière à pouvoir les retrouver facilement par la suite.

Les snippets n'ont pas d'exigences en matière de structure, si ce n'est les limites de l'ordre logique des instructions. Ils peuvent contenir une seule instruction ASSIGN ou une logique de script complexe composée d'une série d'instructions et de blocs imbriqués. Si vous devez créer des fonctions personnalisées, vous devez utiliser des snippets.

Les snippets ne servent pas uniquement à contenir du code personnalisé. Vous pouvez les utiliser pour consolider les affectations de variables en un nombre réduit de lieux. Au lieu d'utiliser une action ASSIGN chaque fois que vous devez ajouter une variable, vous pouvez placer plusieurs instructions de déclaration dans une seule action Snippet.

Vous pouvez faire différentes choses pour rendre vos scripts plus lisibles. Cela peut aider d'autres scripteurs qui pourraient avoir besoin de travailler avec le script plus tard. Vous pouvez :

  • Modifier la propriété Caption de chaque action. Le contenu de cette propriété apparaît dans l'espace de travail du canevas de script. Vous pouvez ajouter un mot ou une courte phrase qui explique ce que fait chaque action. Par exemple, vous pouvez indiquer la compétence utilisée par l'action, le fichier musical qu'elle joue ou ce que fait le code Snippet. Dans CXone Studio, le nom de la propriété est Ajouter une légende.
  • Utilisez les actions Annotation et Note pour fournir une documentation supplémentaire dans votre script. Dans les actions Snippet, vous pouvez ajouter des commentaires.
  • Suivez les autres meilleures pratiques pour la rédaction de scripts dans Studio.

Syntaxe

Comme tous les langages de programmation, Snippet possède des règles syntaxiques qui doivent être respectées. Chaque page d'aide de la section de référence comporte une section sur la syntaxe qui couvre les règles relatives à cet élément du langage. Vous pouvez vous familiariser avec les règles de syntaxe pour :

Les règles de syntaxe sont décrites par des résumés de la syntaxe. Les résumés utilisent certaines conventions pour distinguer les éléments facultatifs des éléments obligatoires. Pour en savoir plus sur ces conventions, consultez la page d'aide Instructions.

Types de données

Les types de données décrivent la manière dont les données sont représentées et les types d'opérations qui peuvent être effectuées avec les données. De nombreux langages de programmation prennent en charge de nombreux types de données qui font la distinction entre différents types de représentations numériques et alphanumériques. Studio ne fait pas cette distinction. Dans Studio, les valeurs sont l'un des types suivants :

  • Chaîne : la valeur de la variable contient des caractères alphanumériques et spéciaux, comme des points, des virgules et des caractères de soulignement. Les valeurs chaîne doivent être placées entre guillemets doubles.
  • Numérique : la valeur de la variable est un nombre. Les valeurs numériques valeurs n'ont pas besoin de doubles guillemets.
  • Date/heure : la valeur de la variable est une date, une heure ou les deux. Lorsqu'une valeur de date/heure est utilisée avec des fonctions de date/heure dans Studio, la valeur doit être placée entre guillemets et précédée d'un dièse à l'extérieur des guillemets : var = #"11-23-2022.".
  • Booléen : ma valeur de la variable est soit true ou 1, soit false ou 0. Ne placez pas les valeurs booléennes entre guillemets.

Il n'est pas nécessaire de déclarer les types de données lors de la création de variables, comme c'est le cas dans certains langages de programmation. Dans Studio, les variables sont implicitement typées. Cela signifie que le type est déterminé automatiquement lors de la compilation du script.

Les types de données font partie intégrante des scripts. Pour en savoir plus sur les types de données dans les scripts Studio, consultez les pages d'aide concernant les structures de données, les expressions et les variables. Si vous travaillez avec des fonctions, vous devez connaître les types de données que vous utilisez dans le script. Vous devez également savoir ce qu’attend la fonction que vous utilisez et comment la sortie peut différer selon le type avec lequel vous l’utilisez.

Structures de données : variables, tableaux et objets

Les structures de données vous permettent de stocker des données à utiliser dans votre script. Vous pouvez récupérer les données de la structure de données lorsque vous en avez besoin ou les remplacer par d'autres données. Dans d'autres langages de programmation, il peut exister de nombreux types de structures de données et elles peuvent être très complexes. Dans Studio, il n'existe que trois types de structures de données :

Vous pouvez créer n'importe laquelle de ces structures de données en la déclarant à l'aide d'une instruction de déclaration.

Expressions

Une expression est tout ce qui, dans votre script, compare une valeur ou aboutit à une valeur. Les exemples suivants sont tous des exemples d'expressions :

  • x = 3(5+10)

  • y = 123 North Street
  • x != 5

Il existe différents types d'expressions, notamment les expressions de chaîne, numériques et booléennesFermé Un type de données qui a deux valeurs possibles : true et false.. Les expressions ont de nombreuses utilisations dans les scripts Studio. Elles servent à :

  • Configurer les propriétés des actions Studio ou dans les snippets.
  • Définir la logique dans un script qui crée des branches et qui simule la prise de décision.
  • Fournir des valeurs littérales pour les propriétés d'action ou dans les snippets.
  • Fournir des calculs mathématiques ou algébriques.

Les opérateurs

Les opérateurs sont des symboles mathématiques qui indiquent quelle opération mathématique ou algébrique doit être effectuée sur les nombres. Studio prend en charge tous les opérateurs mathématiques standard et certains opérateurs algébriques. Il prend également en charge les opérateurs booléensFermé Un type de données qui a deux valeurs possibles : true et false. , qui sont utilisés dans les expressions booléennes. Il s'agit d'expressions dont la valeur est soit vraie, soit fausse. Vous pouvez utiliser des expressions booléennes dans certaines instructions pour créer un mécanisme de prise de décision dans votre script.

Déclarations

Les instructions définissent les actions d'un script lors de son exécution. Il s'agit notamment de créer des variables, d'attribuer de nouvelles valeurs, d'effectuer des calculs et de faire des choix logiques en fonction d'une condition donnée. Certaines instructions n'effectuent qu'une tâche, telle que l'attribution d'une valeur à une variable. D'autres instructions influent sur le déroulement du script. Les instructions sont exécutées dans un ordre logique, mais cet ordre peut être modifié à chaque exécution du script.

Lorsque vous rédigez des scripts avec des actions, vous n'avez généralement pas besoin de penser en termes d'instructions. Dans les snippets, vous pouvez utiliser les types d’instructions suivants :

  • Déclaration : utilisez des instructions de déclaration pour déclarer, ou créer, de nouvelles variables, de nouveaux objets et de nouvelles fonctions.
  • Prise de décision : utilisez les instructions de prise de décision pour que le code snippet sélectionne une tâche à effectuer en fonction des conditions que vous spécifiez. Vous pouvez les utiliser pour contrôler le flux linéaire de ce qui se passe dans le script.
  • Boucle : les instructions en boucle vous permettent de configurer le Snippet pour qu’il réalise une tâche ou un ensemble de tâches de manière répétée jusqu'à ce que la condition de fin spécifiée soit remplie.
  • Autres : ces instructions permettent de terminer des fonctions, d'afficher les résultats dans la fenêtre Snippet editor pendant le débogage et d'inclure des DLL de proxy de service web dans vos snippets.

Certaines instructions sont accompagnées d'actions Studio qui font la même chose. Par exemple, les actions ASSIGN et IF font la même chose que les instructions ASSIGN et IF que vous pouvez utiliser dans les snippets. Pour de nombreuses instructions, la seule possibilité de les utiliser consiste à en faire des snippets.

Mots réservés

Studio comporte des mots réservés qui ne peuvent pas être utilisés comme noms de variables ou d'autres entités dans les scripts. Les mots réservés comprennent les noms de :

Si vous utilisez un mot réservé comme nom d'une entité dans votre script, une erreur se produira. Pour résoudre l'erreur, Vous devez renommer l'entité.

Commentaires

Les commentaires permettent de documenter un élément de votre script ou de votre snippet. Vous pouvez les utiliser pour laisser une note à vous-même ou à un futur scénariste, ou pour expliquer l'objectif d'un élément du script.

Dans les scripts Studio, vous pouvez ajouter des commentaires à l'aide de l'action Note ou de l'action Annotation. Les deux actions permettent d'ajouter un commentaire sur le canevas de script. L'action Annotation place le commentaire de manière visible sur le canevas. Pour lire le commentaire d’une action Note, vous devez double-cliquer sur l'action.

Dans les snippets, vous pouvez ajouter des commentaires en plaçant deux barres obliques (//). Les commentaires peuvent être placés sur leurs propres lignes ou à la fin d'une instruction.

Vous pouvez également utiliser des commentaires dans les snippets pour masquer les lignes de code que vous ne voulez pas voir figurer dans le script lors de son exécution. Ceci est utile pour le dépannage de problèmes.

Les fonctions

Les fonctions sont un moyen de créer du code que vous voulez réutiliser. Vous pouvez créer vos propres fonctions, puis les appeler ailleurs dans votre script lorsque vous voulez utiliser le code que la fonction contient. Studio possède également des fonctions intégrées que vous pouvez utiliser sans avoir à les déclarer dans votre script.

Gestion des chaînes

Dans les snippets, vous pouvez faire de nombreuses choses avec les chaînes en utilisant les fonctions intégrées :

  • Les concaténer
  • Les scinder en sous-chaînes
  • Y effectuer des recherches
  • Remplacer une partie de leur contenu
  • Les comparer
  • Les convertir de majuscules en minuscules et vice versa.

Dans certains cas, il peut être nécessaire de spécifier le formatage des chaînes comportant des dates, des heures ou des nombres. Vous pouvez utiliser les spécificateurs de format désignés pour définir le format que vous voulez que le script utilise. Vous pouvez également utiliser certaines des fonctions intégrées pour convertir les chaînes dans différents formats.

Certains caractères ne peuvent pas être inclus dans les chaînes sans utiliser une séquence d'échappement. Comme les chaînes doivent être placées entre guillemets simples ou doubles, si vous incluez un guillemet simple ou double littéral dans une chaîne, le script l'interprète comme le début ou la fin d'une chaîne. La séquence d'échappement indique au script que le caractère est destiné à être un littéral et non le symbole qu'il utilise par défaut. Les tabulations, les espaces arrière et les accolades ouvertes sont d'autres caractères qui nécessitent des séquences d'échappement.