Documentação HorusBI
Buscar K

Aparência

Abrir no Claude Abrir no ChatGPT

Variables ​

As variáveis do tenant guardam valores reutilizáveis e segredos. Ao contrário dos outros recursos, elas vivem num arquivo único e fixo, variables.yaml, e não têm id no header: o tenant já é a identidade.

Ligue o autocomplete no editor colando esta linha no topo do arquivo:

yaml
# yaml-language-server: $schema=https://docs.horusbi.com.br/schemas/v2/variables.schema.json

Modelo de configuração ​

yaml
# ── header ────────────────────────────────────────────────
kind: variables        # obrigatório, literal "variables"
lumo: v2               # obrigatório, literal "v2"
tenantId: integer      # obrigatório, >= 1
                       # sem id: o arquivo é único no tenant
---
# ── body ──────────────────────────────────────────────────
items:                 # obrigatório
  - key: STRING        # obrigatório. só MAIÚSCULAS, dígitos e _; não pode começar com dígito
    is_secret: boolean # obrigatório
    value: string      # o valor. some da leitura quando is_secret é true
    description: string | null

key é validado pelo padrão ^[A-Z_][A-Z0-9_]*$. Um nome em minúsculas, com hífen ou começando por dígito é rejeitado.

Configuração completa ​

yaml
# variables.yaml
# yaml-language-server: $schema=https://docs.horusbi.com.br/schemas/v2/variables.schema.json
kind: variables
lumo: v2
tenantId: 853
---
items:
  - key: JANELA_CARGA_DIAS
    value: "31"
    is_secret: false
    description: Dias recarregados pelas cargas Temporal.

  - key: EMAIL_ALERTAS
    value: dados@exemplo.com.br
    is_secret: false
    description: Destino das notificações de falha de carga.

  # Em variável secreta, o value não volta na leitura: depois de um
  # lumo pull ele aparece vazio ou com placeholder. Isso é esperado.
  - key: API_TOKEN_ERP
    value: "{{ token }}"
    is_secret: true
    description: Token da API do ERP.

Especificação: header ​

kind ​

Tipo: string · Obrigatório: sim · Valor: variables

lumo ​

Tipo: string · Obrigatório: sim · Valor: v2

tenantId ​

Tipo: integer (>= 1) · Obrigatório: sim

id ​

Proibido. O header de variables não aceita id. O arquivo é único no tenant, e o schema rejeita o campo.

Especificação: body ​

items ​

Tipo: array de objetos · Obrigatório: sim

As variáveis. Cada item exige key e is_secret.

Especificação: item ​

Cada item de items.

key ​

Tipo: string · Obrigatório: sim · Padrão: ^[A-Z_][A-Z0-9_]*$

Nome da variável. Aceita apenas letras maiúsculas, dígitos e sublinhado, e não pode começar com dígito.

yaml
key: JANELA_CARGA_DIAS   # válido

value ​

Tipo: string · Obrigatório: não

Valor da variável. Quando is_secret é true, o servidor não devolve o valor na leitura: depois de um lumo pull, o campo vem vazio ou com um placeholder. Preencha na criação ou para rotacionar o segredo.

is_secret ​

Tipo: boolean · Obrigatório: sim

true marca a variável como segredo. O valor deixa de ser devolvido em leituras.

description ​

Tipo: string ou null · Obrigatório: não

Para que serve a variável.