O Integrador Vtex se utiliza de Objetos no banco de dados do ERP para realizar a consulta dos dados que serão enviados à Vtex. 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 à necessidades de clientes, é possível utilizar Objetos customizados, que não serão atualizadas atualizados mediante à atualizações do integrador e poderão ficar sob total controle do cliente.
Para utilização de Objetos customizadascustomizados, deve-se criar um 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. 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",
}
}
...
- 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 customizadascustomizados.
- 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.