Histórico da Página
TOTVS Colaboração 2.0 - EDI de Vendas X SIGAFAT
Contexto de negócio
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 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
- O Protheus® gera o arquivo com extensão *.xml no diretório de saída do Client NeoGrid.
- 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.
- 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)
- O Client NeoGrid analisa, em um determinado intervalo de tempo, a existência de documentos disponíveis para recebimento. Em caso afirmativo, será gravado no diretório de entrada o arquivo .xml correspondente ao pedido de vendas ou a programação de entrega.
- 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.
- 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 do TOTVS Colaboração no módulo de Faturamento são:
- Pedido de Venda: O módulo de Faturamento recebe os pedidos de compras firmes para efetuar a geração do pedido de vendas.
Benefícios: Notificação da intensão de venda.
- Programação de Entrega: O módulo de Faturamento recebe as datas de necessidade das autorizações de entrega e pedidos de comprar para geração de programação de entrega.
Benefícios: Melhor planejamento das entregas.
Fluxo
Fluxo do processo de geração de Pedido de Vendas (O processo é idêntico para Programação de Entrega):
Macro Processos:
Pré-requisitos instalação/implantação
Compatibilizadores
Rodar update COLABUPDATE.
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 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á os XMLs a serem importados.
Ex. de preenchimento: \NEOGRID\BIN\IN - MV_NGLIDOS: Diretório onde conterá os XMLs ja lidos.
Ex. de preenchimento: \NEOGRID\BIN\LIDOS
Tabelas Utilizadas | CKO – Controle de arquivos TOTVS Colaboração. (Versão 2.000)
|
Rotinas Envolvidas | COLAUTOREAD.PRW (A partir da data 22/01/16, tratamento das threads) MATA410.PRW MATA411.PRW MATA412.PRW |
Sistemas Operacionais | Windows®/ Linux® |
Pré-requisitos utilização/cadastros
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 |
_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) |
_INVOICEMESSAGES | Mensagem da nota fiscal | Informação será gravada no campo C5_MENNOTA |
_TYPECODPROD | Tipo de código de produto | Determina onde será a busca do produto sendo: 'EN' ou 'UP' - Busca o produto através 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 a tabela de preços estiver vazia, utiliza a informação da tag, senão utiliza o campo B1_PRV1 para gravar no campo C6_PRCVEN |
_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á através do campo A1_TABELA |
_PAYMENTTERMCODE | Condição de pagamento | Dificilmente é informada, pois o cliente geralmente, não possui tal informação. Caso não seja informada, a busca ocorretá através do campo A1_COND |
_SELLERCODE | Códido do vendedor | Informação será gravada no campo C5_VEND1 |
- TES: É obtido através campo B1_TS, caso não encontre, busca no parâmetro MV_FATTSPD.
Customização/Facilitadores
Pontos de Entrada:
MA411GRV - Manipula os dados do pedido de vendas gerado através do EDI de Vendas (TOTVS Colaboração)
MA411Cli - Altera o cliente de faturamento através de tag específica no EDI de Vendas (TOTVS Colaboração)
Parâmetros adicionais:
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.
Transações/Entidades/Mensagens únicas
Apresente quais as transações/entidades que são trocadas e quem envia a informação para quem. Pode (e recomenda-se) ter um diagrama, uma tabela ou afins que apresente este fluxo.
Relacione quais são as mensagem únicas (TOTVSMessage) utilizadas e qual o seu relacionamento com as entidades já existentes do ERPs envolvidos.
Exemplos:
Método | ID | Descrição | Origem | Destino | XSD (versões podem variar) |
Cadastros | 01 | Cliente/Fornecedor | RM | Protheus | CustomerVendor_1_000.xsd |
02 | Moeda | RM | Protheus | Currency_1_000.xsd | |
03 | Unidade de Medida | RM | Protheus | UnitOfMeasure_1_000.xsd | |
04 | Produto | RM | Protheus | Item_?_000.xsd | |
05 | Centro de Custo | RM | Protheus | CostCenter_1_000.xsd | |
06 | Ativos | RM | Protheus | NOVA, Ativo fixo | |
07 | Funcionários | RM | Protheus | Employee_1_000.xsd | |
08 | Projeto | RM | Protheus | Project_1_000.xsd | |
09 | Obra | RM | Protheus | SubProject_1_000.xsd | |
10 | Tarefa | RM | Protheus | TaskProject_1_000.xsd | |
11 | Meio de Pagamento | RM | Protheus | ?????.xsd | |
12 | Condições de pagamento | RM | Protheus | PaymentCondition_1_000.xsd | |
13 | Coligada* | RM | Protheus | Company_1_000.xsd | |
14 | Filial* | RM | Protheus | Branch_2_000.xsd | |
Processos | 15 | Solicitações (compras/armazém) | Protheus | RM | Request_1_000.xsd |
16 | Cancelar movimento (solicitação, OS, etc) | Protheus | RM | CancelRequest_1_000.xsd | |
17 | Cancelar movimento (solicitação, OS, etc) | RM | Protheus | CancelRequest_1_000.xsd | |
18 | Baixa de estoque | Protheus | RM | Request_1_000.xsd | |
19 | Baixa de estoque | RM | Protheus | Request_1_000.xsd | |
20 | Consulta Saldo | Protheus | RM |
| |
21 | Apropriação de custos |
|
| Request _1_000.xsd | |
22 | Geração de OS |
|
|
| |
23 | Consulta de OS |
|
|
| |
24 | Ampliação patrimonial |
|
|
|
Fluxo das Informações
Para cada fluxo de informação descreva, se necessário, alterações de comportamento que o respectivo produto irá sofrer. Por exemplo: quando o Logix recebe o PEDIDO de OUTRO ERP, este pedido não poderá ser alterado no Logix.
Liste quais as entidades integradas e como é o mapeamento entre as diferentes estruturas. Por exemplo: Classe no sistema A vira categoria no sistema B, o campo X é refletido no campo Y etc.
Liste quais transações/operações a integração fará com as entidades relacionadas. Exemplo: Insert de PEDIDO, Insert, update de ITEM, buscar saldo em estoque do ITEM no dia X ou buscar dados do FUNCIONÁRIO.
Cadastros
Descreva características gerais do fluxo de informações e que serão comuns para este tipo de entidade. Características particulares para cada entidade deverão ser citadas em tópicos específicos de cada entidade.
Sempre que existir (a sugestão é sempre criar) e for agregador ao documento acrescentar aqui os diagramas/imagens ou até mesmo colocar tais diagramas diretamente na especificação dos processos
Em seguida faça uma descrição para cada um dos fluxos para cada entidade
<Transação/Entidade>
Identificador da Mensagem: <mensagem>
Versão: <versão>
Módulo <marca 1>: <BackOffice – Gestão xxxxxxx>
Módulo <marca 2>: <SIGAXXX>
Tipo de Envio: <Assíncrona/Síncrona>
Mensagem Padrão | PROTHEUS | RM | ||
Tabela | Campo | Tabela | Campo | |
Code | CTO990 | CTO_SIMB | GMOEDA | SIMBOLO * |
Description | CTO990 | CTO_DESC | GMOEDA | DESCRICAO |
Symbol | CTO990 | CTO_SIMB | GMOEDA | SIMBOLO |
Notas:
Observações sobre comportamento desta mensagem ou dos processos envolvidos nela/para ela
A seguir descrever as variações, particularidades da mensagem e processos (integração) de acordo com cada marca
Limitações/Restrições
Descreva limitações e restrições para a integração que está sendo descrita.
Processos
Descreva características gerais do fluxo de informações e que serão comuns para este tipo de entidade. Características particulares para cada entidade deverão ser citadas em tópicos específicos de cada entidade.
Sempre que existir (a sugestão é sempre criar) e for agregador ao documento acrescentar aqui os diagramas/imagens ou até mesmo colocar tais diagramas diretamente na especificação dos processos
Em seguida faça uma descrição para cada um dos fluxos para cada entidade
<Transação/Processo>
Tipo de Fluxo: Protheus -> RM
Mensagem: Request_1_000
Versão: 1.000
Descrição de todo o comportamento e funcionamento do processo. Breve contexto, origem, regras, integração (geração da mensagem, envio, recebimento no destino), o quê supostamente irá ocorrer no destino, retorno, impacto, consequências, o que foi afetado, como conferir, validar, etc o retorno.
Acrescentar um diagrama do processo.
A seguir descrever as variações, particularidades da mensagem e processos (desta integração) de acordo com cada marca
Notas:
Observações sobre comportamento desta mensagem ou dos processos envolvidos nela/para ela
Limitações/Restrições
Descreva limitações e restrições para a integração que está sendo descrita.
Limitações / Restrições Gerais
Descreva limitações e restrições para cada fluxo descrito no tópico anterior. Exemplo:
- ERP1 envia ITEM cadastrado para o ERP2
ERP1 somente enviará o ITEM se este estiver em uma das famílias cadastradas no parâmetro FAMILIA_INTEGRACAO.
Se o tipo de valorização do estoque for FIFO.
- ERP2 envia PEDIDO cadastrado para o ERP1
O pedido recebido no ERP1 vindo do ERP2 estará bloqueado para alteração.
Como fazer (opcional)
Descreva os passos que viabilizem a integração.
Exemplo:
Os passos para viabilizar a integração são:
- No Logix ou no Protheus efetue o cadastro das seguintes informações: Clientes, fornecedores, transportadores, cidades, cotação de moeda e unidades de medida.
- No Logix cadastrar um novo depositante e efetuar toda a parametrização necessária para a operação de WMS.
- No Logix cadastrar um novo produto que seja controlado pelo WMS, para o depositante cadastrado anteriormente.
- No Logix efetuar um processo de recebimento para o produto cadastrado anteriormente, utilizando uma nota fiscal provisória (tipo “A”).
- No Protheus consultar a nota fiscal de recebimento que foi registrada no Logix, validando as informações recebidas.
- No Logix efetuar um processamento de regularização fiscal, efetuando a cobertura dos produtos recebidos anteriormente.
- No Protheus verificar se foi efetuado corretamente o relacionamento entre os dois documentos.
- No Logix efetuar um processo de expedição para o novo produto cadastrado, até o momento do envio da mensagem de integração de pedido de venda.
- No Protheus efetuar o faturamento do pedido de venda recebido.
- No Protheus verificar se a nota fiscal gerada contém todas as informações necessárias para o segmento de operador logístico (armazém geral).
- No Protheus efetuar a escrituração fiscal das notas fiscais, verificando se as regras da legislação deste segmento foram respeitadas.
- No Logix é possível consultar o número do pedido de venda gerado para as notas fiscais de retorno simbólico e conta/ordem no programa WMS6333 (Consulta de Documentos). Para os processos de faturamento de serviço o número do pedido está disponível no programa WMS6411 (Movimentos a Faturar).
Situações comuns (opcional)
Descreva situações problemáticas comuns que podem ocorrer durante o funcionamento da integração e como solucioná-los. Neste ponto também é importante dar instruções de como reconhecer e investigar problemas que podem vir a ocorrer durante a integração. Se houver, apresente tabelas de códigos e descrições de erros que a integração poderá apresentar.
Este tópico possivelmente será alimentado com as experiências durante o desenvolvimento da integração e poderá ser realimentado durante o uso da integração no cliente.
Exemplo 1:
Tratamento de erros de integração (Produto A)
Erro | Mensagem | Solução |
Código do erro | Mensagem exibida | Ação a ser tomada para resolução do erro. |
Tratamento de erros de integração (Produto B)
Erro | Mensagem | Solução |
Código do erro | Mensagem exibida | Ação a ser tomada para resolução do erro. |
Exemplo 2:
Quando uma mensagem é enviada do Logix para o Protheus, podem ocorrer situações em que o WebService não estará totalmente funcional. Nestes casos uma mensagem de erro genérica irá aparecer na tela:
Exemplo:
Erro ao enviar a mensagem de Cidade via Integração
Se o arquivo de log for analisado, poderemos ver a falha na comunicação com o sistema destino:
-------------------------------------------------------------------------------
WSCERR044 / Não foi possível POST : URL http://172.16.31.57:8011/ws/FWWSEAI.apw
ADVPL WSDL Client 1.080707 / tst on 20120315 08:49:51
-------------------------------------------------------------------------------
Para resolver este problema, verifique as configurações do sistema de destino, analisando o funcionamento do servidor utilizado para esta comunicação e a habilitação do endereço do WebService.
Checklist de suporte da aplicação
Crie um check-list de verificação de alguns pontos importantes para o funcionamento e atendimento da integração.
Instalação/Configuração
Relacione itens de verificação para garantir que a integração está corretamente instalada e configurada. Isto não pode ser uma cópia do procedimento de instalação/configuração, mas verificações pontuais que podem remeter aos itens da instalação.
Checklist de Verificações:
Relacione itens de verificações para que o atendente possa:
- Identificar o funcionamento da integração;
- Identificar a ocorrências de problemas;
- Coletar evidências do mau funcionamento relatado pelo cliente;
- Realizar possíveis ajustes na integração quanto à configuração ou negócio.