You are on page 1of 19

Manual de Integração OPaf

Manual de Atualização

Layout de Integração 010
Aplicável à versão 4.1.0.0 e demais releases da suíte de aplicativos OPaf
OPaf ® é marca registrada da ID Brasil Sistemas Ltda
1

Olá! Este é o seu manual...
Este manual visa orientar a execução de serviços destinados a integração do software OPaf, de
propriedade da ID Brasil Sistemas Ltda, com o sistema de gestão (SG) do Parceiro Integrador.

A comunicação entre os sistemas é um processo relativamente simples, todavia, mudanças nos detalhes
podem levar a resultados inesperados. Assim é fundamental que todas as orientações desse manual
sejam seguidas à risca para evitar transtornos e situações inesperadas.

Sugestões de melhoria para esse manual podem ser enviadas por meio de ticket que pode ser
cadastrado em nossa Central de Atendimento no site da ID Brasil – www.idbrasil.com. Suas sugestões
serão bem vindas e nos auxiliam a deixar o nosso material cada vez melhor.

Este manual é parte integrante do Software OPaf, e sua utilização para fins não autorizados sujeita o
Parceiro Integrador às responsabilidades previstas em lei.

2

Índice
Instruções para atualização .......................................................................................................................... 4
Atualização do OPaf com apenas 01 OPaf instalado .................................................................................... 5
Atualizando o OPaf ................................................................................................................................... 5
Informações importantes antes da Atualização ....................................................................................... 5
Alterações na estrutura da Pasta de Instalação ................................................................................... 5
Verificações antes da Atualização ............................................................................................................ 5
Alterações na estrutura da Pasta de Instalação ................................................................................... 5
Faça um backup e apague a sua PASTA MESTRE DE INTEGRAÇÃO ...................................................... 6
Certifique-se de que o Firebird está funcionando corretamente ........................................................ 6
Adeque os cadastros de produtos para manter o padrão correto ....................................................... 6
Nunca execute o atualizador com aplicativos da suíte OPaf abertos .................................................. 6
Sempre mantenha a movimentação atualizada ................................................................................... 7
Download do Atualizador OPaf ............................................................................................................ 7
Executando o Atualizador OPaf ................................................................................................................ 7
Observações importantes......................................................................................................................... 9
Configurando o OPaf após a atualização .................................................................................................. 9
Atualização do OPaf com mais de 01 OPaf instalado ................................................................................. 10
Atualizando o OPaf ................................................................................................................................. 10
Informações importantes antes da Atualização ..................................................................................... 10
Configurando o ambiente corretamente ........................................................................................... 10
Seu cliente emite DAV ou Pré-venda? ................................................................................................ 12
Configurando o OPaf após a atualização ................................................................................................ 12
Atualização do ODav e OPv em terminais .................................................................................................. 16
Atualizando o ODav e OPv ...................................................................................................................... 16
Download do Atualizador OPaf .............................................................................................................. 16
Executando o Atualizador de executáveis OPaf ................................................................................. 16
Informações importantes ....................................................................................................................... 17

3

Instruções para atualização
O objetivo das instruções contidas neste documento é o de informar os procedimentos necessários para
realizar a correta ATUALIZAÇÃO do sistema OPaf em cliente que já possui OPaf instalado em seu
estabelecimento nas versões anteriores a versão 4.1.0.0, abaixo a relação das versões:











OPaf 1.0.0.0
OPaf 1.1.0.3
OPaf 1.2.0.0
OPaf 2.0.1.0
OPaf 2.1.0.0
OPaf 3.0.0.0
OPaf 3.0.3.0
OPaf 3.0.4.0
OPaf 3.0.5.0
OPaf 3.1.0.0
OPaf 4.0.0.0

A versão 4.1.0.0 possui novos recursos como, por exemplo, geração de Nota Fiscal Eletrônica, novo
módulo para utilização de TEF Dedicado Scope e o sistema básico de gestão OGestão. Possui também
correção de algumas rotinas já existentes em versões anteriores, para mais informações verifique o Item
2.3.1.1 – Alterações da versão disponível em nossa Base de Conhecimento.

