Instruções de declaração

As informações desta página de ajuda se aplicam tanto a Studio quanto a Desktop Studio.

Instruções de declaração permitem que você introduza novas variáveis, objetos ou funções em seu script. As palavras-chave para essas instruções são:

  • ASSIGN: Use esta instrução quando precisar criar uma variável ou uma matriz de strings.
  • DYNAMIC: Use this statement when you need to create a dynamic data object.
  • FUNCTION: Use esta instrução para criar uma nova função em seu script.

A discussão de cada tipo de instrução inclui um resumo de sintaxe. Esses resumos usam determinadas convenções para indicar as partes da instrução e se cada parte é obrigatória ou opcional.

ASSIGN instruções

Descrição: instruções ASSIGN criam uma variável com o nome e o valor que você especificar.

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

Studio Ação: Designar

Detalhes: ASSIGN instruções criam um <variable> e atribuem um <value> a ele. Não é necessário declarar um tipo de dados ao criar uma variável, exceto se for um tipo de dados/hora. Variáveis em Studio são tipadas implicitamente, o que significa que você pode criar e atribuir um valor em uma etapa. Por exemplo:

ASSIGN oneName = "Odin"

Se o valor que você está atribuindo a uma variável for numérico, não é necessário colocá-lo entre aspas duplas. Se o valor for uma string, será preciso colocá-lo entre aspas duplas.

Você pode usar instruções ASSIGN para criar uma matriz de string:

ASSIGN manyNames = "Odin|Freya|Thor"

É possível atribuir uma variável como o valor para outra variável:


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

A variável no lado direito do sinal de igual não precisa ser colocada entre chaves e aspas duplas se a variável já tiver sido declarada. O script avalia o termo no lado direito do sinal de igual. Se não estiver entre chaves e aspas duplas e não for numérico, o script assume que é uma variável. Se a variável já existir, o script atribui o seu valor à segunda variável. Se ela ainda não tiver sido declarada, o script a cria com um valor nulo.

Você pode atribuir um valor a um membro de objeto dinâmico usando ASSIGN. Depois de declarar o objeto com DYNAMIC, use ASSIGN para atribuir valores aos membros do objeto. Se o membro ainda não existir, ele será criado quando você atribuir um valor a ele. Use esta sintaxe: ASSIGN <name>.<key> = <value>

Não é necessário usar a palavra-chave ASSIGN ao declarar uma variável ou matriz de strings. No entanto, usá-la pode ser útil. Incluir ASSIGN facilita localizar, usando a Busca Avançada, o local no script em que você introduziu a variável ou matriz. Sem ASSIGN, você deve pesquisar o nome da variável ou matriz. Os resultados da pesquisa conterão todas as referências à variável ou matriz em seu script. Quando você inclui ASSIGN no termo de pesquisa, a pesquisa retorna somente os resultados em que a variável é explicitamente atribuída. Para declarar uma variável sem ASSIGN, use esta sintaxe: <name> = "<value>"

Diretrizes de nomenclatura: Siga estas diretrizes ao nomear variáveis:

  • Use caracteres alfanuméricos (a-z, A-Z, 0-9).

  • O primeiro nome do caractere deve ser uma letra.
  • Use o caractere de sublinhado ( _ ) e o sinal de dólar ( $ ) em qualquer lugar do name.
  • Se o último caractere no nome da variável for um sinal de dólar, o valor é tratado como texto.
  • Não use os nomes de variáveis pré-definidas ou palavras reservadas.

Saiba mais: mais informações sobre variáveis estão disponíveis na página de ajuda Variáveis.

DYNAMIC instruções

Descrição: As instruções DYNAMIC criam uma variável de objeto de dados dinâmicos com o nome especificado.

Sintaxe: DYNAMIC <name>

Detalhes: Um objeto de dados dinâmicos é uma variável que pode conter múltiplos valores. Eles são similares a matrizes, mas têm algumas diferenças importantes.

Os valores mantidos pelos objetos de dados dinâmicos são chamados de parâmetros. Eles são definidos como pares de chave-valor, em que cada parâmetro tem uma chave (nome) e um valor. Depois de declarar o objeto com a palavra-chave DYNAMIC, você pode definir membros do objeto.

