Índice

Contexto de Negócio

TVS Colaboração 2.0 - EDI de Vendas SIGAFAT

A versão 1.0 do TOTVS Colaboração utiliza o TSS (TOTVS® Service SOA) para realização do tráfego dos documentos entre o ERP Microsiga Protheus® e a plataforma NeoGrid por meio do emprego da tecnologia Web Service.

Nesta versão do TOTVS Colaboração, denominada 2.0, foi empregado o uso do Client NeoGrid - que será é o responsável pelo tráfego dos arquivos gerados pelo Microsiga Protheus® - e dos sistemas da NeoGrid em substituição a à utilização do TSS.

A proposta do Client NeoGrid é facilitar e agilizar o processo de transmissão dos documentos fiscais, pois trabalha completamente integrado aos serviços disponíveis no TOTVS Colaboração no que se refere à plataforma NeoGrid. Basicamente, trata-se de um software

que deve ser instalado

para instalação no servidor de aplicação ERP, capaz de monitorar um diretório de saída de documentos alimentado pelo ERP Microsiga Protheus® e de realizar a transmissão para os serviços disponíveis do TOTVS Colaboração sob plataforma NeoGrid.Este software também tem como finalidade verificar junto

a

à plataforma NeoGrid a existência de documentos pendentes de retorno, e em caso afirmativo, atualizar um diretório de entrada para leitura do ERP Microsiga Protheus.

 

Para melhor entendimento, seguem abaixo as etapas do processo padrão de envio de arquivos via TOTVS Colaboração 2.0:

     Envio

Premissa para a Integração Neogrid X Faturamento Protheus

Para receber os arquivos do Neogrid o fonte "colabgeneric.prw" valida a existência da licença 3100 (TOTVS_COLAB_ONDEMAND).

A Ausência desta licença impede a gravação dos arquivos de Logs da integração (pasta XML) e a gravação das tabelas a serem importadas (grava somente o campo CKO_FLAG e impede a gravação das tabelas SC5 e SC6).

Para melhor entendimento, seguem abaixo as etapas do processo padrão de envio de arquivos via TOTVS Colaboração 2.0:

     Envio

1. O Protheus® gera o arquivo com extensão *.xml no diretório de saída do Client NeoGrid.
2. O Client NeoGrid faz uma busca no diretório de
3. O Protheus® gera o arquivo com extensão *.xml no diretório de saída do Client NeoGrid.
4. O Client NeoGrid faz uma busca no diretório de saída e envia o arquivo para os serviços web do TOTVS Colaboração na NeoGrid.
5. Após concluir o envio, o arquivo do diretório de saída é movido para o diretório de documentos enviados. 

  Recebimento (Processo utilizado no Faturamento - SIGAFAT)

1. O Client NeoGrid analisa, em um determinado intervalo de tempo, a existência de documentos disponíveis para recebimento. Em caso afirmativo, será gravado grava-se no diretório de entrada o arquivo .xml correspondente ao pedido de vendas ou a programação de entrega.
2. Após esta gravação, o ERP Microsiga Protheus® executa, via Schedule de importação, a leitura do arquivo e a sua importação para o sistema.
3. O ERP Microsiga Protheus® executa também, via Schedule de importação, a movimentação do arquivo lido (que está no diretório de entrada) para o diretório de arquivos lidos/processados.
   
   

Sistemas Envolvidos  

• Faturamento (SIGAFAT) - Fornecedores da rede Colaboração recebem os pedidos de compra firmes, para assim, gerar o pedido de vendas.
• Faturamento (SIGAFAT) - Fornecedores da rede Colaboração recebem as datas de necessidade das autorizações de entrega e pedidos de compra para gerar a programação de entrega.
  
  

Integração

Os documentos que podem ser recebidos através por meio do TOTVS Colaboração no módulo de Faturamento são:

Fluxo

Fluxo do processo de geração de Pedido de Vendas (O processo é idêntico para Programação de Entrega):

Macro Processos:

Image Modified

Image Modified

Pré-requisitos

implantação

Compatibilizadores

Rodar update COLABUPDATE e UPDFAT50.

