Árvore de páginas

01. DADOS GERAIS

Linha de Produto:DATASUL
Segmento:BACKOFFICE
Módulo:MFT - FATURAMENTO
Função:CONFIGURADOR DE TAGS
Release Expedida:12.1.25

02. OBJETIVO

O Configurador de Tags é uma ferramenta que permite o cadastro de regras para manipulação do arquivo XML gerado no cálculo de uma NF-e ou NFS-e.

As alterações são realizadas exclusivamente no arquivo XML e consequentemente no DANFE, ou seja, não serão efetivadas no registro da tabela Nota Fiscal no Sistema.

03. COMO O CADASTRO FUNCIONA?

O cadastro das regra dentro do Configurador de Tags pode ser explicado em 3 etapas que serão detalhadas abaixo.

1) INFORMAÇÕES DA TAG

Essas informações serão utilizadas para definir um tratamento para determinada Tag da NF-e / NFS-e.

  • Ação: Selecionar qual ação será realizada no XML. Opções: Inclusão de uma nova Tag ou alteração de uma Tag já existente.

  • Documento: Selecionar o documento eletrônico para qual que será cadastrada a regra para manipulação da Tag. Opções: NF-e ou NFS-e.

  • Versão: Informar a versão do documento para qual será cadastrada a regra para manipulação da Tag. Corresponde ao campo "Versão WebService" do programa CD0403B (Configurações do TSS).

  • Tag: Informar o nome da Tag que será aplicada a regra.

  • Tag Pai: Informar o nome da Tag Pai. Essa informação é usada em conjunto com o campo Tag para identificação dentro do XML.

  • Início de Validade: Informar a data do início de validade para a regra.

  • Fim de Validade: Informar a data do fim de validade para a regra.

Interface do cadastro de Informações da Tag

2) REGRAS DA TAG

Depois de cadastrar a Tag, o usuário deverá cadastrar as regras que determinam quando a Tag deve ser inserida ou alterada; o usuário pode cadastrar uma ou mais regras para a Tag, sendo obrigatório cadastrar pelo menos uma regra. Os campos desse cadastro variam de acordo com a ação selecionada para a Tag.

Campos disponíveis na opção Inclusão de Tag

Campos
Descrição da RegraUtilizado como identificador para a regra.
XMLDetermina qual a Tag ou grupo de Tags que serão inseridos no XML quando essa regra for válida. É necessário informa-los na sintaxe XML.
ProgramaPermite informar um programa Progress (.p) que permitirá com que os valores para as Tags informadas no campo XML sejam gerados dinamicamente. Esse programa possui parâmetros de INPUT e OUTPUT que facilitam a manipulação do arquivo XML. Exemplos no final dessa documentação. Opção Alteração de Tag

Campos disponíveis na opção Alteração de Tag

Campos
Descrição da RegraUtilizado como identificador para a regra.
Tipo de OperaçãoDetermina o tipo de operação que será aplicado na Tag quando essa regra for válida.
Valor da Operação

Determina o valor que será aplicado na Tag quando essa regra for válida.

Importante

Exemplos de uso do campo "Tipo de Operação"

Exemplo 1: Demonstrar a alíquota do ISS com duas decimais sem separador decimal.
Se a alíquota de 5% deve ser demonstrada com o valor 500.
O usuário deve selecionar a opção "Multiplicar por" e informar o valor "100" para o campo "Valor da Operação".

Exemplo 2: Demonstrar a alíquota do ISS em valor decimal.
Se a alíquota de 5% deve ser demonstrada com o valor 0,05.
O usuário deve selecionar a opção "Multiplicar por" e informar o valor "0,01" para o campo "Valor da Operação".

Exemplo 3: Formatar o código do serviço com quatro dígitos demonstrando zeros à esquerda.
Se o código de serviço 70 deve ser demonstrado com o valor 0070
O usuário deverá selecionar a opção "Formato numérico" e informar o valor "9999" para o campo "Valor da Operação".

