Manual de Integrao OPaf

Manual de Atualizao

Layout de Integrao 010

Aplicvel verso 4.1.0.0 e demais releases da sute de aplicativos OPaf
OPaf marca registrada da ID Brasil Sistemas Ltda
1

Ol! Este o seu manual...

Este manual visa orientar a execuo de servios destinados a integrao do software OPaf, de
propriedade da ID Brasil Sistemas Ltda, com o sistema de gesto (SG) do Parceiro Integrador.

A comunicao entre os sistemas um processo relativamente simples, todavia, mudanas nos detalhes
podem levar a resultados inesperados. Assim fundamental que todas as orientaes desse manual
sejam seguidas risca para evitar transtornos e situaes inesperadas.

Sugestes 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 sugestes
sero bem vindas e nos auxiliam a deixar o nosso material cada vez melhor.

Este manual parte integrante do Software OPaf, e sua utilizao para fins no autorizados sujeita o
Parceiro Integrador s responsabilidades previstas em lei.

ndice
Instrues para atualizao .......................................................................................................................... 4
Atualizao do OPaf com apenas 01 OPaf instalado .................................................................................... 5
Atualizando o OPaf ................................................................................................................................... 5
Informaes importantes antes da Atualizao ....................................................................................... 5
Alteraes na estrutura da Pasta de Instalao ................................................................................... 5
Verificaes antes da Atualizao ............................................................................................................ 5
Alteraes na estrutura da Pasta de Instalao ................................................................................... 5
Faa um backup e apague a sua PASTA MESTRE DE INTEGRAO ...................................................... 6
Certifique-se de que o Firebird est funcionando corretamente ........................................................ 6
Adeque os cadastros de produtos para manter o padro correto ....................................................... 6
Nunca execute o atualizador com aplicativos da sute OPaf abertos .................................................. 6
Sempre mantenha a movimentao atualizada ................................................................................... 7
Download do Atualizador OPaf ............................................................................................................ 7
Executando o Atualizador OPaf ................................................................................................................ 7
Observaes importantes......................................................................................................................... 9
Configurando o OPaf aps a atualizao .................................................................................................. 9
Atualizao do OPaf com mais de 01 OPaf instalado ................................................................................. 10
Atualizando o OPaf ................................................................................................................................. 10
Informaes importantes antes da Atualizao ..................................................................................... 10
Configurando o ambiente corretamente ........................................................................................... 10
Seu cliente emite DAV ou Pr-venda? ................................................................................................ 12
Configurando o OPaf aps a atualizao ................................................................................................ 12
Atualizao do ODav e OPv em terminais .................................................................................................. 16
Atualizando o ODav e OPv ...................................................................................................................... 16
Download do Atualizador OPaf .............................................................................................................. 16
Executando o Atualizador de executveis OPaf ................................................................................. 16
Informaes importantes ....................................................................................................................... 17

Instrues para atualizao

O objetivo das instrues contidas neste documento o de informar os procedimentos necessrios para
realizar a correta ATUALIZAO do sistema OPaf em cliente que j possui OPaf instalado em seu
estabelecimento nas verses anteriores a verso 4.1.0.0, abaixo a relao das verses:

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 verso 4.1.0.0 possui novos recursos como, por exemplo, gerao de Nota Fiscal Eletrnica, novo
mdulo para utilizao de TEF Dedicado Scope e o sistema bsico de gesto OGesto. Possui tambm
correo de algumas rotinas j existentes em verses anteriores, para mais informaes verifique o Item
2.3.1.1 Alteraes da verso disponvel em nossa Base de Conhecimento.

IMPORTANTE: Alguns estados exigem documentao informando a atualizao do OPaf em verso

anterior para verso 4.1.0.0, qualquer dvida relacionada s documentaes devem ser verificadas
diretamente com o Setor Administrativo da ID Brasil ou pela nossa Gesto de Conhecimento.

Para obter as informaes necessrias, acesse a Gesto de Conhecimento na Central de Atendimento e

localize o Item 5.3 - Documentao necessria para novo cliente.