IMPORTANTE: Alguns estados exigem documentação informando a atualização do OPaf em versão
anterior para versão 4.1.0.0, qualquer dúvida relacionada às documentações devem ser verificadas
diretamente com o Setor Administrativo da ID Brasil ou pela nossa Gestão de Conhecimento.

Para obter as informações necessárias, acesse a Gestão de Conhecimento na Central de Atendimento e
localize o Item 5.3 - Documentação necessária para novo cliente.

Verifique a documentação necessária separada pelo seu estado (UF) antes de realizar a atualização.

4

Atualização do OPaf com apenas 01 OPaf instalado
Atualizando o OPaf
Para parceiros que possuem cliente com APENAS 01 (Um) OPaf instalado no mesmo estabelecimento
comercial (CNPJ) a atualização do sistema deve ser realizada conforme as seguintes instruções:

Informações importantes antes da Atualização
Alterações na estrutura da Pasta de Instalação
O OPaf 4.1.0.0 possui estrutura de instalação seguindo as diretrizes da versão base (OPaf 3.0.0.0) e
consequentemente diferente das versões anteriores à versão OPaf 3.0.0.0.

Por padrão a instalação para versões anteriores a 3.0.0.0 cria pasta denominada “ID Brasil” localizada
em “Arquivos de Programas” do sistema operacional. Esta pasta contém as pastas INTEGRADOR e
CONFIGURADOR.

Após realizar a atualização para o OPaf 3.0.0.0 ou OPaf 3.1.0.0, a pasta “ID Brasil” não será mais
apresentada em “Arquivos de Programas”, uma vez que a partir dessa versão o OPaf passa a criar as
pastas INTEGRADOR e CONFIGURADOR no local padrão de instalação do OPaf (C:\OPaf), concentrando
todos os recursos vinculados ao OPaf em uma única pasta.

Verificações antes da Atualização
Estrutura da Pasta de Instalação
Para que a atualização funcione corretamente é OBRIGATÓRIO que o OPaf esteja instalado de forma
PADRÃO no computador, ou seja, o OPaf deve estar localizado em C:\OPaf\ e o banco de dados OPaf
em C:\OPaf\BD\ com o nome OPAF.FDB.

5

Faça um backup e apague a sua PASTA MESTRE DE INTEGRAÇÃO
A pasta MONITORA deve OBRIGATORIAMENTE ser DELETADA MANUALMENTE onde quer que esteja
localizada antes de executar o Atualizador do OPaf 4.1.0.0. Depois de realizada a atualização do OPaf e
execução do Integrador a pasta MONITORA será criada novamente automaticamente no mesmo local já
indicado na aba Integração do Configurador.

Se a pasta MONITORA não for deletada antes de atualizar o OPaf, ao executar o Integrador TODAS as
remessas que estiverem contidas na pasta REMESSA serão processadas novamente e gerados os
respectivos logs de erro uma vez que são remessas com layout de versão anterior a 4.1.0.0.

Certifique-se de que o Firebird está funcionando corretamente
O Firebird instalado no computador em modo SERVIÇO deve estar OBRIGATORIAMENTE na versão
2.0.3, versão PADRÃO de utilização OPaf. Se o Firebird que estiver sendo executado em modo SERVIÇO
no sistema operacional não estiver na versão 2.0.3 o ATUALIZADOR OPaf NÃO FUNCIONARÁ
CORRETAMENTE e com isso deverá ser realizada instalação correta do Firebird 2.0.3. Para obter as
informações necessárias, acesse a Gestão de Conhecimento na Central de Atendimento e localize o Item
4.3.2 - Firebird.

Adeque os cadastros de produtos para manter o padrão correto
A partir da versão 2.1.0.0 o OPaf passa a restringir o Código do Produto (Registro 005 – Campo 2) a 14
caracteres para manter compatibilidade com o Sintegra, com isso caso exista produto com código que
possua mais de 14 caracteres é necessário antes de iniciar a atualização enviar REMESSA inativando o
cadastro desse(s) produto(s).

Nunca execute o atualizador com aplicativos da suíte OPaf abertos
O OPaf, Integrador e Configurador NÃO PODEM estar em execução no momento em que for realizada a
atualização do OPaf.

