Banco de dados

MENU

Introdução

Bem-vindo à documentação de integração do App do Fornecedor via Banco de Dados. Através deste tipo de integração, você conseguirá manipular dados como cadastro de unidades, propriedades, fornecedores e relatórios diretamente em sua base de dados.

Infraestrutura

A aplicação utiliza dois bancos de dados MySQL: um banco principal usado pela aplicação e um banco exclusivo para integração.

Base de dados	Observações
`appfornecedor_xxx_base`	Banco de dados utilizado pela aplicação - gerenciado por nossa equipe.
`appfornecedor_xxx_integracao`	Banco de dados para integração - permissão para gerenciar tabelas, colunas e dados.

Para garantir a validação e a integridade dos dados, o banco de integração é sincronizado com o banco principal da aplicação. Os dados manipulados na base de integração são enviados para a base da aplicação por meio de uma rotina do servidor. Essa rotina pode ser acionada manualmente através do painel administrativo, permitindo uma atualização eficiente e segura dos dados.

Acesso

O acesso ao banco precisa ser liberado por nossa equipe técnica. Para isso, basta enviar um e-mail para [email protected] solicitando a liberação. Você receberá as credenciais de acesso e, a partir daí, poderá conectar através do seu SGBD preferido.

Modelo de dados

Nesta seção, detalharemos os diferentes objetos (tabelas) presentes no banco de dados, bem como os recursos disponíveis para inserir, atualizar e excluir informações.

Tabelas (SQL)

Abaixo segue o código SQL para criação das tabelas obrigatórias da base de integração, por padrão será entregue os dados de acesso já com essa tabelas criadas, porém abaixo poderá ser utilizado também como exemplo.

dump.sql

Tabela `unidades`

A tabela unidades armazena informações sobre as diferentes unidades da empresa, incluindo detalhes como título, responsável e telefone. Cada unidade é identificada por um código único.

Coluna	Tipo	Chave	Obrigatório	Descrição
`codigo`	varchar	UNIQUE	`sim`	Identificador único da unidade.
`titulo`	varchar		`sim`	Título ou nome da unidade.
`responsavel`	varchar		`não`	Nome do responsável pela unidade.
`telefone`	varchar		`não`	Telefone de contato da unidade.
`ramal`	varchar		`não`	Ramal de contato.
`ativo`	boolean		`sim`	Indica se a unidade está ativa.
`modificado_em`	datetime		`sim`	Data e hora da última modificação do registro. Este campo é utilizado para determinar se o registro deve ser incluído na rotina de sincronização da aplicação, assegurando que apenas os dados atualizados sejam importados.

A unidade é um cadastro obrigatório, caso sua empresa não possua diferentes unidades, utilize o nome e dados da sua empresa.

Tabela `propriedades`

A tabela propriedades contém dados sobre as propriedades, incluindo informações de localização, áreas e detalhes do produtor. Cada propriedade é identificada por um código único e possui uma chave de relacionamento com a tabela unidades.

Coluna	Tipo	Chave	Obrigatório	Descrição
`codigo`	varchar	UNIQUE	`sim`	Identificador único da propriedade.
`codigo_unidade`	varchar		`sim`	Código de relacionamento com a tabela `unidades`.
`titulo`	varchar		`sim`	Título ou nome da propriedade.
`end_logradouro`	varchar		`não`	Logradouro do endereço da propriedade.
`end_numero`	varchar		`não`	Número do endereço da propriedade.
`end_complemento`	varchar		`não`	Complemento do endereço da propriedade.
`end_bairro`	varchar		`não`	Bairro do endereço da propriedade.
`end_cidade`	varchar		`não`	Cidade do endereço da propriedade.
`end_uf`	char(2)		`não`	Unidade Federativa (UF) do endereço da propriedade.
`end_cep`	varchar		`não`	CEP do endereço da propriedade.
`incra`	varchar		`não`	Número do INCRA da propriedade.
`area_total`	varchar		`não`	Área total da propriedade.
`area_produzida`	varchar		`não`	Área produzida da propriedade.
`produtor_telefone`	varchar		`não`	Telefone do produtor.
`produtor_cpf_cnpj`	varchar		`não`	CPF ou CNPJ do produtor.
`produtor_inscricao`	varchar		`não`	Inscrição do produtor.
`ativo`	boolean		`sim`	Indica se a propriedade está ativa.
`modificado_em`	datetime		`sim`	Data e hora da última modificação do registro. Este campo é utilizado para determinar se o registro deve ser incluído na rotina de sincronização da aplicação, assegurando que apenas os dados atualizados sejam importados.

