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 Objetos no banco de dados do ERP para realizar a consulta dos dados que serão enviados para a Vtex. Estes Objetos são adicionados ao banco de dados no ato 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 Objetos customizados, que não serão atualizados mediante à atualizações do integrador e poderão ficar sob total controle do cliente. 

Criação do Arquivo

Para utilização de Objetos customizados, deve-se criar 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".

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

 O conteúdo do arquivo customizacao.json ficará com o seguinte padrão:  

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

{
  "Objetos": {
    "Armazem": "VIEW_CUSTOMIZADA",
    "Categoria": "VIEW_CUSTOMIZADA",
    "Estoque": "VIEW_CUSTOMIZADA",
    "Fornecedor": "VIEW_CUSTOMIZADA",
    "ImagemProduto": "VIEW_CUSTOMIZADA",
    "Marca": "VIEW_CUSTOMIZADA",
    "Nsu": "VIEW_CUSTOMIZADA",
    "Preco": "VIEW_CUSTOMIZADA",
    "Produto": "VIEW_CUSTOMIZADA",
    "Sku": "VIEW_CUSTOMIZADA",
    "PedidoItemCorte": "VIEW_CUSTOMIZADA",
    "PedidoStatus": "VIEW_CUSTOMIZADA",
    "SpVerficaClienteEcommerce": "SP_CUSTOMIZADA",
    "SpInserePedVendaEcommerce": "SP_INSEREEDIPEDVENDAECOMMERCE",
    "SpVerficaClienteEcommerce": "SP_VERIFICACLIENTEECOMMERCE",
    "SpEdiFormaPagtoPedEcommerce": "SP_EDIFORMAPAGTOPEDECOMMERCE",
    "SpGeraTituloPedEcommerce": "SP_GERATITULOPEDECOMMERCE",
    "SpNsuPedVendaEcommerce": "SP_NSUPEDVENDAECOMMERCE"
  }
}

Pré-Requisitos e Restrições


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