FACILE XML-e 4.

MANUAL DE INSTALAÇÃO

CONFIDENCIALIDADE: As informações contidas neste documento, sobre os produtos e serviços são de

propriedade imaterial da FACILE SISTEMAS, sendo sua duplicação permitida apenas para uso interno do
CLIENTE, não podendo ser utilizada como fonte de informações a terceiros, bem como todas as informações
fornecidas à FACILE SISTEMAS não podem ser divulgadas, salvo em caso de autorização por escrito de
ambas as partes.
 SUMÁRIO
1. Patch de Programa .............................................................................................................................................. 4
2. Compatibilizadores .............................................................................................................................................. 4
3. Dicionário de Dados ............................................................................................................................................ 5
4. Pontos de Entrada ............................................................................................................................................... 7
MT100TOK - Uso Obrigatório .............................................................................................................................. 7
MT103PN – Uso Obrigatório ................................................................................................................................ 7
MT140PC – Usado em situação especial .......................................................................................................... 8
5. Criando o Menu .................................................................................................................................................... 8
6. Configurando os JOBs ..................................................................................................................................... 14
7. CRIAÇÃO DE PARAMETROS .......................................................................................................................... 16
FIM DA INSTALAÇÃO! ................................................................................................................................................. 16

DISCLAIMER:
Protheus®, ADVPL® e TSS® são produtos e marca registrada de propriedade da TOTVS S.A. A FACILE SISTEMAS é
uma empresa de desenvolvimento independente e não tem nenhum vínculo direto ou indireto com a TOTVS ®,
qualquer uma de suas franquias ou qualquer um de seus representantes.
 1. Patch de Programa

A implantação da ferramenta se inicia com a aplicação do patch de programa no repositório de

programas (RPO) do Protheus.
Caso não possua o patch atualizado da ferramenta, solicite em:
ar@facilesistemas.com.br

2. Compatibilizadores

A ferramenta utiliza tabelas e parâmetros customizados, com isso precisamos executar dois
compatibilizadores para que sejam criados corretamente.
Para aplicação dos compatibilizadores, basta chamar no programa inicial do Protheus:
2.1. Para dicionário (SX) no Banco de Dados:
U_UPDDICBD

2.2. Para dicionário (SX) na System:

U_UPDX004
Após finalizar o UPDX004, execute:
U_UPDX005
Após finalizar o UPDX005, execute:
U_UPDX006

No próximo item (Dicionário) estará detalhado as alterações que os compatibilizadores geram em

seu ERP Protheus.
3. Dicionário de Dados

3.1. Tabela ZZZ – FACILE Central XML-e

CAMPO TIPO TAMANHO DECIMAL TITULO DESCRIÇÃO

ZZZ_FILIAL C 2 Filial Filial do Sistema
ZZZ_SITDOC C 1 Sit. NF-e Situação da Nota Fiscal
ZZZ_STATUS C 1 Manif. Atual Status da Manifestação
ZZZ_DOC C 9 Nota Fiscal Número da Nota Fiscal
ZZZ_SERIE C 3 Serie Serie da Nota Fiscal
ZZZ_EMISNF D 8 Emissão NF Data Emissão da NF
CNPJ
ZZZ_CNPJ C 14 Fornece CNPJ Fornecedor
ZZZ_NOEMIT C 60 Nome/Razão Nome/Razão
ZZZ_CHAVE C 60 Chave NF Chave da Nota Fiscal
ZZZ_CODEVE C 3 Cod.Evento Status do Evento
ZZZ_XML M 10 XML XML
ZZZ_DTRECB D 8 Data Recebto Data de Recebimento
ZZZ_ORIGEM C 1 Origem XML Origem XML
ZZZ_OK C 4 OK OK
ZZZ_VLDOC N 13 2 Valor NF-e Valor NF-e
ZZZ_ANONFE C 4 Ano Emissão Ano Emissão NFe
ZZZ_MESNFE C 2 Mês Emissão Mês Emissão da NFE
ZZZ_IEEMIT C 11 Inscr. Est. Inscrição Estadual emiten
ZZZ_DESRES C 150 Desc.Proces. Descrição do Processament
ZZZ_CODRET C 3 Cod.Process. Status da Resposta
ZZZ_DTREC D 8 Data Aut. Data recebimento
ZZZ_TIPO C 1 Tipo XML Tipo de XML
ZZZ_UF C 2 Estado Estado de Origem
ZZZ_ENVMAI C 1 Mail Enviado E-Mail Enviado

