No Master Data, é possível criar filtros tanto para acesso por API quanto para a visualização nos formulários. A criação de filtros facilita a busca e consulta de dados, possibilitando um maior controle sobre seus dados.
A criação de filtro deve ser configurada primeiro na entidade de dados e posteriormente no formulário desejado, conforme os passos descritos nas seções a seguir.
Requisitos para filtros
Siga as recomendações abaixo ao definir campos como filtros:
- Não utilize campos dos tipos CEP, Text e File como filtros.
- Adicione como filtro um campo que contenha poucas opções em seu preenchimento, como "Categoria", por exemplo.
Configurar filtro na entidade de dados
Siga as instruções abaixo para definir um campo existente como filtro na entidade de dados:
-
No Admin VTEX, acesse Configurações da loja > Storefront > Master Data.
-
No Master Data, clique na engrenagem ao lado de uma aplicação.
-
Clique em Estrutura de dados.
-
Acesse a aba Entidades de dados.
-
Clique no botão de edição na entidade em que deseja configurar o filtro.
Você será direcionado(a) para a listagem de campos da entidade.
-
Clique no botão com símbolo de engrenagem no campo que deseja configurar como filtro.
-
Marque a opção É filtrável?.
-
Clique no botão
Salvar
. -
Na listagem de entidades, clique no botão de disquete para publicar a entidade.
-
Clique no botão de reindexação para indexar a entidade.
Configurar filtro no formulário
Siga as instruções abaixo para configurar filtros no formulário:
-
No Admin VTEX, acesse Configurações da loja > Storefront > Master Data.
-
Na aplicação em que está o formulário onde deseja criar o filtro, clique no símbolo de engrenagem .
Você será direcionado(a) para a listagem de formulários da aplicação.
-
Clique no botão de edição na linha do formulário que deseja editar.
-
Preencha o campo Filtros com o nome interno do campo marcado como filtro. O nome interno corresponde ao valor do primeiro campo na criação e edição de entidade de dados, o nome do campo que não é possível alterar. Para inserir mais de um valor, separe-os por vírgula, sem espaço.
-
Clique no botão
Salvar
.
Filtrar registros do formulário
Após a criação do filtro, é possível utilizá-lo no formulário. Para isso, siga o passo a passo abaixo:
-
No Admin VTEX, acesse Configurações da loja > Storefront > Master Data.
-
Na aplicação desejada, identifique o formulário que deseja visualizar e clique no ícone de listagem .
Você será direcionado(a) para a listagem de registros desse formulário. Na lateral, você verá os filtros configurados.
-
Para filtrar, selecione o nome do filtro e seu valor e, em seguida, clique em
Filtrar
.É possível filtrar por vários campos ao mesmo tempo e vários valores no mesmo campo. Para retirar um filtro, clique no
X
ao lado do valor.