# Guia do Definition Builder

> Guia passo a passo para criar Definitions do DQS usando o assistente de 5 passos. Configure objetos, campos, limiares e pesos de dimensão.

Source: https://dataqualitysense.com/pt/resources/using-dqs/definition-builder/
Last updated: 2026-06-03

---

## O que é uma Definition?

Uma Definition é a sua verificação de qualidade de dados configurada no DQS. Ela especifica qual objeto do Salesforce analisar, quais campos incluir, quais capabilities medir e quais limiares aplicar.

Pense em uma Definition como uma receita. Você diz ao DQS quais ingredientes (campos) examinar e quais padrões (limiares) aplicar. O DQS segue a sua receita toda vez que você roda uma varredura.

## O assistente de 5 passos

O Definition Builder guia você por cinco passos:

1. **Selecionar Capabilities** - Escolha o que medir
2. **Definir o Escopo** - Escolha qual objeto e campos
3. **Adicionar Filtros** - Restrinja o conjunto de registros (opcional)
4. **Configurar** - Defina limiares e opções
5. **Revisar** - Valide e ative

Cada passo se apoia no anterior. Você pode salvar o progresso em qualquer passo e retornar depois.

## Passo 1: Selecionar Capabilities

Neste passo, você escolhe quais dimensões de qualidade de dados medir.

### Capabilities disponíveis

O assistente exibe dois painéis:

**Data Quality (higiene operacional)**
- Completeness - Os campos estão preenchidos?
- Validity - Os valores correspondem aos formatos esperados?
- Uniqueness - Os registros são distintos?
- Timeliness - Os dados estão atuais?
- Consistency - Os valores são uniformes?

**AI Readiness (preparação para o Agentforce)**
- PII Detection - Os dados sensíveis estão protegidos antes da exposição à IA?

### Selecionando capabilities

1. Clique em um card de capability para selecioná-lo
2. O card se destaca e aparece um checkmark
3. Selecione várias capabilities para uma análise abrangente
4. Clique novamente para desmarcar

> **Dica:** Comece com 2-3 capabilities na sua primeira Definition. Você pode adicionar mais depois.

### Melhor prática: comece com foco

Selecione capabilities com base no seu objetivo imediato:

| Objetivo | Capabilities recomendadas |
|------|--------------------------|
| Melhorar a qualidade de entrada de dados | Completeness, Validity |
| Encontrar duplicatas | Uniqueness |
| Limpar registros obsoletos | Timeliness |
| Preparar para IA/Agentforce | Toda a AI Readiness |
| Auditoria completa dos dados | Todas as capabilities |

Clique em **Continue** quando tiver selecionado suas capabilities.

## Passo 2: Definir o Escopo

Neste passo, você escolhe qual objeto e campos do Salesforce analisar.

### Selecionando um objeto

1. Use o dropdown de seleção de objeto
2. Pesquise pelo nome do objeto ou pelo API name
3. Clique para selecionar o objeto

O DQS suporta objetos padrão e customizados. O assistente exibe o label e o API name do objeto para ajudar você a selecionar o correto.

> **Dica:** Comece com um objeto de alto valor como Contact, Lead ou Account. Eles costumam ter o maior impacto na qualidade de dados.

### Selecionando campos

Depois de escolher um objeto, o assistente exibe os campos disponíveis.

1. Os campos são agrupados por tipo (texto, número, data etc.)
2. Clique na linha de um campo para selecioná-lo
3. Use a caixa de busca para encontrar campos específicos
4. Selecione vários campos para análise

O assistente mostra quais capabilities se aplicam a cada campo com base no tipo do campo:

| Capability | Tipos de campo compatíveis |
|------------|------------------------|
| Completeness | A maioria dos tipos (text, number, date, picklist etc.) |
| Validity | Text, email, phone, URL, picklist |
| Uniqueness | Todos os tipos |
| Timeliness | Apenas Date e DateTime |
| Consistency | Text, picklist, email |

### Configuração por campo

Você pode definir limiares diferentes para campos individuais. Isso é útil quando:

- Campos críticos precisam de limiares mais rígidos
- Alguns campos têm requisitos de formato exclusivos
- Diferentes campos têm diferentes expectativas de atualidade

Clique no ícone de engrenagem ao lado de um campo para acessar as configurações por campo.

Clique em **Continue** quando tiver selecionado seus campos.

## Passo 3: Adicionar Filtros (Opcional)

