Páginas filhas
  • Manual Operacional da Customização - Integração VTEX Orquestrador DN

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...


Objetivo
Este documento foi elaborado para orientar aos usuários-chave do SENAI DN sobre os requisitos e funcionalidades do Orquestrador, customização aplicada ao TOTVS Educacional (SGE) que atua na integração entre o PROTHEUS a API do Protheus (que é de gestão do SENAI DN) e a Plataforma VTEX. A partir da leitura dos dados das vendas/pedidos realizados pela plataforma VTEX, o Orquestrador envia as informações para as API 's do PROTHEUS SENAI DN retornando o status da integração à plataforma VTEX.

...


Metodologia
Este material tem como base a visão prática e completa do Processo Customizado, da área Educacional através da Customização existente - FS008696 - Integração VTEX - Orquestrador.
A metodologia utilizada tem como ponto de partida o mapeamento completo do respectivo processo, relacionado com as interfaces no Sistema TOTVS Educacional (SGE). Sempre que houver alguma atividade a ser realizada no Sistema, as suas funcionalidades e rotinas serão explicadas com detalhe.

Aviso

Esse projeto não trata exportação para o PROTHEUS da integração nativa, mas  sim para API do Protheus que é de gestão do SENAI DN.

Expandir
titlePremissas

Liberação dos anexos customizados na árvore de perfil:
Os anexos da customização - Integração VTEX devem ser liberados nas permissões de perfil dos usuários para aparecerem nos seus respectivos lugares. Para mais detalhes de como liberar no perfil dos usuários acesse o Manual de Instalação de Customizações na seção: Liberando Acesso aos Menus.


Expandir
titleParâmetros da Customização

A parametrização da customização da API PROTHEUS do PROTHEUS  deverá ser realizada de modo que sejam configurados as informações do endereço e dados de acesso para as API's do PROTHEUS (SENAI DN).

Essa parametrização está disponível em: TOTVS Educacional | Customização l Orquestrador VTEX l Parâmetros.



Na interface, os parâmetros processam a autenticação BASIC nas API's de exportação do PROTHEUS, para os quais o usuário deverá efetuar as seguintes parametrizações:

  • Endereço Webservice PROTHEUS: Endereço do webservice utilizado para exportação de clientes, contas a receber e cancelamentos do PROTHEUS;
  • Token: Token de autenticação do webservice PROTHEUS;
  • Número máximo de tentativas de reenvio: Quantidade de vezes que um registro deve ser reenviado, em caso de erro.



Expandir
titleConsulta de Pedidos VTEX

O processo de consulta de pagamentos VTEX, identifica os dados associados aos pagamentos das vendas realizadas e/ou canceladas.  Os dados de Pedidos VTEX, enviados para o a API PROTHEUS DN, serão consultados por este processo (Maiores detalhes sobre o processo, cliquei aqui), mas será acrescentados a consulta dos campos abaixo:

  • CNAE;
  • Inscrição Municipal;
  • Aderiu ao Simples;
  • Inscrição Estadual.
Expandir
titleExportação de Clientes para PROTHEUS

Após consulta dos Pedidos (conforme citado no item anterior), a é realizada a exportação de para o a API PROTHEUS DN. Esse processo exporta todos os dados consultados, realizando primeiramente uma identificação de cadastro de cliente pré-existente no PROTHEUS.

  • Para clientes que já possuem cadastro no PROTHEUS, seu cadastro será atualizada caso necessário.
  • Para clientes que ainda não possuem cadastro, seu cadastro será criado no PROTHEUS.

Esse processo pode ser agendado ou executado de forma manual através do Menu: TOTVS Educacional l Customização l Orquestrador VTEX l Exportação de Dados para o PROTHEUS.