Exemplo 4:  Formatar um valor com quatro decimais.
Se um determinado valor é demonstrado no arquivo XML com duas decimais e é necessário que seja demonstrado com quatro decimais.
O usuário deverá selecionar a opção "Formato numérico" e informar o valor ">>>>>9.9999" para o campo "Valor da Operação".

Quando ocorrer algum erro ao aplicar o "Tipo de Operação" na Tag, a Tag permanecerá com o seu antigo valor.

Exemplo: Selecionar a opção "Multiplicar por" para uma Tag com valor caracter.

Interface do cadastro de regra da Tag

3) Faixas de campos da regra

Uma regra é composta por uma ou mais faixas de seleção que serão comparadas com os valores da nota fiscal e/ou itens da nota fiscal. As faixas podem ser parametrizadas pelos campos abaixo:

  • CFOP (Código da CFOP da natureza de operação do item da nota fiscal).
  • Cidade da Nota (Cidade da nota fiscal).
  • Cidade do Cliente (Cidade do cliente da nota fiscal).

  • Cidade do Estabelecimento (Cidade do estabelecimento da nota fiscal).

  • Classificação Fiscal (Classificação fiscal do item da nota fiscal).

  • Código do Cliente (Código do cliente da nota fiscal).

  • Código do Estabelecimento (Código do estabelecimento da nota fiscal).

  • Código do Item (Código do item da nota fiscal).

  • Código do Serviço (Código de serviço do item da nota fiscal).

  • Estado da Nota (Estado da nota fiscal).

  • Estado do Cliente (Estado do cliente da nota fiscal).

  • Estado do Estabelecimento (Estado do estabelecimento da nota fiscal).

  • Natureza de Operação (Natureza de operação do item da nota fiscal).

  • País da Nota (País da nota fiscal).

  • País do Cliente (País do cliente da nota fiscal).

  • País do Estabelecimento (País do estabelecimento da nota fiscal).

  • Série (Série da nota fiscal).

SE UMA TAG POSSUIR MAIS DE UMA REGRA

O sistema validará todas as regras até encontrar uma regra válida e então aplicará o "Tipo de Operação" na Tag.
O relacionamento condicional entre as regras é do tipo "OU" (operador lógico OR), dessa forma, basta que uma das regras seja válida.

QUANDO UMA REGRA POSSUIR MAIS DE UMA FAIXA DE SELEÇÃO

Todas as faixas cadastradas para a Regra deverão ser válidas para que o sistema aplique o "Tipo de Operação" na Tag.
O relacionamento condicional entre as faixas de seleção é do tipo "E" (operador lógico AND), dessa forma uma regra será considerada válida somente quando os dados do documento estiverem dentro de todas as faixas de seleção cadastradas para a Regra.

TAG DE ITEM DO DOCUMENTO COM SELEÇÃO POR ITEM

Se o usuário cadastrar uma Tag do bloco de itens do documento com uma regra com faixa de seleção por item (ou outro campo dependente do item), o sistema aplicará o "Tipo de Operação" na Tag de cada item do documento que esteja dentro da faixa de seleção.

TAG DE DOCUMENTO COM SELEÇÃO POR ITEM

Se o usuário cadastrar uma Tag do bloco do documento com uma regra com faixa de seleção por item (ou outro campo dependente do item), o sistema aplicará o "Tipo de Operação" na Tag somente se todos os itens do documento que estiverem dentro da faixa de seleção.

Interface do cadastro de campos de faixa da regra

04. PRÓXIMOS PASSOS

Após a conclusão do cadastro das regra dentro do Configurador de Tags, é necessário habilitar a funcionalidade para o estabelecimento emissor da nota fiscal através do parâmetro "Utiliza Regras Específicas para Transmissão de Documentos Eletrônicos". Com o parâmetro habilitado, a rotina do Configurador de Tags será executada durante o cálculo das notas fiscais emitidas para o estabelecimento.

A rotina do Configurador de Tags verificará todas as regras cadastradas para as tags do cadastro efetuado anteriormente, e quando encontrar uma regra válida para a nota fiscal, aplicará a ação parametrizada no XML do documento.