3.2. Tabela ZZW – Produto X Fornecedor XML-e

CAMPO TIPO TAMANHO DECIMAL TITULO DESCRIÇÃO

ZZW_FILIAL C 2 Filial Filial do Sistema
ZZW_FORNEC C 6 Fornecedor Código do Fornecedor
ZZW_LOJA C 2 Loja Loja do Fornecedor
ZZW_NOMFOR C 40 Nome Fornec. Nome do Fornecedor
ZZW_CODPRF C 30 Cod.Prod.For Código do Produto no Forn
ZZW_PRODUT C 15 Produto Código do Produto
ZZW_NOMPRO C 40 Descrição Nome do Produto
3.3. Parâmetros (Todos os parâmetros são configuráveis via Wizard na Central XML-e)

PARAMETRO TIPO DESCRIÇÃO CONTEUDO

ZZ_CERTCA C Caminho do arquivo CA.PEM
ZZ_CERTKEY C Caminho do arquivo KEY.PEM
ZZ_CERTPRI C Caminho do arquivo CERT.PEM
ZZ_CIENAUT L MANIFESTA CIENCIA DA OPERACAO .T.
ZZ_CLASSIF L ATIVA A ABERTURA DA CLASSIFICAÇÃO DA NFE .T.
ZZ_DESTFIS C Destinatários que receberam mudanças de status da NF
ZZ_OPERCOM C TIPO DE OPERACAO PARA COMPRAS
ZZ_OPERTRA C TIPO DE OPERACAO PARA TRANSFERENCIA
ZZ_PCOBRIG L ATIVA OBRIGATORIEDADE DE VINCULAR .F.
ZZ_PSWENTR C SENHA QUE AUTORIZA ENTRADA DA NFE FACILE@123
ZZ_TIMEUPD N TEMPO PARA REFRESH DA TELA 10
ZZ_UPDEAN L ATUALIZA O EAN NO B1_CODBAR .T.
ZZ_VERSAOM C VERSAO DO WEBSERVICE 1.00
ZZ_VLDCOFI L ATIVA VALIDACAO DE COFINS NA CLASSIFICAÇÃO .T.
ZZ_VLDICMS L ATIVA VALIDACAO DE ICMS NA CLASSIFICAÇÃO .T.
ZZ_VLDIPI L ATIVA VALIDACAO DE IPI NA CLASSIFICAÇÃO .T.
ZZ_VLDNCM C REGRA DE VALIDACAO DO NCM 1
DESATIVA (.T.) A TELA DE CONFRONTO DE
ZZ_VLDNFE L IMPOSTOS .F.
ZZ_VLDPIS L ATIVA VALIDACAO DE PIS NA CLASSIFICAÇÃO .T.
ZZ_VLDST L ATIVA VALIDACAO DE ST NA CLASSIFICAÇÃO .T.
ZZ_XMLAUTO L INFORMA SE IRA BAIXAR O XML .T.
 4. Pontos de Entrada

Para o melhor aproveitamento da ferramenta utilizamos pontos de entrada disponibilizados pela

TOTVS, segue abaixo os detalhes para cada um deles:
MT100TOK - Uso Obrigatório
Descrição: Ponto de entrada para validações na inclusão do documento de entrada
Uso customizado: Utilizamos esse ponto de entrada para realizar a validação dos impostos no
momento da classificação da nota fiscal de entrada.
Sugerimos incluir o código abaixo no final do fonte, logo antes do Return. (caso tenha o P.E. já
aplicado no projeto do cliente)
If Alltrim(FunName()) $ "MATA103/PTX0007/PTX0018/PTX0008/PTX0001"
lRet := U_PTX0010()
EndIf

