Instructions de déclaration

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 dynamique.
• FUNCTION : utilisez cette instruction pour créer une nouvelle fonction dans votre script.

Instructions ASSIGN

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

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

Action Studio : Assign

Détails : les instructions ASSIGN créent une <variable> et lui attribuent une <value>. Vous n'avez pas besoin de déclarer de type de données lorsque vous créez une variable, sauf s'il s'agit d'un type date/heure. Les variables dans Studio sont implicitement typées, ce qui signifie que vous pouvez créer et assigner une valeur en une seule étape. Par exemple :

ASSIGN oneName = "Odin"

Si la valeur que vous attribuez à une variable est numérique, il n'est pas nécessaire de la mettre entre guillemets. 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 n'est pas entre accolades et guillemets et s'il n'est pas numérique, le script considère qu'il s'agit d'une variable. Si elle existe déjà, le script attribue sa valeur à la deuxième 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 en utilisant ASSIGN. Après avoir déclaré l'objet à l'aide de DYNAMIC, utilisez ASSIGN pour attribuer 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>

Il n'est pas nécessaire d'utiliser le mot-clé ASSIGN lors de la déclaration d'une variableou d'un . Il peut toutefois s’avérer utile. L'inclusion d’ASSIGN permet de localiser facilement, à l'aide de la recherche avancée, l'endroit de 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 la 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 : vous trouverez plus d’informations sur les variables sur la page d'aide Variables.

Instructions DYNAMIC

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

Syntaxe : DYNAMIC <name>

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

Les valeurs contenues dans un objet de données dynamique sont appelées « Paramètres ». Elles sont définies comme des paires clé-valeur, où chaque paramètre a 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 attribuez à un objet est numérique, il n'est pas nécessaire de la mettre entre guillemets. Si la valeur est une chaîne, elle doit être placée entre guillemets.

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 : vous trouverez plus d’informations sur les objets de données dynamiques sur les pages d'aide Objets et Structures de données .

Instructions FUNCTION 

Description : crée une fonction personnalisée.

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

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

Détails : déclarez une fonction en lui donnant un <name> avec un ensemble de parenthèses ouvertes et fermées à 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> qui doit 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. La syntaxe à utiliser pour appeler la fonction dépend du fait que la fonction renvoie ou non une valeur.

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 voulez 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, à savoir l'appel d'une fonction membre de la fonction GetRESTproxy()

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)