Verifique a documentao necessria separada pelo seu estado (UF) antes de realizar a atualizao.

Atualizao 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 atualizao do sistema deve ser realizada conforme as seguintes instrues:

Informaes importantes antes da Atualizao

Alteraes na estrutura da Pasta de Instalao
O OPaf 4.1.0.0 possui estrutura de instalao seguindo as diretrizes da verso base (OPaf 3.0.0.0) e
consequentemente diferente das verses anteriores verso OPaf 3.0.0.0.

Por padro a instalao para verses anteriores a 3.0.0.0 cria pasta denominada ID Brasil localizada
em Arquivos de Programas do sistema operacional. Esta pasta contm as pastas INTEGRADOR e
CONFIGURADOR.

Aps realizar a atualizao para o OPaf 3.0.0.0 ou OPaf 3.1.0.0, a pasta ID Brasil no ser mais
apresentada em Arquivos de Programas, uma vez que a partir dessa verso o OPaf passa a criar as
pastas INTEGRADOR e CONFIGURADOR no local padro de instalao do OPaf (C:\OPaf), concentrando
todos os recursos vinculados ao OPaf em uma nica pasta.

Verificaes antes da Atualizao

Estrutura da Pasta de Instalao
Para que a atualizao funcione corretamente OBRIGATRIO que o OPaf esteja instalado de forma
PADRO 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.

Faa um backup e apague a sua PASTA MESTRE DE INTEGRAO

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 atualizao do OPaf e
execuo do Integrador a pasta MONITORA ser criada novamente automaticamente no mesmo local j
indicado na aba Integrao do Configurador.

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

Certifique-se de que o Firebird est funcionando corretamente

O Firebird instalado no computador em modo SERVIO deve estar OBRIGATORIAMENTE na verso
2.0.3, verso PADRO de utilizao OPaf. Se o Firebird que estiver sendo executado em modo SERVIO
no sistema operacional no estiver na verso 2.0.3 o ATUALIZADOR OPaf NO FUNCIONAR
CORRETAMENTE e com isso dever ser realizada instalao correta do Firebird 2.0.3. Para obter as
informaes necessrias, acesse a Gesto de Conhecimento na Central de Atendimento e localize o Item
4.3.2 - Firebird.

Adeque os cadastros de produtos para manter o padro correto

A partir da verso 2.1.0.0 o OPaf passa a restringir o Cdigo do Produto (Registro 005 Campo 2) a 14
caracteres para manter compatibilidade com o Sintegra, com isso caso exista produto com cdigo que
possua mais de 14 caracteres necessrio antes de iniciar a atualizao enviar REMESSA inativando o
cadastro desse(s) produto(s).

Nunca execute o atualizador com aplicativos da sute OPaf abertos

O OPaf, Integrador e Configurador NO PODEM estar em execuo no momento em que for realizada a
atualizao do OPaf.

Sempre mantenha a movimentao atualizada

Antes de atualizar o OPaf verifique se no existe movimento de caixa retroativo em aberto. Se existir
efetue o fechamento do dia corretamente para posteriormente realizar a atualizao 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 instalao do OPaf (C:\OPaf\). Para obter as informaes
necessrias, acesse a Gesto 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 instrues abaixo:

Passo 01 Executando o Atualizador

Execute o atualizador OPaf.

Passo 02 Selecione o local para atualizao

Confirmar Local de Destino. (Por padro deve ser instalado em C:\OPaf) e clique em instalar.

Passo 03 Avance
Clique em avanar para continuar a realizar o procedimento.

Passo 04 Senha para atualizao

Utilize a senha: 4430294327

Passo 05 Selecione o local de instalao do OPaf

Confirmar Local de instalao do OPaf. (Por padro deve ser instalado em C:\OPaf).

Passo 06 Verificando a instalao do Firebird?

Neste passo o atualizador OPaf verificar se o Firebird instalado no computador responde ao padres
utilizados.

No campo Diretrio Firebird localize a pasta onde o Firebird 2.0.3 est instalado.