Tabela `fornecedores`

A tabela fornecedores registra informações dos fornecedores e parceiros, como nome, CPF/CNPJ, e perfil de acesso. Cada fornecedor é identificado por um código único.

Coluna	Tipo	Chave	Obrigatório	Descrição
`codigo`	varchar	UNIQUE	`sim`	Identificador único do fornecedor ou parceiro.
`codigo_parceiro`	varchar		`não`	Código do parceiro. Campo não utilizado caso perfil seja “fornecedor”.
`nome`	varchar		`sim`	Nome do fornecedor ou parceiro.
`cpf_cnpj`	varchar		`sim`	CPF ou CNPJ do fornecedor ou parceiro.
`perfil`	enum		`sim`	Perfil de acesso (“fornecedor” ou “parceiro”).
`ativo`	bool		`sim`	Indica se o fornecedor ou parceiro está ativo.
`modificado_em`	datetime		`sim`	Data e hora da última modificação do registro. Este campo é utilizado para determinar se o registro deve ser incluído na rotina de sincronização da aplicação, assegurando que apenas os dados atualizados sejam importados.

Tabela `fornecedores__propriedades`

A tabela fornecedores__propriedades é uma tabela de relacionamento que associa fornecedores a propriedades e unidades. Ela permite mapear quais fornecedores estão vinculados a quais propriedades e unidades, facilitando a gestão e a integração desses dados.

Coluna	Tipo	Chave	Obrigatório	Descrição
`codigo_fornecedor`	varchar		`sim`	Código de relacionamento com a tabela `fornecedores`.
`codigo_propriedade`	varchar		`sim`	Código de relacionamento com a tabela `propriedades`.

Relatórios

No banco de dados de integração, os usuários têm a capacidade de criar tabelas adicionais especificamente para a geração de relatórios dentro do sistema. Esta funcionalidade oferece total flexibilidade, permitindo aos usuários definir a estrutura de dados conforme suas necessidades específicas de relatórios.

Fluxo para criação de relatório

Criação das tabelas Crie as tabelas adicionais no banco de dados de integração, personalizando a estrutura de dados para atender às exigências do relatório.
Vinculação de dados ao fornecedor Para limitar o conteúdo de um relatório que o fornecedor terá acesso, você pode vincular cada registro à um fornecedor ou à uma propriedade.

Para isso, será preciso criar uma coluna na tabela desejada para receber o valor do vínculo.

→ Vincular registro ao fornecedor: Na tabela que deseja realizar o vínculo, crie uma coluna onde seu valor deverá ser ou o CPF/CNPJ do fornecedor ou o código de integração dele.

→ Vincular registro à propriedade: Na tabela que deseja realizar o vínculo, crie uma coluna onde seu valor será o código de integração da propriedade.

Solicitação de liberação Após a criação e configuração das tabelas de dados, solicite a liberação do relatório por meio de nossa equipe técnica. Este processo envolve a verificação e a configuração dos parâmetros do relatório dentro da aplicação para assegurar que ele funcione conforme esperado.
Configuração pela equipe técnica Nossa equipe técnica configurará o relatório dentro da aplicação, integrando-o ao sistema de forma que ele possa ser acessado e utilizado pelos usuários finais. Esta configuração inclui a definição de como os dados serão apresentados e quaisquer filtros ou opções de visualização que possam ser necessários.
Disponibilização do relatório Uma vez liberado e configurado, o relatório será disponibilizado dentro da aplicação. Os usuários poderão acessar o relatório através da interface do sistema, permitindo a análise e visualização dos dados conforme definido.