🪪 Nome

O campo Nome é o identificador técnico da opção de ordenação.

Exemplos ilustrativos:

menor-preco

mais-vendidos

lancamentos

O Nome pode ser utilizado em outras configurações da plataforma, como na definição da ordenação padrão de um grupo.

Por isso, recomenda-se que ele:

• seja único;
• não contenha espaços;
• siga um padrão de nomenclatura;
• não seja alterado depois que estiver em uso.

⚠️ Alterar o Nome pode quebrar associações existentes. Uma Configuração por Grupo, por exemplo, pode estar utilizando esse identificador como ordenação padrão.

🏷️ Label

O campo Label define o texto amigável que poderá ser apresentado ao consumidor.

Exemplo:

O Label pode utilizar:

• espaços;
• acentos;
• letras maiúsculas e minúsculas;
• uma descrição mais clara para o consumidor.

💡 O Nome é utilizado tecnicamente. O Label é utilizado na experiência da loja.

🧱 3. Campos de Ordenação

Os Campos de Ordenação definem quais informações dos produtos serão utilizadas para montar a sequência da listagem.

Uma ordenação pode utilizar apenas um campo ou combinar vários campos.

Exemplos de informações que podem ser utilizadas:

• preço;
• nome do produto;
• data de cadastro;
• quantidade vendida;
• quantidade de acessos;
• disponibilidade;
• relevância;
• posição manual;
• outro campo disponível no índice.

⚠️ Utilize somente campos existentes no índice do Smart Finder. Um campo inexistente ou escrito incorretamente pode fazer a ordenação não funcionar como esperado.

🔢 Prioridade entre os campos

Quando uma opção possui mais de um campo, a ordem em que eles aparecem define sua prioridade.

O Smart Finder considera:

1. o primeiro campo como critério principal;
2. o segundo campo como critério de desempate;
3. o terceiro campo como novo critério de desempate;
4. os campos seguintes na mesma sequência.

Exemplo ilustrativo

De forma simplificada:

1. os produtos são organizados pela disponibilidade;
2. entre produtos com a mesma disponibilidade, aparecem primeiro os que possuem maior valor de vendas;
3. se ainda houver empate, será utilizado o nome do produto.

ℹ️ Esse exemplo não representa uma configuração padrão. Os campos e a ordem devem ser definidos de acordo com a estratégia de cada loja.

🔼 Direção crescente — Asc

A opção Asc significa crescente.

Seu efeito depende do tipo de informação utilizada:

🔽 Direção decrescente — Desc

A opção Desc significa decrescente.

⚠️ A direção precisa ser escolhida de acordo com o conteúdo real do campo. Em campos de status, disponibilidade ou valores codificados, a ordem pode não ser intuitiva.

🎯 Ordenação por relevância

Quando uma ordenação utiliza o campo técnico de pontuação, geralmente representado por _score, os produtos são organizados de acordo com a relevância calculada pelo Elasticsearch.

A pontuação pode considerar:

• correspondência com o nome do produto;
• palavras-chave;
• Query Boosts;
• Boost Fields;
• similaridade;
• outras regras configuradas.

Em uma ordenação por relevância, normalmente é utilizada a direção Desc, fazendo com que as maiores pontuações apareçam primeiro.

ℹ️ A pontuação não é cadastrada diretamente no produto. Ela é calculada durante a consulta.

➕ Como adicionar um campo

Para incluir um critério em uma ordenação:

1. localize a opção desejada;
2. clique em Adicionar Campo;
3. informe o nome técnico do campo;
4. selecione Asc ou Desc;
5. revise a posição do campo na sequência;
6. salve a configuração;
7. teste a ordenação no preview.

💡 Inclua critérios de desempate quando necessário. Isso ajuda a evitar que produtos com valores iguais apareçam em uma sequência imprevisível.

🗑️ Como remover um campo

Utilize o ícone de exclusão ao lado do campo.

Antes de removê-lo:

• registre o nome;
• registre a direção;
• confirme sua posição na sequência;
• verifique se ele é utilizado como critério principal ou de desempate;
• teste o comportamento no preview.