No campo Usurio e Senha informe o usurio e senha do Firebird:

o

Usurio = sysdba

Senha = masterkey

Passo 07 Avance
Clique em avanar para continuar a realizar o procedimento. Neste ponto, sero demonstrados os
processamentos de Scripts de atualizao e QGs de correo no banco de dados. Toda a operao de
atualizao ser demonstrada por meio de barras de status.

Passo 08 Avance
Clique em avanar para continuar a realizar o procedimento.

Passo 09 Selecione o local para instalao

Confirmar Local de Destino. (Por padro deve ser instalado em C:\OPaf).

Passo 10 Qual o caminho no menu iniciar do Windows?

Identificao 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 criao automtica dos cones no

desktop do seu cliente final.

Instalar OPaf: Atualiza a verso corrente do OPaf.

Passo 13 Avance Novamente

Confirme as configuraes realizadas e clique em Instalar.

Passo 14 Aguarde o processo de atualizao dos arquivos

Aguarde a realizao da atualizao dos arquivos para correto funcionamento do OPaf.
Passo 15 Instale o componente da NFe
Finalizada instalao do Firebird ser apresentado por sim a instalao do componente para utilizao
de NF-e, a instalao do mesmo tambm deve ser realizada obrigatoriamente de forma padro.
Passo 16 Conclua a atualizao
Por fim clique em Concluir para finalizar a instalao.
Passo 17 Importao da tabela do IBPT
Aps a finalizao da instalao do OPaf, baixe o item 2.4.1.6.1 - Aplicativo ImportarIBPT e o item
2.4.1.6.2 - Arquivo IBPT para importao da Gesto 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.
Aps importada a tabela ser apresentada a mensagem Arquivo C:\OPaf\IBPTax.csv importado com
sucesso.
8

Clique em OK e finalize o executvel, aps esse processo pode-se dar continuidade a configurao
normalmente.

Observaes importantes
Durante a instalao o sistema dever inserir os arquivos necessrios para que o ECF funcione
corretamente.

Ao realizar esse processo o sistema pode identificar arquivos de inicializao j

existentes no sistema operacional como, por exemplo, Bemafi32.ini, Elgin.ini, etc e solicitar confirmao
para substitu-los. Alguns cuidados devem ser tomados caso o modelo de ECF em uso no
estabelecimento utilize algum arquivo de inicializao, se possuir confirme opo para SUBSTITUIR o
arquivo, lembrando-se de sempre guardar as informaes dos arquivos de INI das fabricantes para
poder reutiliza-las, assim as configuraes de comunicao com o ECF no sero perdidas.

Configurando o OPaf aps a atualizao

Aps realizar a atualizao do sistema OPaf os seguintes parmetros devem ser verificados no
Configurador:

Passo 01 Acessar o Configurador e renovar a licena

Acessar o Configurador e ir Aba PAF > PAF-ECF

Gerar nova requisio de licena e enviar para o Suporte OPaf para que possa ser

enviada licena de uso da verso 4.1.0.0.

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

Acessar o Configurador e importar a licena.

Passo 02 Verifique suas tabelas de preo

Acessar o Configurador e ir Aba > PAF > Tabelas de Preo
Caso na instalao do OPaf antes da ATUALIZAO tenha sido realizado cadastro de Tabelas de Preo
com caracteres MINSCULOS dever ser realizado OBRIGATORIAMENTE excluso das tabelas de preo
e posteriormente realizar NOVO CADASTRO para padronizar os caracteres em MAISCULO.

Clique em EXCLUIR TODOS OS PREOS DOS PRODUTOS e posteriormente envie novo arquivo de
remessa com os preos dos produtos para as novas tabelas de preo cadastradas.
9

Atualizao do OPaf com mais de 01 OPaf instalado

Atualizando o OPaf
As instrues abaixo so para parceiros que J POSSUEM MAIS DE UM SISTEMA OPAF INSTALADO E
EM USO EM UM MESMO ESTABELECIMENTO COMERCIAL (CNPJ). A atualizao dever ser realizada na
sequncia dos procedimentos apresentados abaixo.