Na versão 2.0 do TOTVS Colaboração a configuração da estrutura de onde os XMLs devem ser importados, são configurados através é feita a importação dos XMLs, é configurada por meio de 3 parâmetros.

• MV_TCNEW: Documentos que utilizam o novo modelo do TOTVS Colaboração, sendo: 0-todos,1-NFE,2-CTE,3-NFS,4-MDe,5-MDfe,6-Recebimento
  Ex. de preenchimento: 6
  
  
• MV_NGINN: Diretório onde conterá que contêm os XMLs a serem importadosimportar.
  Ex. de preenchimento: \NEOGRID\BIN\IN                              
                                                                                                                                                                                                                 
• MV_NGLIDOS: Diretório onde conterá que contêm os XMLs ja já lidos.
  Ex. de preenchimento: \NEOGRID\BIN\LIDOS                                                                                                                                                                                                                                        

Tabela

Renomeie o nome da tabela CKO (X2_ARQUIVO) para CKOCOL via configurador 

Image Added

Pré-requisitos utilização

De/Para de tag + cadastros (Pedidos de vendas - MATA411)

Tag	Conteúdo	Informações Adicionais
_ORDERTYPECODE	Tipo do Pedido	000 - Pedido com condições especiais 001 - Pedido Normal 002 - Pedido de Mercadorias Bonificadas 003 - Pedido de Consignação 004 - Pedido Vendedor 005 - Pedido Comprador 006 - Pedido de Demonstração 007 - Programação de entrega 008 - Contrato fornecimento
_ORDERID	Número do pedido do Emissor	Informação

será

é gravada no campo C6_PEDCLI
_DHINIDELIVERY	Data e hora de entrega do item	Informações

serão

gravadas nos campos C6_ENTREG e C6_HORENT
_FREIGHTTYPE	Tipo de frete	1 - CIF (Frete por conta do vendedor) 2 - FOB (Frete por conta do comprador) 3 - SFT (Sem frete)
_INVOICEMESSAGES	Mensagem da nota fiscal	Informação

será

gravada no campo C5_MENNOTA
_TYPECODPROD	Tipo de código de produto	Determina onde

será

é feita a busca do produto sendo: 'EN' ou 'UP' - Busca o produto

através

por meio do código de barras (B1_CODBAR) 'BP' - Busca pela amarração de clientes x produtos (A7_PRODUTO)
_ITEMCODE	Código do produto	Informação

será

gravada no campo C6_PRODUTO
_QUANTITY	Quantidade de venda	Informação

será

gravada no campo C6_QTDVEN
_UNITYPRICE	Preço unitário do produto

Se

Grava o campo C6_PRCVEN.  Caso não seja informado o UNITYPRICE e houver vinculo com a tabela de preços

estiver vazia, utiliza a informação da tag, senãoutiliza o campo B1_PRV1 para gravar no campo C6_PRCVEN

, o sistema buscará o valor da tabela de preços (mesmo valor do campo C6_PRUNIT)
_CUSTOMERGOVINFO	CGC do cliente	Informação

será

gravada no campo C5_CLIENTE
_DELIVERYCUSTOMERGOVERNMENTALINFORMATION	CGC do cliente de entrega	Informação

será

gravada no campo C5_CLIENT. Caso não seja informado,

será

é considerado o cliente de faturamento, também como cliente de entrega.
_VENDORGOVINFO	CGC do fornecedor	Utiliza informação para buscar na tabela SM0 para emitir na empresa/filial correta
_PRICETABLENUMBER	Tabela de preços	Dificilmente é informada, pois o cliente geralmente, não possui tal informação. Caso não seja informada, a busca

ocorrerá

ocorre através do campo A1_TABELA

_PAYMENTTERMCODECondição de pagamento

O valor do produto na tabela de preços será gravado no campo C6_PRUNIT, da mesma forma que na operação padrão sem uso do colaboração
_PAYMENTTERMCODE	Condição de pagamento	Dificilmente é informada, pois

Dificilmente é informada, pois

o cliente geralmente, não possui tal informação. Caso não seja informada, a busca

ocorretá através

ocorre por meio do campo A1_COND
_SELLERCODE	Códido do vendedor	Informação

