Histórico da Página
Projeto: FS008780 - Conciliador GenéricoConciliador
Nome do Cliente: Confederação Nacional da Indústria - SENAI
...
Esse documento tem como base descrever a integração entre VTEX x GETNET x PROTHEUS, que visa conciliar as vendas feitas na VTEX, integrado ao Protheus do DN e a GTENETGETNET.
Para isso, será apresentada uma visão prática da solução desenvolvida, explorando os conceitos utilizados e as funcionalidades do Sistema. O material descreve algumas etapas referentes como:
...
Este material tem como base a visão prática e completa da funcionalidade Customizada.
| Aviso | |
|---|---|
Importante: O Portal Conciliador não está preparado para tratar transações referentes à plano de assinatura (onde o Order id do pedido fica errado no extrato da GetNet) e pedidos com itens de sellers diferentes, já que a transação foi definida para ter apenas um seller relacionado. | |
| Expandir | |
| title | Síntese
| Expandir | |||
|---|---|---|---|
| |||
Portal Web, totalmente apartado do SGE, com a finalidade de realizar a conciliação de vendas realizadas no VTEX, integrando com GetNet e Protheus. |
| Expandir | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
Pré-requisitos Acessar o ambiente de instalação do portal para acessar os parâmetros. Não existe interface no portal conciliador para informar os parâmetros. Detalhamento do Processo Os parâmetros necessários para execução dos processos devem ser Pré-requisitos Os anexos de retorno 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. Detalhamento do Processo Os parâmetros necessários para execução dos processos GetNet, VTEX serão informados no arquivo de configuração do Portal Conciliador (web.config). Deverão ser configurado os seguintes parâmetros: GetNet:URL API - Solicitação de extrato Token de acessoVTEX: URL API - Feed de Pedido URL API - Consulta Pedido Token de acessoProtheus: URL API - Busca Títulos URL API - Baixa Títulos URL API - Insere Títulos Authorization Ocp-Apim-Subscriotion-Key
| ||||||||||||||||||||
| Expandir | ||||||||||||||||||||
|
| Aviso | ||
|---|---|---|
| ||
Não está prevista funcionalidade de logoff automático do usuário após um período de inatividade. |
Autenticação dos usuários
A autenticação no portal será feita através do Azure do SENAI DN, ao acessar o endereço do Portal Conciliador, será exibida tela de login /autenticação do Azure, conforme exemplo abaixo:
Após login efetuado, o usuário será direcionado para o endereço inicial do Portal Conciliador, já autenticado.
Perfil / Grupos de usuários:
Todos os usuários com acesso ao Portal Conciliador terão acesso à todas as funcionalidades disponíveis. A restrição de acesso conforme o grupo será para visualização de dados pertinentes a cada Grupo/Regional.
Ao logar no Portal Conciliador, ele identificará o grupo do usuário logado e permitirá a visualização apenas dos dados do Regional (grupo) do usuário.
Caso um usuário esteja associado a mais de um grupo, ele terá permissão para visualizar os dados de todos os grupos associados. Usuários associados ao grupo SENAI DN não terão restrição de acesso à dados.
| Aviso | ||
|---|---|---|
| ||
A utilização dos grupos do Azure se faz necessária neste momento devido ao curto prazo para desenvolvimento das funcionalidades do Conciliador e necessidade imediata de controle de acesso à dados por Regional. Com a evolução do Portal Conciliador, este recurso poderá ser migrado para dentro do portal (usuários e perfis), com novo esforço e custo necessário para adequação. |
| title | Processo de Importação de Dados (Integração - Dados GetNet, VTEX e Protheus) |
|---|
Modelo de Solução
- Integrador
- Importar dados do Extrato Getnet
- Importar dados dos Pedidos VTEX - resumo
- Para cada pedido importado (GetNet/VTEX), importar dados dos títulos gerados no Protheus.
- Vincular as informações GetNet, VTEX e Protheus e preencher o status da conciliação (GetNet x VTEX e GetNet x Protheus).
- Transação
- Interface para visualização das transações, exibindo as informações importadas da GetNet, VTEX e Protheus, por pedido/tipo de transação (Crédito, Cancelamento e Chargeback), com seus respectivos status de conciliação (DN).
- GetNet: Exibir dados importados do extrato GetNet que são necessários para realizar a conciliação.
- VTEX: Exibir dados importados dos pedidos realizados no Marketplace que são necessários para realizar a conciliação.
- Protheus: Exibir dados importados dos títulos já gerados pela integração financeira entre VTEX e SGE, relacionados ao pedido.
- Conciliação: Exibir resumo da conciliação realizada automaticamente, mostrando informações que são comparadas dos três sistemas e evidenciando as diferenças, caso existam.
- Conferir manualmente
- Opção para o usuário marcar um registro como Conferido Manualmente e informar alguma observação pertinente. Utilizado apenas para os registros que não foram conciliados com sucesso automaticamente.
Detalhamento do Processo
No menu do Portal Conciliador, será exibida uma opção chamada Integrador, que terá três submenus responsáveis por realizar a importação dos dados da VTEX, GetNet e Protheus, gravando o vínculo entre eles, quando identificado.
O processo de importação não será automatizado neste momento. Ele precisa ser disparado manualmente por algum usuário responsável (administrador financeiro) e não terá opção de informar o período que deseja consultar. Para isso o usuário devera acionar os seguintes processos:
1- Buscar dados das Transações GetNet (Extrato)
Ao acionar o processo de Importação de Dados, os dados das transações realizadas e processadas pela GetNet serão obtidos através da API GetNet de solicitação de extrato eletrônico (demonstrativo), serão buscados todos os registros desde a última execução do processo até a data atual.
Serão importadas transações de Crédito à vista, Crédito Parcelado Lojista, Crédito Parcelamento Administradora, Cancelamento e Chargeback com status igual a 0-Aprovado. Transações com status Não Aprovado ou outro status diferente de Aprovado não serão importadas para o Conciliador.
Conciliação Automática
Ao importar os dados do GetNet, os status da conciliação entre GetNet e VTEX e GetNet e Protheus deverão ser preenchidos automaticamente, de acordo com o tipo de transação (crédito, cancelamento e chargeback) e a conferência e comparação de dados, conforme descrito nos itens Conciliação dos sub-requisitos de Transações (crédito, cancelamento e chargeback).
2- Busca dados das vendas VTEX (Pedidos)
Ao acionar o processo de Importação de Dados, os dados das vendas realizadas através do Marketplace VTEX serão obtidos, através da API VTEX, e gravados na tabela correspondente do Portal Conciliador. Serão buscados todos os pedidos disponíveis no feed de pedidos VTEX.
Importante:
- Serão buscados todos os pedidos realizados no VTEX e disponíveis no feed. Uma vez importado para o conciliador, o pedido não será alterado. Portanto, caso ocorra atualização de status (cancelado, por exemplo), o status do pedido não será atualizado no Conciliador.
- Cada pedido do VTEX pode ser composto por mais de um item (Curso). No extrato da GetNet, recebemos uma transação única referente ao pedido. Portanto, no contexto do conciliador, precisamos somar os valores dos itens do pedido VTEX para comparar com o valor do pedido/transação no extrato GetNet.
- No VTEX existem pedidos referentes à cursos gratuitos, que não geram dados financeiros e contrato. Estes pedidos não serão importados para o conciliador. Para identificá-los, iremos buscar apenas os pedidos com dados de pagamento preenchidos (paymentData).
- Não será gerado log detalhado do processo de importação. Ao finalizar a importação, será exibida na tela a informação do status da importação (sucesso ou erro) e mensagem de erro, caso ocorra. Caso o log detalhado seja necessário, deverá ser contratado escopo adicional para tratá-lo.
Conciliação Automática
Ao importar os dados do VTEX, o status da conciliação entre GetNet e VTEX deverá ser preenchido automaticamente (transações de crédito) conforme conferência e comparação de dados, descrito no Req.02.1 - Transações dos tipos Crédito à vista, Crédito Parcelado Lojista e Crédito Parcelamento Administradora / Conciliação.
3- Buscar dados dos títulos no Protheus
Em andamento
| title | Conciliação da Transação |
|---|
Pré-requisitos
Identificar se as vendas que aconteceram no VTEX tem registro de extrato relacionado no GetNet e vice-versa.
Detalhamento do Processo
A interface de conciliação VTEX x GetNet x Protheus poderá ser acionada através do menu lateral chamado Transação. Ao clicar no menu, será exibida a página com a lista de pedidos e suas informações (GetNet, VTEX e Protheus), com informações do vínculo entre eles e o status da conciliação dos dados.
conciliador appsettings.json, disponível no diretório de instalação (exemplo: c:\TOTVS\ApiConciliador). Segue a lista:
| Expandir | ||
|---|---|---|
| ||
Parâmetros de Acesso:
|
| Expandir | ||
|---|---|---|
| ||
Parâmetros de acesso:
Outros Parâmetros:
|
| Expandir | ||
|---|---|---|
| ||
Parâmetros de acesso:
Outros parâmetros:
|
| Aviso | ||
|---|---|---|
| ||
Não existe interface para preenchimento destes valores. |
| Expandir | ||
|---|---|---|
| ||
Detalhamento do Processo Por meio do arquivo appsettings.json, será possível adicionar grupos de novos regionais ou parceiros. Para incluir ou atualizar um Seller, será necessário utilizar o seguinte template base conforme exemplo abaixo, disponível em: c:\TOTVS\Conciliador\ConciliadorPortal { Após o usuário informar os valores para cada campo citado acima, será necessário incluir estas informações do template no arquivo appsettings.json dentro da lista de Sellers.
|
| Expandir | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Pré-requisitos A publicação deste portal pode ser feita através do Internet Information Services (IIS) Windows. Detalhamento do Processo O Portal Conciliador terá uma estrutura própria de login e layout. Os dados serão armazenados na nova base de dados criada. Os campos e filtros serão definidos no detalhamento de cada tela/página que compõem o portal. A página inicial do portal irá trazer a lista de menus disponíveis na lateral esquerda, conforme modelo abaixo:
O usuário terá opção de realizar o logoff do portal, através de ícone no canto superior direito.
Autenticação dos usuários A autenticação no portal será feita através do Azure do SENAI DN, ao acessar o endereço do Portal Conciliador, será exibida tela de login /autenticação do Azure, conforme exemplo abaixo:
Após login efetuado, o usuário será direcionado para o endereço inicial do Portal Conciliador, já autenticado. Perfil / Grupos de usuários: Todos os usuários com acesso ao Portal Conciliador terão acesso à todas as funcionalidades disponíveis. A restrição de acesso conforme o grupo será para visualização de dados pertinentes a cada Grupo/Regional. Ao logar no Portal Conciliador, ele identificará o grupo do usuário logado e permitirá a visualização apenas dos dados do Regional (grupo) do usuário. Caso um usuário esteja associado a mais de um grupo, ele terá permissão para visualizar os dados de todos os grupos associados. Usuários associados ao grupo SENAI DN não terão restrição de acesso à dados.
|
| Expandir | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Funcionalidades do menu Integrador
Detalhamento do Processo No menu do Portal Conciliador, será exibida uma opção chamada Integrador, que terá submenus responsáveis por realizar a importação dos dados da VTEX, GetNet, Protheus e Pagamentos, gravando o vínculo entre eles, quando identificado.
O processo de importação não será automatizado neste momento. Ele precisa ser disparado manualmente por algum usuário responsável (administrador financeiro) e não terá opção de informar o período que deseja consultar.
|
| Expandir | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
|
| Expandir | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
Funcionalidades do menu Transação
Pré-requisitos Executar os processo de importação de dados (Integrador), para identificar se as vendas que aconteceram no VTEX tem registro de extrato relacionado no GetNet e vice-versa. Detalhamento do Processo A interface de conciliação VTEX x GetNet x Protheus poderá ser acionada através do menu lateral chamado Transação. Será exibida a lista de pedidos e suas informações (GetNet, VTEX e Protheus) e os status das conciliações dos dados. O usuário terá a opção de expandir os dados das vendas do VTEX, do extrato GetNet e dos títulos do Protheus, vinculadas através do número do pedido e seus respectivos status de Conciliação.
Ao acessar este menu, será exibida interface com opções de filtros disponíveis para exibição dos registros, que serão:
Esta interface lista todas as transações de crédito, cancelamento e chargeback. O filtro da interface ficou definido da seguinte forma:
Após seleção dos filtros, será exibida a lista de transações/pedidos conforme valores informados pelo usuário. A relação de informações será exibida nos blocos de informações (GetNet, VTEX, Protheus e Conciliação) conforme os seguintes tipos de transação abaixo.
|
| Expandir | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Funcionalidade do menu Recebimentos
Detalhamento do Processo A Interface de Recebimentos esta disponível no portal Conciliador através do menu lateral, ao clicar neste menu será exibidos os dados do extrato GetNet referentes aos pagamentos efetuados para o SENAI, de forma resumida, com opção de expandir o registro para visualização dos detalhes importados do GetNet, Protheus e sua Conciliação. Cada pagamento precisa ter um título correspondente no Protheus. Para conciliação diária de recebimentos, é necessário verificar quais são os registros de pagamento obtidos no extrato GetNet, os registros referentes aos descontos realizados pela GetNet em decorrência de cancelamento ou chargeback e os títulos relacionados a todas essas transações/pagamentos (contas a pagar e receber).
Ao acionar a interface de Conciliação de Recebimentos, será possível visualizar os dados dos pagamentos do extrato GetNet, crédito ou débito, obtidos através da API GetNet de solicitação de extrato eletrônico, e seus respectivos títulos gerados no Protheus, obtidos através das APIs Protheus (a pagar e a receber). As informações desta interface não serão agrupadas por Pedido, como acontece com a interface de Conciliação das Transações. Na tela inicial, será exibida uma linha para cada pagamento/título identificado. Ao acessar, será exibida interface com opções de filtros disponíveis para exibição dos registros, que serão:
Ao digitar na caixinha, a pesquisa é feita automaticamente a partir dos registros existentes na tela. Ao clicar em busca avançada, é exibida interface que possibilita fazer um filtro mais detalhado, conforme campos disponíveis abaixo:
Ao expandir o registro, serão detalhadas as informações da GetNet e Protheus, além dos dados da Conciliação, conforme abaixo:
Ao clicar na seta para expandir, os dados são exibidos conforme abaixo:
|
| Expandir | ||||
|---|---|---|---|---|
| ||||
O processo de Extração de dados é acionado no Menu lateral que tem o mesmo nome: Extração de Dados:
Ao acessar o Menu será apresentado na tela os seguintes campos:
Ao clicar em Gerar arquivo é apresentado uma mensagem de informando que o tempo de geração vai depender do volume de dados do período selecionado. E quando finalizado o processo será apresentada uma notificação que a geração foi concluida.
Quando o arquivo é gerado, será apresentado no grid a linha com o nome do Arquivo, as datas de referencia, a data de execução e a ações (download e exclusão).
O usuário poderá selecionar o tipo do arquivo que deseja fazer o Download: CVC ou XLSX
No arquivo são apresentados os dados do recebimento. Exemplo:
Os arquivos gerados, permaneceram no grid até que o usuário faça a exclusão. Para que isso acontece é necessário clicar no ícone de exclusão na linha do arquivo desejado:
|
| Expandir | |||||
|---|---|---|---|---|---|
| |||||
Funcionalidade do menu Valores Diários
Detalhamento do Processo A interface de Valores Diários deve realizar o somatório dos valores conforme abaixo, com regras diferenciadas para vendas de DN e DRs/Parceiros: Total Recebimentos: São considerados os pagamentos de crédito (sinal +): Total Descontos: São considerados os pagamentos de débito (sinal -):
Ao acessar a interface, o usuário poderá visualizar a lista de registros por data e preencher os campos necessários. Será uma visão, que listará os seguintes campos:
|
| Expandir | |||||
|---|---|---|---|---|---|
| |||||
Funcionalidades do menu Baixa de Títulos
Detalhamento do Processo Enviar para o Protheus, através de API, a baixa dos títulos pagos ou descontados pela GetNet na data referenciada, já registrados nas interfaces de Recebimentos. Serão enviados todos os títulos associados aos Recebimentos: pagamentos do extrato GetNet a receber (crédito) ou a pagar (cancelamento e chargeback). O menu Baixa de Títulos, estará disponível no portal conciliador, para o usuário enviar as baixas dos títulos diariamente para o Protheus e visualizar eventuais erros que possam ocorrer no processo. Para executar o processo de baixa de títulos, o usuário deverá clicar no botão Executar Processo e informar uma data referência para envio da baixa para o Protheus.
Ao clicar em Executar, a customização só irá enviar a baixa dos títulos se o valor do banco estiver preenchido na interface Valores Diários para a data de referência selecionada. Não será validada a diferença entre o valor depositado no banco (informado pelo usuário) e os valores de pagamentos e cancelamentos. Não será possível selecionar registros/títulos. Este processo deverá identificar todos os pagamentos efetuados pela GetNet na data referência (recebimentos e abatimentos), para então localizar os títulos correspondentes no Protheus para envio da baixa. Serão enviadas para o Protheus a baixa de todos os títulos cuja a data de pagamento da GetNet seja igual a data referência informada (a pagar e receber). Ao acessar este menu, será exibida a interface com logs dos últimos processamentos feitos por data e tipo (pagar ou receber), com opção de reprocessamento em caso de erro, para execução manual. Serão exibidos os dados:
Ao clicar no botão "Executar baixa" será exibida uma tela para ser informada a data de referência a ser considerar para baixa dos títulos. Importante: Foi adicionado um novo status para os registros de processamento de baixa, por data e tipo (pagar e receber):
Ao expandir (clicar na seta) o registro será exibida a lista dos títulos processados por data e tipo, seus respectivos status de baixa e mensagem de erro (quando existir), como detalhe do log do processo.
Caso exista pelo menos um título com status de Baixa com Erro, o status do processamento será Erro o usuário deverá processar novamente a data referência através desta interface. Nestes casos, serão enviadas novamente apenas as baixas dos títulos que ainda não foram baixados. Quando todos os títulos da data/referência estiverem baixados com sucesso, o status do processamento deve ser alterado para Sucesso. O usuário poderá visualizar o identificador do título com erro através desta interface, ao expandir o resumo da execução do processo. Após processamento, será gravado resumo do log do processo, status geral do processamento e status da baixa por título.
|
| Expandir | ||||||
|---|---|---|---|---|---|---|
| ||||||
Publicação e disponibilização do Portal Conciliador + Api em ambiente produção:
| ||||||
| Expandir | ||||||
| ||||||
Pré-requisitos Este botão ficará habilitado para usuário, apenas quando a transação selecionada estiver com status GetNet x VTEX ou GetNet x Protheus diferente de Conciliado (21) ou igual a Conferido Manualmente, caso um dos dois ou os dois estejam com valores diferentes será exibido a caixa com o campo observação e o botão salvar. Detalhamento do Processo O menu Conferir Manualmenteestá disponível na interface de Conciliação de Transação no portal Conciliador e o usuário poderá alterar o status da conciliação manualmente (GetNet x VTEX e GetNet x Protheus), nos casos em que as transações não tenha sido conciliadas automaticamente, pelo conciliador genérico. Ao clicar neste menu, a customização irá habilitar uma caixa de texto para o usuário preencher alguma observação na transação e salvar. Neste momento, os status da conciliação(GetNet x VTEX e/ou GetNet x Protheus) serão alterados para Conferido Manualmente e ficarão visíveis na página inicial da transação.
Através desta mesma interface será possível visualizar as observações já preenchidas. |
Import HTML Content
Visão Geral
Conteúdo das Ferramentas