BeryX · Documentação
A documentação técnica do BeryX, aberta a quem avalia e a quem integra.
Os documentos que mantemos junto ao código do produto, publicados sem reescrita: o que o BeryX faz, como se liga às suas fontes e ferramentas, e como calcula cada número.
Primeiros passos por perfil
O que cada pessoa da equipa pode fazer no BeryX, o primeiro dia e a rotina de cada semana.
Primeiros passos
Que perfil tens no BeryX, o tour de boas-vindas da app e onde encontrar ajuda dentro dela, com o guia de cada perfil.
Ler o documentoAdministrador do workspace
Ligar as fontes, convidar a equipa, aprovar as correções e configurar as integrações: o primeiro dia e a rotina de quem gere o workspace.
Ler o documentoMembro
Ligar fontes, correr scans, escrever regras e tratar os problemas: o que o papel de membro permite e por onde começar.
Ler o documentoLeitor
Acompanhar a qualidade dos dados sem alterar nada: painéis, relatórios, o assistente e quando pedir ajuda a um administrador.
Ler o documentoResponsável de domínio
O dono de um data product: SLA, consumidores registados, versões publicadas, montra pública e aprovações do domínio.
Ler o documentoAdministrador da organização
Início de sessão único, workspaces de equipa, restrições de acesso, políticas herdadas, quotas e auditoria da organização.
Ler o documentoFaturação
O contrato, as faturas e a repartição de custos por workspace, domínio e equipa, para quem acompanha os custos da organização.
Ler o documentoIntegrações
Tokens de API e o que se liga com eles: CI, agentes de código por MCP, Excel e Power BI, webhooks e orquestradores.
Ler o documento
Avaliar
Para RFP, due diligence e revisões de segurança.
Capacidades por critério de avaliação
Profiling, monitorização, matching, limpeza, metadados e orquestração, pelos critérios dos analistas — com o código e os testes por trás de cada capacidade e o que ainda falta quando é parcial.
Ler o documentoSegurança e conformidade
Acesso read-only, credenciais cifradas, anti-SSRF, RGPD self-service, anonimização antes do LLM, subprocessadores e o estado das certificações.
Ler o documentoMétodos — como calculamos cada número
Score de qualidade, anomalias, drift, duplicados, trust score e impacto financeiro: fórmulas, constantes, pressupostos e o que é exato, estimado ou amostrado.
Ler o documentoAcessibilidade — ACR WCAG 2.2
Relatório de conformidade de acessibilidade (ACR baseado no VPAT® 2.5) da app e do site: os 55 critérios WCAG 2.2 de nível A e AA, com a cláusula EN 301 549, o estado de cada um, a evidência e o que ainda falta.
Ler o documento
Ligar fontes e pipelines
Credenciais por fonte, webhooks de orquestradores e o gate de qualidade em CI.
Guia de conectores
Como obter credenciais e configurar cada fonte — BigQuery, Snowflake, Databricks, SQL Server, Salesforce, Kafka, SharePoint e outras — e o estado de validação de cada uma.
Ler o documentodbt Cloud e Airflow
Scans disparados pelo webhook do dbt Cloud e o pacote beryx-airflow (operator, sensor e callbacks) para esperar pelo veredito numa DAG.
Ler o documentoGate de qualidade em CI
Contratos ODCS exportados por dataset e validados no pipeline: schema divergente, score abaixo do mínimo ou issues críticos abertos chumbam o pipeline.
Ler o documento
Integrar no seu ecossistema
A política de estabilidade da API, agentes IA, lineage e catálogos de dados.
Versionamento e depreciação da API
O que é estável na API v1, o que conta como quebra, como e com quanto tempo avisamos antes de retirar algo (headers Deprecation e Sunset), as versões do SDK suportadas e como reportar um problema.
Ler o documentoWebhooks de saída
Os alertas, escalations e digests do BeryX no seu SIEM, PagerDuty ou automação: eventos, JSON Schema do corpo, assinatura HMAC-SHA256 com janela anti-replay de 5 minutos, retry e verificação em Python e Node.
Ler o documentoServidor MCP
A qualidade de dados ao alcance de agentes IA (Claude Desktop, Claude Code ou qualquer cliente MCP), read-only e com o RBAC do workspace.
Ler o documentoOpenLineage
Cada scan como run OpenLineage no Marquez, DataHub ou Astro, ligado às tabelas que leu — e o seu lineage dentro do BeryX.
Ler o documentoCatálogo externo
Veredito, score e resultado de cada regra publicados como testes de qualidade no OpenMetadata e como assertions no DataHub.
Ler o documento
Claude na sua conta cloud
Plano Enterprise: os dados e a fatura dos tokens ficam na conta da sua organização.
Guia da aplicação, página a página
Para que serve cada página da app e o que podes fazer lá — o mesmo guia que a Ajuda da app resume.
Monitorizar
Visão Geral
É a página de entrada do BeryX: mostra os primeiros passos até ativares o workspace e o dashboard da persona que escolhes no cabeçalho (Engenharia, Gestão ou Executivo). Usa-a para ver de relance o estado da qualidade dos teus dados.
Modo TV
Painel em ecrã inteiro para a TV da equipa, sem menu nem interação: mostra o score do workspace, as issues críticas, os scans e as últimas issues e sinais, e atualiza-se sozinho a cada 60 segundos. Precisa de uma sessão iniciada.
Datasets
O catálogo dos datasets descobertos nas tuas fontes de dados, com o score de qualidade de cada um. Usa-o para encontrar um dataset, comparar datasets e ver o catálogo em mapa, por domínios ou pela qualidade dos metadados.
Detalhe do dataset
A página de um dataset, com o score, o perfil das colunas, as sugestões e os issues abertos, organizada em separadores. Usa-a para perceber a qualidade de uma tabela, pedir um scan ou um relatório IA e exportar o contrato ou a remediação.
Domínio
O scorecard de um domínio (data product): score agregado, issues abertas, SLA, conformidade, consumidores, datasets e membros. Usa-o para saber se o data product cumpre o SLA e as políticas e o que falta corrigir.
Scan ao vivo
Mostra um scan a correr em tempo real: as fases, os datasets analisados, as colunas perfiladas e as regras a passar ou a falhar, dataset a dataset. Abre-a a partir de Conexões, do detalhe de um dataset ou dos dados de demonstração.
Problemas
Lista os problemas de qualidade dos teus datasets, com filtros por severidade, tipo, dimensão e estado. É aqui que fazes a triagem: atribuir um dono, perceber a causa e o impacto, e resolver, ignorar ou adiar cada problema.
Incidentes
Agrupa num só incidente os problemas abertos que surgem na mesma janela de 2 horas em datasets ligados por linhagem, e aponta o dataset de origem. Serve para atacar a causa na origem em vez de tratar cada sintoma a jusante.
Cumprimento de SLOs
Mostra se os dados chegam a tempo: compara, dia a dia, a latência prometida no contrato de cada dataset com a idade dos dados observada em cada perfil. Serve para acompanhar o cumprimento face ao objetivo e explicar as violações ao negócio.
Duplicados
Mostra os grupos de registos repetidos que os scans encontram em cada dataset, por correspondência exata ou aproximada, com uma amostra para confirmares. Serve para rever cada grupo e, no separador Entre datasets, emparelhar registos de dois sistemas.
Correspondências
Compara dois datasets e mostra que registos descrevem a mesma entidade, como clientes, contas ou fornecedores. Serve para medir quanto dois sistemas concordam; o BeryX lê as duas fontes, nunca escreve nelas, e não cria registos-mestre.
Mapa de PII
Mostra onde vivem os dados pessoais do workspace: em que datasets e colunas há PII, de que tipo, como foi detetada e se as colunas estão cobertas por regras ativas. Serve para rever a exposição com o DPO; mostra só metadados, nunca os valores.
Agir
Sugestões
Recomendações acionáveis geradas em cada scan, por heurísticas e, quando disponível, por IA. Usa esta página para rever, aprovar ou dispensar correções e acompanhar cada uma até um scan confirmar que o problema desapareceu.
Plano do dia do steward
O steward junta todos os dias o que pede decisão humana e propõe ações ordenadas por risco, impacto e idade. Usa esta página para aprovar ou rejeitar as ações do dia e definir a política do steward.
Regras
As regras de qualidade do workspace, que o scan avalia automaticamente e que abrem issues quando falham. Usa esta página para criar, editar, ativar ou apagar regras e para importar regras do dbt, Great Expectations, SodaCL ou ODCS.
Packs de regras
Galeria de regras curadas por indústria, cada uma com o porquê do limite. Usa-a para pré-visualizar um pack contra um dataset e propor as regras que fizerem sentido; só entram no motor depois de aceites nas Sugestões.
Atividades
Board das issues do workspace, em quatro colunas de estado. Usa-o para triar em equipa: mudar o estado de cada issue, atribuir um responsável, definir prazos e ver o histórico de mudanças.
Sinais
Queixas de dados encontradas nos tickets Jira, nas páginas Confluence e nos canais Slack/Teams escolhidos pela equipa, ligadas ao catálogo. Usa esta página para promover as relevantes a issues e dispensar o ruído.
Compreender
Relatórios IA
Relatórios escritos por IA para engenharia, gestão ou executivos, sobre um dataset ou todo o workspace; sem IA disponível, são gerados por um template offline. Usa esta página para pedir relatórios e abrir cada um para o ler, exportar ou partilhar.
Rotinas
Esta página mostra, passo a passo, como um relatório IA é feito: de onde vêm os dados, o que é verificado e quem escreve o texto. Usa-a para perceber um relatório concreto, ver onde falhou e ajustar os relatórios agendados.
Conhecimento
A memória da equipa sobre os dados do workspace: resumos de relatórios e diagnósticos, como os problemas foram resolvidos e as decisões registadas. Usa-a para pesquisar o que já se sabe, acrescentar notas e ver como fontes, datasets e qualidade se ligam.
Glossário
Os termos de negócio do workspace, como «Receita líquida», e as colunas que os implementam. Um termo aprovado, com a ligação à coluna aceite, entra no contrato ODCS dela como businessName e herda a qualidade das colunas ligadas.
Dados de referência
As listas de códigos do workspace, como países, moedas ou estados de encomenda, com versões que não mudam depois de criadas e mapeamentos dos códigos de outros sistemas. As regras «Lista de referência» validam colunas contra elas, e a coerência mostra onde os datasets divergem.
Assistente
Faz perguntas em linguagem corrente sobre os datasets, issues, custos e relatórios do workspace e recebe respostas a partir desses dados. Nada muda sem a tua aprovação: as regras e issues que o assistente propõe só são criados se aprovares.
Ligar o teu agente
Liga o teu agente de código ao BeryX para ele consultar a qualidade, o contrato e as colunas PII de cada tabela antes de lhe mexer. A página dá a configuração pronta a colar para cada ferramenta, só de leitura.
Conformidade
Reúne a evidência do art. 10.º do AI Act para os teus sistemas de IA: registas cada sistema, afetas os datasets de treino, validação e teste, e vês o que o BeryX mede e o que só tu podes declarar.
Governação
Mostra se o programa de governação está a funcionar: cobertura do catálogo, resolução de problemas, SLAs, adoção, qualidade por dimensão, incidentes e uso, cada KPI contra a sua meta. Usa-a para acompanhar o programa e prestar contas.
Ligar ao Excel / Power BI
Liga o Power Query, no Excel ou no Power BI, a tabelas estáveis de scores, problemas, SLO, custos e atividade do workspace, com um token só de leitura. Usa-a para fazeres as tuas análises sem pedir nada à equipa de dados.
Administrar
Conexões
Aqui ligas o BeryX às tuas fontes de dados, sempre só de leitura, e decides quando cada uma é analisada. Usa esta página para acrescentar uma fonte, testar a ligação, descobrir tabelas ou pedir um scan.
Equipa & Acessos
Aqui geres quem entra no workspace e o que cada pessoa pode ver: utilizadores, equipas, acessos por domínio, tokens de API, autenticação de dois fatores, IA e plano. Só os administradores fazem alterações nesta página, exceto no separador «Organização», que é de quem tem um papel na organização.
Notificações
Leva os alertas do BeryX para onde a equipa já trabalha: Slack, Microsoft Teams, email ou um webhook. Aqui também configuras as escalas de piquete, os tickets no Jira ou no Linear e o repositório git para as correções aprovadas.
Presença
Decide o que o BeryX publica nas ferramentas da equipa, para onde e com que conteúdo. Hoje só o Slack recebe publicações e tem bot; o Teams, o GitHub, o Confluence e o Jira aparecem com o que o BeryX já faz com eles. A página é só para admins do workspace.
Auditoria
Mostra quem mudou o quê no workspace: membros, plano, conexões, tokens, canais e acessos de suporte da BeryxTech, com os eventos sensíveis destacados. Só os administradores do workspace a veem.
Consola da BeryxTech
Só para a equipa da BeryxTech; as contas dos clientes não a veem. Reúne clientes, organizações, métricas da plataforma e acessos de suporte, só com metadados: os dados de um cliente só se leem com um acesso aprovado pelo admin dele.
Ajuda & integrações
Reúne o que o BeryX consegue ler, como calculamos cada número, como ligar agentes IA, Excel e Power BI, um guia curto de cada página e onde pedir ajuda à equipa de suporte da BeryxTech.
Conta e acesso
Entrar e ativar a conta
Aqui inicias sessão, crias uma conta gratuita ou recuperas o acesso. É também aqui que confirmas o email e defines a password a partir dos links que te enviamos, e que fazes a verificação em dois passos.
Segurança da conta
Protege a tua conta com autenticação de dois fatores: além da password, o início de sessão pede um código da tua app autenticadora. Aqui ativas, geres os códigos de recuperação e, se a política o permitir, desligas. Também vês e terminas as tuas sessões abertas.
Ligar a tua conta Slack
Liga a tua conta Slack à tua conta do BeryX para perguntares ao bot no Slack. A mesma página liga a tua conta Microsoft 365 ao agente do Microsoft 365 Copilot. Abre a partir do link que o bot ou o agente te envia e mostra também as contas que já ligaste.
Páginas públicas
Qualidade de dados verificada
Página pública, que abre sem sessão para quem tiver o link, com o resumo de qualidade de um dataset que o dono decidiu partilhar: score, veredito, dimensões, checks a falhar e contrato de dados. Nunca mostra amostras nem dados pessoais.
Montra do data product
Página pública, que abre sem sessão para quem tiver o link, com o que um consumidor precisa para decidir usar um data product: o SLA declarado e o cumprimento deste mês, a readiness por caso de uso e o veredito e o score de cada dataset. Nunca mostra amostras, colunas nem dados pessoais.
Proposta de contrato de dados
Página sem sessão, aberta pelo link que te enviaram, onde revês secção a secção a proposta de contrato de um dataset, como dono do sistema fonte. Com todas as secções aceites, aceitas o contrato e o BeryX passa a verificá-lo.
Subprocessadores
Página pública, sem sessão, com as empresas a quem a BeryxTech confia parte do tratamento de dados do BeryX: finalidade, dados, região, base legal e DPA de cada uma, e as alterações anunciadas com antecedência.
DORA e NIS2
Página pública, sem sessão, com respostas curtas para RFPs de entidades financeiras (DORA) e de entidades essenciais ou importantes (NIS2). Resume o que a BeryxTech dá aos clientes regulados; não é uma declaração de conformidade nem um contrato.