será

gravada no campo C5_VEND1

 

• TES: É obtido através campo por meio do campo B1_TS, caso não encontre, busca no parâmetro MV_FATTSPD.

 

Customização/Facilitadores

Pontos de Entrada (Pedido de venda - MATA411):

OBS: A exclusão do pedido de vendas

MA411Cli - Altera o cliente de faturamento através de tag específica no EDI de Vendas (TOTVS Colaboração)

Parâmetros adicionais (Pedido de venda - MATA411):

MV_CENTFAT - Determina se o cliente de entrega será considerado como cliente de faturamento no SC5.

MV_FATEDIP - Determina que a busca do produto seja efetuada de forma diferenciada, independente do tipo do produto.

Se utilizar a busca diferencial de produto faz primeiro a busca pelo SA7 (indepedente do tipo), Se não encontrar, busca pelo código de barras B1_CODBAR.

Cadastros 

Importante: Sempre que um item de produto tiver o tipo EN ou UP a busca no Protheus será sempre efetuada através do código de barras (B1_CODBAR), sendo assim, é imprescindível que este campo esteja devidamente
preenchido, caso contrário a busca será realizada através da amarração de Produto x Cliente (SA7).  
* Caso a regra acima citada não atenda, ver o parâmetro MV_FATEDIP.

Configuração de Schedule

e exclusão de itens do pedido de vendas não é contemplada atualmente pela integração via TOTVS Colaboração.

De/Para de tag + cadastros (Programação de Entrega - MATA412)

Pré-requisitos Cadastros

1. No módulo Faturamento em Atualizações / Cadastros / Clientes inclua um Cliente com o mesmo CNPJ do pedido de compra enviado pela NEOGRID;
   

   Importante: Para gerar pedido de vendas é necessário informar a condição de pagamento, tabela de preços e o TES. Por ser rotina automática siga os seguintes procedimentos:

   
    * Tabela de Preços: Pode ser informada por meio do XML na tag <PRICETABLENUMBER>, caso não seja informada, o sistema busca a condição no cadastro do cliente (A1_TABELA – folder: Vendas).

   
    * TES: O TES é configurado no cadastro de produtos (B1_TS – folder: Cadastrais), caso não haja informação, o sistema utiliza o TES padrão, conforme parâmetro MV_FATTSPD.

     * Condição de pagamento: Pode ser informada por meio do XML na tag <PAYMENTTERMCODE >, caso não seja informada, o sistema busca a condição no cadastro do cliente (A1_COND – folder: Vendas).
   Obs.: Não utilize a condição de pagamento de tipo 09, pois esta condição depende de interface para inserção das parcelas e datas, por se tratar de rotina automática, tal processo não é possível.

2. Em Atualizações / Cadastros / Produtos inclua um Produto para utilização do TOTVS Colaboração 2.0;
   

   Importante: Sempre que um item de produto tiver o tipo EN ou UP a busca no Protheus é sempre efetuada por meio do código de barras (B1_CODBAR), sendo assim, é imprescindível que este campo esteja devidamente preenchido, caso contrário a busca é realizada por meio da amarração de Produto x Cliente (SA7).  
   * Caso a regra acima citada não atenda, verifique o parâmetro MV_FATEDIP.

   Importante: Pode haver conflitos na busca do produto por código de barrar (B1_CODBAR) devido a configuração do parâmetro MV_CONSBAR, responsável por definir a quantidade de caracteres considerados no código, ou seja, poderão ser acrescidos números dependendo da quantidade informada no XML.

1. Em Atualizações / Cadastros / Produto x Cliente efetue a amarração;

2. Em Atualizações / Cadastros / TES inclua um TES;

3. Em Atualizações / Cenários de Venda / Tabela de preço inclua uma tabela de preço e efetue a respectiva amarração dos produto.

Customização/Facilitadores

Pontos de Entrada (Pedido de venda - MATA411):

MA411GRV - Manipula os dados do pedido de vendas gerado por meio do EDI de Vendas (TOTVS Colaboração) 

MA411Cli - Altera o cliente de faturamento por meio de tag específica no EDI de Vendas (TOTVS Colaboração)