É possível consultar no FT0909, botão "Histórico do XML", quais alterações foram realizadas pelo Configurador de Tags.

Parâmetro "Utiliza Regras Específicas para Transmissão de Documentos Eletrônicos" no CD0403 (Manutenção Estabelecimento)
Consulta das alterações realizadas pelo Configurador de Tags no programa FT0909E.

05. EXEMPLOS


Exemplos da ação "Alteração de Tag"

1) Eliminar a tag infCpl do XML da NF-e

1.1) Criar um cadastro no Configurador de Tags conforme o exemplo abaixo.

1.2) XML antes da execução do Configurador de Tags

1.3) XML após a execução do Configurador de Tags

2) Concatenar um texto na tag infAdFisco

2.1) Criar um cadastro no Configurador de Tags conforme o exemplo abaixo.

2.2) Como foi informado o Tipo de Operação "Programa", é necessário vincular um programa Progress que ficará responsável por atribuir o valor desejado.

Programa de exemplo: exemplo1.p

2.3) XML após a execução do Configurador de Tags

Exemplo da ação "Inclusão de Tag"

1) Inclusão do grupo de tags entrega

1.1) Criar um cadastro no Configurador de Tags conforme o exemplo abaixo.

<entrega>
    <CNPJ>01527909000165</CNPJ>
    <xLgr>RUA SANTA CATARINA</xLgr>
    <nro>1500</nro>
    <xBairro>CENTRO</xBairro>
    <cMun>3550308</cMun>
    <xMun>SAO PAULO</xMun>
    <UF>SP</UF>
</entrega>

1.2) Como foi informado o campo "Programa", é necessário vincular um programa Progress que ficará responsável por atribuir o valor desejado. Por mais que os valores das Tags já foram preenchidos no cadastro, é possível alterá-los pelo programa.

Programa de exemplo: exemplo2.p

1.3) XML após a execução do Configurador de Tags. Obs: Notem que a tag "nro" foi alterada via programa.


Programa Template

No Configurador de Tags, é possível utilizar um programa Progress para atribuir valores as tags que serão incluídas ou alteradas. Esse programa Progress possui uma assinatura de parâmetros que deve ser respeitada para que a execução funcione com sucesso.

Programa Template

// As definições das temp-table dos parâmetros e alguns funções auxiliares podem ser consultadas na include ftapi924.i.

{ftp/ftapi924.i}

DEFINE INPUT PARAM TABLE FOR ttParam.                                              /* Temp-Table com os parâmetros */
DEFINE INPUT-OUTPUT PARAM TABLE FOR ttStructClient.                       /* Temp-Table com a estrutura do XML parametrizado para a regra */
DEFINE INPUT-OUTPUT PARAM TABLE FOR ttStructCurrent.                    /* Temp-Table com o estrutura atual do XML */
DEFINE INPUT-OUTPUT PARAM cTagValue AS CHARACTER NO-UNDO.  /* Valor da Tag */

RETURN "OK".

Exemplos:

ftnfe001a.p - Incluir a tag infAdProd se existir relacionamento item-cli com narrativa informada 

ftnfe002a.p - Atribui a quantidade do item para as tags qTrib e qCom em notas fiscais de diferença de preço com finalidade complementar

ftnfe003a.p - Incluir a tag infAdic e infCpl ou alter -la quando existir cadastro no CD0208 para o item com o tipo de texto NF-e

06. SITUAÇÕES ATENDIDAS PELO CONFIGURADOR DE TAGS

Gerar quantidade do item nas Tags qTrib e qCom em notas fiscais de diferença de preço com finalidade complementar

Gerar tag infAdProd com a observação do item do pedido de venda

Gerar tag infCpl com informações ou características do item

Tag codcanc do XML de cancelamento da NFS-e

Tag cresponsavelretencao no XML da NFS-e

Tags dthremissao e dtcompetencia da NFS-e de substituição