Choice

Conheça o componente e saiba como utilizá-lo.

Micaella Mazoni avatar
Escrito por Micaella Mazoni
Atualizado há mais de uma semana

IMPORTANTE: esta documentação foi descontinuada. Leia a documentação Choice atualizada no nosso novo portal de documentação.

O Choice permite o desvio de fluxo dentro de um pipeline. Ele faz parte de um conjunto de componentes que auxilia na organização das integrações.    

Para trabalhar com esse tipo de componente, você precisa conhecer os 2 tipos de estrutura do Choice. Eles são utilizados para criar os caminhos: 

  • WHEN: define uma condição que realiza um desvio no seu fluxo para uma linha de execução específica. É necessário ter pelo menos 1 condição declarada. 

  • OTHERWISE: a estrutura é executada quando nenhuma das condições WHEN é atendida. É necessário ter pelo menos 1 condição declarada. 

 

Dê uma olhada nos parâmetros de configuração desse componente:

  • Label: define o nome do caminho. Esse nome deve ser único, não podendo se repetir no pipeline.

  • Type: define a estrutura de desvio (WHEN ou OTHERWISE).

  • Type Rules: define o tipo de linguagem (SIMPLE ou JSON PATH), que será utilizado para a declaração da condição (quando WHEN for escolhido no parâmetro “Type”).

  • Condition: declara a condição utilizada para definir se o caminho deve ser executado. Quando as condições previamente definidas gerarem conflito ou causarem uma sobreposição, apenas uma delas será executada (quando WHEN for escolhido no parâmetro “Type”).

 

TYPE RULES

  • JSON PATH

Define expressões que passam por um componente JSON para alcançar um subconjunto. Quando você estiver utilizando o Choice, será feito um match para executar o caminho.
​ 

Imagine que, no passo anterior ao Choice, o seu fluxo de dados possui a seguinte saída:

{

"cidade" : "Sao Paulo"

}

          

A seguinte Condition declarada como WHEN validaria a execução do desvio:

$.[?(@.cidade == 'Sao Paulo')]

              

Conheça as demais opções para a declaração JSON PATH:

  • $: a raiz do objeto ou vetor.

  • .propriedade: seleciona uma propriedade específica no objeto relacionado.

  • ['propriedade']: seleciona uma propriedade específica no objeto relacionado. Coloque apenas aspas simples ao redor do nome da propriedade. Dica: considere essa instrução caso o nome da propriedade contenha caracteres especiais, assim como espaços, ou caso comece com caracteres diferentes de A..Za..z_.

  • [n]: seleciona o elemento n de um vetor. Os índices começam com 0.

  • [indice1,indice2,]: seleciona elementos do vetor com índices específicos e retorna uma lista.

  • ..propriedade: recursiva descendente: busca um nome de propriedade decrescentemente e retorna um vetor de todos os valores com esse nome de propriedade. Sempre retorna uma lista, mesmo que apenas 1 propriedade seja encontrada.

  • *: o curinga seleciona todos os elementos em um objeto ou vetor, qualquer que seja os seus nomes ou índices. Por exemplo, endereço.* significa todas as propriedades do objeto endereço e livro[*] significa todos os itens de um vetor de livro.

  • [entrada:saida] / [entrada:]: seleciona elementos de um vetor de entrada e até, porém não necessariamente, um vetor de saída. Se a saída é omitida, selecione todos os vetores até o final do vetor. Uma lista é retornada.

  • [:n]: seleciona os primeiros n elementos do vetor. Uma lista é retornada.

  • [-n:]: seleciona os últimos n elementos do vetor. Uma lista é retornada.

  • [?(expressao)]: expressão de filtro. Seleciona todos os elementos em um objeto ou vetor que coincidem com o filtro especificado. Uma lista é retornada.

  • [(expressao)]: expressões de script podem ser utilizadas no lugar de nomes explícitos de propriedades ou índices. Por exemplo, [(@.tamanho-1)], que seleciona o último item de um vetor. Aqui, tamanho se refere ao tamanho do vetor em questão mais do que um arquivo JSON nomeado "tamanho".

  • @: utilizado em expressões de filtro para fazer referência ao nó atual que está sendo processado.

  • ==: igual a .1 e '1' são considerados o mesmo resultado. Valores de string devem ser anexados em aspas simples (e não em aspas): [?(@.cor=='vermelho')].

  • !=: diferente de. Valores de string devem ser anexados em aspas simples.

  • >: maior que.

  • >=: maior ou igual a.

  • <: menor que.

  • <=: menor ou igual a.

  • =~: compatível com uma RedEx Java Script regular. Por exemplo, [?(@.descricao =~ /gato.*/i)] casa itens cuja descrição começa com gato (ignora maiúsculas e minísculas). 

  • !: utilizado para negar um filtro. Por exemplo, [?(!@.isbn)] casa itens que não possuem a propriedade isbn. 

  • &&: operador lógico E. Exemplo:

[?(@.categoria=='ficcao' && @.preco < 10)]

             

  • ||: operador lógico OU. Exemplo:

[?(@.categoria=='ficcao' || @.preco < 10)]

Para saber mais, clique aqui.

       

SIMPLE

É basicamente destinada a ser uma linguagem pequena e simples para avaliar Expressões e Predicados sem exigir novas dependências ou conhecimento do JSON PATH.
​               

Imagine que, no passo anterior ao Choice, o seu fluxo de dados possui a seguinte saída:

{

"cidade" : "São Paulo"

}

           

 A condição declarada como WHEN validaria a execução do desvio:

#{cidade} == 'São Paulo'

         

Conheça as demais opções para a declaração SIMPLE:

  • ==: igual a.

  • =~: igual a, ignorando maiúsculas e minúsculas (quando comparando strings).

  • >: maior que.

  • >=: maior ou igual a.

  • <: menor que.

  • !=: diferente.

  • !=~: diferente de, ignorando maiúsculas e minúsculas (quando comparando strings).

  • regex: valida uma RegEx contra a string informada. Exemplo: #{cidade} regex 'S.*'

  • &&: operador lógico E. Exemplo:

 #{cidade} == 'Sao Paulo' && #{estado} == 'SP'

  • ||: operador logico OU. Exemplo:

#{cidade} == 'Sao Paulo' || #{estado} == 'RJ'

                      

 Exemplo:

Respondeu à sua pergunta?