Parâmetros adicionais (Pedido de venda - MATA411):

MV_CENTFAT - Determina se o cliente de entrega é considerado como cliente de faturamento no SC5.

MV_FATEDIP - Determina que a busca do produto é efetuada de forma diferenciada, independente do tipo do produto.

Se utilizar a busca diferencial de produto faça primeiro a busca pelo SA7 (independente do tipo), se não encontrar, busque pelo código de barras B1_CODBAR.

MV_CROSFAT - Define se utiliza Prog. Entrega ou Ped. Venda no CrossDocking. 1- Não utiliza, 2- Prog de Entrega, 3- Pedido Vendas  (Valor default: 1)

MV_FATLBAT - Este parâmetro define se a liberação dos itens será realizada de forma automática na geração do Pedido de Venda através da Programação de Entrega, evitando assim a necessidade de liberar novamente o Pedido, caso tenha sido incluído manualmente e foi reprocessado pelo posterior uso do Colaboração. (Valor default: .T.)

Parâmetros usados pelo compras que podem interferir no processo do Faturamento (Pedido de venda - MATA411)

Se o parâmetro MV_IMPXML  estiver como F o sistema gravará a tabela CKOCOL corretamente. Caso esteja como T, será necessário preencher os parâmetros abaixo para que o sistema grave a tabela

MV_EXCEDI - Informa qual ou quais código dos arquivos que não serão importados, mantendo-os na pasta IN
MV_COLEDI - Informa qual ou quais código dos arquivos que serão importados

Se o parâmetro MV_IMPXML estiver como F, os parâmetros acima, deveram estar em branco, pois não existe tratativa para utilizar o Importador XML e o Totvs Colaboração em conjunto. A definição de qual ferramenta utilizar é informada no parâmetro MV_IMPXML.

 Documentação dos parâmetros do Compras no link abaixo

TC03 - Parâmetros

Configuração de Schedule

1. Efetue a configuração do Agent:

   Importante: Dúvidas quanto ao cadastramento do Schedule, vide manual.
   
   Image Added
   

2. Configure o job que aciona as seguintes funções:

   COLAUTOREAD() - Faz o processamento dos arquivos recebidos, alterando os xml's da pasta IN para LIDOS, grava o registro na tabela CKOCOL.

   MA411Job() - Faz a leitura do XML para gerar Pedido de vendas (XML iniciado em '005_').

   MA412Job() - Faz a leitura do XML para gerar Programação de Entrega (XML iniciado em '252').

   Utilizando o SIGACFG, menu Ambiente / Schedule / Schedule;

   Importante: Configure para que a execução seja feita em apenas uma empresa, para não gerar vários agendamentos seguidos e duplicar os pedidos/programação de entrega (internamente o job trata para gravar o pedido na empresa/filial correta  conforme CNPJ informado na tag <VendorGovInfo>)
   
   Image Added
   
   
   

3. Na opção Alterar selecione o botão Recorrência. 
   Importante: Com exceção do ColAutoRead(), é necessário configurar um intervalo de execução do Schedule para que ele não gere pedidos/programação de entrega em duplicidade ao executar agendamentos seguidos.

   Image Added
   Esquema macro de funcionamento:

   Image Added
   
   

Análise de processamento

1. Quando o schedule do TOTVS colaboração (ColAutoRead) é executado e o arquivo é movido para pasta configurado no parâmetro ‘MV_NGLIDOS’, é criado um registro na tabela ‘CKOCOL’;
   
   

2. Na tabela ‘CKOCOL’, observe o campo CKO_FLAG, se o conteúdo do mesmo for 0, isto significa que o arquivo foi processado com erros e que o pedido não foi gerado/programação de entrega, não foi gerado;

3. Neste caso, trata-se de um problema de execução de rotina automática, ou de problema na leitura do xml. Sendo assim, acesse a pasta “XML” (caso a pasta não exista, crie uma pasta com o nome XML no startpath do Protheus) e verifique se consta um arquivo de nome “deliveryschedule_salesorder”, sem sim, é porque se trata de um problema de cadastro.

