Déclarations

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

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.

Les instructions dans les snippets consistent en une ou plusieurs lignes de code. Une simple instruction d'une ligne peut créer une variable et lui attribuer une valeur, comme ceci :

ASSIGN firstName = "Beowulf"

Une instruction complexe peut comporter plusieurs groupes de lignes imbriquées, comme suit :

ASSIGN Names="Odin|Freya|Thor|Loki" ASSIGN SubCounter=1 FOREACH Name IN Names { IF Name = "Odin" | Name = "Freya" { ASSIGN NewNames[SubCounter]= "{Name}" ASSIGN SubCounter=SubCounter + 1 } }

L'ordre logique d'exécution des instructions dans un snippet peut être modifié s'il y a une erreur dans le snippet. Lorsqu'une erreur se produit, l'action Snippet est immédiatement interrompue. Les autres instructions dans le snippet ne sont pas exécutées. Au lieu de cela, un message d'erreur est enregistré dans une variable _ERR afin d’indiquer la nature du problème.

Types d’instructions

Vous pouvez utiliser les types d’instructions suivants dans les snippets :

  • 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.

Mots-clés

Les mots-clés sont des commandes qui commencent les instructions. Il s'agit de termes prédéfinis et réservés. Le compilateur reconnaît le mot-clé et exécute la tâche qui lui est associée.

Chaque type d’instruction que vous pouvez utiliser dans un snippet est associé à un mot-clé. Par exemple, pour déclarer une variable, vous pouvez utiliser le mot-clé ASSIGN. Pour effectuer une sélection, vous pouvez également utiliser le mot-clé IF. L'instruction et le mot-clé portent le même nom, de sorte qu'une instruction IF utilise le mot-clé IF.

Les mots-clés disponibles dans le langage Snippet sont décrits avec l’instruction associée à chacun d'entre eux. Une liste complète des mots-clés est également disponible.

Syntaxe des instructions

Toutes les instructions commencent par un mot-clé et sont suivies de mots ou de codes qui définissent ce que fait l’instruction. Chaque instruction possède sa propre syntaxe. La section Résumé de la syntaxe de cette page explique comment lire les syntaxes des instructions.

Certaines instructions nécessitent un code conditionnel. Il s'agit de code qui fixe une condition et définit ce qui se passe si la condition est ou n'est pas remplie. Le code conditionnel peut être une ou plusieurs instructions. Il doit toujours être entouré d'accolades ( { } ), même s'il s'agit d'une seule ligne. Le code conditionnel est parfois appelé bloc.

Lorsque le compilateur rencontre une nouvelle ligne ou une accolade ouverte, il reconnaît la fin d'une instruction. Le placement des accolades est relativement flexible. Les formats suivants sont tous valides :


IF x=1 {TRACE "one" } 

IF x=1 {TRACE "one" } IF x=2 {TRACE "two" }
IF x=1 {
  TRACE "one"
}

IF x=1
{
  TRACE "one"
}

Lorsque le code intégré nécessite plusieurs instructions, suivez les règles suivantes :

  • Placez une instruction par ligne.
  • Si plusieurs instructions sont nécessaires, elles doivent être placées sur des lignes séparées. Cela facilite la lecture du code.
  • Les instructions intégrées qui nécessitent leur propre code intégré peuvent occuper plusieurs lignes, en respectant les formats valides pour l'utilisation d’accolades.

Résumé de la syntaxe

Dans les pages d'aide en ligne qui couvrent chaque type d'instruction, chaque type d'instruction est accompagné d'un résumé de la syntaxe. Ce résumé vous indique le format utilisé pour ce type d’instruction. Il explique quels sont les éléments requis et ceux qui sont facultatifs. Il montre également comment les éléments de syntaxe doivent être imbriqués.

Le tableau suivant définit chaque élément des résumés de la syntaxe. Toutes les instructions ne comprennent pas tous les éléments. Lorsque vous déchiffrez un résumé de syntaxe, prêtez attention à l'imbrication des éléments.

Élément

Détails

COMMAND