6

Sempre mantenha a movimentação atualizada
Antes de atualizar o OPaf verifique se não existe movimento de caixa retroativo em aberto. Se existir
efetue o fechamento do dia corretamente para posteriormente realizar a atualização do OPaf.

Download do Atualizador OPaf
Realize o DOWNLOAD DO ATUALIZADOR de acordo com a arquitetura do sistema operacional de seu
cliente (32 ou 64 Bits) e salve-o na pasta de instalação do OPaf (C:\OPaf\). Para obter as informações
necessárias, acesse a Gestão de Conhecimento na Central de Atendimento e localize o Item 2.4.1.5.2 Atualizador OPaf 4.1.0.0 32 Bits ou o Item 2.4.1.5.3 – Atualizador OPaf 4.1.0.0 64Bits, dependendo do
seu sistema operacional.

Executando o Atualizador OPaf
Execute o atualizador do OPaf que você efetuou seguindo o passo anterior e siga as instruções abaixo:

Passo 01 – Executando o Atualizador
Execute o atualizador OPaf.

Passo 02 – Selecione o local para atualização
Confirmar Local de Destino. (Por padrão deve ser instalado em C:\OPaf) e clique em instalar.

Passo 03 – Avance
Clique em avançar para continuar a realizar o procedimento.

Passo 04 – Senha para atualização
Utilize a senha: 4430294327

Passo 05 – Selecione o local de instalação do OPaf
Confirmar Local de instalação do OPaf. (Por padrão deve ser instalado em C:\OPaf).

Passo 06 – Verificando a instalação do Firebird?
Neste passo o atualizador OPaf verificará se o Firebird instalado no computador responde ao padrões
utilizados.

7

No campo Diretório Firebird localize a pasta onde o Firebird 2.0.3 está instalado.

No campo Usuário e Senha informe o usuário e senha do Firebird:
o

Usuário = sysdba

o

Senha = masterkey

Passo 07 – Avance
Clique em avançar para continuar a realizar o procedimento. Neste ponto, serão demonstrados os
processamentos de Scripts de atualização e QGs de correção no banco de dados. Toda a operação de
atualização será demonstrada por meio de barras de status.

Passo 08 – Avance
Clique em avançar para continuar a realizar o procedimento.

Passo 09 – Selecione o local para instalação
Confirmar Local de Destino. (Por padrão deve ser instalado em C:\OPaf).

Passo 10 – Qual o caminho no menu iniciar do Windows?
Identificação da Pasta no Menu Iniciar.

Passo 12 – O que será efetuado?
Selecionar e confirmar os processos a serem instalados.

Criar um ícone na Área de trabalho: Se você deseja a criação automática dos ícones no

desktop do seu cliente final.

Instalar OPaf: Atualiza a versão corrente do OPaf.

Passo 13 – Avance Novamente
Confirme as configurações realizadas e clique em Instalar.

Passo 14 – Aguarde o processo de atualização dos arquivos
Aguarde a realização da atualização dos arquivos para correto funcionamento do OPaf.
Passo 15 – Instale o componente da NFe
Finalizada instalação do Firebird será apresentado por sim a instalação do componente para utilização
de NF-e, a instalação do mesmo também deve ser realizada obrigatoriamente de forma padrão.
Passo 16 – Conclua a atualização
Por fim clique em Concluir para finalizar a instalação.
Passo 17 – Importação da tabela do IBPT
Após a finalização da instalação do OPaf, baixe o item 2.4.1.6.1 - Aplicativo ImportarIBPT e o item
2.4.1.6.2 - Arquivo IBPT para importação da Gestão de conhecimento e coloque-os na pasta do OPaf.
Abra o aplicativo para importar a tabela do IBPT, selecione a mesma e clique em IMPORTAR.
Após importada a tabela será apresentada a mensagem “Arquivo C:\OPaf\IBPTax.csv importado com
sucesso”.
8

Clique em OK e finalize o executável, após esse processo pode-se dar continuidade a configuração
normalmente.