Por exemplo:

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

Letras maiúsculas e minúsculas são importantes ao fazer referência a objetos de dados dinâmicos e seus parâmetros. BeowulfCharacteristics não é o mesmo que beowulfCharacteristics.

Se o valor que você está atribuindo a um objeto for numérico, não é necessário colocá-lo entre aspas duplas. Se o valor for uma string, será preciso colocá-lo entre aspas duplas.

Use DYNAMIC para declarar quaisquer objetos que sejam passados para o script a partir de outros scripts ou integrações. Os Objetos devem ser declarados em todos os scripts, caso contrário, isso causa um erro de validação de script quando você salva.

Diretrizes de nomeação: ao nomear objetos de dados dinâmicos, siga estas orientações:

  • Use caracteres alfanuméricos (a-z, A-Z, 0-9).

  • O primeiro nome do caractere deve ser uma letra.
  • Use o caractere de sublinhado ( _ ) e o sinal de dólar ( $ ) em qualquer lugar do name.
  • Não use os nomes de variáveis pré-definidas ou palavras reservadas.

Saiba mais: mais informações sobre objetos de dados dinâmicos estão disponíveis nas páginas de ajuda Objetos e Estruturas de dados.

DYNAMIC tem outro uso importante, que é criar declarações para objetos que são passados para o script a partir de outras fontes. Se você não declarar esses objetos, isso causa um erro quando o script é salvo. .

FUNCTION instruções

Descrição: Cria uma função personalizada.

Sintaxe para declarar: FUNCTION <name><([parameter], [...])> <{ ... [RETURN [data]]}>

Sintaxe para chamar: <functionName><([parameter], [parameter], [...])><{<varName>.<functionName><([parameter], [parameter], [...])>}>

Detalhes: Declare uma função atribuindo a ela um <name> com um conjunto de parênteses abertos e fechados no final. Por exemplo, FUNCTION functionName(). Adicione [parameters] opcionais entre os parênteses. Parâmetros permitem que você passe dados, chamados de argumentos, para dentro e fora da função.

Entre as chaves { RETURN <data>} após o cabeçalho da declaração, inclua o código que quer que o script execute quando a função é chamada. Termine o código com a palavra-chave RETURN seguida da variável <data> que você deseja que contenha a saída da função. Incluir uma variável após RETURN é necessário somente se você precisar retornar dados ao script de chamada.

Nomes de funções devem sempre incluir os parênteses, mesmo se a função não tiver parâmetros. Por exemplo:

FUNCTION noParams()

FUNCTION twoParams(name, accountNum)

Você pode chamar uma função no seu script onde precisa usar o código que ela contém. A sintaxe que você usa para chamar a função depende se a função retorna ou não um valor.

Se a definição da função tem <parameters>, o script deve passar as informações adequadas à função. Você deve incluir os parâmetros na chamada da função. Inclua todos os parâmetros na mesma ordem em que aparecem na definição da função. Por exemplo, callVar.twoParams('Beowulf', 349839)

Se desejar que o resultado da função seja atribuído a uma variável, você pode chamar a função como parte de uma instrução ASSIGN. Por exemplo, ASSIGN var = otherVar.function(). No entanto, há um caso em que isso não funciona, que é chamar uma função de membro da GetRESTproxy() função.

Adicione um comentário após o nome da função na definição da função para fornecer ajuda em linha à função. A ajuda em linha oferece sugestões em menus pop-up à medida que você digita na janela do Snippet editor.

Diretrizes de nomenclatura: Ao nomear funções, siga estas diretrizes:

  • Use caracteres alfanuméricos (a-z, A-Z, 0-9).

  • O primeiro nome do caractere deve ser uma letra.
  • Use o caractere de sublinhado ( _ ) e o sinal de dólar ( $ ) em qualquer lugar do name.
  • Não use palavras reservadas ou os nomes de funções internas.

Saiba mais: mais informações sobre funções estão disponíveis na página de ajuda Functions.

Exemplo

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)