4. O arquivo deve conter:

   * O número do arquivo XML entre colchetes e
   * A informação do que está errada no cadastro:
   Image Added
   
   

5.  Se não for possível efetuar a criação do arquivo é apresentada uma mensagem no AppServer:
   
   Image Added
   
   
6. Se o arquivo ultrapassar 1MB o arquivo é deletado e um novo arquivo de log é criado:
   
   Image Added
   
   
7. O log também pode ser consultado por meio do arquivo “Order”:
   
   Image Added
   
   8. Para que o arquivo order seja gerado com informações é necessário a inclusão de um Cliente com o mesmo CNPJ do pedido de compra enviado pela NEOGRID conforme tag _CustomerGovInfo;

Image Added

Image Added

• Importante : Caso o XML possua a TAG _DELIVERYCUSTOMERGOVERNMENTALINFORMATION preenchida e o cliente não existir na base (a chave é o CNPJ), o sistema poderá emitir a mensagem
  Image Added
  

Event Viewer

Os logs podem ser enviados também via Event Viewer. Ao utilizar este processo, os logs chegam por e-mail  com o status do processamento de cada xml.

Cadastre o processo com o código '056'.

Para configurar o Event Viewer acesse o módulo Faturamento (SIGAFAT): 

Miscelânea / Inscr. Event Viewer / Incluir

Para receber e-mail configure o SMTP:

Acesse o configurador (SIGACFG): EMAIL/PROXY / Configurar

Vide documentação do Event Viewer.

https://cms.totvs.com/mktfiles/tdiportais/helponlineprotheus/portuguese/cfga040_event_viewer.htm

Importante: Os dados do Event Viewer ficam cadastrados na tabela SXH, por ser uma tabela de dicionário de dados, dependendo da quantidade de registros trafegados, pode haver estouro do tamanho, fazendo-se necessário efetuar o backup da tabela e recriá-la novamente vazia.

Invoice - Espelho da Nota

Invoice é processo de envio do espelho da nota.

É possível enviar o Invoice por meio da Neogrid, para isso, é necessário possuir o client da Neogrid instalado.

Os XML's emitidos após a trnasmissão da nota ficam na pasta OUT (MV_NGOUT) e o job da Neogrid faz a leitura e a importação do Invoice.

É possível enviar o Invoice também via TSS.

A seguir o processo detalhado:

Configurações

• MV_COLESP: Este parâmetro é responsável pela ativação da geração do espelho da Nota para EDI de vendas
  Ex. de preenchimento: .T.
  
  
• MV_NGOUT : Diretório que contêm os XMLs a enviar para a Neogrid.
  Ex. de preenchimento: \NEOGRID\BIN\OUT 
  
  
• MV_SPEDURL: URL para comunicação com o TSS.
  Ex. de preenchimento: http://LocalHost:8090/ 
  
  
• MV_SPEDCOL: Informa se utiliza o TOTVS Colaboração
  Ex. de preenchimento: N
  
  
• MV_ESPECIE: Contêm os tipos de documentos fiscais utilizados na emissão de notas fiscais.
  Ex. de preenchimento: UNI=NF; 1=SPED
  
  
• MV_TCNEW: Documentos que utilizam o novo modelo TOTVS Colab. Onde:0-todos,1-NFE,2-CTE,3-NFS,4-MDe,5-MDfe,6-Recebimento.   
  Ex. de preenchimento: 0.
  
  Para o Totvs Colaboração 1.0 é necessário configurar o serviço do TSS. Vide documentação.
  

             É necessário possui o RDMAKE NFEspNeo.prw compilado no repositório.

Utilização

1. É necessário faturar o pedido emitido por meio do TOTVS Colaboração, acesse: Atualizações / Pedidos / Pedido de Vendas > Selecione o pedido, clique em Ações Relacionadas / Preparar Documento de Saída;
2. Selecione a Série da nota e confirme;

É necessário transmitir a nota:

Image Added

Se a transmissão for bem sucedida, é gerado o arquivo com extensão .XML com a Invoice (Espelho da nota):

Image Added

Exemplos de XML recebido:

Pedido de Vendas:

005_20160409024448005_6121.xml

Programação de entrega:

252_20141215152121498_0001.xml

Emissão NFE:

170_20160505074718699_0001.xml

Espelho da nota (Invoice):

006_20170329170830764_0001.xml

FAQ

1. O arquivo .xml foi processado pelo TOTVS Colaboração e gravado na tabela CKOCOL, mas não gerou pedido e/ou programação de entrega e nem gravou informações no log.
   R.: Geralmente o ColAutoRead() possui recorrência Sempre Ativo configurado no Schedule, ou seja, assim que termina de executar uma tarefa, ele já executa outra em seguida, sem dar pausas. Dependendo da recorrência do schedule de pedidos e/ou programação de entrega, por exemplo, a cada 30 min, o sistema só vai tentar gerar os registros na hora marcada no agendamento.
   
   
2. Como eu sei que o pedido/programação de entrega foram gerados por meio da tabela CKOCOL?
   R.: Pelo campo CKO_FLAG. Se o status for igual a '1' significa que o registro foi gerado com sucesso.
   
   
3. Na consulta do log de execução automática consta que o cliente é inválido, mas o cliente está ativo (A1_MSBLQL) e consigo gerar o pedido com os dados do xml de forma manual.
   R.: Verifique o processo de numeração do Protheus (SXE/SXF), pois, este problema geralmente ocorre quando a numeração disponível já está gravada no banco de dados.
   
   
4. Se o XML for processado com erro e não gerou o pedido e/ou programação de entrega, quando ele será gerado novamente? 
   R.: O controle ocorre por meio do campo CKO_FLAG, enquanto ele for igual a '0', a cada nova execução do schedule, o sistema tentará processar o registro novamente.
   
   
5. Como eu sei que o pedido de venda gerado, refere-se ao TOTVS Colaboração?
   R.: É possível identificar um pedido de vendas proveniente do TOTVS Colaboração por meio dos campos C5_ORIGEM, neste campo é gravado o conteúdo "MATA411" ou por meio do campo C6_PEDCLI que grava o número do pedido de compras do cliente conforme tag _ORDERID.
   
   
6. O sistema gerou pedidos e/ou programações de entregas duplicados.
   R.: Analise a recorrência dos agendamentos, o ideal é nunca agendar o MA411JOB() e o MA412JOB() como sempre ativo, pois pode ocorrer um delay entre uma geração e outra, ocasionando o sobreposição do processamento, gerando assim, registros duplicados.
   
   
7. No INVOICE é possível filtrar e transmitir apenas os XMLs gerados a partir da Neogrid?
   R.: Sim, para isso, é necessário efetuar o filtro de forma customizada através do RDMAKE NFEspNeo.prw
   
   
8.  Se o cliente enviou através do xml uma solicitação para geração de pedido, mas notou que, por exemplo, a quantidade de vendas estava errada, como o registro pode ser alterado de forma automática?
   R.: Basta o cliente transmitir uma nova solicitação, com os dados corretos informando o mesmo _ORDERID (C6_PEDCLI) do pedido gerado, com isso, o sistema identificará que o pedido existe e efetuará a respectiva alteração, conforme novo xml.
   
   
9. Na geração do pedido é utilizado o processo de TES Inteligente, como o sistema trata isso de forma automática, pois não há nenhuma tag específica que trata essa informação?
   R.: Este processo precisa ser tratado de forma customizada utilizando o ponto de entrada MA411GRV.
   
   
10. Através da programação de entrega o pedido não é gerado automaticamente?
    R.: Não. Apenas a programação de entrega é gerada. A geração do pedido por meio da programação de entrega é efetuada de forma manual pela opção "Gerar Pedido"
    
    
11. Qual a licença TOTVS necessária para o recebimento do arquivo XML no Protheus e o que acontece na ausência da mesma ?
    R : Para receber os arquivos do Neogrid o fonte "colabgeneric.prw" valida a existência da licença 3100 (TOTVS_COLAB_ONDEMAND).
    A ausência desta licença grava a tabela CKO sempre com o flag de erro, movimenta o arquivo da pasta In para Lidos, não gera os arquivos de Log para da pasta XML e não grava o Pedido de Vendas