Observações importantes
Durante a instalação o sistema deverá inserir os arquivos necessários para que o ECF funcione
corretamente.

Ao realizar esse processo o sistema pode identificar arquivos de inicialização já

existentes no sistema operacional como, por exemplo, Bemafi32.ini, Elgin.ini, etc e solicitar confirmação
para substituí-los. Alguns cuidados devem ser tomados caso o modelo de ECF em uso no
estabelecimento utilize algum arquivo de inicialização, se possuir confirme opção para SUBSTITUIR o
arquivo, lembrando-se de sempre guardar as informações dos arquivos de INI das fabricantes para
poder reutiliza-las, assim as configurações de comunicação com o ECF não serão perdidas.

Configurando o OPaf após a atualização
Após realizar a atualização do sistema OPaf os seguintes parâmetros devem ser verificados no
Configurador:

Passo 01 – Acessar o Configurador e renovar a licença
Acessar o Configurador e ir à Aba PAF > PAF-ECF

Gerar nova requisição de licença e enviar para o Suporte OPaf para que possa ser

enviada licença de uso da versão 4.1.0.0.

Salvar a licença enviada pelo Suporte OPaf em C:\OPaf\Configurador.

Acessar o Configurador e importar a licença.

Passo 02 – Verifique suas tabelas de preço
Acessar o Configurador e ir à Aba > PAF > Tabelas de Preço
Caso na instalação do OPaf antes da ATUALIZAÇÃO tenha sido realizado cadastro de Tabelas de Preço
com caracteres MINÚSCULOS deverá ser realizado OBRIGATORIAMENTE exclusão das tabelas de preço
e posteriormente realizar NOVO CADASTRO para padronizar os caracteres em MAIÚSCULO.

Clique em EXCLUIR TODOS OS PREÇOS DOS PRODUTOS e posteriormente envie novo arquivo de
remessa com os preços dos produtos para as novas tabelas de preço cadastradas.
9

Atualização do OPaf com mais de 01 OPaf instalado
Atualizando o OPaf
As instruções abaixo são para parceiros que JÁ POSSUEM MAIS DE UM SISTEMA OPAF INSTALADO E
EM USO EM UM MESMO ESTABELECIMENTO COMERCIAL (CNPJ). A atualização deverá ser realizada na
sequência dos procedimentos apresentados abaixo.

Informações importantes antes da Atualização
Configurando o ambiente corretamente
Identificamos que alguns parceiros que tem mais de um PDV no mesmo estabelecimento (CNPJ) estão
configurando o sistema de forma INADEQUADA. A PMI (Pasta Mestre de Integração) estava sendo
configurada individualmente por PDV, conforme Figura 01.

10

Figura 01 – Forma ERRADA de configurar a PMI

Isso pode causar perda de informações e geração de informações incompletas nos arquivos do MENU
FISCAL.

É fundamental que a PMI seja configurada de forma unificada para o estabelecimento (CNPJ), conforme
demonstra a Figura 02.

Figura 02 – Forma CORRETA de configurar a PMI

Por meio das informações geradas na Licença de uso do OPaf um PDV deverá ser definido como
CONCENTRADOR com o objetivo de centralizar todas as informações de movimentação do
estabelecimento.

Deverá ser utilizada APENAS UMA PASTA MONITORA para integração (Envio e recebimento de dados)
dos arquivos para todos os PDVs do estabelecimento.

11

Seu cliente emite DAV ou Pré-venda?
Se o seu cliente possui esse ambiente com mais de um PDV e EMITE DAV OU PRÉ-VENDA E UTILIZA
UMA VERSÃO INFERIOR À 2.1.0.0, entre em contato com o Suporte OPaf para mais informações.

Se não emite DAV ou Pré-Venda apenas siga as instruções contidas no tópico Atualização do OPaf com
apenas 01 OPaf instalado e em seguida o tópico Configurações após a atualização do OPaf.

Configurando o OPaf após a atualização
Após realizar a atualização do sistema OPaf os seguintes parâmetros devem ser verificados no
Configurador:

Passo 01 – Acessar o Configurador e renovar a licença
Acessar o Configurador e ir à Aba PAF > PAF-ECF