Segue exemplo do ponto de entrada que poderá ser utilizado: (caso NÃO tenha o P.E. já aplicado
no projeto do cliente)

User Function MT100TOK()

Local aArea := GetArea()

local lret := paramixb[1]

If Alltrim(FunName()) $ "MATA103/PTX0007/PTX0018/PTX0008/PTX0001"
lret := U_PTX0010()
EndIf

RestArea(aArea)

Return lret

MT103PN – Uso Obrigatório

Descrição: Ponto de entrada chamado na abertura da tela de inclusão de documento de entrada.
Uso customizado: Utilizamos esse ponto de entrada para realizar a amarração da TES e do pedido
de compra nos itens do documento de entrada.
Sugerimos incluir o código abaixo no final do fonte, logo antes do Return. (caso tenha o P.E. já
aplicado no projeto do cliente)

If SubStr(Alltrim(FunName()),1,3) == 'PTX'
MsgRun("Calculando impostos, aguarde...","Processando",{||U_PTX0015(.T.) })

EndIf
Segue exemplo do ponto de entrada que poderá ser utilizado: (caso NÃO tenha o P.E. já aplicado
no projeto do cliente)

User Function MT103PN()

If SubStr(Alltrim(FunName()),1,3) == 'PTX'
MsgRun("Calculando impostos, aguarde..."," ",{|| U_PTX0015(.T.) })

EndIf

Return .T.

MT140PC – Usado em situação especial

Esse ponto de entrada deverá ser utilizado exclusivamente na situação em que a empresa utilize o
parâmetro MV_PCNFE ativo.
Descrição: Ponto de entrada para manipular o parâmetro MV_PCNFE
Uso customizado: Utilizamos esse ponto de entrada para informar ao sistema que naquele
momento da inclusão da Pré-Nota não será necessário realizar a validação do pedido de compra.
Obs.: A utilização desse ponto de entrada não atrapalha no processo padrão adotado pelo
MV_PCNFE.
Segue exemplo do ponto de entrada que poderá ser utilizado:

User Function MT140PC()

//|Apenas na rotina Central XML-e |

If !Alltrim(FunName()) $ "PTX0007/PTX0018/PTX0008/PTX0001"
Return Nil
EndIf

Return .F.

5. Criando o Menu

No menu iremos ter as principais rotinas da ferramenta, com isso basta seguirmos a criação abaixo:
Acesse o ambiente Configurador (SIGACFG) e vá no caminho:
Ambiente > Cadastros > Menus
Selecione o menu desejado, no nosso exemplo será o Compras, e clique no botão “Ok”
No quadro da esquerda, clique no primeiro nível da árvore “Compras” e clique no botão “Adicionar
>>” para que o menu seja enviado para o quadro da direita.

Agora no quadro da esquerda, clique na pasta “&Atualizações” e depois clique no botão “Novo
Grupo”
Na tela que abrir digite: “FACILE XML-e” nos três campos, com isso teremos criado o grupo de
menu da ferramenta.
Agora vamos criar os itens desse grupo de menu, conforme passos abaixo:
Primeiramente clique na pasta criada “FACILE XML-e”, com isso informamos que os itens serão
criados dentro desse grupo de menus.
Clique no botão “Novo Item” e preencha a tela conforme a imagem abaixo e clique em “OK” para
salvar:

Vamos para o próximo item de menu:

Clique novamente no botão “Novo Item” e preencha a tela conforme a imagem abaixo e clique em
“OK” para salvar:
Vamos para o próximo item de menu:
Clique novamente no botão “Novo Item” e preencha a tela conforme a imagem abaixo e clique em
“OK” para salvar:
RELATÓRIOS:
Agora no quadro da esquerda, clique na pasta “&Relatórios” e depois clique no botão “Novo
Grupo”
Na tela que abrir digite: “FACILE XML-e” nos três campos, com isso teremos criado o grupo de
menu da ferramenta.

