Instructions de déclaration

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

Les instructions de déclaration vous permettent d'introduire de nouvelles variables, de nouveaux objets ou de nouvelles fonctions dans votre script. Les mots-clés de ces instructions sont les suivants :

  • ASSIGN: Utilisez cette instruction lorsque vous devez créer une Variable ou un tableau de chaînes.
  • DYNAMIC : Utilisez cette instruction lorsque vous devez créer un objet de données dynamiques.
  • FUNCTION : utilisez cette instruction pour créer une nouvelle fonction dans votre script.

L'analyse de chaque type d’instruction comprend un résumé de la syntaxe. Ces résumés utilisent certains conventions pour indiquer les parties de l'instruction et si chaque partie est obligatoire ou en option.

ASSIGN Déclarations

Description : les instructions ASSIGN créent une variable avec le nom et la valeur que vous précisez.

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

Studio Action : Assign

Détails : ASSIGN crée une instruction <variable> et lui attribue une <value>. Vous n'êtes pas obligé de déclarer un type de données lorsque vous créez une variable, sauf s'il s'agit d'une type date/heure. Les variables dans Studio sont typées de manière implicite, ce qui signifie que vous pouvez créer et affecter une valeur en une seule étape. Par exemple :

ASSIGN oneName = "Odin"

Si la valeur que vous affectez à une variable est numérique, vous n'avez pas besoin de l'entourer de guillemets doubles. Si la valeur est une chaîne, elle doit être placée entre guillemets.

Vous pouvez utiliser des instructions ASSIGN pour créer un tableau de chaînes :

ASSIGN manyNames = "Odin|Freya|Thor"

Vous pouvez assigner une variable comme valeur d'une autre variable :


ASSIGN x =  1
ASSIGN y = x 
ASSIGN var1 = z

La variable située à droite du signe égal n'a pas besoin d'être entourée d'accolades et de guillemets doubles si elle est déjà déclarée. Le script évalue le terme à droite du signe égal. S'il ne se trouve pas entre accolades et guillemets doubles et qu'il n'est pas numérique, le script suppose qu'il s'agit d'une Variable. S'il existe déjà, le script attribue sa valeur à la seconde variable. S'i elle n'est pas déclarée, le script la crée avec une valeur nulle.

Vous pouvez affecter une valeur à un membre d'objet dynamique à l'aide de ASSIGN. Après avoir déclaré l'objet avec DYNAMIC, utilisez ASSIGN pour affecter des valeurs aux membres de l'objet. Si le membre n'existe pas encore, il est créé lorsque vous lui attribuez une valeur. Utilisez la syntaxe suivante : ASSIGN <name>.<key> = <value>

L'utilisation du mot-clé ASSIGN lors de la déclaration d'une Variable ou d'un tableau de chaînes n'est pas obligatoire. Il peut toutefois s’avérer utile. L'ajout de ASSIGN permet de localiser facilement, à l'aide de la Recherche avancée, l'endroit dans votre script où vous avez introduit la variable ou le tableau. Sans ASSIGN, vous devez rechercher le nom de la variable ou du tableau. Les résultats de recherche contiendront toutes les références à la Variable ou au tableau dans votre script. Lorsque vous incluez ASSIGN dans votre mot-clé, la recherche ne renvoie que les résultats où la variable est explicitement attribuée. Pour déclarer une variable sans ASSIGN, utilisez la syntaxe suivante : <name> = "<value>".

Consignes d’appellation : respectez les règles suivantes pour nommer les variables :

  • Utilisez des caractères alphanumériques (a-z, A-Z, 0-9).

  • Le premier caractère du nom doit être une lettre.
  • Utilisez le caractère de soulignement ( _ ) et le signe dollar ( $ ) n'importe où dans le nom.
  • Si le dernier caractère d'un nom DE variable est un symbole dollar, la valeur est traitée comme du texte.
  • N'utilisez pas les noms des variables prédéfinies ou des mots réservés .

En savoir plus : Plus d'informations sur les variables sont disponibles sur la page d'aide variables.

DYNAMIC Déclarations

Description : les instructions DYNAMIC créent une variable d'objet données dynamiques avec le nom spécifié.

Syntaxe : DYNAMIC <name>

Détails : un objet de données dynamique est une variable qui peut contenir plusieurs valeurs. Elles sont similaires aux tableaux, mais présentent quelques différences clés.

Les valeurs contenues dans un objet de données dynamique sont appelées « paramètres ». Ils sont définis sous forme de paires clé-valeur, où chaque paramètre possède une clé (nom) et une valeur. Après avoir déclaré l'objet avec le mot-clé DYNAMIC, vous pouvez définir les membres de l'objet.

Par exemple :

DYNAMIC beowulfCharacteristics
beowulfCharacteristics.name = "Beowulf"
beowulfCharacteristics.occupation= "Hero" 
beowulfCharacteristics.foe = "Grendel" 

La casse est importante lorsque vous faites référence à des objets de données dynamiques et à leurs paramètres. BeowulfCharacteristics n'est pas identique à beowulfCharacteristics.

Si la valeur que vous affectez à un objet est numérique, vous n'avez pas besoin de l'entourer de guillemets doubles. Si la valeur est une chaîne, elle doit être placée entre guillemets.