Filtros restringem quais registros o DQS analisa. Este passo é opcional, mas útil para grandes datasets ou casos de uso específicos.

### Quando usar filtros

| Cenário | Exemplo de filtro |
|----------|----------------|
| Analisar apenas accounts ativos | Status = 'Active' |
| Focar em registros recentes | CreatedDate = LAST_90_DAYS |
| Excluir dados de teste | Name does not contain 'Test' |
| Direcionar para regiões específicas | BillingCountry = 'United States' |

### Construindo um filtro

1. Clique em **Add Condition**
2. Selecione um campo no dropdown
3. Escolha um operador (equals, contains, greater than etc.)
4. Insira um valor
5. Repita para condições adicionais

### Lógica de filtro

Use lógica AND/OR para combinar condições:

- **AND** - Todas as condições devem ser verdadeiras
- **OR** - Qualquer condição pode ser verdadeira

Exemplo: `(Status = 'Active') AND (Industry = 'Technology' OR Industry = 'Finance')`

### Prévia da contagem de registros

O assistente mostra quantos registros correspondem ao seu filtro. Use isso para verificar se o filtro funciona como esperado.

- Uma contagem de 0 significa que nenhum registro corresponde (verifique seu filtro)
- Uma contagem muito alta pode precisar de mais filtragem em orgs grandes

> **Dica:** Pule os filtros na sua primeira Definition para ter um quadro completo. Adicione filtros depois para análises direcionadas.

Clique em **Continue** para prosseguir (ou pule este passo).

## Passo 4: Configurar

Neste passo, você define limiares e opções para cada capability selecionada.

### Configurações Global vs. Per-Field

As configurações se aplicam em dois níveis:

1. **Global** - Configurações padrão para todos os campos
2. **Per-Field** - Sobrescreve configurações para campos específicos

Configure primeiro as configurações globais e depois customize campos individuais, se necessário.

### Configuração de Completeness

| Opção | Descrição | Padrão |
|--------|-------------|---------|
| Treat blanks as incomplete | Conta valores só com espaços em branco como ausentes | Yes |
| Treat placeholders as incomplete | Conta N/A, TBD, Unknown como ausentes | Yes |
| Custom placeholder values | Adicione seus próprios padrões de placeholder | None |
| Threshold | Percentual mínimo aceitável de completude | 95% |

**Exemplo de configurações para Contact:**
- Threshold: 90% para campos opcionais
- Threshold: 99% para campos obrigatórios como Email
- Placeholders: N/A, TBD, Unknown, -, .

### Configuração de Validity

| Opção | Descrição | Padrão |
|--------|-------------|---------|
| Pattern type | Email, URL, Fixed Length, Custom Regex | Email |
| Custom regex | Seu próprio padrão de validação | None |
| Case sensitive | Diferencia maiúsculas e minúsculas | No |
| Include blank values | Conta valores em branco como inválidos | No |

**Padrões embutidos:**
- **Email** - Formato em conformidade com RFC 5322
- **URL** - Formato HTTP/HTTPS
- **Fixed Length** - Contagem exata de caracteres

### Configuração de Uniqueness

| Opção | Descrição | Padrão |
|--------|-------------|---------|
| Case sensitive | Trata "ABC" e "abc" como diferentes | No |
| Threshold | Percentual mínimo aceitável de unicidade | 95% |

### Configuração de Timeliness

| Opção | Descrição | Padrão |
|--------|-------------|---------|
| Freshness window (days) | Dias até os dados serem considerados obsoletos | 90 |
| Grace period (days) | Margem antes de sinalizar como obsoleto | 7 |
| Operational range | Limites de data mínima/máxima esperados | None |

**Exemplo de configurações por campo:**
- LastModifiedDate: janela de atualidade de 30 dias
- LastActivityDate: janela de 90 dias
- BirthDate: nenhuma verificação de atualidade necessária

### Configuração de Consistency

| Opção | Descrição | Padrão |
|--------|-------------|---------|
| Expected values | Lista de valores válidos | None |
| Import from picklist | Preenche automaticamente a partir da picklist do campo | No |
| Case sensitive | Diferencia maiúsculas e minúsculas | No |
| Top N dominant values | Mostra os valores mais frequentes | 5 |

### Configuração de PII Detection

| Opção | Descrição | Padrão |
|--------|-------------|---------|
| Pattern type | Quais padrões de PII varrer | All patterns |
| Custom patterns | Adicione seus próprios padrões regex para dados sensíveis específicos da org | None |