As informações associadas ao cadastro de cliente enviadas ao PROTHEUS são:

  • Empresa: Código da empresa PROTHEUS - Valor fixo 01;
  • Filial: Código da filial - Valor fixo: 03DN0001;
  • CPF/CNPJ;
  • Tipo Pessoa: F - Pessoa física / J: Pessoa jurídica;
  • Nome Pessoa: Nome do responsável financeiro;
  • Inscrição Estadual: Pessoa física: Isento / Pessoa jurídica: Código de cadastro informado pelo cliente. Quando não preenchido: Isento;
  • Inscrição Municipal: Pessoa física: Isento / Pessoa jurídica: Código de cadastro informado pelo cliente. Quando não preenchido: Isento;
  • Endereço/Telefone: Inclui Logradouro, complemento, CEP, bairro, estado, código e nome da cidade, DDI/DDD, telefone;
  • País: Valor fixo 105;
  • E-mail;
  • Simples Nacional: Pessoa física: Valor fixo 2 / Pessoa jurídica: 1 para optante e 2 para não optante;
  • Contribuinte ICMS: Pessoa física: Valor fixo 2 / Pessoa jurídica: Se possuir inscrição estadual - valor fixo 2, se não possuir inscrição estadual - envia vazio;
  • País: Valor fixo 01058;
  • Código CNAE: Quando informado pelo cliente, enviado conforme a máscara/formato: 9999-9/99. Quando não localizado no PROTHEUS, será apresentado erro, registrado no monitor de LOG da integração.


Expandir
titleCliente Seller

A identificação de um cliente Seller (Pessoa jurídica) é realizada a partir da verificação do campo: Nome do Seller no cadastro do Item do pedido no Monitor de Vendas.

  • Cliente Não Seller: Corresponde a Loja Principal DN.
  • Cliente Seller: Corresponde às Lojas DR's e Parceiros.

Para cliente do tipo: Seller cujo CNPJ já se encontra cadastrado no PROTHEUS, não será aplicada nenhuma atualização ao PROTHEUS.  Já para um cliente do tipo: Seller que não tenha o CNPJ localizado/cadastrado no PROTHEUS, será apresentada uma mensagem de erro, gravado no monitor de LOG da integração.


