Home TOTVS Varejo Supermercados

Árvore de páginas

Versões comparadas

Versão antiga 3

changes.mady.by.user Almir da Silva Rosa

Gravado em

comparado com

Nova versão 4

changes.mady.by.user Almir da Silva Rosa

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 das Views 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 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 "InstallationFiles\APIIntegrador.zip\appsettings.json".

Image Added

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

 O conteúdo do arquivo deve seguir o seguinte padrão:  


{
   "Objetos": {
    "NOME_DA_CARGA": "NOME_DA_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 dos Objetos oficiais do projeto: 
{
  "Objetos": {
    "Armazem": "ECMIV_ARMAZEM",
    "Categoria": "ECMIV_CATEGORIAS",
    "Estoque": "ECMIV_ESTOQUES",
    "Fornecedor": "ECMIV_FABRICANTES",
    "ImagemProduto": "ECMIV_IMAGENS_PRODUTOS",
    "Marca": "ECMIV_MARCAS",
    "Nsu": "ECMIV_PEDIDO_NSU",
    "Preco": "ECMIV_PRECOS",
    "Produto": "ECMIV_PRODUTOS",
    "Sku": "ECMIV_EMBALAGENS",
    "PedidoItemCorte": "ECMIV_PEDIDO_ITEM_CORTE",
    "PedidoStatus": "ecmiv_pedido_status",
    "SpVerficaClienteEcommerce": "SP_VERIFICACLIENTEECOMMERCE"
  }
}Alguns detalhes em relação à customização das Views: 


Aviso

Notas

  • 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 customizadas 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 valor contendo o nome da view customizada. Ou seja, não será necessário informar os outros valores.