Manual Operacional da Customização - Integração VTEX Orquestrador DN

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.

A parametrização da customização da API 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.

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 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.

Após consulta dos Pedidos (conforme citado no item anterior), é realizada a exportação para 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:

O processo de exportação de contas a receber envia os valores pagos no VTEX para API 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 de acordo com a forma de pagamento:

• 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.

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, conforme citado anteriormente.

EXEMPLO

Pedido Id: 122550
Valor Total do Pedido: R$ 300,00
Itens do Pedido:

• Curso A: Valor R$ 100,00 - Seller: SENAI Bahia - Comissão*: R$ 10,00
• Curso B: Valor R$ 100,00 - Loja Principal DN
• Curso C: Valor R$ 100,00 - Seller: SENAI Bahia - Comissão: R$ 10,00

Verificados os itens do pedido, serão enviadas ao PROTHEUS duas contas a receber, conforme:

• Conta a receber 01: Com ao cliente SENAI Bahia - Valor R$ 20,00
• Conta a receber 02: Com cliente que realizou a compra na Loja Principal DN - Valor R$ 100,00

 *COMISSÃO

O cálculo do valor correspondente a comissão a partir das vendas/pedidos de clientes do tipo Seller, é realizado considerando:
Valor do percentual da comissão x o Valor do Item .

Este será o valor enviado apenas para itens vendidos por Seller, dividido pelo número de parcelas. Caso o pagamento tenha sido parcelado, os valores serão enviados divididos pelo número de parcelas do pagamento do Pedido.

Pedido Id: 122552
Valor: R$ 100,00
Comissão: 10%
Itens do Pedido:

• Curso A: Valor R$ 100,00

Total Comissão Seller SENAI Bahia: R$ 10,00
Pedido Id: 122552
Valor: R$ 300,00
Parcelamento: 02 Parcelas
Itens do Pedido:

• Curso A: Valor R$ 100,00 - Comissão: R$ 10,00 - Seller: SENAI Bahia
• Curso B: Valor R$ 100,00 - Loja Principal DN
• Curso C: Valor R$ 100,00 - Comissão: R$ 10,00 - Seller: SENAI Bahia

Verificados os itens do pedido dividido em 2X, serão enviadas ao PROTHEUS duas contas a receber, conforme:

• Conta a receber 01: Correspondente ao cliente SENAI Bahia - Valor R$ 20,00

02 parcelas de R$10,00 (cada).

• Conta a receber 02: Correspondente ao cliente Loja Principal DN - Valor R$ 100,00

02 parcelas de R$50,00 (cada).

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.

Sempre  que a exportação de contas a receber é enviada com Sucesso para 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.

O Monitor de Log, disponível em: TOTVS Educacional | Sistema Indústria | Orquestrador VTEX | Monitor de Log, armazena os dados exportados dos registros relacionados à Integração VTEX, possibilitando o acompanhamento e identificação dos registros exportados e importados com sucesso ou que necessitam ser reenviados.

A funcionalidade é baseada em duas visões, sendo a primeira o valor de registro principal e a segunda (Item Log) representando os detalhes de cada situação do registro principal.

Ao clicar sobre um registro de log, o usuário poderá consultar as demais informações complementares associadas ao registro, tais como:

• Id Log: Identificador sequencial de Log;
• Campos Chave: Descrição dos campos utilizados para gerar o registro integrado;
• Valores Chave: Chave primária do registro integrado;
• Status: Situação da Integração (Sucesso ou Erro);
• Funcionalidade: Tipo de Processo que está sendo feito (Por exemplo: Exportação de Dados);
• Data de Criação: Data de Criação do registro;
• Data da última alteração: Data da última alteração do registro;
• Número de tentativas de Reenvio: Quantidade de vezes que um registro já foi reenviado;
• Criador por: Usuário responsável pela inclusão do registro;
• Alterado Por: Usuário responsável pela alteração do registro;
• Módulo: Orquestrador VTEX.

No item de log terá disponível para consulta os seguintes campos:

• Id. Item Log: Identificador sequencial de log.;
• Id. Log: Identificador sequencial de log;
• Mensagem: Mensagem com o status da integração do item;
• Status: Situação da integração do item selecionado;
• Dados Enviados: Relação dos dados enviados para integração;
• Dados Recebidos: Relação dos dados recebidos;
• Data de Criação: Data de criação do registro;
• Data da Última Alteração: Data da última alteração do registro.

Através do Monitor de Log, o usuário poderá processar o reenvio 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.