Informaes importantes antes da Atualizao

Configurando o ambiente corretamente
Identificamos que alguns parceiros que tem mais de um PDV no mesmo estabelecimento (CNPJ) esto
configurando o sistema de forma INADEQUADA. A PMI (Pasta Mestre de Integrao) estava sendo
configurada individualmente por PDV, conforme Figura 01.

10

Figura 01 Forma ERRADA de configurar a PMI

Isso pode causar perda de informaes e gerao de informaes 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 informaes geradas na Licena de uso do OPaf um PDV dever ser definido como
CONCENTRADOR com o objetivo de centralizar todas as informaes de movimentao do
estabelecimento.

Dever ser utilizada APENAS UMA PASTA MONITORA para integrao (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 VERSO INFERIOR 2.1.0.0, entre em contato com o Suporte OPaf para mais informaes.

Se no emite DAV ou Pr-Venda apenas siga as instrues contidas no tpico Atualizao do OPaf com
apenas 01 OPaf instalado e em seguida o tpico Configuraes aps a atualizao do OPaf.

Configurando o OPaf aps a atualizao

Aps realizar a atualizao do sistema OPaf os seguintes parmetros devem ser verificados no
Configurador:

Passo 01 Acessar o Configurador e renovar a licena

Acessar o Configurador e ir Aba PAF > PAF-ECF

Gerar nova requisio de licena e enviar para o Suporte OPaf para que possa ser

enviada licena de uso da verso 4.1.0.0.

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

Acessar o Configurador e importar a licena.

Passo 02 Verifique suas tabelas de preo

Acessar o Configurador e ir Aba > PAF > Tabelas de Preo
Caso na instalao do OPaf antes da ATUALIZAO tenha sido realizado cadastro de Tabelas de Preo
com caracteres MINSCULOS dever ser realizado OBRIGATRIAMENTE excluso das tabelas de preo
e posteriormente realizar NOVO CADASTRO para padronizar os caracteres em MAISCULO.

Clique em EXCLUIR TODOS OS PREOS DOS PRODUTOS e posteriormente envie novo arquivo de
remessa com os preos dos produtos para as novas tabelas de preo cadastradas.

12

Passo 03 Configure somente 01 pasta mestre de integrao PMI

Se a sua instalao j estiver utilizando corretamente o ambiente de configurao da PMI, voc poder
seguir diretamente para o Passo 05, se o seu ambiente ainda no est devidamente configurado, siga as
instrues abaixo.

O que difere entre esse tipo de ambiente e os ambientes de instalao 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 integrao (Envio e recebimento de dados) dos
arquivos para todos os PDVs do estabelecimento.

Passo 04 Parametrize o OPaf para funcionar corretamente

Por meio das informaes geradas na Licena de uso do OPaf um PDV dever ser definido como
CONCENTRADOR com o objetivo de centralizar todas as informaes de movimentao do
estabelecimento.

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

Para que todos os PDVs possam ter acesso mesma pasta MONITORA a seguinte configurao deve ser
realizada:

Figura 04 Configurao da Aba PAF > Integrao

Aba PAF > Integrao

Campo > Pasta Mestre de Integrao:

o

No exemplo da Figura 03 foi criada e compartilhada pasta denominada

INTEGRAO na raiz do sistema OPaf Concentrador (C:\OPaf\INTEGRAO).

o

O campo Pasta Mestre de Integrao deve ser preenchido com o caminho do

compartilhamento da PMI.
o

No exemplo da Figura 04 foi preenchido como \\192.168.1.1\INTEGRAO.

O IP 192.168.1.1 representa o caminho de localizao 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

Integrao dever ser preenchido com o mesmo caminho \\192.168.1.1\INTEGRAO.

o

Com isso a configurao do campo Pasta Mestre de Integrao ser definida de

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

Com a padronizao da configurao do campo Pasta Mestre de Integrao todos os

PDVs estaro realizando a integrao por meio da mesma pasta MONITORA. Ao
executar o Integrador de cada PDV, o Integrador das instalaes do CONCENTRADOR e
dos PDVs estaro comunicando com o mesmo caminho definido no configurador.

Conexo Com Concentrador

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

o

Para o OPaf que for definido como CONCENTRADOR aps a importao da

licena esse campo estar desabilitado.

o

Para o OPaf que no for Concentrador o campo estar habilitado, dever ser

definido no campo o caminho de rede para comunicao 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 no for Concentrador, o campo BD
do

Concentrador

dever

ser

preenchido

com

192.168.1.1:C:\OPaf\BD\OPAF.FDB.
Assim todos os PDVs estaro comunicando com o OPaf Concentrador.
Aps realizar a comunicao possvel clicar no cone Testar para
verificar se a comunicao com o OPaf Concentrador est funcionando
corretamente.

Passo 05 Verifique as configuraes do Firewall

Para que a comunicao com o OPaf Concentrador funcione corretamente obrigatrio que o
computador tenha definido no Firewall regra permitindo acesso a Porta 3050 do Firebird ou que o
Firewall esteja desativado.

15

Atualizao do ODav e OPv em terminais

Atualizando o ODav e OPv
Aps atualizar o sistema OPaf onde est localizado o aparelho Emissor de Cupom Fiscal ECF para que
os aplicativos ODav e OPv existentes em Terminal tambm sejam atualizados os seguintes
procedimentos devem ser realizados:

Download do Atualizador de Executveis OPaf

Realize o DOWNLOAD do ATUALIZADOR DE EXECUTVEIS e salve-o na pasta de instalao do OPaf
(C:\OPaf). Para obter as informaes necessrias, acesse a Gesto de Conhecimento na Central de
Atendimento e localize o Item 2.4.1.5.4 - Atualizador de Executveis OPaf 4.1.0.0.

Executando o Atualizador de executveis OPaf

Passo 01 Executando
Execute o atualizador OPaf no terminais de acesso.

Passo 02 Avance
Clique em avanar e em seguida Insira a senha fornecida pela ID Brasil.

Passo 03 Senha para atualizao de executveis

Utilize a senha: 4430294327

Passo 04 Selecione o local da instalao

Confirmar Local de Destino. (Por padro deve ser instalado em C:\OPaf).

Passo 05 Qual o caminho no menu iniciar do Windows?

Identificao 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 criao automtica dos cones no

desktop do seu cliente final.

16

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

de emisso de cupons fiscais e integrao.

Atualizar ODav: Software que permite a digitao de DAV gravando automaticamente

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

Atualizar Opv: Software que permite a digitao de PR-VENDA gravando

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

Atualizar Configurador: Software que permite realizar a parametrizao do OPaf.

Atualizar Integrador: Software que permite a integrao entre o SG e o OPaf.

Atualizar OGestao: Software que permite realizar consultas, cadastros e gesto de dados

do OPaf.

Atualizar WSOPaf: Software que permite a integrao entre o SG e o OPaf via

webservice.

Passo 07 Instale
Clique em Instalar para continuar o processo.

Passo 08 Conclua a atualizao

Por fim clique em Concluir para finalizar a atualizao.

Informaes importantes
Para que a integrao funcione corretamente essencial que todas as configuraes sejam realizadas
conforme as instrues acima.

Para que o recurso de Atualizao de Movimentao do Estabelecimento do MENU FISCAL funcione

corretamente obrigatrio que todos os PDVs que possuem o OPaf instalado tenham todos os produtos
cadastrados de forma idntica, ou seja, se por exemplo o OPaf 1 possui 10 cadastros de produto o OPaf
2 tambm deve possuir os mesmos 10 produtos cadastrados.

Aps a atualizao do OPaf dever ser enviada novamente Remessa de dados completa para
certificao da validade do novo layout.

17

Aps as configuraes serem efetuadas corretamente, a atualizao de movimentao do

estabelecimento disponvel no MENU FISCAL do OPaf poder ser efetuada somente no PDV
CONCENTRADOR.

18

19