Importação de CEPs - e-DNE
Faça a importação dos CEPs para a sua base de dados utilizando o banco de dados do Diretório Nacional de Endereços, fornecido pelos Correios. Através dessa importação do e-DNE para o Gestão Empresarial | ERP, você terá disponível todos os CEPs (novos e atualizados) para serem utilizados nas telas de cadastro.
Dessa forma, sistema irá processar as informações do banco de dados do Correios e inserir e/ou atualizar as novas faixas e atualizações de CEPs nas tabelas já existentes: Tabelas - Cep (E008CEP) e Tabelas - Cidades para RAIS - SIG (E008RAI).
Como obter o recurso?
Esse recurso é liberado de forma customizada. Para ter acesso aos CEPs, é necessário, primeiramente, adquirir a base de dados dos Correios e, em seguida, realizar o processo de importação para a base de dados do Gestão Empresarial | ERP.
Pré-requisitos
- Adquirir os arquivos .txt dos Correios;
- Obter os arquivos dos modelos de importação, regras, TBS e web services através do arquivo importacao-de-ceps-arquivos.zip. É necessário que o TBS de origem das informações fique no mesmo diretório do TBS destino (sapiens.tbs). Caso a sua solução esteja em um ambiente Cloud, para que isso seja possível, abra um chamado para equipe IT Services solicitando a criação de um diretório temporário na pastar raiz do sistema, contendo o TBS origem;
- Possuir o Middleware Senior do ambiente em execução.
Configurações para importação dos CEPs
A partir do arquivo sapiens_origem.tbs, crie as tabelas customizadas na sua base de dados:
Nome | Descrição |
---|---|
USU_T008BAI | CEP - LOG_BAIRRO |
USU_T008CPC | CEP - LOG_CPC |
USU_T008GUS | CEP - LOG_GRANDE_USUARIO |
USU_T008LOC | CEP - LOG_LOCALIDADE |
USU_T008LOG | CEP - LOG_LOGRADOURO |
USU_T008OPE | CEP - LOG_UNID_OPER |
USU_T008RLO | RAI - LOG_LOCALIDADE |
- Acesse o diretório de instalação ou ambiente Cloud do sistema;
- Localize a aplicação CBDS. Abra uma aplicação para acesso ao arquivo sapiens_origem.tbs e outra para acesso ao sapiens.tbs (que será o TBS destino), que está conectado à sua base de dados;
- No CBDS que está com o arquivo sapiens_origem.tbs aberto, em Tabelas, localize (uma por vez) a tabela que deverá ser criada no TBS destino;
- Selecione a tabela, acesse Editar > Copiar;
- Acesse o outro CBDS aberto (com o arquivo sapiens.tbs) e em Tabelas, vá em Editar > Colar;
- Faça este processo (copiar e colar) para todas as tabelas customizadas indicadas;
- Por fim, após adicionar todas as tabelas customizadas (do sapiens_origem.tbs) para a sua base de dados (arquivo sapiens.tbs), faça a personalização da base de dados para que essas tabelas constem efetivamente na base de dados.
Atenção
É necessário que os dois arquivos de TBS estejam na mesma pasta e as aplicações de CBDS sejam do mesmo diretório de instalação.
Importe os web services customizados, com.senior.fsw.cad.cep e com.senior.fsw.cad.rais, responsáveis por cadastrar os CEPs e cidades, conforme os arquivos disponibilizados, nas tabelas nativas (Tabelas - Cep (E008CEP) e Tabelas - Cidades para RAIS - SIG (E008RAI)). Esses web services verificam a operação a ser efetuada (inserção ou atualização) e fazem a chamada nas regras de processamento, além de contar com o cadastro centralizado para todas as regras.
Esses web services customizados são executados em modo síncrono (através do Middleware Senior). Portanto, em sua regra, o seu modo de execução está definido com o valor "2 - Modo Síncrono".
Para realizar esse procedimento, acesse Recursos > Implementações > Web services > Editar e faça a importação dos arquivos com.senior.fsw.cad.cep.ssf e com.senior.fsw.cad.rais.ssf.
Importante
Após importação, efetue o deploy dos web services através da ferramenta de deploy.
Adicione os modelos de importação, responsáveis por buscar os arquivos e alimentar as tabelas customizadas, no seu diretório de instalação: \<Diretório de instalação>\Sapiens\ImpExp:
- SAIM01008
- SAIM01009
- SAIM01010
- SAIM01011
- SAIM01012
- SAIM01013
- SAIM01014
Atenção
Caso você já possua um modelo de importação com a mesma numeração, ajuste para uma numeração disponível. Por exemplo, você já possui um modelo de importação SAIM01008, altere para SAIM01020, que ainda não está em uso.
Adicione as regras, responsáveis por processar as tabelas customizadas, registros pendentes e gravar o log de processamento, no seu diretório de instalação: \<Diretório de instalação>\Sapiens\Regras:
- SARG180.LSP
- SARG181.LSP
- SARG182.LSP
- SARG183.LSP
- SARG184.LSP
- SARG185.LSP
Todas as regras estão preparadas para o modo de execução "2 - Execução".
Atenção
Caso você já possua uma regra com a mesma numeração, ajuste para uma numeração disponível. Por exemplo, você já possui a regra SARG180.LSP, altere para SARG200.LSP, que ainda não está em uso.
Cadastre os processos automáticos para cada modelo de importação:
- Acesse Recursos > Processos Automáticos > Cadastro (F000AGE);
- Na guia Importação, indique um novo código do processo automático e sua descrição. Utilize o nome do modelo de importação para relacionar com o processo automático. Por exemplo, processo automático "53 - LOG_BAIRRO", que é referente ao modelo SAIM01011 - Importação de CEP - Arquivo origem LOG_BAIRRO;
- Em Tipo do Processo, selecione "2 - Importação";
- Mantenha as sugestões padrões do sistema nos campos:
- Horário Validade: 00:00 - 23:59
- Somente Dias Úteis: "N - Não"
- Indique o código da empresa e filial em que o processo será executado. E o usuário e senha do usuário responsável pela execução do processo automático;
- Selecione o arquivo do modelo de importação correspondente ao processo criado:
- SAIM01008 - Importação de Cidades - Arquivo LOG_LOCALIDADE
- SAIM01009 - Importação de CEP - Arquivo origem LOG_LOCALIDADE
- SAIM01010 - Importação de CEP - Arquivo origem LOG_LOGRADOURO
- SAIM01011 - Importação de CEP - Arquivo origem LOG_BAIRRO
- SAIM01012 - Importação de CEP - Arquivo origem LOG_GRANDE_USUARIO
- SAIM01013 - Importação de CEP - LOG_CPC
- SAIM01014 - Importação de CEP - LOG_UNID_OPER
- Em Arquivo de Entrada, busque pelo arquivo de importação dos Correios, de acordo com o processo criado: \<Diretório de instalação>\Sapiens\ProcessaCep\<Pasta>\<Nome do arquivo dos Correios>.txt. Por exemplo, C:\Sapiens\Sapiens\ProcessaCep\LOG_BAIRRO\LOG_BAIRRO.txt;
- Em Ação Sobre Arquivo determine a ação que será tomada sobre o arquivo de entrada, caso não exista ocorrências no processo. Neste caso, "4 - Mover", para mover o arquivo .txt para a pasta informada em Caminho mover arquivo, com o nome original do arquivo;
- Informe o diretório para qual será movido o arquivo de entrada no campo Caminho mover arquivo. Sugestão, possuir a pasta Processados em \<Diretório de instalação>\Sapiens\ProcessaCep\;
- Em Ação sobre arquivo ao ocorrer erros determine a ação que será tomada sobre o arquivo de entrada, caso apresente algum erro. Neste caso, "3 - Manter", para que o arquivo permaneça no local com o mesmo nome;
- Clique em Inserir e acesse a guia Regra para criar um processo automático para cada regra importada;
- Utilize o nome da regra para relacionar com o processo automático. Por exemplo, processo automático "54 - Localidade", que é referente a regra SARG180.LSP - Importação CEP CORREIOS - Localidade;
- Em Tipo do Processo, selecione "9 - Regra";
- Determine a periodicidade de execução da regra conforme a sua necessidade;
- Indique o código da empresa e filial em que o processo será executado. E o usuário e senha do usuário responsável pela execução do processo automático;
- Indique o código da regra:
- SARG180.LSP - Importação CEP CORREIOS - Localidade
- SARG181.LSP - Importação CEP Correios - Logradouro
- SARG182.LSP - Importação CEP CORREIOS - Grande Usuário
- SARG183.LSP - Importação CEP CORREIOS - Cidade
- SARG184.LSP - Importação CEP CORREIOS - LOG_UNID_OPER
- SARG185.LSP - Importação CEP CORREIOS - LOG_CPC
- Clique em Inserir para finalizar o cadastro do processo automático.
Atenção
Para que sejam importadas corretamente as informações no Gestão Empresarial | ERP, é necessário que os arquivos sejam colocados nas pastas na seguinte ordem: LOG_LOCALIDADE, LOG_BAIRRO e LOG_LOGRADOURO_XX. Essas informações são obrigatórias para que as demais sejam integradas corretamente. Desta forma, após processadas essas três pastas pelos processos automáticos e verificado que os arquivos foram movidos automaticamente para a pasta de arquivos processados, os demais arquivos (LOG_CPC, LOG_GRANDE_USUARIO, LOG_LOCALIDADE_CID e LOG_UNID_OPER) poderão ser inseridos nas pastas correspondentes e de processados. Caso sejam inseridos os arquivos fora de ordem, poderão ocorrer erros na integração.
Para que isso ocorra de forma automática, parametrize o campo Processo Sucessor de cada processo automático.
Após adquirir os arquivos dos Correios, crie a pasta ProcessaCep no diretório de instalação do sistema: \<Diretório de instalação>\Sapiens\ProcessaCep, para que sejam importados automaticamente os arquivos.
Nessa pasta, ProcessaCep, crie as pastas correspondentes para cada arquivo importado:
Pasta | Arquivo dos Correios | Composição do arquivo |
---|---|---|
LOG_BAIRRO | LOG_BAIRRO.txt | Bairro |
LOG_CPC | LOG_CPC.txt | Caixa Postal Comunitária (CPC) são áreas rurais e/ou urbanas periféricas não atendidas pela distribuição domiciliária. |
LOG_GRANDE_USUARIO | LOG_GRANDE_USUARIO.txt | Clientes com grande volume postal (empresas, universidades, bancos, órgãos públicos, entre outros). |
LOG_LOCALIDADE | LOG_LOCALIDADE.txt | Municípios, distritos e povoados do Brasil. Os CEPs neste arquivo valem para todos os logradouros da cidade, não necessitando consulta nos demais arquivos. |
LOG_LOCALIDADE_CID | LOG_LOCALIDADE.txt | |
LOG_LOGRADOURO_XX | LOG_LOGRADOURO_XX.txt. Sendo o "XX, o estado correspondente. Por exemplo, LOG_LOGRADOURO_SC | Contém os registros das localidades codificadas por logradouro. |
LOG_UNID_OPER | LOG_UNID_OPER.txt | Unidade Operacional dos Correios. São agências próprias ou terceirizadas, centros de distribuição, entre outros. |
Importante
É imprescindível que todos os arquivos estejam devidamente armazenados na pasta correspondente. Caso tenha ausência de algum arquivo, o processo automático, se utilizado para atualização automática das informações, não será executado devidamente.
Além disso, caso algum destes arquivos tenha alguma modificação, eles devem ser atualizados dentro da pasta em seu diretório e o processo automático deve ser executado devidamente.
Leiaute dos arquivos
Campo | Descrição | Tipo |
---|---|---|
BAI_NU | Chave do bairro | NUMBER(8) |
SEPARADOR | @ | |
UFE_SG | Sigla da UF | CHAR(2) |
SEPARADOR | @ | |
LOC_NU | Chave da localidade | NUMBER(8) |
SEPARADOR | @ | |
BAI_NO | Nome do bairro | VARCHAR2(72) |
SEPARADOR | @ | |
BAI_NO_ABREV | Abreviatura do nome do bairro (opcional) | (opcional) VARCHAR2(36 |
Campo | Descrição | Tipo |
---|---|---|
CPC_NU | Chave da caixa postal comunitária | NUMBER(8) |
SEPARADOR | @ | |
UFE_SG | Sigla da UF | CHAR(2) |
SEPARADOR | @ | |
LOC_NU | Chave da localidade | NUMBER(8) |
SEPARADOR | @ | |
CPC_NO | Nome da CPC | VARCHAR2(72) |
SEPARADOR | @ | |
CPC_ENDERECO | Endereço da CPC | VARCHAR2(100 |
SEPARADOR | @ | |
CEP | CEP da CPC | CHAR(8 |
SEPARADOR | @ | |
CPC_NU | Chave da caixa postal comunitária | NUMBER(8) |
SEPARADOR | @ | |
CPC_INICIAL | Número inicial da caixa postal comunitária | VARCHAR2(6) |
SEPARADOR | @ | |
CPC_FINAL | Número final da caixa postal comunitária | VARCHAR2(6) |
Campo | Descrição | Tipo |
---|---|---|
GRU_NU | Chave do grande usuário | NUMBER(8) |
SEPARADOR | @ | |
UFE_SG | Sigla da UF | CHAR(2) |
SEPARADOR | @ | |
LOC_NU | Chave da localidade | NUMBER(8) |
SEPARADOR | @ | |
BAI_NU | Chave do bairro | NUMBER(8) |
SEPARADOR | @ | |
LOG_NU | Chave do logradouro (opcional) | NUMBER(8) |
SEPARADOR | @ | |
GRU_NO | Nome do grande usuário | VARCHAR2(72) |
SEPARADOR | @ | |
GRU_ENDERECO | Endereço do grande usuário | VARCHAR2(100) |
SEPARADOR | @ | |
CEP | CEP do grande usuário | CHAR(8) |
SEPARADOR | @ | |
GRU_NO_ABREV | Abreviatura do nome do grande usuário (opcional) | VARCHAR2(36) |
Campo | Descrição | Tipo |
---|---|---|
LOC_NU | Chave da localidade | NUMBER(8) |
SEPARADOR | @ | |
UFE_SG | Sigla da UF | CHAR(2) |
SEPARADOR | @ | |
LOC_NO | Nome da localidade | VARCHAR(72) |
SEPARADOR | @ | |
CEP | CEP da localidade (para localidade não codificada, ou seja loc_in_sit = 0) (opcional) | CHAR(8) |
SEPARADOR | @ | |
LOC_IN_SIT | Situação da localidade:
|
CHAR(1) |
SEPARADOR | @ | |
LOC_IN_TIPO_LOC | Tipo de localidade:
|
CHAR(1) |
SEPARADOR | @ | |
LOC_NU_SUB | Chave da localidade de subordinação (opcional) | NUMBER(8) |
SEPARADOR | @ | |
LOC_NO_ABREV | Abreviatura do nome da localidade (opcional) | VARCHAR(36) |
SEPARADOR | @ | |
MUN_NU | Código do município IBGE (opcional) | CHAR(7) |
Campo | Descrição | Tipo |
---|---|---|
LOC_NU | Chave da localidade | NUMBER(8) |
SEPARADOR | @ | |
UFE_SG | Sigla da UF | CHAR(2) |
SEPARADOR | @ | |
LOC_NU | Chave da localidade | NUMBER(8) |
SEPARADOR | @ | |
BAI_NU_INI | Chave do bairro final do logradouro (opcional) | NUMBER(8) |
SEPARADOR | @ | |
LOG_NO | Nome do logradouro | VARCHAR2(100) |
SEPARADOR | @ | |
LOG_COMPLEMENTO | Complemento do logradouro (opcional) | VARCHAR2(100) |
SEPARADOR | @ | |
CEP | CEP do logradouro | CHAR(8) |
SEPARADOR | @ | |
TLO_TX | Tipo de logradouro | VARCHAR2(36) |
SEPARADOR | @ | |
LOG_STA_TLO | Indicador de utilização do tipo de logradouro (S ou N) (opcional) | CHAR(1) |
SEPARADOR | @ | |
LOG_NO_ABREV | Abreviatura do nome do logradouro (opcional) | VARCHAR2(36) |
Campo | Descrição | Tipo |
---|---|---|
UOP_NU | Chave da UOP | NUMBER(8) |
SEPARADOR | @ | |
UFE_SG | Sigla da UF | CHAR(2) |
SEPARADOR | @ | |
LOC_NU | Chave da localidade | NUMBER(8) |
SEPARADOR | @ | |
BAI_NU | Chave do bairro | NUMBER(8) |
SEPARADOR | @ | |
LOG_NU | Chave do logradouro (opcional) | NUMBER(8) |
SEPARADOR | @ | |
UOP_NO | Nome da UOP | VARCHAR2(100) |
SEPARADOR | @ | |
UOP_ENDERECO | Endereço da UOP | VARCHAR2(100) |
SEPARADOR | @ | |
CEP | CEP da UOP | CHAR(8) |
SEPARADOR | @ | |
UOP_IN_CP | Indicador de caixa postal (S ou N) | CHAR(1) |
SEPARADOR | @ | |
UOP_NO_ABREV | Abreviatura do nome da unidade operacional (opcional) | VARCHAR2(36) |
Perguntas frequentes (FAQ)
Não. Esse processo de importação de CEPs, não atualiza os CEPs que já estão em cadastros existentes, como o de cliente, fornecedor, etc. A inserção/atualização só irá ocorrer nas tabelas Tabelas - Cep (E008CEP) e Tabelas - Cidades para RAIS - SIG (E008RAI).
Não. Os CEPs excluídos não são indicados pelos Correios. Os arquivos contém apenas novas faixas e atualizações de CEPs.
O Diretório Nacional de Endereços (e-DNE) é um banco de dados, disponibilizado pelos Correios, que comporta mais de 900 mil CEPs brasileiros.
Não. A rotina não faz este tratamento. Para isso, é recomendável realizar a sua própria personalização.