➕ Como adicionar uma opção de ordenação

Para criar uma nova opção:

1. clique em Adicionar Opção de Ordenação;
2. informe um Nome técnico único;
3. informe o Label;
4. adicione os campos de ordenação;
5. defina a direção de cada campo;
6. revise a prioridade;
7. clique em Salvar;
8. valide a ordenação no preview;
9. publique depois da validação.

Depois de cadastrar a opção na aba Global:

• verifique nas Configurações Básicas se ela deve ser exibida em cada contexto;
• verifique nas Configurações por Grupo se ela deve ser utilizada como ordenação padrão.

🗑️ Como remover uma opção de ordenação

A opção Remover exclui toda a configuração, incluindo:

• Nome;
• Label;
• campos;
• direções.

Antes de remover:

1. registre todos os valores;
2. verifique se ela está visível nas Configurações Básicas;
3. verifique se algum grupo a utiliza como ordenação padrão;
4. teste o impacto da remoção;
5. publique somente após a validação.

⚠️ Remover uma opção utilizada como padrão pode gerar inconsistências na navegação da loja.

⚙️ 4. Parâmetros Extras

O bloco Parâmetros Extras permite incluir configurações técnicas adicionais utilizadas no processamento do Smart Finder.

Cada parâmetro é composto por:

Os parâmetros podem influenciar aspectos como:

• interpretação das consultas;
• operadores;
• relevância;
• campos pesquisados;
• correspondência mínima;
• tratamento de texto;
• outras funções técnicas.

⚠️ Não existe uma lista única de parâmetros obrigatórios para todas as lojas. O preenchimento depende da implementação e das necessidades da operação.

🏷️ Nome do parâmetro

O campo Nome deve corresponder a um parâmetro reconhecido pela implementação do Smart Finder.

Não utilize nomes criados livremente.

Um parâmetro desconhecido pode:

• ser ignorado;
• não produzir efeito;
• alterar a consulta de maneira inesperada;
• causar erro no processamento.

📝 Valor do parâmetro

O campo Valor precisa seguir o formato esperado pelo parâmetro informado.

Ele pode ser:

• texto;
• número;
• percentual;
• verdadeiro ou falso;
• nome de campo;
• lista de campos;
• expressão;
• outro valor técnico.

Exemplos ilustrativos de formatos:

true

75%

ProductName^50 SearchKeywords^20

ℹ️ Os exemplos demonstram apenas formatos possíveis. Eles não devem ser copiados sem confirmar qual parâmetro está sendo configurado.

➕ Como adicionar um parâmetro

1. clique em Adicionar Parâmetro;
2. informe o Nome técnico;
3. informe o Valor no formato esperado;
4. clique em Salvar;
5. teste os contextos afetados no preview;
6. publique depois da validação.

Para remover, utilize o ícone de exclusão.

⚠️ Antes de remover um parâmetro, registre seu Nome e Valor. A exclusão pode modificar diferentes comportamentos da busca.

🚀 5. Boost Fields

Os Boost Fields permitem influenciar a relevância dos produtos com base em campos e valores existentes no índice.

Uma regra pode, por exemplo, aumentar a prioridade de produtos que:

• estejam disponíveis;
• possuam imagem;
• pertençam a determinado agrupamento;
• tenham um indicador de destaque;
• apresentem determinado valor em um campo;
• atendam a uma função de pontuação.

Cada Boost Field pode conter:

🪪 Name

O campo Name define qual informação do produto será avaliada.

Exemplos conceituais:

• disponibilidade;
• presença de imagem;
• identificador;
• popularidade;
• campo de destaque;
• outro campo indexado.

⚠️ O Name precisa corresponder exatamente ao campo existente no índice.

⚖️ Boost

O Boost representa o peso atribuído à regra.

Quanto maior o valor em comparação com outras regras, maior tende a ser sua influência.

O Boost não representa:

• percentual;
• quantidade de posições;
• garantia de prioridade;
• número fixo de pontos.

Ele é combinado com outras regras e critérios de relevância.

💡 O valor deve ser analisado de forma relativa. Uma regra com Boost maior tende a influenciar mais que outra com Boost menor.