Agora vamos criar os itens desse grupo de menu, conforme passos abaixo:
Primeiramente clique na pasta criada “FACILE XML-e”, com isso informamos que os itens serão
criados dentro desse grupo de menus.
Clique no botão “Novo Item” e preencha a tela conforme a imagem abaixo e clique em “OK”
Agora iremos repetir o mesmo procedimento para o relatório “PTXR002”.
Clique no botão “Novo Item” e preencha a tela conforme a imagem abaixo e clique em “OK” para
salvar:

Para finalizar, vamos salvar o nosso menu para que já possa ser utilizado no módulo de compras.
Clique no botão “Gerar” e na janela que abrir preencha conforme a imagem abaixo e clique no
botão “Gerar” dessa nova janela.

Confirme a geração do menu e informe que deseja substituir o atual.

Com isso finalizamos o Menu e a instalação da ferramenta FACILE XML-e!!

 6. Configurando os JOBs

Os Jobs são responsáveis pela automatização dos processos na ferramenta, como por exemplo,
buscar as chaves e os seus respectivos XML diretamente do SEFAZ e também outros processos
como workflow.
Recomendamos criar dois appservers exclusivos para execução desses Jobs, no final do
appserver.ini deverá ser inserido as seguintes informações:
1º Criação do Service FACILE:
Copie e cole a pasta appserver da produção e renomeie a nova colocando o _FACILE na frente,
afim de facilitar a manutenção do serviço.

No appserver_FACILE, edite o appserver.ini (pode ser um ou dois appserver, dependendo do

volume de dados e padrões de cada empresa),

Deixe só um environment, o da produção, retirando outros que possam poluir o arquivo. Renomeie
o environment da produção para FACILE.

Inclua os serviços abaixo: (pode ser um ou dois appserver, dependendo do volume de dados
e padrões de cada empresa),
AppServer01:
;;Job Responsável por buscar as chaves no Sefaz
[PTXJ001]
MAIN=U_PTXJ001
ENVIRONMENT=FACILE
nparms=2
Parm1=01
Parm2=0101
;;Job responsável por realizar o download do XML da CT-e
[PTXJ003]
MAIN=U_PTXJ003
ENVIRONMENT=FACILE
nparms=2
Parm1=01
Parm2=0101

;;Tag responsável por inicializar e controlar os jobs

[ONSTART]
JOBS=PTXJ001,PTXJ003
REFRESHRATE=4000

AppServer02:
;;Job responsável por revalidar as chaves no Sefaz
[PTXJ004]
MAIN=U_PTXJ004
ENVIRONMENT=FACILE
nparms=2
Parm1=01
Parm2=0101

;;Tag responsável por inicializar e controlar os jobs

[ONSTART]
JOBS=PTXJ004
REFRESHRATE=4000

O que significa cada TAG?

MAIN => Nome do programa a ser chamado

ENVIRONMENT => Ambiente que o JOB será executado
nparms => Quantidade de parâmetro a serem utilizados
Parm1 => Informe o código da Empresa
Parm2 => Informe o código da Filial
REFRESHRATE => Intervalo de tempo, em segundos, para que o Job seja executado
 7. Criando RPO para o FACILE XML-e

Após aplicar o patch, Pontos de Entrada e Update no RPO da produção, criar uma pasta FACILE
salvar uma cópia do RPO de produção dentro dela.
Os appserver.ini criados deverão apontar para esse RPO FACILE.

8. Criação de Parâmetros

Deverá ser criado manualmente os parâmetros abaixo:

ZZ_AUTHLOG
Descrição: job-facile@apalonso.com.br
Tipo: Caracter

ZZ_AUTHPSW
Descrição: pdkiwx
Tipo: Caracter

ZZ_CODEAUT
Tipo: Lógico
Descrição: Integração de licenças
Conteúdo: .T.

FIM DA INSTALAÇÃO!

Para utilizar a ferramenta inicie o processo de configuração, seguindo o Manual de Configuração

do FACILE XML-e.