Desk

Um desk é uma área compartilhável do tenant. Publicar um recurso num desk é o que o torna visível para os membros daquele desk.

Existem dois tipos, e eles são recursos distintos, com comandos de publicação distintos:

Kind	O que recebe	Como publicar
dw-desk	Flows e tabelas do DW	lumo flow publish
bi-desk	Apps de BI	lumo app publish

lumo new dw-desk --name "Operação"
lumo new bi-desk --name "Comercial"

Um desk nasce vazio. Ele não lista os recursos que contém: quem carrega o vínculo é o deskId de cada recurso publicado.

Ligue o autocomplete no editor colando, no topo do arquivo, a linha do tipo correspondente:

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

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

Modelo de configuração

Os dois tipos têm o mesmo corpo. Só muda o kind do header.

# ── header ────────────────────────────────────────────────
id: integer            # obrigatório, >= 1
kind: dw-desk          # obrigatório: dw-desk ou bi-desk
lumo: v2               # obrigatório, literal "v2"
tenantId: integer      # obrigatório, >= 1
---
# ── body ──────────────────────────────────────────────────
nome: string           # obrigatório, mínimo 1 caractere
descricao: string | null
tags: [string]

Configuração completa

# dw-desks/operacao--1402.yaml
# yaml-language-server: $schema=https://docs.horusbi.com.br/schemas/v2/dw-desk.schema.json
id: 1402
kind: dw-desk
lumo: v2
tenantId: 853
---
nome: Operação
descricao: Flows e tabelas do DW da operação diária.
tags: [producao]

Um bi-desk é idêntico, trocando o kind:

# bi-desks/comercial--2226.yaml
# yaml-language-server: $schema=https://docs.horusbi.com.br/schemas/v2/bi-desk.schema.json
id: 2226
kind: bi-desk
lumo: v2
tenantId: 853
---
nome: Comercial
descricao: Apps de vendas.

Especificação: header

id

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

kind

Tipo: string · Obrigatório: sim · Valores: dw-desk, bi-desk

Decide o que o desk pode receber e contra qual schema o lumo lint valida o arquivo. Um flow publicado com --desk apontando para um bi-desk é rejeitado.

lumo

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

tenantId

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

Especificação: body

nome

Tipo: string (mínimo 1 caractere) · Obrigatório: sim

Nome do desk.

descricao

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

O que o desk agrupa.

type

Tipo: string · Obrigatório: não · Valor: dw num dw-desk, bi num bi-desk

Discriminador do tipo de desk. É redundante com o kind do header, e o servidor o define.

tags

Tipo: array de string · Obrigatório: não · Default: []

Campos gerenciados pelo servidor

Campo	O que é
version	Versão do recurso.
criado_em, criado_por, publicado_em, publicado_por	Auditoria.