Integrações Baseadas em Banco de Dados
Passo 1: Clique na aba Integração, no menu à esquerda da interface do NFS-e Settings e em seguida na opção Integração baseada em banco de dados localizada na parte inferior da interface do NFS-e Settings.
A figura abaixo ilustra a interface do NFS-e Settings com as opções destacadas.
Interface do NFS-e Settings
Passo 2: Clique no botão Adicionar e a tela de Integração baseada em banco de dados será exibida:
Tela Integração baseada em banco de dados
A.No campo Nome, digite o nome utilizado para identificar a Integração.
B.No campo Assembly clique no ComboBox e selecione a DLL DefaultIntegration utilizado para integração via arquivo.
C.No campo Classe estará contido o valor a ser chamado da DLL, clique no ComboBox onde são apresentadas todas as classes de integrações possíveis de escolha onde cada classe de integração tem sua diferença. Entre elas são:
Para a classe de integração “V”, será gerado uma integração padrão;
Para a classe de integração “V2”, traz o número do RPS para o cancelamento;
Para a classe de integração “V3”, traz o código de controle;
Para a classe de integração “V4”, traz o RPSID (Matrícula) e número original do RPS;
Para a classe de integração “V5”, traz Data/Hora e Código de Verificação para o cancelamento;
Para a classe de integração “V6”, traz a série original do RPS no cancelamento.
Observação: Por exemplo, caso escolhido a classe de integração “V6”, automaticamente ela irá herdar os retornos das outras classes de integração, e assim com as demais classes.
Para integração de Cancelamento não irá integrar os campos de RPS Original e Matrícula.
Para o módulo do NFS-e e-Agente não irá retornar na integração os campos de Número do RPS Original e Número da Matrícula.
A opção de Integrar Valores Originais só irá gerar a integração dos campos se o Job for processo sequencial.
Só serão preenchidos os campos de acordo com o retorno de cada prefeitura, caso a prefeitura não retorne determinado campo, o mesmo ficará vazio. *Recomenda-se que sempre seja utilizado a última versão da classe de integração. |
D.No campo Formato do arquivo, clique e selecione o formato descrito no manual fornecido pela prefeitura de seu município. Neste exemplo, foi selecionado o formato UTF8.
E.No campo Formato de Data, selecione o formato de retorno do campo data do arquivo de integração.
F.No campo Exemplo, é apresentado o formato de retorno da data de arquivo de integração.
G.No campo Repositório padrão, informe o diretório onde serão gravados os arquivos utilizados para integração com o ERP.
H.Clique no botão 
para especificar o diretório que será utilizado pela integração, ou se preferir, insira manualmente o endereço do diretório.
I.O botão Validar, é utilizado para validar o diretório configurado para integração.
J.No campo Tipo do documento, selecione o formato do arquivo que será gravado para realizar a integração com o ERP. Este formato pode ser em XML ou Texto (txt).
K.Opção Utilizar hierarquia de pastas é utilizada para realizar uma organização por diretórios dos arquivos gerados para realização da integração.
L.A opção Integrar Valores Originais, utilizado para gerar a integração com os campos de Número da RPS Original e Número da Matrícula que será gerado na linha 0000.
M. A opção Documentos de Entrada, permite ao cliente selecionar como que ele deseja realizar o retorno da integração de nota de entrada. Se habilitada a funcionalidade a integração será gerada no formato do XML de NFS-e que é retornado pelo Web Service da Prefeitura, caso contrário é retornado no Layout da NDDigital.
Observação: A opção de Documento de Entrada ficará disponível somente para documentos do Tipo 'XML'. |
Passo 3: Clique na aba Conexão com o banco de dados e a seguinte tela será exibida:
Tela Conexão com o banco de dados
A.No campo SGBD, selecione o banco de dados que será utilizado (SQL Server ou Oracle).
B.No campo Servidor, informe o nome do servidor ou o seu IP.
C.No campo Banco de Dados, informe o nome do banco de dados.
D.No campo Tabela, informe o nome da tabela que armazenará as integrações, por padrão é utilizada a tabela tbintegration.
E.No campo Usuário, informe o usuário utilizado para se conectar no banco de dados.
F.No campo Senha, informe a senha utilizada para se conectar no banco de dados.
G.O campo Outros dados, pode ser utilizado para informar dados complementares da conexão.
H.O campo Porta é exibido somente quando for selecionado o banco de dados Oracle, é utilizado para determinar a porta que fará comunicação com o banco.
I.O campo Conexão, apenas exibe a connection string que será utilizada pelo aplicativo para se conectar com o banco de dados.
J.O botão Validar é utilizado para validar a conexão com o banco de dados.
Observação: O usuário e senha a serem informados devem possuir permissão para ler, escrever, excluir e criar tabelas e registros no banco de dados. |
Passo 4: O campo Formatação do Campo do Arquivo é utilizado para formatar o nome do arquivo de integração via arquivo TXT ou XML. Será possível customizar as integrações de Envio/Autorização, RPS Convertida, RPS com Erros, Cancelamento, NFS-e de Entrada e Controle Impressão. Para visualizar as variáveis disponíveis para customizar a nomenclatura do arquivo de integração clique com o botão direito do mouse dentro da caixa desejada e será apresentada uma lista com os campos disponíveis para cada campo. Clique na aba Nomenclatura do Arquivo e a tela abaixo será exibida:
Tela Nomenclatura do Arquivo
Envio/Autorização: |
[NUMNFSE]: Número da NFS-e que é retornada pelo Município;
[JOBID]: Número do ID do Job;
[NUMRPS]: Número da RPS;
[SERIE]: Série da RPS;
[TIPO]: Tipo da RPS;
[CNPJ]: CNPJ do Prestador de Serviço;
[DATA]: Data do processo da nota no formato AAAAMMDD;
[HORA]: Hora do processo da nota no formato HHMMSS.
RPS Convertida: |
[JOBID]: Número do ID do Job;
[NUMRPS]: Número da RPS;
[SERIE]: Série da RPS;
[TIPO]: Tipo da RPS;
[CNPJ]: CNPJ do Prestador de Serviço;
[DATA]: Data do processo da nota no formato AAAAMMDD;
[HORA]: Hora do processo da nota no formato HHMMSS.
RPS com Erros: |
[JOBID]: Número do ID do Job;
[NUMRPS]: Número da RPS;
[SERIE]: Série da RPS;
[TIPO]: Tipo da RPS;
[CNPJ]: CNPJ do Prestador de Serviço;
[DATA]: Data do processo da nota no formato AAAAMMDD;
[HORA]: Hora do processo da nota no formato HHMMSS.
Cancelamento: |
[NUMNFSE]: Número da NFS-e que é retornada pelo Município;
[JOBID]: Número do ID do Job;
[NUMRPS]: Número da RPS;
[SERIE]: Série da RPS;
[TIPO]: Tipo da RPS;
[CNPJ]: CNPJ do Prestador de Serviço;
[DATA]: Data do processo da nota no formato AAAAMMDD;
[HORA]: Hora do processo da nota no formato HHMMSS.
NFS-e de Entrada: |
[NUMNFSE]: Número da NFS-e que é retornada pelo Município;
[CNPJ]: CNPJ do Prestador de Serviço;
[JOBID]: Número do ID do Job;
[CODVER]: Código de Verificação da NFS-e;
[DATA]: Data do processo da nota no formato AAAAMMDD;
[HORA]: Hora do processo da nota no formato HHMMSS.
Controle Impressão: |
[JOBID]: Número do ID do Job;
[NUMRPS]: Número da RPS;
[SERIE]: Série da RPS;
[TIPO]: Tipo da RPS;
[CNPJ]: CNPJ do Prestador de Serviço;
[DATA]: Data do processo da nota no formato AAAAMMDD;
[HORA]: Hora do processo da nota no formato HHMMSS.
Observação: A configuração da Nomenclatura do Arquivo de integração para banco de dados será utilizada apenas para o NFS-e Datacenter. Caso exista mais de uma instância do NFS-e Connector configurada o diretório de integração deverá ser o mesmo do NFS-e Connector que está sendo utilizado pelo Job e vinculado ao executor. |
Passo 5: Aba Conversão de campos, siga os passos no link: Aba Conversão de campos (Integração)