Pacote de documentação - modelo de exemplo

Dica:

Download the sample template file to use it as a starting point for your documentation package: Documentation Framework Sample.docx.

Use this structure as your mandatory attachment when submitting a Process Mining App Template. Paste into a Word / PDF file, fill in the grey placeholders, and attach the finished document to your listing.

1 | Identificação do modelo (obrigatório)

Item	Valor
Nome do modelo de aplicativo	Gerenciamento de incidentes do Salesforce
Versão	v1.0 (julho de 2025)
Sistema(s) de origem	Salesforce Service Cloud
Ferramenta de extração	CData Sync
Banco de dados de destino	Snowflake / SQL Server

2 | Estrutura de dados — Objetos obrigatórios (obrigatório)

Purpose: show reviewers you will deliver the minimum raw tables the template expects. Do not list every field here;

Camada	Tabelas /Arquivos obrigatórios	Observações
Transacional	Histórico de casos, Caso	Tabelas de objeto principal
Dados Mestres	Conta, Contato, TipoDeRegistro, Usuário, FunçãoDeUsuário, Perfil	Necessário para junções e pesquisas de dimensão
Marco	Marco, tipo de marco	Habilita a análise de data de vencimento e SLA

Convenção de nomeação de arquivo (exemplo):

bash

Case_raw.csv

CaseHistory_raw.csv

...

Observação: todos os arquivos entregues como UTF-8 CSV com delimitador de vírgula.

3 | Instruções de configuração (recomendado)

3.1 Conexão de origem - Salesforce

1. Connector: CData Sync
2. Auth Scheme: Basic
3. Credenciais necessárias:
   • User – Salesforce API user
   • Password – user password
   • Security Token – Salesforce token
   • Login URL – e.g. https://login.salesforce.com

3.2 Trabalho do CData Sync

Etapa	Configuração	Valor
1	Esquema de destino	<target_schema>
2	....	N/A

3.3. Banco de dados de destino

• Snowflake *or
• SQL Server – choose one.
• Conceda ao usuário de destino do CData CREATE TABLE, INSERT, UPDATE, DELETE no esquema de destino.

3.4 Transformações (dbt)

• Todas as tabelas *_raw são transformadas por meio de modelos dbt para o formato final de entrada do Process Mining.

Observação: indique aos usuários se há algum modelo específico em que eles precisam prestar atenção (por exemplo valores codificados etc)

4 | Pré-requisitos do sistema (recomendado)

Component	Requisito Mínimo
Perfil do Salesforce	Acesso somente leitura a objetos na Seção 2
Versão do CData Sync	xx.XX ou posterior (as versões anteriores exigem edições de consulta por nota do provedor)

5 | Guia do usuário (recomendado)

(Forneça a documentação que abrange diretrizes de navegação específicas caso haja métricas ou campos que precisem ser configurados antes da publicação)

6 | Solução de problemas e suporte (recomendado)

Cenário	Causa raiz	Resolution
Falha de autenticação	Token ou restrição de IP inválido	Redefinir token de segurança do Salesforce e IP CData da lista de permissões
Tabelas ausentes	O perfil não tem acesso a objetos	Conceder permissão de leitura no nível do objeto
.....	N/A	N/A

Support contact: [e-mail] – response within 4 business hours.