Utilisez DYNAMIC pour déclarer tout objet transmis à votre script depuis d'autres scripts ou intégrations. Les Objets doivent être déclarés dans chaque script, sous peine de provoquer une erreur de validation de script lors de l'enregistrement.

Conventions de dénomination : pour nommer les objets de données dynamiques, respectez les conventions suivantes :

  • Utilisez des caractères alphanumériques (a-z, A-Z, 0-9).

  • Le premier caractère du nom doit être une lettre.
  • Utilisez le caractère de soulignement ( _ ) et le signe dollar ( $ ) n'importe où dans le nom.
  • N'utilisez pas les noms des variables prédéfinies ou des mots réservés .

En savoir plus : Plus d'informations sur les objets de données dynamiques sont disponibles sur les pages d'aide Objets et Structures de données.

DYNAMIC a une autre utilisation importante, qui consiste à créer des instructions de déclaration pour les objets qui sont transmis au script à partir d'autres sources. Si vous ne déclarez pas ces objets, cela provoque une erreur lorsque le script est sauvegardé. .

FUNCTION Déclarations

Description : crée une fonction personnalisée.

Syntaxe à déclarer : FUNCTION <name><([parameter], [...])> <{ ... [RETURN [data]]}>

Syntaxe pour l'appel : <functionName><([parameter], [parameter], [...])><{<varName>.<functionName><([parameter], [parameter], [...])>}>

Details : déclarez une fonction en lui attribuant un <name> suivi d'un ensemble de parenthèses ouvrante et fermante à la fin. Par exemple, FUNCTION functionName(). Ajoutez un [parameters] facultatif entre les parenthèses. Les Paramètres permettent de transmettre des données, appelées « arguments », à l'entrée et à la sortie de la fonction.

Entre les accolades { RETURN <data>} après l'en-tête de la déclaration, incluez le code que vous voulez que le script exécute lorsque la fonction est appelée. Terminez le code par le mot-clé RETURN suivi de la variable <data> que vous souhaitez utiliser pour contenir la sortie de la fonction. L'inclusion d'une variable après RETURN n'est nécessaire que si vous devez retransmettre des données au script appelant.

Les noms de fonctions doivent toujours comporter des parenthèses, même si la fonction n'a pas de paramètres. Par exemple :

FUNCTION noParams()

FUNCTION twoParams(name, accountNum)

Vous pouvez appeler une fonction dans votre script lorsque vous avez besoin d'utiliser le code qu'elle contient. Quelle syntaxe vous utilisez pour appeler la fonction dépend du fait que la fonction renvoie une valeur ou non.

Si la définition de la fonction comporte <parameters>, le script doit transmettre les informations appropriées à la fonction. Vous devez inclure les paramètres dans l'appel de fonction. Incluez tous les paramètres dans l'ordre dans lequel ils apparaissent dans la définition de la fonction. Par exemple, callVar.twoParams('Beowulf', 349839)

Si vous souhaitez que le résultat de la fonction soit affecté à une variable, vous pouvez appeler la fonction dans le cadre d'une instruction ASSIGN. Par exemple, ASSIGN var = otherVar.function(). Toutefois, il existe un cas où cela ne fonctionne pas : il s'agit d'appeler une fonction membre de la GetRESTproxy() fonction.

Ajoutez un commentaire après le nom de la fonction dans la définition de la fonction afin de fournir une aide intégrée pour la fonction. L'aide en ligne propose des suggestions dans des menus contextuels lorsque vous type dans la fenêtre éditeur d'Extrait.

Conventions de dénomination : pour nommer les fonctions, respectez les conventions suivantes :

  • Utilisez des caractères alphanumériques (a-z, A-Z, 0-9).

  • Le premier caractère du nom doit être une lettre.
  • Utilisez le caractère de soulignement ( _ ) et le signe dollar ( $ ) n'importe où dans le nom.
  • N'utilisez pas les mots réservés ou les noms des fonctions intégrées.

En savoir plus : vous trouverez Plus d'informations sur les fonctions sur la Page d'aide Fonctions.

Exemple

FUNCTION TimerRound(Timer)
{
  IF Timer = "-1"
  {
    ASSIGN Timer = Timer
  }
  ELSE
  {
    ASSIGN PeriodLocation = Timer.indexof('.')
	IF PeriodLocation = 0
	{
	  ASSIGN Timer = Timer
	}
	ELSE
	{
	    ASSIGN DataLength = Timer.length
	    IF DataLength - PeriodLocation <= 2
	        {
	          ASSIGN Timer = Timer
            }   
	    ELSE
	     {
            ASSIGN DigitCheck = Timer.substr(PeriodLocation + 3, PeriodLocation + 3)
            IF DigitCheck >=5 && DigitCheck <= 9
               {
                  ASSIGN Timer = Timer + .01
               }
            ELSE
              {
                 ASSIGN Timer = Timer
              }
		
            ASSIGN Timer = Timer.substr(1, PeriodLocation + 2)
         }
      }
   }
  
   TRACE "{Timer}"
   RETURN Timer
}

IF TEST = 1
   {
      ASSIGN DC1 = "1.931876668494874"
   }   

   ASSIGN DC1 = TimerRound(DC1)