Centro de suporte da Workiva

Com os parâmetros, você pode solicitar valores a serem usados com os filtros ou cálculos de uma consulta cada vez que ela for executada. Ao definir esses valores no tempo de execução, você pode usar uma consulta em um contexto diferente - como conta, região ou período de tempo - a cada vez que ela for executada.

Você pode criar parâmetros personalizados para usar com uma consulta específica ou o proprietário do espaço de trabalho pode criar parâmetros globais para usar com várias consultas.

Criar parâmetros personalizados para uma consulta

Você pode definir os parâmetros de uma consulta no Builder ou no SQL Editor. Quando você cria um parâmetro, pode usá-lo com vários filtros e cálculos na consulta. 

Etapa 1. Criar o parâmetro

1. No painel Parameters (Parâmetros) , clique em Add (Adicionar) e selecione Create New Parameter (Criar novo parâmetro).
   
<!--
2. From the Parameters panel, click Create Parameter.
   
-->
3. Para ajudar a identificar o parâmetro, digite um nome exclusivo com apenas caracteres alfanuméricos e sem espaços.
4. Em Filter type, selecione o tipo de dados a ser filtrado, como Text ou Integer.

Etapa 2. Configurar os valores do parâmetro

Quando uma consulta é executada, seus parâmetros podem aceitar valores de forma livre - com base no tipo de dados - ou fornecer uma lista de valores específicos para você escolher. 

• Para aceitar qualquer valor de forma livre, digite o padrão (se aplicável) e clique em Create.
• Para fornecer uma lista de valores específicos:

1. Ativar Picklist.
2. Para ativar vários valores para o parâmetro, marque a caixa Multi-Select .
3. Em List Options, digite os valores a serem escolhidos, pressionando Enter após cada um.

   Observação: Para um parâmetro de data ou carimbo de data/hora, insira cada opção no formato YYYY-MM-dd.

4. Selecione qualquer valor padrão para o parâmetro e clique em Accept.

   Observação: Para um parâmetro de seleção múltipla, selecione pelo menos um valor padrão.

5. Clique em Create para concluir.

Etapa 3. Usar o parâmetro na consulta

Para aplicar o valor do parâmetro à consulta, use-o em um filtro ou cálculo:

• Para definir o valor de um filtro com base no parâmetro no Builder, selecione-o quando você definir o filtro no painel direito Filter Properties.

  Observação: Para um parâmetro de seleção múltipla , selecione um operador de filtro de Is In List ou Is Not In List na guia Filters.

• Para usar o parâmetro com um filtro no SQL Editor ou referenciar seu valor em um cálculo, insira seu nome após dois pontos (:) na instrução SQL, como :ReportingPeriod.

Use parâmetros globais em uma consulta

O proprietário do seu espaço de trabalho pode configurar parâmetros globais para valores comuns usados em várias consultas. Para usar parâmetros globais em uma consulta:

1. No painel Parameters , clique em Add e selecione Select Global Parameter.
   
2. Selecione os parâmetros globais a serem usados na consulta e clique em Add.
3. Para editar o parâmetro global, selecione-o e atualize seu nome ou valor conforme necessário para a consulta.

   Observação: Para garantir uma análise consistente, o proprietário do espaço de trabalho pode bloquear um parâmetro global para impedir que seu valor seja editado.

4. Para aplicar o valor de um parâmetro global à consulta, use-o em um filtro ou cálculo:

   • Para definir o valor de um filtro com base no parâmetro no Builder, selecione-o quando você definir o filtro no painel direito Filter Properties.

     Observação: Para um parâmetro de seleção múltipla, selecione um operador de filtro de Is In List ou Is Not In List na guia Filters.

   • Para fazer referência ao parâmetro no SQL Editor, digite seu nome após dois pontos (:) na instrução SQL, como, por exemplo, :ReportingPeriod.
   • Para fazer referência a um valor de parâmetro em uma instrução SQL de cálculo, selecione o parâmetro no menu Parameters.

Editar um parâmetro de consulta

Para ajustar ou gerenciar os detalhes de um parâmetro:

1. No painel Parameters, selecione o parâmetro a ser editado.
2. Edite o nome, o tipo de dados ou os valores do parâmetro, conforme necessário.
3. Clique em Aplicar.

Remover um parâmetro de consulta

Se você não precisar mais de um parâmetro, poderá removê-lo da consulta. No painel Parameters, clique no parâmetro Delete e clique em Save .