Escolar Documentos
Profissional Documentos
Cultura Documentos
Manual de Atualização/Configuração
Versão 7.0 - 2021/2022
Versão 7.0 1
Manual de Configuração
Sumário
1 Introdução ................................................................................................... 4
Versão 7.0 2
Manual de Configuração
7 Informações técnicas......................................................................................57
Versão 7.0 3
Manual de Configuração
1 Introdução
Este documento tem como objetivo capacitar e orientar os usuários administradores do
sistema Totvs/Protheus a realizar a atualização da ferramenta, realizar a configuração do
certificado digital e configurar os parâmetros do Wizard de Configuração.
Como pré-requisito é importante ter conhecimento na ferramenta VSCode para aplicação
do pacote.
Versão 7.0 4
Manual de Configuração
Deste modo foi desenvolvida a Central XML, uma ferramenta que agiliza o processo de lançamento
de notas ficais eletrônicas, conhecimentos de transportes eletrônico e notas fiscais de serviço
através do preenchimento automático da maioria das informações, garantindo a integridade dos
documentos pela possibilidade da realização do download do XML direto do site da Sefaz ou
realizar a importação do xml através do recebimento por e-mail enviado pelo fornecedor.
Versão 7.0 5
Manual de Configuração
3 Fluxo de Atualização
Versão 7.0 6
Manual de Configuração
Versão 7.0 7
Manual de Configuração
Conecte-se no ambiente, configurado anteriormente, que foi escolhido para aplicação do pacote,
este ambiente deve estar totalmente exclusivo (sem nenhum usuário conectado).
Versão 7.0 8
Manual de Configuração
Depois de realizada a conexão, clique com o botão direito do mouse em cima do arquivo do
pacote salvo e clique em Patch Apply from file (Aplicar pacote do arquivo).
Versão 7.0 9
Manual de Configuração
Caso haja contrário será apresentada a mensagem “Start build error:...” e a causa do erro, neste
exemplo, não foi possível obter acesso exclusivo ao repositório de objetos (rpo).
Versão 7.0 10
Manual de Configuração
Acessar o sistema, com um usuário com perfil de administrador, no módulo onde foi instalada a
rotina da Central XML, geralmente, no ambiente de Compras – SIGACOM (02) > Atualizações >
Central XML > Gerenciador Central XML.
Se não houver nenhuma configuração a ser alterada na atualização a ser feita, no Wizard de
configuração, avance por todas as etapas até a última.
Versão 7.0 11
Manual de Configuração
Na última etapa será apresentada a tela para criação / atualização das tabelas da ferramenta.
Atenção, para que a ferramenta possa realizar a atualização, é necessário que neste momento
não haja nenhum usuário ou Job acessando as tabelas da Central XML, ou seja, o acesso à
ferramenta deve ser exclusivo.
Clique em SIM para que seja feita a atualização completa. Caso não seja realizado este processo,
ao acessar a ferramenta pode ocorrer uma série de erros devido a divergências entre as instruções
do programa e o dicionário de dados.
Sendo assim, a execução do Wizard de Configuração torna-se obrigatória toda vez que haja
necessidade de atualização da ferramenta.
Versão 7.0 12
Manual de Configuração
Como forma de validação da atualização é possível observar a data da versão da Central XML
localizada no Menu Inicial no rodapé à direita. Esta deve estar com a mesma data informada na
nomenclatura da patch recebida.
Versão 7.0 13
Manual de Configuração
A tela inicial apresentada no Wizard traz a tela de „Boas Vindas‟ com a informação da versão do
programa, neste caso V7.0.
Versão 7.0 14
Manual de Configuração
Para que haja redundância dos dados, ou seja, a duplicação de componentes para garantir serviço
ininterrupto e evitar falha no recebimento dos XML, a configuração do e-mail é obrigatória.
Com esse recurso é possível assegurar o recebimento dos XML mesmo que haja indisponibilidade
ou conexão intermitente dos WebServices da Secretaria da Fazenda, o e-mail fará a captura dos
XML (NFe, CTe e NFSe) enviados pelos fornecedores via e-mail.
Como premissa é necessário realizar a criação de um e-mail exclusivo para a ferramenta, pois
esta, ao acessar a caixa de entrada para realizar a baixa, faz a exclusão de todos os e-mails
recebidos sendo inviável a utilização do e-mail por um colaborador.
Versão 7.0 15
Manual de Configuração
smtp.seudominio.com.br
587
seuemail@seudominio.com.br
suasenha
seuemail@seudominio.com.br
Quando a hospedagem for contratada de terceiros, será necessário solicitar a informação das
configurações para os mesmos.
Versão 7.0 16
Manual de Configuração
A ferramenta irá validar as informações inseridas apresentando a mensagem abaixo com retorno
de sucesso ou falha. E também fará um disparo de e-mail teste.
Atenção, caso não possua as informações de e-mail ou não queira utilizar o recurso basta
clicar em avançar para a próxima janela sem o preenchimento dos campos.
Versão 7.0 17
Manual de Configuração
pop.seudominio.com.br
995
seuemail@seudominio.com.br
suasenha
Quando a hospedagem for contratada de terceiros, será necessário solicitar a informação das
configurações para os mesmos.
Versão 7.0 18
Manual de Configuração
A ferramenta irá validar as informações inseridas apresentando a mensagem abaixo com retorno
de sucesso ou falha.
Atenção, caso não possua as informações de e-mail ou não queira utilizar o recurso basta
clicar em avançar para a próxima janela sem o preenchimento dos campos.
Versão 7.0 19
Manual de Configuração
Nesta etapa há uma série de configurações e parâmetros que permitem utilizar recursos que
podem auxiliar os processos dos usuários e processos gerenciais no dia a dia. A seguir
detalharemos cada um dos itens.
Caso não seja preenchido, vai permitir a classificação por todos os usuários.
Versão 7.0 20
Manual de Configuração
ID Usuários Compras?
Neste parâmetro é possível escolher quais os usuários poderão realizar o lançamento da prenota
caso seja necessário fazer esta limitação. Para configuração, deverão ser inseridos os códigos dos
usuários separados por „#‟ cerquilha. Exemplo: 000001#000006#000027.
Caso não seja preenchido, vai permitir o lançamento da prenota por todos os usuários.
Caso não seja preenchido, vai permitir a alteração do pedido de compras por todos os usuários.
Versão 7.0 21
Manual de Configuração
Versão 7.0 22
Manual de Configuração
Produto de Frete?
Caso haja um produto de Conhecimento de Transporte padrão utilizado pela empresa, o mesmo
deverá ser inserido neste parâmetro. Se preenchido, todos os XML de CTe carregarão este código
automaticamente.
Exemplo:
Versão 7.0 23
Manual de Configuração
A ferramenta pode receber XML tanto de fornecedores quanto devolução de clientes, esse
parâmetro foi criado para diferir quando a nota for considerada de fornecedor ou cliente. Nesse
campo se houver mais de um CFOP deve ser separado por „#‟ cerquilha.
Caso este parâmetro estiver desabilitado, o usuário sempre será obrigado a realizar a
consulta da Chave de acesso na Sefaz para validação do XML na classificação do
documento. Orientamos manter o parâmetro padrão MV_CHVNFE = .T., desta forma, o parâmetro
da Central XML não será considerado respeitando o parâmetro padrão.
Versão 7.0 24
Manual de Configuração
Versão 7.0 25
Manual de Configuração
Manifesta Automaticamente?
Esse parâmetro define se o sistema irá realizar automaticamente o manifesto de Confirmação da
Operação da Nota Fiscal-após classificação do documento.
Orientamos a análise junto à contabilidade para ativação deste recurso, pois o mesmo
confirma para a SEFAZ (Secretaria da Fazenda) que os produtos foram recebidos
corretamente.
Versão 7.0 26
Manual de Configuração
Para o funcionamento desse recurso a tag <cEAN> do arquivo XML deve estar preenchida e
no cadastro do produto deve estar com o mesmo código do arquivo XML.
A Central XML mantém por padrão um backup de todos os XML recebidos no diretório da
Protheus_Data > Central XML > XML > CT-e.
Versão 7.0 27
Manual de Configuração
Versão 7.0 28
Manual de Configuração
Chama Executável: Essa opção possibilita ao usuário a chamada de uma aplicação instalada
individualmente na máquina do usuário como, por exemplo, o software Danfe View.
Imprime PDF: Impressão em formato PDF padrão da ferramenta utilizando WebService.
Versão 7.0 29
Manual de Configuração
Versão 7.0 30
Manual de Configuração
Esse parâmetro tem um vínculo com o filtro inicial “Visualizar todas as Empresas” ou “apenas a
empresa” que foi feito o login. Para visualizar a nota fiscal e o lançamento de outra filial será
necessário selecionar “Todas as Empresas”.
Versão 7.0 31
Manual de Configuração
Versão 7.0 32
Manual de Configuração
Para o funcionamento deste recurso a tag <cEAN> do arquivo XML deve estar preenchida
e no cadastro do produto deve estar com o mesmo código do arquivo XML.
Estornar Prenota?
Esse parâmetro emite o manifesto de operação não realizada quando o usuário realiza a exclusão
da Prenota.
Orientamos a análise junto à contabilidade para ativação deste recurso, pois este
confirma para a SEFAZ que a operação da venda não foi realizada.
Versão 7.0 33
Manual de Configuração
Destinatário do estorno?
Este parâmetro define quais são os e-mails que receberão um alerta para informar os estornos
realizados.
Confere e Alerta?
Este parâmetro irá apresentar um alerta na tela para informar quando houver divergências entre
os impostos vindos do XML e a TES informada na linha do produto na Central XML.
Versão 7.0 34
Manual de Configuração
Versão 7.0 35
Manual de Configuração
Esta etapa apresenta a configuração do certificado digital que é utilizado para realizar a baixa dos
documentos através do TSS com as conexões dos WebServices. Essa configuração é imprescindível
para download dos XML. Também há duas configurações para Notas Fiscais de Serviço.
Versão 7.0 36
Manual de Configuração
Clique no botão „Procurar‟. Será apresentada uma tela para navegação dos diretórios do servidor.
Versão 7.0 37
Manual de Configuração
Deve ser localizada a pasta „certs‟ do diretório do TSS que contém os arquivos extraídos dos
certificados configurados no Protheus no módulo do Faturamento. Clique na pasta para selecioná-
la e depois em „Abrir‟.
Neste momento a ferramenta fará a cópia de todos os arquivos .pem do diretório „certs‟ do TSS
para o diretório „cerconf‟ localizado no Protheus_data > centralxml > cerconf.
Para que seja possível a utilização desta opção o TSS - TOTVS® SERVICE SOA, serviço que
responde e realiza requisições de serviços WebService, deve estar instalado no mesmo
servidor que o sistema.
Versão 7.0 38
Manual de Configuração
Será apresentada a tela para informar o tipo de certificado digital, o arquivo do certificado digital
e a senha.
Versão 7.0 39
Manual de Configuração
Observe que ao selecionar o arquivo do lado direito, o nome do arquivo é preenchido. Clique em
abrir.
Insira a senha e clique em confirmar, neste momento a ferramenta irá extrair os arquivos do
certificado para o diretório da Central XML na Protheus_Data.
Versão 7.0 40
Manual de Configuração
Feito este processo, a ferramenta está pronta para o sincronismo e baixa dos documentos.
Versão 7.0 41
Manual de Configuração
Versão 7.0 42
Manual de Configuração
Os parâmetros abaixo são do módulo do BPO que tem a finalidade de escriturar as Notas Fiscais de
saída, é utilizado geralmente por contabilidades externas.
Versão 7.0 43
Manual de Configuração
Versão 7.0 44
Manual de Configuração
Versão 7.0 45
Manual de Configuração
Caso tenha interesse em conhecer esta facilidade, entre em contato com a equipe do
comercial!
Versão 7.0 46
Manual de Configuração
Na última etapa será apresentada a tela para criação / atualização das tabelas da ferramenta.
Se estiver sendo aplicada uma nova patch para atualização da ferramenta será necessário
criar/atualizar as tabelas da Central XML, neste caso clique em SIM. Atenção, para que a
ferramenta possa realizar a atualização, é necessário que neste momento não haja nenhum
usuário ou Job acessando as tabelas da Central XML, ou seja, o acesso à ferramenta deve ser
exclusivo. Se este processo não for realizado na atualização, ao acessar a ferramenta pode
ocorrer uma série de erros devido a divergências entre as instruções do programa e o dicionário
de dados.
Sendo assim, a execução do Wizard de Configuração torna-se obrigatória toda vez que haja
necessidade de atualização da ferramenta. Se ocorrer a atualização corretamente do dicionário
de dados, será apresentada uma tela com a mensagem “Processo Finalizado com Sucesso”.
Versão 7.0 47
Manual de Configuração
Como forma de validação da atualização é possível observar a data da versão da Central XML
localizada no Menu Inicial no rodapé à direita. Esta deve estar com a mesma data informada na
nomenclatura da patch recebida.
Versão 7.0 48
Manual de Configuração
6 Configuração de Jobs
É possível criar um JOB (serviço automático) para realizar a sincronização e baixa automática dos
XMLs através da conexão com os servidores da SEFAZ (Secretaria da Fazenda).
Este recurso viabiliza a baixa com maior agilidade, pois as requisições são enviadas de maneira
automática sem a interferência do usuário, de maneira que, quando o fornecedor fizer a emissão
do documento e este estiver disponível no ambiente nacional (AN) da Sefaz, a Central XML irá
realizar a requisição da baixa através da conexão do TSS (utilizando o certificado digital) com os
WebServices da Secretaria da Fazenda.
Este recurso não é obrigatório, porém é recomendado para que haja menos processos e maior
facilidade para aquisição do XML.
Como boas práticas, orientamos a criação de um novo serviço do Protheus (Application Server)
exclusivo para o JOB. Para executar essa atividade siga os procedimentos a seguir:
Atenção, estes procedimentos devem ser feitos por um profissional da equipe de TI que
tenha experiência com manutenção do sistema TOTVS Protheus. Caso haja alguma
dificuldade para configuração, não deixe de acionar a nossa equipe de Suporte.
Versão 7.0 49
Manual de Configuração
Para a baixa/download das Notas Fiscais Eletrônicas a Central XML necessita realizar o manifesto
da Ciência da Operação. Por este motivo, recomendamos a análise junto à contabilidade, para
averiguar se os manifestos podem ser realizados sem que prejudique o processo da empresa.
O Job funciona por grupo de empresa, ou seja, para cada empresa será necessário uma nova
configuração.
;===============================================
;Schedule Baixar XML NF-E (Central XML) EMP 01
;===============================================
Comentário para identificar a configuração do Job no appserver.ini.
[CEX_NF_JOB_01]
Nome do Job, este pode ser alterado, exemplo „JOB_NFE_EMP01‟.
main=U_CEXMMDEJB
Nome da função, não pode ser alterada.
environment=CENTRALXML
Informar o mesmo ambiente configurado anteriormente neste Application Server.
nParms=2
Quantidade de parâmetros utilizados, não pode ser alterado.
Parm1=XX
Código do Grupo de Empresa, por exemplo „01‟.
Parm2=XX;XX;
Código das Filiais do Grupo de Empresa, por exemplo: „01‟. Para adicionar mais de uma filial,
separe por ponto e vírgula „01;02;03„.
Após configuração, inserir o nome do(s) Job(s) na TAG [ONSTART] como no exemplo abaixo:
[ONSTART]
JOBS= CEX_NF_JOB_01, CEX_NF_JOB_02,... - separado por vírgula.
Refreshrate=3600 - Intervalo de tempo em segundos entre um sincronismo e o outro.
Versão 7.0 50
Manual de Configuração
;===============================================
;Schedule Baixar XML NF-E (Central XML) EMP 02
;===============================================
[CEX_NF_JOB_02]
main=U_CEXMMDEJB
environment=CENTRALXML
nParms=2
Parm1=02
Parm2=01;
[ONSTART]
JOBS= CEX_NF_JOB_01, CEX_NF_JOB_02
Refreshrate=3600
Versão 7.0 51
Manual de Configuração
O Job funciona por grupo de empresa, ou seja, para cada empresa será necessário uma nova
configuração.
;===============================================
;Schedule Baixar XML CT-E (Central XML) EMP 01
;===============================================
Comentário para identificar a configuração do Job no appserver.ini.
[CEX_CT_JOB_01]
Nome do Job, este pode ser alterado, exemplo „CEX_CTE_EMP01‟.
main=U_CEXMCTEJB
Nome da função, não pode ser alterada.
environment=CENTRALXML
Informar o mesmo ambiente configurado anteriormente neste Application Server.
nParms=2
Quantidade de parâmetros, não pode ser alterado.
Parm1=XX
Código do Grupo de Empresa, por exemplo „01‟.
Parm2=XX;XX;
Código das Filiais do Grupo de Empresa, por exemplo: „01‟. Para adicionar mais de uma filial,
separe por ponto e vírgula „01;02;03„.
Após configuração, inserir o nome do(s) Job(s) na TAG [ONSTART] como no exemplo abaixo:
[ONSTART]
JOBS= CEX_NF_JOB_01,…, CEX_CT_JOB_01,... - separado por vírgula.
Refreshrate=3600 - Intervalo de tempo em segundos entre um sincronismo e o outro.
Versão 7.0 52
Manual de Configuração
[ONSTART]
JOBS= CEX_NF_JOB_01,CEX_NF_JOB_02, CEX_CT_JOB_01
Refreshrate=3600
Versão 7.0 53
Manual de Configuração
O Job de e-mail, diferentemente dos anteriores, não será necessária configuração por empresa.
;===============================================
; Schedule Baixar XML por Email (Central XML)
;===============================================
Comentário para identificar a configuração do Job no appserver.ini.
[JB_MAILCENT]
Nome do Job, este pode ser alterado, exemplo „CEX_JOB_EMAIL‟.
main=U_CEXMJBMAI
Nome da função, não pode ser alterada.
environment=CENTRALXML
Informar o mesmo ambiente configurado anteriormente neste Application Server.
nParms=2
Quantidade de parâmetros, não pode ser alterado.
Parm1=01
Código do Grupo de Empresa, por exemplo „01‟.
Parm2=01
Código das Filiais do Grupo de Empresa, por exemplo: „01‟.
Após configuração, inserir o nome do(s) Job(s) na TAG [ONSTART] como no exemplo abaixo:
[ONSTART]
JOBS= CEX_NF_JOB_01,…, CEX_CT_JOB_01,…,CEX_NFS_JOB_01,..., JB_MAILCENT - separado
por vírgula.
Refreshrate=3600 - Intervalo de tempo em segundos entre um sincronismo e o outro.
Versão 7.0 54
Manual de Configuração
[ONSTART]
JOBS= CEX_NF_JOB_01,CEX_NF_JOB_02, CEX_CT_JOB_01,CEX_NFS_JOB_01,JB_MAILCENT
Refreshrate=3600
Versão 7.0 55
Manual de Configuração
Após criação do novo Application Server com a configuração dos Jobs no appserver.ini, crie um
atalho do aplicativo Appserver.exe e, com o botão direito do mouse, clique em propriedades.
Insira ‟-CONSOLE‟ (após o „.exe‟). Em seguida execute o mesmo como Administrador, neste
momento será apresentada a execução do JOB em tempo real.
Após a validação do JOB, altere a propriedade do atalho para „–INSTALL‟ (após o „.exe‟). Este
recurso irá instalar este Application Server como serviço no Sistema Operacional conforme nome
definido nas configurações do arquivo „appserver.ini‟.
Na configuração de serviço do Windows, basta definir o serviço do Job como automático para que
seja sempre iniciado junto aos demais serviços do Windows automaticamente Start (Iniciar).
Versão 7.0 56
Manual de Configuração
7 Informações técnicas
A seguir serão disponibilizados alguns tópicos relacionados à estrutura, parâmetros e informações
restritas à ferramenta.
BPO:
RECNFBPO – Tabela do cabeçalho;
RECNFBPOITENS – Tabela dos itens.
Outras:
RECNFLOGE - Tabela de registro de Log Central XML;
RECNFSINCXM - Tabela de registro de integração de XML;
RECNFSTATUS – Registro das informações do botão „Status‟.
Versão 7.0 57
Manual de Configuração
Versão 7.0 58
Manual de Configuração
Versão 7.0 59
Manual de Configuração
Os parâmetros abaixo não são apresentados no Wizard de Configuração da ferramenta, devem ser
alterados diretamente pelo Configurador do Protheus.
Zipa Retorno do WS
O parâmetro XM_COMPXML foi criando visando a redução de espaço de arquivo XML no servidor
na pasta Protheus_Data/centralxml. Quando o parâmetro for habilitado, os arquivos serão zipados
(comprimidos) liberando espaço no disco rígido (HD).
Versão 7.0 60
Manual de Configuração
Este parâmetro deve ser criado manualmente pelo configurador SIGACFG e parametrizado
conforme a necessidade da empresa. Para o funcionamento, a Central XML deve estar
sempre atualizada com a ultimar versão.
Versão 7.0 61
Manual de Configuração
A seguir estão listados alguns parâmetros padrões do Protheus que podem ser utilizados para
configuração de regras em conjunto com a ferramenta.
Chave de acesso
MV_CHVNFE = .T.
Habilita a consulta da chave de acesso na Sefaz para verificar a validade do XML para Notas Fiscais
e Conhecimentos de Transporte no documento de entrada.
MV_DCHVNFE = .T.
Obriga a digitação da chave de Notas Fiscais e Conhecimentos de Transporte caso a espécie seja
SPED ou CTE e Formulário Próprio=NÃO, no Documento de Entrada.
MV_VCHVNFE =.T.
Verifica se o CNPJ constante na chave bate com o CNPJ do fornecedor informado na nota e se o
número e a série constante na chave batem com o número e série digitados na nota, caso a
espécie seja SPED ou CTE e Formulário Próprio=NÃO.
MV_BCHVNFE = .T.
Na rotina de documento de entrada, aba Informações do Danfe, ao informar uma chave NF-e
inválida no cenário de Internet não conectada, é permitido a gravação do documento de entrada .
Diante da impossibilidade de validar a chave NF-e sem uma conexão com a SEFAZ, foi criado o
parâmetro MV_BCHVNFE para informar se a chave NF-e deve ser gravada ou o campo F1_CHVNFE
retornado para branco, caso não exista uma internet conectada.
Versão 7.0 62
Manual de Configuração
Pedido de Compras
MV_PCNFE
Obriga a amarração do pedido de compra no Documento de Entrada. Pode ser configurado com:
T (True) – Amarração obrigatória.
F (False) – Amarração não obrigatória.
MV_TESPCNF
Caso o parâmetro MV_PCNFE estiver habilitado, pode ser utilizado o parâmetro MV_TESPCNF para
informar ao sistema exceções de lançamentos, ou seja, sem a amarração do pedido de compras.
Sendo assim, basta informar os Tipos de Entrada e Saída (TES) que não necessitam da amarração
com o pedido de compras, como por exemplo, uma devolução de venda.
MV_ALTPRCC
Permite configurar se o preço unitário do produto pode ser alterado, no registro da entrada da
nota fiscal ou na inclusão da autorização de entrega, mesmo quando os valores já foram
informados no pedido compras, na autorização de entrega ou no contrato de parceria.
1 – Valida o preço informado no pedido de compras, ou seja, no registro da entrada da nota fiscal
(rotina Documento de Entrada) ou na Classificação da Prenota. Não permite alteração no preço
unitário do produto quando relacionado a um pedido de compras.
Versão 7.0 63
Manual de Configuração
Versão 7.0 64