Layout Importação de Dados Base CRM
Índice
Visão Geral
Para realizar a importação dos dados de um sistema legado para o Base CRM, é necessário entender que o Base CRM é composto por sete tipos de informação: Contas, Contatos, Contratos, Relacionamentos, Relacionamentos de Contrato e Usuários.
Esses dados são enviados de um computador remoto, onde está sendo utilizado o sistema legado, diretamente para o Base CRM em um intervalo de minutos definido pelo usuário. Este envio ocorre de forma automática através de um aplicativo Java, apelidado de robô, que estará sendo executado no computador remoto.
Quando a importação é feita por um dos sistemas da Base Software, o processo de extração dos dados do sistema legado, ocorre de forma automática através de “gatilhos” acionados sempre que uma determinada ação do sistema ocorre, gerando assim um Log de Exportação que será executado e enviado para o Base CRM através do robô.
Quando essa importação é feita por algum outro sistema que não seja da Base Software, ou seja, não é nativamente adaptado para exportar automaticamente as informações para o Base CRM, existe a necessidade de criar Arquivos de Exportação nos padrões que o robô interpretará e fará o envio das informações para o Base CRM.
Arquivos
Os arquivos deverão ser no formato TXT.
Por padrão, para todos os arquivos a primeira linha deverá conter as colunas dos campos, as demais linhas representam os dados do sistema.
Cada coluna, é separada por virgula e seu conteúdo deve ser colocando entre aspas compostas.
Ao final de cada linha deverá existir um ponto e virgula.
Contas
O nome do arquivo deverá ser contas.txt.
Os tipos de conta válidos são: pessoa, imovel e condominio.
Os tipos de conta deverão ser identificados em minusculo e sem acentuação. |
O que definirá se uma conta é inquilino, proprietário, fiador, corretor ou qualquer outro título é o relacionamento entre as contas.
Mais abaixo, poderá ser visto o layout para a exportação dos relacionamentos. |
Os campos ou “colunas” do arquivo de contas são:
- id – é a identificação da conta no sistema legado, ou seja, o código único da conta.
- nome
- tipo_conta – Precisa estar entre um dos valores pessoa, imovel ou condominio.
- endereco
- bairro
- cidade
- estado
- cep
- cpf
- cnpj
- email2
- telefone
- telefone2
- descricao – Campo utilizado para adicionar outros detalhes, caso seja necessário.
- website
- status – Precisa estar entre um dos valores ativo ou cancelado.
Faça o download do arquivo contas.txt para ver um exemplo. |
Contatos
O nome do arquivo deverá ser contatos.txt.
Cada contato está diretamente ligado a uma conta. Ou seja, uma conta pode possuir vários contatos.
Segue os campos ou “colunas” do arquivo de contatos.
- id – é a identificação do contato no sistema legado, ou seja, o código único do contato.
- idconta – é a identificação da conta a que este contato está vinculado.
- tipoconta – tipo da conta a que este contato está vinculado. (pessoa, imovel ou condominio).
- nome
- telefone
- telefone2
- cep
- endereco
- bairro
- cidade
- estado
- descricao – Caso precise adicionar outros detalhes a este contato.
- status' – precisa estar entre um dos valores ativo ou cancelado
Faça o download do arquivo contatos.txt para ver um exemplo. |
Não esqueça do ponto e virgula no final de cada linha. |
Contratos
O nome do arquivo deverá ser contratos.txt.
Ao incluir um contrato no sistema, ele não estará vinculado a nenhuma conta.
O contrato será somente visualizado em uma conta quando fizer a importação dos relacionamentos do contrato.
Mais abaixo, poderá ser visto o layout para a exportação dos relacionamentos de contratos. |
Segue os campos ou “colunas” do arquivo de contratos.
- id – é a identificação do contrato no sistema legado, ou seja, o código único do contrato.
- data_inicio – data de inicio do contrato.
- data_fim – data que termina o contrato.
- tipo_contrato – Precisa estar entre os valores adm imovel, adm locacao ou adm condominio.
- descricao – Outros detalhes do contrato.
- status – Precisa estar entre um dos valores ativo ou cancelado.
Faça o download do arquivo contratos.txt para ver um exemplo. |
Não esqueça do ponto e virgula no final de cada linha. |
Usuários
O nome do arquivo deverá ser usuarios.txt.
Os usuários importados para o Base CRM são os usuários que farão a utilização do sistema. Ao incluir um usuário ele vem com uma senha padrão ( 1234 ) que poderá ser modificada posteriormente pelo administrador do sistema.
O nível do usuário, será utilizado somente na primeira carga do sistema para vincular o usuário a um possível departamento pré configurado. Que posteriormente poderá ser modificado.
Segue os campos ou “colunas” do arquivo de usuarios.
- id – é a identificação do usuário no sistema legado, ou seja, o código único do usuário.
- login – login utilizado entrar no Base CRM.
- nome – Nome do usuário.
- telefone
- telefone2
- nivel – Precisa estar entre os valores atendente, gerente e gerente de locação
- status – Precisa estar entre os valores ativo e cancelado.
Faça o download do arquivo usuarios.txt para ver um exemplo. |
Não esqueça do ponto e virgula no final de cada linha. |
Relacionamentos
É importante primeiro que se tenha o entendimento do que é um relacionamento: Um relacionamento é uma interação ou ligação entre duas contas no Base CRM. |
O nome do arquivo deverá ser relacionamentos.txt.
Segue os campos ou “colunas” do arquivo de relacionamentos.
- idmaster – é a identificação única da conta master no sistema.
- tipo_conta_master – Precisa estar entre pessoa, imovel e condominio.
- tipo_relacionamento – Precisa estar entre condomino, inquilino, proprietario, sindico, fiador, fornecedor, funcionario, corretor, interessado e responsavel.
- idrelacionado – é a identificação única da conta relacionada no sistema.
- tipo_conta_relacionado – Precisa estar entre pessoa, imovel e condominio.
- chave_diferencial – Utilizada para diferenciar dois relacionamentos do mesmo tipo entre duas contas.
Digamos que eu tenha as contas (id = 1, Sr. Joaquim) e ( id = 2, Condomínio alto luxo ). Por algum motivo o Sr. Joaquim é condômino em duas unidades do condomínio alto luxo, então o que diferenciará esse relacionamento será a chave_diferencial onde será informada o código de qual unidade ele pertence. Então, caso o mesmo relacionamento ocorra em duas situações com as mesmas contas, o que diferenciará será a chave diferencial. O arquivo de relacionamentos é simples estruturalmente porém pode tornar-se de grande complexidade pela abstração que ele proporciona às contas do Base CRM. |
- descricao – Utilizado para adicionar outros detalhes do relacionamento.
Suponhamos que eu queira vincular a conta do Sr. Joaquim ( id = 1 ) à um imóvel existente no sistema (id = 2) afirmando que o Sr. Joaquim é proprietário deste imóvel. Isso é possível através dos relacionamentos. Teríamos assim um relacionamento do tipo “proprietario” entre Joaquim e seu imóvel que ficaria da seguinte forma:
Primeira linha do arquivo: “idmaster”, “tipo_conta_master”, “tipo_relacionamento”, “idrelacionado”, “tipo_conta_relacionado”; |
Primeira linha do arquivo: “1”, “pessoa”, “proprietario”, “2”, “imovel”; |
No exemplo acima, a conta com id = 1 de tipo = pessoa representa o Sr. Joaquim. A conta de id = 2 do tipo imovel representa o Imóvel do Sr. Joaquim.
Os tipos de relacionamentos possíveis no Base CRM são:
- condomino – Define o relacionamento de condômino entre uma pessoa e um condomínio. Neste caso o idmaster é o do condômino e o idrelacionado é do condomínio.
- inquilino – Define o relacionamento de inquilino entre uma pessoa e um imóvel. Neste caso o idmaster é o do inquilino e o idrelacionado é do imóvel.
- proprietario – Define o relacionamento de proprietário entre uma pessoa e um imóvel. Neste caso o idmaster é do proprietário e o idrelacionado é do imóvel.
- sindico – Define o relacionamento de síndico entre uma pessoa e um condomínio. Neste caso o idmaster é do síndico e o idrelacionado é do condomínio.
- fiador – Define o relacionamento de fiador entre uma pessoa e um imóvel. Neste caso o idmaster é do fiador e o idrelacionado é do imóvel.
- Corretor – Define o relacionamento de corretor entre uma pessoa e um imóvel. Neste caso o idmaster é do corretor e o idrelacionado é do imóvel.
- Interessado – Define o relacionamento de interessado entre uma pessoa e um imóvel. Neste caso o idmaster é do interessado e o idrelacionado é do imóvel.
- fornecedor – Define o relacionamento de fornecedor entre duas pessoas ou uma pessoa e um condomínio, ou seja, uma empresa (pessoa) pode ser fornecedora de um condomínio.
- funcionario – Define o relacionamento de funcionário entre uma pessoa e um condomínio, ou seja, é possível adicionar os funcionários do condomínio para que possam ser encontrados no Base CRM. Neste caso o idmaster é do funcionário e o idrelacionado é do condomínio
- responsavel – Define o relacionamento de responsável entre duas pessoas. A figura do responsável é um funcionário da administradora ( que terá de ser incluído como conta no arquivo de contas ) e outras pessoas. Para que possa saber quais pessoas (ou condomínios) aquele funcionário é responsável. Neste caso o idmaster é do responsável e o idrelacionado é da conta que ele será responsável.
- procurador – Define o relacionamento de procurador entre duas pessoas. Neste caso o idmaster é o do procurador e o idrelacionado é a conta que será a cedente
Fique atento também na classificação das contas relacionando os campos idmaster com tipo_conta_master e idrelacionado com tipo_conta_relacionado. |
Faça o download do arquivo relacionamentos.txt para ver um exemplo. |
Não esqueça do ponto e virgula no final de cada linha. |
Relacionamentos de Contrato
O nome do arquivo deverá ser relacionamentos_de_contrato.txt.
Os relacionamentos de contrato definem a relação que uma conta possui com um contrato no Base CRM.
Segue os campos ou “colunas” do arquivo de contratos.
- Idcontrato – é a identificação única do contrato no sistema.
- tipo_contrato – Precisa estar entre adm imovel, adm locacao e adm condominio.
- idconta – é a identificação única da conta no sistema.
- tipo_conta – Precisa estar entre pessoa, imovel e condominio.
- tipo_relacionamento – Precisa estar entre contratante, fiador e imovel.
- descricao – Utilizado para adicionar outros detalhes do relacionamento.
Por exemplo: O tipo de relacionamento de contratante, define que a pessoa é a contratante da administração de imóvel. O tipo de relacionamento de imovel define um possível imóvel que está envolvido em um contrato. O tipo de relacionamento de fiador define que conta ocupa o título de fiador no contrato.
Faça o download do arquivo relacionamentos_de_contrato.txt para ver um exemplo. |
Não esqueça do ponto e virgula no final de cada linha. |
Abaixo está um exemplo do arquivo de relacionamentos de contrato relacionamentos_de_contrato.txt
Suponha que exista um contrato de locação de id = 1, um imóvel com id = 2, uma pessoa, a contratante, com id = 3 e um fiador com id = 4.
“idcontrato”, “tipo_contrato”, “idconta”, “tipo_conta”, “tipo_relacionamento”, “descricao”; “1”, “adm locacao”, “2”, “imovel”, “imovel”, “Imovel contratado”; “1”, “adm locacao”, “3”, “pessoa”, “contratante”, “Pessoa que está contratando”; “1”, “adm locacao”, “4”, “pessoa”, “fiador”, “Pessoa que está sendo o fiador”;
Followup
Followups são registros de andamento ou histórico de uma conta, imóvel ou condomínio, importantes para fazer uma análise geral da conta. O arquivo de contas terá o formato txt. Sendo formado da seguinte maneira: • A primeira linha contém as colunas dos campos, as demais linhas representam as contas do sistema. • Cada coluna, é separada por virgula e seu conteúdo deve ser colocando entre aspas compostas. • Ao final de cada linha existe um ponto e virgula. Seguem abaixo os campos ou “colunas” do arquivo de Followups. • Id – É a identificação única do followup no sistema • data – O formato da data é dd-mm-YYYY • hora – O formato da hora é HH:mm • descricao – Descrição geral do followup. • status_followup – Precisa estar entre ativo ou cancelado • tipo_followup – Precisa estar entre agenda , follow_up, ocorrencia, solicitacao ou andamento • followup_id – Quando criado um followup do tipo solicitacao, este followup poderá conter muitos followups de andamento, que também são registros deste arquivo txt. Então, se este followup é de andamento, ele terá um followup pai de solicitacao Abaixo está um exemplo do arquivo de followup's followups.txt . "id","data","hora","descricao","status_followup","tipo_followup","followup_id"; "10","11-08-2010","14:00","Solicitou login e senha pelo e- mail.","ativo","solicitacao",""; "11","12-08-2010","09:10","Foi feita uma ligação para o cliente, mas ele não estava","ativo","andamento","10"; "12","12-08-2010","11:25","Cliente foi atendido e seu login e senha foram informados","ativo","andamento","10"; A ligação entre os followups e as contas do BaseCRM é feita através de um outro mecanismo Contas do Followup, com definição a seguir.
Contas do Followup
O arquivo de contas terá o formato txt. Sendo formado da seguinte maneira: • A primeira linha contém as colunas dos campos, as demais linhas representam as contas do sistema. • Cada coluna, é separada por virgula e seu conteúdo deve ser colocando entre aspas compostas. • Ao final de cada linha existe um ponto e virgula. Seguem abaixo os campos ou “colunas” do arquivo de contratos: • idfollowup – É a identificação única do followup no sistema • idconta – É a identificação única da conta no sistema • tipo_conta – Precisa estar entre pessoa, imovel ou condominio. • tipo_relacionamento – Precisa estar entre condomino, inquilino, proprietario, sindico, fiador, fornecedor, funcionario ou responsavel. • Descricao – Descrição livre do relacionamento entre a conta e o followup. Abaixo está um exemplo do arquivo de contas dos followups contas_followups.txt. Imagine que a conta 232 é um funcionário de nome José, que a conta 232 é um condomínio chamado Condomínio Alto Luxo, e que a conta 234 é uma condômina chamada Maria. "idfollowup","idconta","tipo_conta","tipo_relacionamento","descricao"; "10","232","pessoa","funcionario",""; "10","233","condominio","condominio",""; "10","234","pessoa","condomino","";