Home TOTVS Varejo Supermercados

Árvore de páginas

Versões comparadas

Versão antiga 1

changes.mady.by.user Andre Guaraldo Caires

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Marco Antonio Gimenes Junior

Gravado em

Chave

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

Objetivos

Este documento tem como objetivo explicar o funcionamento das customizações dos objetos de integração.

Customização dos Objetos

O Integrador Vtex se utiliza de Views Objetos no banco de dados do ERP para realizar a consulta dos dados que serão enviados à para a Vtex. Estas Views Estes Objetos são adicionadas adicionados ao banco de dados no ato de da instalação do integrador e são atualizadas no ato da execução do sistema. . Alguns Objetos que o integrador Vtex utiliza também são nativos do ERP.

Entretanto, mediante à as necessidades de clientes, é possível utilizar Views customizadas Objetos customizados, que não serão atualizadas atualizados mediante à atualizações do integrador e poderão ficar sob total controle do cliente. 

Criação do Arquivo

Para utilização de Views customizadas Objetos customizados, deve-se criar um a pasta _IntegradorNativoVtexConfiguracoes no disco C: e dentro desta pasta o arquivo chamado "customizacao.json".

O caminho desse arquivo deverá ser informado no parâmetro "CaminhoArquivoCustomizacao" do arquivo "appsettings.json" que fica na raiz do projeto "C:\TOTVS_Varejo_Supermercados\Servicos\Integracao_Nativa_VTEX\IntegradorNativoVtex\appsettings.json".

Image Added

O valor padrão desse parâmetro é "C://_IntegradorNativoVtexConfiguracoes/customizacao.json". Podendo ser customizado.

 O conteúdo do arquivo customizacao.json ficará com Integrador (mesmo diretório contendo o arquivo appsettings.json). O conteúdo do arquivo deve seguir o seguinte padrão:  

Image Added

Seguir os nomes das chaves que contém no appsettings.json conforme exemplo abaixo:

{
  "ViewsObjetos": {
    "NOME_DA_CARGAArmazem": "VIEW_CUSTOMIZADA",
    "Categoria": "VIEW_CUSTOMIZADA",
    "Estoque": "NOME_DA_VIEW_CUSTOMIZADA",
    "Fornecedor": "VIEW_CUSTOMIZADA",
  }
}Dentro do arquivo "appsettings.json", que contém configurações utilizadas pelo integrador, existe uma estrutura similar, contendo os nomes das cargas disponíveis e os nomes das Views oficiais do projeto: 
{
  "Views": {  "ImagemProduto": "VIEW_CUSTOMIZADA",
    "Marca": "VIEW_CUSTOMIZADA",
    "ArmazemNsu": "ECMIVVIEW_ARMAZEMCUSTOMIZADA",
    "CategoriaPreco": "ECMIVVIEW_CATEGORIASCUSTOMIZADA",
    "EstoqueProduto": "ECMIVVIEW_ESTOQUESCUSTOMIZADA",
    "FornecedorSku": "ECMIVVIEW_FABRICANTESCUSTOMIZADA",
    "ImagemProdutoPedidoItemCorte": "ECMIVVIEW_IMAGENS_PRODUTOSCUSTOMIZADA",
    "MarcaPedidoStatus": "ECMIVVIEW_MARCASCUSTOMIZADA",
    "NsuSpVerficaClienteEcommerce": "ECMIVSP_PEDIDO_NSUCUSTOMIZADA",
    "PrecoSpInserePedVendaEcommerce": "ECMIVSP_PRECOSINSEREEDIPEDVENDAECOMMERCE",
    "ProdutoSpVerficaClienteEcommerce": "ECMIVSP_PRODUTOSVERIFICACLIENTEECOMMERCE",
    "SkuSpEdiFormaPagtoPedEcommerce": "ECMIVSP_EMBALAGENSEDIFORMAPAGTOPEDECOMMERCE",
    "PedidoItemCorteSpGeraTituloPedEcommerce": "ECMIV_PEDIDO_ITEM_CORTESP_GERATITULOPEDECOMMERCE",
    "PedidoStatusSpNsuPedVendaEcommerce": "ecmivSP_pedido_statusNSUPEDVENDAECOMMERCE"
  }
}Alguns detalhes em relação à customização das Views: 

Pré-Requisitos e Restrições


Aviso
  • Sempre reiniciar o Serviço Integração Nativa VTEX - Serviço Integração após inserir um objeto customizado no arquivo de customização.
  • Os dados retornados pelas Views customizadas devem possuir o mesmo nome e tipo de dados retornados pelas Views oficiais. 
    • Exemplo: caso deseje customizar um campo "Descricao" na View de Produtos, o campo retornado na view customizada deve possuir o mesmo nome "Descricao". 

  • Os dados de entrada das procedures customizadas devem possuir o mesmo nome e tipo de dados das procedures oficiais. 
    • Exemplo: caso deseje customizar uma funcionalidade da "SpVerficaClienteEcommerce", os parâmetros de entrada da procedure customizada devem possuir os mesmos nomes dos da procedure original.
  • O conteúdo

...

  • dos Objetos existente no arquivo "appsettings.json" não deve ser alterado.

...

  • Objetos customizados devem ser declaradas exclusivamente no arquivo "customizacao.json"
  • O arquivo "customizacao.json" não precisa declarar

...

  • Objetos que não foram

...

  • customizados. 
    • Exemplo: caso apenas a View de Marcas seja customizada, o arquivo "customizacao.json" conterá apenas a chave "Marca" e o

...

    • nome da view customizada.

...

    •  
  • As views ecmiv_precos,ecmiv_embalagens,ecmiv_estoques e ecmiv_imagens_produtos são chamadas pelo integrador dentro de functions. Caso uma dessas views sejam customizadas, é necessário customizar também a function e inserir a view customizada.
    • Exemplo: View de preço customizada. Encontrar a function fn_busca_ecmiv_precos. Customizar a mesma e inserir a view customizada dentro dela.