Skip to main content

Using Variables in Squad Tasks

In Orkeia, you can use variables in fields like description, expectedResult of tasks to make them dynamic, reusable, and customizable at runtime.

Syntax

Variables follow the following format:
#{NOME_DA_VARIAVEL}

How It Works

Variables are automatically replaced at the time of Squad execution. Based on what is passed, whether in the description or expectedResult.

Example

{
  "description": "Revisar o contrato do cliente #{CLIENTE_NOME} com o número #{CONTRATO_ID}.",
  "expectedResult": "Contrato #{CONTRATO_ID} deve estar validado no sistema até #{DATA_LIMITE}."
}

Corresponding Payload

{
  "CLIENTE_NOME": "Matheus Matos",
  "CONTRATO_ID": "CT-2025-123",
  "DATA_LIMITE": "10/09/2025"
}

Rendered Result

  • Description: Revisar o contrato do cliente Matheus Matos com o número CT-2025-123.
  • Expected Result: Contrato CT-2025-123 deve estar validado no sistema até 10/09/2025.

Common Use Cases

VariableCommon Use
#{CLIENTE_NOME}Client’s name
#{CONTRATO_ID}Contract/document code
#{DATA_LIMITE}Due date or delivery date
#{USUARIO_RESPONSAVEL}Name of the responsible user
#{EMAIL}Notification email
#{ENDERECO}Relevant address or location

Notes

  • Variables must be in the exact format #{VARIAVEL}.
  • Variables missing from the payload will not be replaced and will appear in the final text as they are.
  • Use clear and standardized names to facilitate reuse.

Where Can I Use Variables?

Variables are used within Tasks and can appear in two specific fields:
  • task.description
  • task.expectedResult
Thus, at runtime, they are applied to the tasks of the Squads.