Quando identificado mais de um cadastro de cliente associado a um mesmo CPF/CNPJ o processos executará as validações:

  • Identificação do código de cliente;
  • Venda realizada na Loja DN;
  • Venda realizada na Loja dos Sellers (DR's/Parceiros).


Informações

A customização verifica os itens do pedido, visto que, podem existir clientes diferentes para cada item de um mesmo pedido. O item do pedido não tem relação somente com o produto comprado, mas também com o cliente tipo: Seller.

Expandir
titleExportação de Contas a Receber para PROTHEUS

O processo de exportação de contas a receber envia os valores pagos no VTEX para o PROTHEUSAPI do PROTHEUS (SENAI DN).  Enviando as informações financeiras associadas aos pedidos realizados na plataforma VTEX, que estejam com status: Pronto para manuseio.

O usuário deve utilizar o mesmo processo de exportação de cliente, uma vez que não será possível enviar clientes e contas a receber separadamente.



Neste processo serão enviados os dados da transação, valores e parcelas que compõem o pedido, tais como:

  • Empresa: Código da empresa PROTHEUS - Valor fixo 01;
  • Filial: Código da filial - Valor fixo: 03DN0001;
  • Data da Venda do Pedido;
  • Forma de Pagamento: CC - Cartão de Crédito / CD - Cartão de Débito / BOL - Boleto / PIX - Pagamento via PIX;
  • ID VTEX: Código OrderID do pedido;
  • Código do Cliente;
  • Loja do Cliente;
  • Pedido de Venda: 
  • Número do Cartão: Quando utilizado os métodos de pagamento CC - Cartão de Crédito ou CD - Cartão de Débito;
  • Código da Autorização: Quando utilizado os métodos de pagamento CC - Cartão de Crédito ou CD - Cartão de Débito;
  • NSU: Quando utilizado os métodos de pagamento CC - Cartão de Crédito ou CD - Cartão de Débito;
  • Nosso Número: Quando utilizado o método de pagamento BOL - Boleto Bancário;
  • Código da Linha Digitável do Boleto Gerado: Quando utilizado o método de pagamento BOL - Boleto Bancário;
  • Código TXID Transação PIX: Quando utilizado o método de pagamento PIX - Pagamento via PIX;
  • Valor: Valor de cada parcela do pedido.


...

Expandir
titleExportação de Contas a Pagar para PROTHEUS

O processo de consulta de pagamentos VTEX, identifica os dados associados aos pagamentos das vendas realizadas e/ou canceladas.  Os dados de Pedidos VTEX, enviados para o PROTHEUS, serão consultados por este processo (Maiores detalhes sobre o processo, cliquei aqui). 

Sempre que o processo de consulta de pagamentos VTEX, identificar vendas com status cancelado é gerado um 'contas a pagar', conforme detalhado abaixo:

Para pedidos Cancelados na VTEX:

  • Caso o pedido com status cancelado na VTEX, já possuir registro no Monitor de Vendas (já exportado para o PROTHEUS) será enviado os dados para inclusão de Pagamento no PROTHEUS.
  • Caso o pedido cancelado ainda não possua registro no Monitor de Vendas, primeiramente será feito a Exportação de Cliente para o PROTHEUS (descrito no menu acima) e posteriormente o envio dos dados para inclusão de Pagamento no Protheus.


Aviso
titlePIX e Boleto

Para pedidos cancelados e que a forma de pagamento seja PIX ou Boleto, caso os dados bancários do Cliente não estejam preenchidos, não ocorrerá a exportação de contas a pagar.

Informações
  • A exportação de contas a pagar, considera a devolução total do valor do cancelamento.
  • Serão considerados tanto cancelamento feito diretamente na VTEX, quanto os realizados via SGE.
  • As regras de cancelamento, também se aplicam para os pedidos identificados como Cancelado Chargeback. (Para maiores informações Clique aqui).
Expandir
titleMovimentação do Pedido VTEX

Sempre  que a exportação de contas a receber é enviada com Sucesso para o a API PROTHEUS; é enviado automaticamente para plataforma VTEX, uma atualização para que o Pedido passe do status: Pronto para manuseio para Faturado.

Essa atualização pode ser visualizada na tela do Monitor de Vendas, no campo Status Pedido:



O campo Status Protheus, também exibido na tela do Monitor de Vendas, a cada tentativa de Integração do Pedido com o PROTHEUS, terá seu valor atualizando, considerando:

  • Não Integrado - indicando que o Pedido será exportando na próxima execução do processo de Integração
  • Integrado com Sucesso: Indicando que o pedido foi exportado com Sucesso para o PROTHEUS.
  • Integração com erro - Indicando que o podido não foi exportado, por algum erro/validação.

Caso ocorra algum erro durante esse envio para plataforma VTEX, o usuário poderá consultar para que os ajustes necessários sejam providenciados.

...

Expandir
titleMonitor de Log - Processo de Reenvio de Dados

Através do Monitor de Log, o usuário poderá processar o reenvio ao a API PROTHEUS dos registros que apresentam status de erro ou pendente, ou seja, que não foram exportados corretamente.
O processo de reenvio está disponível para execução em: TOTVS Educacional | Sistema Indústria | Orquestrador VTEX | Monitor de Log | Processos | Reenvio de Log.



O reenvio poderá ser executado de duas formas, a saber:

  • Manualmente: Quando executado de forma manual, ao acessar o monitor de log, será permitido o usuário selecionar apenas um único registro com o status de erro ou pendente por vez. Após selecionar o registro a ser reenviado, o usuário deverá clicar em: Processos l Reenvio de Log.
  • Automático: O envio automático, ou seja, via agendamento, se aplica a todos os registros gravados no monitor de log que apresentem status de erro ou pendente, conforme o número máximo de tentativas parametrizadas.

Ao processar o reenvio de log, a customização tentará realizar novamente o envio das informações ao PROTHEUS. Uma vez reenviado, o registro terá o seu status alterado para: Sucesso.


Aviso
titleObservações:
  • Caso o parâmetro (Número Máximo de tentativas) esteja vazio, a customização não realizará nenhuma tentativa de reenvio automaticamente;
  • Quando o número máximo de tentativas de reenvio for atingido e em nenhuma das tentativas tenha retornado sucesso, a customização passará o status do registro para Cancelado e, desta forma, não integrado ao PROTHEUS (SENAI DN). Dependendo do erro ocorrido, o usuário precisará acessar o Monitor de log e analisar os logs, corrigir os registros (caso necessário) e então acionar o processo de reenvio.