Gerar nova requisição de licença e enviar para o Suporte OPaf para que possa ser

enviada licença de uso da versão 4.1.0.0.

Salvar a licença enviada pelo Suporte OPaf em C:\OPaf\Configurador.

Acessar o Configurador e importar a licença.

Passo 02 – Verifique suas tabelas de preço
Acessar o Configurador e ir à Aba > PAF > Tabelas de Preço
Caso na instalação do OPaf antes da ATUALIZAÇÃO tenha sido realizado cadastro de Tabelas de Preço
com caracteres MINÚSCULOS deverá ser realizado OBRIGATÓRIAMENTE exclusão das tabelas de preço
e posteriormente realizar NOVO CADASTRO para padronizar os caracteres em MAIÚSCULO.

Clique em EXCLUIR TODOS OS PREÇOS DOS PRODUTOS e posteriormente envie novo arquivo de
remessa com os preços dos produtos para as novas tabelas de preço cadastradas.

12

Passo 03 – Configure somente 01 pasta mestre de integração PMI
Se a sua instalação já estiver utilizando corretamente o ambiente de configuração da PMI, você poderá
seguir diretamente para o Passo 05, se o seu ambiente ainda não está devidamente configurado, siga as
instruções abaixo.

O que difere entre esse tipo de ambiente e os ambientes de instalação com apenas um terminal é que a
PMI (MONITORA) deve ser configurada de forma unificada para o estabelecimento (CNPJ), conforme
demonstra a Figura 03.

Figura 03 – Forma CORRETA de configurar a PMI

Deve ser utilizada apenas uma pasta MONITORA para integração (Envio e recebimento de dados) dos
arquivos para todos os PDVs do estabelecimento.

Passo 04 – Parametrize o OPaf para funcionar corretamente
Por meio das informações geradas na Licença de uso do OPaf um PDV deverá ser definido como
CONCENTRADOR com o objetivo de centralizar todas as informações de movimentação do
estabelecimento.

No momento em que for enviada a requisição de licença para o Suporte OPaf deve ser informado que
a mesma se refere a uma instalação em ambiente com mais de um OPaf no mesmo estabelecimento
(CNPJ), dessa forma será definido na licença um único concentrador para todos os OPaf instalados.
13

Para que todos os PDVs possam ter acesso à mesma pasta MONITORA a seguinte configuração deve ser
realizada:

Figura 04 – Configuração da Aba PAF > Integração

Aba PAF > Integração

Campo > Pasta Mestre de Integração:
o

No exemplo da Figura 03 foi criada e compartilhada pasta denominada

INTEGRAÇÃO na raiz do sistema OPaf Concentrador (C:\OPaf\INTEGRAÇÃO).
o

O campo Pasta Mestre de Integração deve ser preenchido com o caminho do

compartilhamento da PMI.
o

No exemplo da Figura 04 foi preenchido como \\192.168.1.1\INTEGRAÇÃO.

o

O IP 192.168.1.1 representa o caminho de localização do computador onde está

instalado o OPaf definido como CONCENTRADOR.
o

Para os demais PDVs onde o OPaf está instalado o campo Pasta Mestre de

Integração deverá ser preenchido com o mesmo caminho \\192.168.1.1\INTEGRAÇÃO.
o

Com isso a configuração do campo Pasta Mestre de Integração será definida de

forma padrão para todos os PDVs que possuem o OPaf instalado inclusive o
Concentrador.
14

Com a padronização da configuração do campo Pasta Mestre de Integração todos os
PDVs estarão realizando a integração por meio da mesma pasta MONITORA. Ao
executar o Integrador de cada PDV, o Integrador das instalações do CONCENTRADOR e
dos PDVs estarão comunicando com o mesmo caminho definido no configurador.

Conexão Com Concentrador

Campo > BD do Concentrador (DAV / Pré-Venda)
o

Para o OPaf que for definido como CONCENTRADOR após a importação da

licença esse campo estará desabilitado.
o

Para o OPaf que não for Concentrador o campo estará habilitado, deverá ser

