Layout Importação de Dados Base CRM

De WikiBase

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.


Atencao.png

Os campos do tipo carácter deverão conter um tratamento especial quando compostos por aspas (") ou [ENTER] para quebra de linha.

Toda ocorrência de aspas dentro do campo deverá ser precedida de uma barra invertida antes das aspas, Ex.: RUA "A" No 500 deverá ser representado como RUA \"A\" No 500.

Toda ocorrência de [ENTER] (quebra de linha) quando necessário deverá ser representada por \n, Ex.: DATA INICIAL:01/01/2015[ENTER]DATA FINAL:31/01/2015 deverá ser representado como DATA INICIAL:01/01/2015\nDATA FINAL:31/01/2015.

Contas

O nome do arquivo deverá ser contas.txt.

Os tipos de conta válidos são: pessoa, imovel e condominio.


Atencao.png

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.


Dica.png

Mais abaixo, poderá ser visto o layout para a exportação dos relacionamentos.


Os campos ou “colunas” do arquivo contas.txt são:

Nome do Campo Tipo Tamanho Máximo Obrigatório Observações
id Alfanumérico 100 Sim É a identificação da conta no sistema legado, ou seja, o código único da conta.
usuario_responsavel Alfanumérico 100 Não id do usuário responsável/gerente da conta (campo id da tabela usuarios.txt)
nome Alfanumérico 255 Sim  
tipo_conta Alfanumérico 15 Sim Precisa estar entre um dos valores pessoa, imovel ou condominio
endereco Alfanumérico 255 Sim  
bairro Alfanumérico 255 Não  
cidade Alfanumérico 255 Não  
estado Alfanumérico 255 Não  
cep Alfanumérico 20 Não  
cpf Alfanumérico 20 Não  
cnpj Alfanumérico 20 Não  
email Alfanumérico 255 Não Endereço de e-mail principal.
email2 Alfanumérico 255 Não Endereço de e-mail alternativo.
telefone Alfanumérico 255 Não  
telefone2 Alfanumérico 255 Não  
descricao Alfanumérico Livre Não Campo utilizado para adicionar outros detalhes, caso seja necessário.
website Alfanumérico 255 Não  
status Alfa 15 Sim Precisa estar entre um dos valores ativo, cancelado ou potencial.



Dica.png

O status de contas em potencial poderá ser utilizado para clientes que ainda não fazem parte da carteira, possibilitando a configuração de filtros de contas com status potencial para a realização de campanhas de captação.

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.

Os campos ou “colunas” do arquivo contatos.txt são:

Nome do Campo Tipo Tamanho Máximo Obrigatório Observações
id Alfanumérico 255 Sim É a identificação do contato no sistema legado, ou seja, o código único do contato.
idconta Alfanumérico 100 Sim É a identificação da conta a que este contato está vinculado.
tipoconta Alfanumérico 100 Sim Tipo da conta a que este contato está vinculado. (pessoa, imovel ou condominio).
nome Alfanumérico 255 Sim  
telefone Alfanumérico 255 Não  
telefone2 Alfanumérico 255 Não  
email Alfanumérico 255 Não  
cep Alfanumérico 15 Não  
endereco Alfanumérico 255 Não  
bairro Alfanumérico 255 Não  
cidade Alfanumérico 255 Não  
estado Alfanumérico 255 Não  
descricao Alfanumérico Livre Não Caso precise adicionar outros detalhes a este contato.
status Alfa 15 Sim precisa estar entre um dos valores ativo ou cancelado.


Dica.png

Faça o download do arquivo contatos.txt para ver um exemplo.


Atencao.png

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.


Dica.png

Mais abaixo, poderá ser visto o layout para a exportação dos relacionamentos de contratos.


Os campos ou “colunas” do arquivo contratos.txt são:

Nome do Campo Tipo Tamanho Máximo Obrigatório Observações
id Alfanumérico 255 Sim É a identificação do contrato no sistema legado, ou seja, o código único do contrato.
data_inicio Data (DD/MM/AAAA) 10 Não Data de inicio do contrato.
data_fim Data (DD/MM/AAAA) 10 Não Data que termina o contrato.
tipo_contrato Alfa 20 Sim Valores padrão:
adm imovel (contratos de administração de imóveis)
adm locacao (contratos de locação)
adm condominio (contratos de administração de condomínios)
Obs. Os valores padrão sugeridos acima são de controle dos tipos de contrato dos sistemas, porém, a tabela permite outros tipos de contrato desde que não ultrapassem o limite de 40 posições para o conteúdo do campo.
descricao Alfanumérico Livre Não Outros detalhes do contrato. Ver um exemplo na imagem abaixo.
A expressão \n representa o salto de linha na descrição do contrato, conforme poderá ser observado no arquivo de exemplo.
status Alfa 15 Sim Precisa estar entre um dos valores ativo ou cancelado.


Dicas de descrição para o contrato de administração de condomínio (adm condominio):


Base CRM Exemplo Contrato.JPG


Dicas de descrição para o contrato de administração de imóveis (adm imovel):


Base CRM Exemplo Contrato Adm Imov.JPG


Dicas de descrição para o contrato de administração de locação (adm locacao):


Base CRM Exemplo Contrato Adm Loc.JPG


Dica.png

Faça o download do arquivo contratos.txt para ver um exemplo.


Atencao.png

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.

Os campos ou “colunas” do arquivo usuarios.txt são:

Nome do Campo Tipo Tamanho Máximo Obrigatório Observações
id Alfanumérico 100 Sim É a identificação do usuário no sistema legado, ou seja, o código único do usuário.
login Alfanumérico 255 Não Nome de usuário para acesso ao Base CRM.
nome Alfanumérico 255 Sim Nome completo do usuário.
telefone Alfanumérico 255 Não  
telefone2 Alfanumérico 255 Não  
email Alfanumérico 255 Não  
nivel Alfa 20 Não Precisa estar entre os valores:
atendente
gerente (gerente de condomínio)
gerente de locação
status Alfa 15 Sim Precisa estar entre os valores ativo ou cancelado.


Dica.png

Faça o download do arquivo usuarios.txt para ver um exemplo.


Atencao.png

Para a tabela de usuários deverá ser gerado um registro equivalente na tabela de contas, pois, para que seja feito o relacionamento entre usuários com nível gerente e as demais contas do sistema.

Não esqueça do ponto e virgula no final de cada linha.

Relacionamentos

Atencao.png

É 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 e muito importante na identificação da maioria das contas, pois, dependendo do tipo de relacionamento a conta poderá ser identificada através de ícones específicos (Ex. Síndico, Fornecedor, Procurador, etc.).


O nome do arquivo deverá ser relacionamentos.txt.


Dica.png

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.


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”,"chave_diferencial","descricao","status";

Primeira linha do arquivo: “1”, “pessoa”, “proprietario”, “2”, “imovel”,"1","100%","ativo";

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


Atencao.png

Fique atento também na classificação das contas relacionando os campos idmaster com tipo_conta_master e idrelacionado com tipo_conta_relacionado.


Os campos ou “colunas” do arquivo relacionamentos.txt são:

Nome do Campo Tipo Tamanho Máximo Obrigatório Observações
idmaster Alfanumérico 100 Sim É é a identificação única da conta master no sistema.
tipo_conta_master Alfa 15 Sim Precisa estar entre pessoa, imovel ou condominio.
tipo_relacionamento Alfa 20 Sim Precisa estar entre condomino
inquilino
proprietario (de imóvel)
sindico
fiador
fornecedor
funcionario (de condomínio)
corretor
interessado
responsavel (conta de usuário de nível gerente responsável pela administração).


Obs. Os valores padrão sugeridos acima são de controle dos tipos de relacionamento dos sistemas, porém, a tabela permite outros tipos desde que não ultrapassem o limite de 40 posições para o conteúdo do campo.

idrelacionado Alfanumérico 100 Sim É a identificação única da conta relacionada no sistema.
tipo_conta_relacionado Alfa 15 Sim Precisa estar entre pessoa, imovel ou condominio.
chave_diferencial Alfanumérico 255 Sim Utilizada para diferenciar dois relacionamentos do mesmo tipo entre as mesmas contas.
descricao Alfanumérico Livre Não Utilizado para adicionar outros detalhes do relacionamento.
status Alfa 15 Sim Precisa estar entre ativo ou cancelado.



Atencao.png

Não esqueça do ponto e virgula no final de cada linha.


Dica.png

Além os tipos fixos do sistema, o Base CRM disponibiliza ícones especiais de identificação para a conta. São eles: Conselheiro, Curador, Inventariante, Segurado e Sub Síndico.

O sistema disponibiliza ícones de identificação somente para os tipos relacionados acima. Então, a implementação de um novo tipo não está condicionada à identificação através de um ícone específico.


Integração com ICondo

Atencao.png

No caso de integração do CRM com o ICondo os relacionamentos de condômino/síndico com condomínio e proprietário/inquilino com imóvel devem conter as informações de login e senha padronizados no campo descrição do arquivo de relacionamentos, conforme os padrões abaixo.


  • Para relacionamentos de condôminos:
[LOGIN:LOGIN_INTERNET_CONDOMINO]\n[SENHA:SENHA_INTERNET_CONDOMINO]\nCOMPLEMENTO_UNIDADE
  • Para relacionamentos de síndicos:
[LOGIN:LOGIN_INTERNET_SINDICO]\n[SENHA:SENHA_INTERNET_SINDICO]\nCOMPLEMENTO_UNIDADE_SINDICO
  • Para relacionamentos de proprietários:
[LOGIN:LOGIN_INTERNET_PROPRIETARIO]\n[SENHA:SENHA_INTERNET_PROPRIETARIO]\nPERC.:PERCENTUAL_IMOVEL
  • Para relacionamentos de inquilinos:
[LOGIN:LOGIN_INTERNET_INQUILINO]\n[SENHA:SENHA_INTERNET_INQUILINO]


Dica.png

Faça o download do arquivo relacionamentos.txt para ver um exemplo.

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.

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.

Os campos ou “colunas” do arquivo relacionamentos_de_contrato.txt são:

Nome do Campo Tipo Tamanho Máximo Obrigatório Observações
idcontrato Alfanumérico 100 Sim É a identificação única do contrato no sistema.
tipo_contrato Alfa 20 Sim Precisa estar entre adm imovel, adm locacao ou adm condominio.
idconta Alfanumérico 100 Sim É a identificação única da conta no sistema.
tipoconta Alfanumérico 100 Sim Tipo da conta a que este contato está vinculado. (pessoa, imovel ou condominio).
tipo_relacionamento Alfa 15 Sim Precisa estar entre contratante, fiador ou imovel.
descricao Alfanumérico Livre Não Utilizado para adicionar outros detalhes do relacionamento.
status Alfa 15 Sim Precisa estar entre ativo ou cancelado.


Dica.png

Faça o download do arquivo relacionamentos_de_contrato.txt para ver um exemplo.


Atencao.png

Não esqueça do ponto e virgula no final de cada linha.


Funcionalidades