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.

...

Aviso

Esse projeto não trata exportações para o PROTHEUS (integração nativa), mas sim, para uma API do PROTHEUS que é exclusiva e de gestão do SENAI DN.

title
Informações
iconfalse

Toggle Cloak

Expandir

Premissas


Cloak

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

o Manual de Instalação de

Customizações na

Customizações na seção: Liberando Acesso aos Menus.



Image Removedexpand
Informações
icon
title
false

Toggle Cloak
Parâmetros da Customização

Cloak

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.

Image Removed

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.

Image Removedexpand
Informações
icon
title
false

Toggle Cloak
Consulta de Pedidos VTEX

Cloak

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

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.

Image Removed

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
icon
title
false

Toggle Cloak
Exportação de Clientes

Cloak

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.

Image Removed
Image Removed

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

Empresa:
Campo Protheus CampoObservações
EmpresaEmpresaCódigo da empresa PROTHEUS - Valor fixo 01
;
FilialFilial
:
Código da filial - Valor fixo: 03DN0001
;
CPFCNPJCPF/CNPJCPF/CNPJ
;
do cliente
A1_PESSOATipo Pessoa
:
F - Pessoa física / J: Pessoa jurídica
;
A1_NOMENome Pessoa
:
Nome do responsável financeiro
;
A1_INSCRInscrição Estadual
:
Pessoa física: Isento / Pessoa jurídica: Código de cadastro informado pelo cliente. Quando não preenchido: Isento
;
A1_INSCRMInscriçã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
    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

    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.

    A1_ENDEndereçoLogradouro do residência do cliente
    A1_COMPLEMComplementoComplemento do residência do cliente
    A1_CEPCEPCEP do cliente
    A1_BAIRROBairroBairro do cliente
    A1_ESTEstadoEstado do cliente
    A1_COD_MUNCódigo do MunicípioCódigo do Município do cliente 
    A1_MUNMunicípioMunicípio do cliente
    A1_DDIDDIDDI do cliente
    A1_DDDDDDDDD do cliente
    A1_TELTelefoneTelefone do cliente
    A1_PAISCódigo do PaísCódigo do país do cliente - Valor fixo 105
    A1_EMAILE-mailE-mail do cliente
    A1_SIMPNACSimples NacionalPessoa física: Valor fixo 2 / Pessoa jurídica: 1 para optante e 2 para não optante;
    A1_CONTRIBContribuinte ICMSPessoa 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;
    A1_CNAECódigo CNAEQuando 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.
    Cliente 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).


    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.

    Informações
    iconfalse

    Toggle Cloak
    Exportação de Contas a Receber

    Cloak

    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, tais como:


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


    contasReceberdebitoCartão de Débito

    Dados utilizados pela integração quando a forma de pagamento é por cartão de débito:


    Campo ProtheusCampoObservações
    EmpresaEmpresaCódigo da empresa PROTHEUS - Valor fixo 01
    FilialFilialCódigo da filial - Valor fixo: 03DN0001
    Data_VendaData da Venda do PedidoData da Venda do Pedido
    E1_XFORMPGForma de PagamentoCC - Cartão de Crédito / CD - Cartão de Débito / BOL - Boleto / PIX - Pagamento via PIX
    E1_XIDVTEXOrderID VTEXCódigo do pedido no VTEX
    E1_CLIENTECódigo do ClienteCódigo do Cliente
    E1_LOJALoja do ClienteLoja do Cliente
    E1_PEDIDOPedido de VendaPedido de Venda
    E1_CARTAONúmero do CartãoNumero do cartão de crédito ou cartão de débito
    E1_CARTAUTCódigo da AutorizaçãoCódigo de autorização do cartão 
    E1_NSUETFNSUNSU do cartão
    E1_XVLRDR

    E1_XQPARDR

    parcelas (E1_VALOR)ParcelasValor de cada parcela do pedido
    creditoCartão de CréditoDados utilizados pela integração quando a forma de pagamento é por cartão de crédito:


    Campo ProtheusCampoObservações
    EmpresaEmpresaCódigo da empresa PROTHEUS - Valor fixo 01
    FilialFilialCódigo da filial - Valor fixo: 03DN0001
    Data_VendaData da Venda do PedidoData da Venda do Pedido
    E1_XFORMPGForma de PagamentoCC - Cartão de Crédito / CD - Cartão de Débito / BOL - Boleto / PIX - Pagamento via PIX
    E1_XIDVTEXOrderID VTEXCódigo do pedido no VTEX
    E1_CLIENTECódigo do ClienteCódigo do Cliente
    E1_LOJALoja do ClienteLoja do Cliente
    E1_PEDIDOPedido de VendaPedido de Venda
    E1_CARTAONúmero do CartãoNumero do cartão de crédito ou cartão de débito
    E1_XVLRDR

    E1_XQPARDR

    parcelas (E1_VALOR)ParcelasValor de cada parcela do pedido
    boletoBoletoDados utilizados pela integração quando a forma de pagamento é por boleto:


    Campo ProtheusCampoObservações
    EmpresaEmpresaCódigo da empresa PROTHEUS - Valor fixo 01
    FilialFilialCódigo da filial - Valor fixo: 03DN0001
    Data_VendaData da Venda do PedidoData da Venda do Pedido
    E1_XFORMPGForma de PagamentoCC - Cartão de Crédito / CD - Cartão de Débito / BOL - Boleto / PIX - Pagamento via PIX
    E1_XIDVTEXOrderID VTEXCódigo do pedido no VTEX
    E1_CLIENTECódigo do ClienteCódigo do Cliente
    E1_LOJALoja do ClienteLoja do Cliente
    E1_PEDIDOPedido de VendaPedido de Venda
    E1_XIDTRAN

    E1_XVLRDR

    E1_XQPARDR

    parcelas (E1_VALOR)ParcelasValor de cada parcela do pedido
    pixPix
    Campo ProtheusCampoObservações
    EmpresaEmpresaCódigo da empresa PROTHEUS - Valor fixo 01
    FilialFilialCódigo da filial - Valor fixo: 03DN0001
    Data_VendaData da Venda do PedidoData da Venda do Pedido
    E1_XFORMPGForma de PagamentoCC - Cartão de Crédito / CD - Cartão de Débito / BOL - Boleto / PIX - Pagamento via PIX
    E1_XIDVTEXOrderID VTEXCódigo do pedido no VTEX
    E1_CLIENTECódigo do ClienteCódigo do Cliente
    E1_LOJALoja do ClienteLoja do Cliente
    E1_PEDIDOPedido de VendaPedido de Venda
    E1_XIDTRAN

    E1_XDTHRPX

    E1_XVLRDR

    E1_XQPARDR

    parcelas (E1_VALOR)ParcelasValor de cada parcela do pedido

    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.

    Image RemovedNeste 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.
    Informações
    iconfalse
    Expandir
    titleContas a Receber Seller

    Toggle Cloak
    Exportação de Contas a Receber Seller

    Cloak

    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.

    status

    colour

    Green

    titlecolour

    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


     

    Estadotitle

    Yellow

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

    Image Removed

     

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

    info

    titlePagamentos por PIX ou Boleto

    Durante o processo de envio de Contas a receber, quando identificado que um pedido é da modalidade de pagamento pix ou boleto,  a customização consultará o valor do repasse do Monitor de Vendas. Não será realizada a soma do repasse de cada item

    expand
    Informações
    icon
    title
    false

    Toggle Cloak
    Exportação de Contas a Pagar

    Cloak

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


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

    • 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).
    expand
    Informações
    icon
    title
    false

    Toggle Cloak
    Movimentação do Pedido VTEX

    Cloak

    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:

    Image Removed

    Image Removed

    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.

    title
    Informações
    Expandir
    iconfalse

    Toggle Cloak

    Monitor de Log

    Cloak

    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.

    Image Removed

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

    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.
    Image Removed
    title
    Aviso


    Observação:

    Os registros apresentados no monitor de log leitura não poderão ser manipulados, ou seja, não será permitido ao usuário realizar alterações como inclusão, edição e exclusão.

    expand
    Informações
    icon
    title
    false

    Toggle Cloak
    Monitor de Log - Processo de Reenvio de Dados

    Cloak

    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.

    Image Removed


    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.

    title
    Aviso

    Observaçõ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.