Skip to content

Documentação Metabase

No presente documento você encontra um guia rápido de boas práticas e acesso aos paineis do metabase.

Criando o local - Contexto

Na pasta "Desenvolvimento" crie uma coleção com o contexto no qual será utilizado o painel e suas perguntas. Após isso, lembre-se de criar uma descrição para sua coleção que explique claramente o propósito daquele conjunto de perguntas e painéis e o contexto no qual estes estão inseridos.

No restante do presente documento, essa coleção será chamada de contexto.

Criando um painel

Crie o painel dentro do seu contexto.

Nomenclatura

Para nomear seu painel, diga exatamente o que o painel está avaliando e o que ele representa.

Isso será feito no seguinte padrão: - O que o painel mostra - A quem o painel está direcionado

Por exemplo: Se estou criando o painel com a visualização do super ranking para assessores, "Super Ranking - Assessor"

Veja o guia completo de nomenclatura aqui

Descrição

Na descrição de seu painel (que o metabase julga opcional mas para o presente fluxo, é obrigatório) diga claramente o que aquela pergunta faz, de onde os dados vêem e qual a necessidade daquela pergunta para o contexto no qual está inserida.

Criando perguntas

No metabase, as perguntas são consultas SQL realizadas por meio da interface gráfica.

Por meio das perguntas, é possível criar visualizações de dados específicos que permitem entendimento mais assertivo das informações.

Antes de criar uma pergunta, saiba o local para onde sua pergunta irá, explique claramente qual o contexto do painel que está montando e mantenha a organização de seu desenvolvimento.

Se ocorrer a necessidade da mesma pergunta em contextos diferentes, crie duas perguntas, ainda que elas tenham o mesmo nome.

Quando sua pergunta na verdade for uma base de dados

No caso da mesa digital, por exemplo, foi necessário criar uma partição de dados específica para montar os painéis. Quando isso acontecer, crie uma coleção dentro do seu contexto chamada 'dados' e todas as perguntas que forem relacionadas a extrair ou particionar dados para seu contexto, deverão ser colocadas aqui.

Essa coleção NÃO será excluída ao mover seu contexto para produção

Nomeando sua pergunta

No nome, descreva claramente o que aquela pergunta está mostrando.

Isso será feito seguindo o padrão: - Agrupamento do dado - quando houver (Soma de) - Dado que está sendo utilizado (Captação) - Condição para mostrar aquele dado (Faixa de NET)

Por exemplo: Se sua pergunta trata da Captação referente a clientes dentro de uma faixa de NET específica, então seu nome será: 'Soma de Captação, clientes < 200k'.

Veja o guia completo de nomenclatura aqui

Descrição

Na descrição da sua pergunta (que o metabase julga opcional mas para o presente fluxo, é obrigatório, perguntas sem descrição serão apagadas em 30 dias) diga claramente o que aquela pergunta faz, de onde os dados vêem e qual a necessidade daquela pergunta para o contexto no qual está inserida.

Perguntas em desuso

Ao deixar de utilizar uma pergunta, crie uma coleção dentro do seu contexto, com o nome "Arquivo Temporário" isso servirá para manter um backup das perguntas no caso de elas voltarem a ser utilizadas.

As perguntas em "Arquivo Temporário" que não forem em 30 dias serão apagadas.

Quando seu contexto para produção, apague a pasta "Arquivo Temporário" deste para evitar poluição do metabase.

Movendo para stage

Quando seu contexto estiver em fase de teste e validação mova-o para a pasta "Staging"

Essa parte do fluxo existe para criar todos os testes e validações no seu painel e perguntas. Esteja sempre em contato com a pessoa que irá utilizar o seu painel isso será útil para garantir que seu trabalho será prontamente aprovado e poderá passar para produção sem maiores problemas.

Movendo para Produção

Quando seu contexto estiver validado, aprovado e pronto para publicação, mova-o para a pasta "Produção".

Nessa pasta contém todos os contextos que já estão publicados.

Fazendo alterações em contextos em produção

Atenção: Se for necessário realizar qualquer tipo de alteração em qualquer painel, pergunta ou contexto dentro da pasta produção esta deve ser finalizada no mesmo dia.

Se as alterações forem muitas, despublique seu contexto, retorne-o para stage e garanta que painéis futuros não tenham mais tamanhas mudanças.