Le nom du mot-clé à utiliser avec l’instruction. Remplacez COMMAND par le mot-clé de l’instruction que vous créez.

Les mots-clés ne sont pas sensibles à la casse. Par exemple  : FOREACH est identique à foreach pour le compilateur. Toutefois, l'action Snippet convertit automatiquement tous les mots-clés en majuscules la prochaine fois que vous ouvrez le snippet.

Dans l'aide en ligne, les mots-clés sont toujours présentés en majuscules.

<required>

Les chevrons indiquent un élément obligatoire. Le texte entre les chevrons indique le type d'élément, tel qu'une expression, une variable ou une valeur littérale.

Par exemple, dans le résumé de la syntaxe d'une instruction FOREACH, deux éléments sont obligatoires :

FOREACH <var> in <array> { ... [ BREAK]}

Les chevrons et le texte qu'ils contiennent ne doivent jamais être utilisés littéralement dans votre script. Remplacer cette partie par l'élément de code qu'elle décrit. Par exemple, remplacez <expression> par une expression telle que i = 0.

[optional]

Les crochets indiquent un élément facultatif. Le texte entre crochets indique le type d'élément que vous pouvez utiliser. Par exemple, dans le résumé de la syntaxe de IF, la clause optionnelle ELSE est placée entre crochets  : [ELSE { ... }.

Si vous utilisez un élément facultatif, il doit apparaître à l'endroit indiqué dans le résumé de la syntaxe par rapport aux autres éléments.

Les crochets ne doivent jamais être utilisés littéralement dans votre script.

{ ... } Les accolades indiquent qu'un bloc de code peut être utilisé.

Les accolades sont différentes des crochets et des chevrons utilisés dans le résumé de la syntaxe. Les chevrons et les crochets ne sont pas censés être inclus dans votre code, mais les accolades doivent être incluses littéralement dans votre code. Par contre, vous devez remplacer les points de suspension ( ... ) à l'intérieur des accolades dans le résumé de la syntaxe par des instructions Snippet.

Trait vertical ( | )

Le trait vertical indique que vous avez le choix des éléments à inclure dans l’instruction. Par exemple, dans le résumé de la syntaxe de l'instruction ASSIGN, le trait vertical indique que vous avez le choix de placer la valeur entre guillemets :

ASSIGN <variable> = "<value>" | <value>

L'explication de la syntaxe explique le choix.

Points de suspension (...)

Les points de suspension ont deux significations possibles :

  • L'emplacement du code dans un bloc, s'il se trouve entre accolades.
  • Un motif continu, s'il est trouvé entre crochets avec un mot-clé.

Un exemple d'utilisation de points de suspension pour indiquer un motif continu se trouve dans le résumé de la syntaxe de SELECT :

SELECT <{ CASE <expression> [{ ... }] [CASE <expression> <{ ... }>] [CASE ...] [DEFAULT <{ ... }>] }>

Le[CASE ...] indique que vous pouvez continuer à ajouter autant de clauses CASE que nécessaire en suivant le motif établi.

Par exemple, le résumé de la syntaxe des instructions IF utilisées sur cette page est le suivant :

IF <expression> <{ ... }>

Le résumé montre que :

  • Le mot clé est IF.
  • L'élément suivant est une expression obligatoire.
  • Le dernier élément est un bloc de code obligatoire qui doit être placé entre accolades.

Le résumé de la syntaxe des instructions SWITCH est plus complexe :

SWITCH <var> <{CASE <literal> [{ ... }] [CASE <literal> [{ ... }]] [CASE ...] [DEFAULT [{ ... }]] }>

Le résumé montre que :

  • Le mot clé est SWITCH.
  • L'élément suivant est le nom d'une variable obligatoire.
  • Le bloc de code est obligatoire et doit contenir une clause CASE avec une valeur littérale.
  • La clause obligatoire CASE peut contenir un bloc de code facultatif.
  • Le bloc de code de l’instruction SWITCH peut inclure d'autres clauses facultatives CASE en suivant le motif établi dans le résumé.
  • Le bloc de code de l'instruction SWITCH peut contenir une clause facultative DEFAULT avec un bloc de code facultatif.