definido no campo o caminho de rede para comunicação com o banco de dados do OPaf
Concentrador.
Por exemplo: Conforme a Figura 03 o PDV Concentrador possui IP
192.168.1.1.
Seguindo o exemplo para o OPaf que não for Concentrador, o campo BD
do

Concentrador

deverá

ser

preenchido

com

192.168.1.1:C:\OPaf\BD\OPAF.FDB.
Assim todos os PDVs estarão comunicando com o OPaf Concentrador.
Após realizar a comunicação é possível clicar no ícone Testar para
verificar se a comunicação com o OPaf Concentrador está funcionando
corretamente.

Passo 05 – Verifique as configurações do Firewall
Para que a comunicação com o OPaf Concentrador funcione corretamente é obrigatório que o
computador tenha definido no Firewall regra permitindo acesso a Porta 3050 do Firebird ou que o
Firewall esteja desativado.

15

Atualização do ODav e OPv em terminais
Atualizando o ODav e OPv
Após atualizar o sistema OPaf onde está localizado o aparelho Emissor de Cupom Fiscal – ECF para que
os aplicativos ODav e OPv existentes em Terminal também sejam atualizados os seguintes
procedimentos devem ser realizados:

Download do Atualizador de Executáveis OPaf
Realize o DOWNLOAD do ATUALIZADOR DE EXECUTÁVEIS e salve-o na pasta de instalação do OPaf
(C:\OPaf). Para obter as informações necessárias, acesse a Gestão de Conhecimento na Central de
Atendimento e localize o Item 2.4.1.5.4 - Atualizador de Executáveis OPaf 4.1.0.0.

Executando o Atualizador de executáveis OPaf
Passo 01 – Executando
Execute o atualizador OPaf no terminais de acesso.

Passo 02 – Avance
Clique em avançar e em seguida Insira a senha fornecida pela ID Brasil.

Passo 03 – Senha para atualização de executáveis
Utilize a senha: 4430294327

Passo 04 – Selecione o local da instalação
Confirmar Local de Destino. (Por padrão deve ser instalado em C:\OPaf).

Passo 05 – Qual o caminho no menu iniciar do Windows?
Identificação da Pasta no Menu Iniciar.

Passo 06 – O que será instalado?
Selecionar e confirmar os programas a serem instalados.

Criar um ícone na Área de trabalho: Se você deseja a criação automática dos ícones no

desktop do seu cliente final.
16

Atualizar Opaf: Software de propriedade da ID Brasil Sistemas que agrega funcionalidade

de emissão de cupons fiscais e integração.

Atualizar ODav: Software que permite a digitação de DAV gravando automaticamente

no banco de dados do Opaf para posterior faturamento no OPaf.

Atualizar Opv: Software que permite a digitação de PRÉ-VENDA gravando

automaticamente no banco de dados do Opaf para posterior faturamento no OPaf.

Atualizar Configurador: Software que permite realizar a parametrização do OPaf.

Atualizar Integrador: Software que permite a integração entre o SG e o OPaf.

Atualizar OGestao: Software que permite realizar consultas, cadastros e gestão de dados

do OPaf.

Atualizar WSOPaf: Software que permite a integração entre o SG e o OPaf via

webservice.

Passo 07 – Instale
Clique em Instalar para continuar o processo.

Passo 08 – Conclua a atualização
Por fim clique em Concluir para finalizar a atualização.

Informações importantes
Para que a integração funcione corretamente é essencial que todas as configurações sejam realizadas
conforme as instruções acima.

Para que o recurso de Atualização de Movimentação do Estabelecimento do MENU FISCAL funcione
corretamente é obrigatório que todos os PDVs que possuem o OPaf instalado tenham todos os produtos
cadastrados de forma idêntica, ou seja, se por exemplo o OPaf 1 possui 10 cadastros de produto o OPaf
2 também deve possuir os mesmos 10 produtos cadastrados.

Após a atualização do OPaf deverá ser enviada novamente Remessa de dados completa para
certificação da validade do novo layout.

17

Após as configurações serem efetuadas corretamente, a atualização de movimentação do
estabelecimento disponível no MENU FISCAL do OPaf poderá ser efetuada somente no PDV
CONCENTRADOR.

18

19