📝 Value

O campo Value define qual valor o produto precisa possuir para atender à regra.

Exemplos conceituais:

true

Disponível

Destaque

O formato precisa ser exatamente igual ao valor armazenado no índice.

⚠️ Diferenças de acento, letras maiúsculas, espaços ou grafia podem impedir que a regra seja aplicada.

🧮 Function

O campo Function permite informar uma expressão técnica utilizada no cálculo da relevância.

Sua utilização depende da implementação do Smart Finder.

Pode ser usada para:

• transformar valores;
• aplicar cálculos;
• normalizar informações;
• controlar a pontuação;
• combinar condições.

⚠️ Não preencha esse campo sem conhecer a sintaxe esperada.

⚙️ Function Name

O campo Function Name identifica uma função técnica previamente reconhecida pela plataforma.

Uma função pode ser utilizada para:

• escalar valores;
• normalizar pontuações;
• aplicar uma regra específica;
• processar dinamicamente um campo.

⚠️ Não crie ou altere nomes de funções livremente. A função precisa existir na implementação.

🧪 Exemplo conceitual de Boost Field

Considere uma operação que deseja aumentar a relevância de produtos que possuam imagem.

Uma regra poderia utilizar:

De forma simplificada:

1. o Smart Finder verifica o campo;
2. identifica os produtos que possuem o valor esperado;
3. aplica o peso configurado;
4. combina essa pontuação com as demais regras;
5. calcula a relevância final.

ℹ️ Esse é apenas um exemplo de funcionamento. Os campos e valores variam conforme a estrutura de cada loja.

➕ Como adicionar um Boost Field

1. clique em Adicionar Boost Field;
2. informe um Name válido;
3. defina o Boost;
4. informe o Value, quando necessário;
5. preencha Function ou Function Name somente quando houver definição técnica;
6. clique em Salvar;
7. teste os diferentes contextos no preview;
8. publique após a validação.

🧠 6. Relação com as demais configurações

A aba Global fornece configurações que podem ser utilizadas por outros contextos.

ℹ️ O comportamento final depende da combinação entre a aba Global e as configurações específicas de cada contexto.

🧪 7. Como testar a aba Global

Depois de realizar uma alteração:

1. registre a configuração anterior;
2. altere somente uma opção, campo ou parâmetro;
3. clique em Salvar;
4. selecione Preview;
5. execute uma busca;
6. navegue por categorias;
7. navegue por marcas;
8. acesse listas e vitrines;
9. teste as opções de ordenação;
10. verifique a ordenação padrão;
11. compare a ordem dos produtos;
12. publique somente após validar todos os contextos afetados.

Cenários recomendados

✅ 8. Checklist antes de publicar

• A aba Global está selecionada.
• O Nome da ordenação é único.
• O Label está adequado ao consumidor.
• Os campos de ordenação existem no índice.
• A prioridade entre os campos foi revisada.
• Asc e Desc estão coerentes com o tipo de informação.
• Os critérios de desempate foram validados.
• A nova ordenação foi habilitada nos contextos necessários.
• A ordenação padrão dos grupos continua válida.
• Os Parâmetros Extras possuem Nome e Valor reconhecidos.
• Os Boost Fields utilizam campos existentes.
• Functions e Function Names foram preenchidos somente com orientação técnica.
• Busca, Categoria, Marca e Lista de Produtos foram testadas.
• O preview apresentou o comportamento esperado.

🚀 9. Como aplicar as alterações

Depois de concluir os ajustes:

1. clique em Salvar;
2. selecione Preview;
3. valide as opções de ordenação;
4. teste a busca principal;
5. teste categorias e marcas;
6. teste as Listas de Produtos;
7. confirme a ordenação padrão dos grupos;
8. retorne à configuração;
9. clique em Publicar quando o comportamento estiver validado.

As alterações somente serão disponibilizadas aos consumidores após a publicação.

⚠️ Faça pequenas alterações e teste uma configuração por vez. Como a aba Global pode influenciar diferentes áreas da loja, mudanças simultâneas dificultam a identificação da origem de um comportamento.