### Indicador de custo de processamento

Cada capability mostra um custo de processamento:

| Custo | Capabilities | Impacto |
|------|--------------|--------|
| LOW | Completeness, Validity | Rápido, recursos mínimos |
| MEDIUM | Timeliness, Consistency, PII Detection | Tempo de processamento moderado |
| HIGH | Uniqueness | Processamento mais longo, mais comparações |

Considere o custo ao selecionar capabilities para grandes datasets.

Clique em **Continue** quando a configuração estiver completa.

## Passo 5: Revisar

O passo final mostra um resumo da sua Definition.

### Checklist de revisão

Verifique o seguinte antes de ativar:

1. **Object** - Objeto correto selecionado
2. **Fields** - Todos os campos importantes incluídos
3. **Capabilities** - Verificações apropriadas selecionadas
4. **Filters** - A contagem de registros parece correta
5. **Thresholds** - As configurações atendem aos seus requisitos

### Resumo da Definition

O resumo exibe:

- Nome da Definition (editável)
- Objeto-alvo e contagem de registros
- Capabilities selecionadas com variantes
- Contagem de campos por capability
- Custo de processamento estimado

### Nomeando sua Definition

Use nomes descritivos que indiquem:
- O objeto sendo analisado
- O propósito ou escopo
- O responsável (opcional)

**Bons nomes:**
- "Contact Data Quality - Sales Team"
- "Lead AI Readiness Check"
- "Account Completeness - EMEA Region"

**Nomes ruins:**
- "Definition 1"
- "Test"
- "My Definition"

### Salvando e ativando

Você tem duas opções:

1. **Save as Draft** - Salva sem ativar (editável depois)
2. **Activate** - Salva e deixa pronta para varredura

Definitions em rascunho podem ser editadas. Definitions ativas ficam bloqueadas, mas prontas para rodar.

## Exemplo: criando uma Definition para Contact

Vamos percorrer a criação de uma Definition de Data Quality para Contact.

### Passo 1: Selecionar Capabilities

Selecione:
- Completeness (verificar dados ausentes)
- Validity (verificar formatos de e-mail e telefone)
- Timeliness (encontrar registros de contato obsoletos)

### Passo 2: Definir o Escopo

Objeto: Contact

Campos:
- Email (text, email)
- Phone (phone)
- MailingCity (text)
- MailingState (text)
- MailingCountry (text)
- Title (text)
- LastActivityDate (date)

### Passo 3: Adicionar Filtros

Condição: `AccountId != null` (apenas Contacts com Accounts)

Prévia da contagem de registros: 15.234 registros

### Passo 4: Configurar

**Completeness:**
- Threshold: 90%
- Treat blanks as incomplete: Yes
- Placeholders: N/A, Unknown, TBD

**Validity:**
- Campo Email: padrão Email
- Campo Phone: padrão Phone (se disponível)

**Timeliness:**
- LastActivityDate: janela de atualidade de 60 dias
- Grace period: 14 dias

### Passo 5: Revisar

Nome: "Contact Data Quality - Active Accounts"

Resumo:
- 7 campos
- 3 capabilities
- 15.234 registros
- Custo estimado: LOW

Clique em **Activate** para concluir.

## Gerenciando Definitions

### Visualizando todas as Definitions

Na tela inicial do DQS, você vê:
- Todas as suas Definitions
- O status (Draft, Active, Archived)
- A data da última varredura
- Ações rápidas

### Editando Definitions

- **Draft** - Totalmente editável
- **Active** - Crie uma nova versão para editar
- **Archived** - Somente visualização

### Arquivando Definitions

Arquive as Definitions que você não precisa mais:
1. Clique no menu dropdown
2. Selecione **Archive**
3. Confirme

Definitions arquivadas continuam visualizáveis, mas não podem rodar.

## Solução de problemas

### "No fields available"

**Causa:** As capabilities selecionadas não correspondem aos tipos de campo disponíveis.

**Solução:** Selecione capabilities diferentes ou escolha um objeto com tipos de campo compatíveis.

### "0 records match filter"

**Causa:** As condições do filtro são restritivas demais.

**Solução:** Ajuste os valores do filtro ou remova condições.

## Próximos passos

- [Executando varreduras](/pt/resources/using-dqs/running-scans/): execute sua Definition
- [Entendendo os resultados](/pt/resources/using-dqs/understanding-results/): interprete os resultados da varredura