Usar parâmetros em relatórios

2025-05-21

Você usa parâmetros em relatórios para controlar os dados recuperados, solicitando ao usuário um valor ou um conjunto de valores quando o usuário executa o relatório. A consulta do conjunto de dados recupera apenas os dados solicitados pelo usuário. Você também pode adicionar parâmetros ocultos e especiais nos relatórios que não solicitam a entrada do usuário, mas podem ser usados para operações como filtragem de dados e detalhamento dinâmico.

Observação

O comprimento máximo dos valores de parâmetro passados do Microsoft Dynamics 365 Customer Engagement (local) é de 2.000 caracteres. Por exemplo, se você executar um relatório e criar um filtro de dados por meio da interface do usuário Localização Avançada , a expressão de filtro resultante que é passada para um parâmetro de filtro não pode exceder 2.000 caracteres. Não há limite máximo para o número de parâmetros que você pode especificar. No entanto, talvez seja necessário limitar o comprimento da cadeia de caracteres na linha URL e o número de parâmetros para atender aos requisitos de um navegador específico.

Adicionando parâmetros

Você pode adicionar parâmetros a um relatório para definir os parâmetros individuais de um relatório, passar informações por meio de uma consulta ou fornecer acesso às configurações do usuário, como CRM_CurrencySymbol e CRM_CurrencyPositivePattern parâmetros.

O <ReportParameter> é um elemento no arquivo de definição de relatório (RDL) usado para descrever um parâmetro individual no relatório. O <QueryParameter> contém informações sobre um parâmetro individual que é passado para a fonte de dados como parte de uma consulta. O seguinte código XML retirado do ficheiro RDL do Resumo de Conta demonstra como usar os parâmetros ReportParameter e QueryParameter.

<ReportParameter Name="CRM_FilteredAccount">  
  <DataType>String</DataType>  
    <Nullable>true</Nullable>  
    <DefaultValue>  
      <Values>  
         <Value>select * from FilteredAccount</Value>  
      </Values>  
    </DefaultValue>  
    <AllowBlank>true</AllowBlank>  
    <Prompt>CRM_FilteredAccount</Prompt>  
</ReportParameter>

<Query>  
   <rd:UseGenericDesigner>true</rd:UseGenericDesigner>  
   <CommandText>declare @sql as nVarchar(max)  
      set @sql = '  
      SELECT top 10 CAST(accountid as nvarchar(100)) as AccountID,  
      name, '''' as None  
      FROM (' + @FilteredAccount + ') as fa'  
      exec(@sql)  
   </CommandText>  
   <QueryParameters>  
      <QueryParameter Name="@FilteredAccount">  
         <Value>=Parameters!FilteredAccount.Value</Value>  
      </QueryParameter>  
   </QueryParameters>  
   <DataSourceName>CRM</DataSourceName>  
</Query>

Os exemplos a seguir mostram como usar os parâmetros QueryParameter e ReportParameter num relatório baseado em Fetch.

<ReportParameter Name="FilteredAccount">  
      <DataType>String</DataType>  
      <Prompt>Filtered Account</Prompt>  
            <DefaultValue>  
                  <Values>  
                        <Value>  
                              <fetch version="1.0" output-format="xml-platform" mapping="logical" distinct="false">  
                              <entity name="account">  
                              <all-attributes/>  
                              </entity>  
                              </fetch>  
                        </Value>  
                  </Values>  
            </DefaultValue>  
    </ReportParameter>

<Query>  
        <DataSourceName>DataSource1</DataSourceName>  
        <CommandText>  
                  <fetch>   
                  <entity name="account" enableprefiltering="true" prefilterparametername="FilteredAccount">  
                  <attribute name="accountid" />  
                  <attribute name="name" />  
                  </entity>  
                  </fetch>  
            </CommandText>  
        <QueryParameters>  
          <QueryParameter Name="FilteredAccount">  
            <Value>=Parameters!FilteredAccount.Value</Value>  
          </QueryParameter>  
        </QueryParameters>  
        <rd:UseGenericDesigner>true</rd:UseGenericDesigner>  
      </Query>

Parâmetros ocultos

O Designer de Relatórios no Visual Studio tem suporte interno para parâmetros ocultos. Além disso, você pode ocultar parâmetros adicionando um prefixo CRM_ ao nome do parâmetro em um relatório. Por padrão, os parâmetros com um prefixo CRM_ ficam ocultos quando o relatório é publicado. Ao executar o relatório, você não será solicitado a inserir valores de parâmetro para os parâmetros ocultos.

Parâmetros especiais

A tabela a seguir mostra os parâmetros ocultos especiais que você pode usar em seus relatórios.

Parâmetro	Descrição
`CRM_FilterText`	Contém o valor do texto do filtro que um usuário de relatório cria interativamente no Visualizador de Relatórios quando executa um relatório. O parâmetro está em uma caixa de texto de resumo do filtro localizada no cabeçalho do relatório. O valor inicial é definido como o filtro padrão.
`CRM_URL`	Defina o URL da aplicação. Utilize este parâmetro quando estiver a explorar.
`CRM_FilteredEntity`	Use em uma expressão de consulta para habilitar a pré-filtragem de dados (por meio da Localização Avançada).

Você deve criar todos os parâmetros em um relatório antes de poder consultá-los. Os valores desses parâmetros especiais são preenchidos pelo Customer Engagement (no local) quando o utilizador executa o relatório.

Parâmetros de formato adicionais

A tabela a seguir contém parâmetros adicionais que você pode usar nos relatórios. Entre eles estão parâmetros que fornecem acesso às informações de configurações de número do usuário. Você pode usar esses valores para formatar e exibir os valores numéricos. Esses parâmetros são semelhantes aos valores especificados na classe NumberFormatInfo. Use esses parâmetros em relatórios personalizados para formatar os dados de acordo com as configurações do usuário.

Parâmetro	Descrição
`CRM_FullName`	O nome completo do usuário em nome do qual o relatório está sendo executado.
`CRM_UserTimeZone`	Nome do fuso horário do usuário, por exemplo, Hora Padrão do Pacífico.
`CRM_UILanguageId`	Localidade atual (LCID) do usuário.
`CRM_YearStartWeekCode`	A primeira semana do ano usada nos aplicativos Dynamics 365 for Customer Engagement.
`CRM_WeekStartDayCode`	O primeiro dia da semana que é usado no Customer Engagement.
`CRM_FiscalCalendarStart`	A data de início do ano fiscal usada no Customer Engagement.
`CRM_FiscalPeriodType`	Especifica como o ano fiscal é dividido — Trimestral, Mensal, Anual e assim por diante.
`CRM_FiscalYearDisplayCode`	Especifica se o nome do ano fiscal é exibido com base em quando o ano fiscal começa ou termina.
`CRM_FiscalYearPeriodConnect`	Especifica como o exercício fiscal e o período fiscal são conectados quando exibidos juntos.
`CRM_FiscalYearFormat`	Especifica como o nome do ano fiscal será exibido.
`CRM_FiscalPeriodFormat`	Especifica como o período fiscal será exibido.
`CRM_FiscalYearPrefixFormat`	Especifica se um prefixo é anexado ao ano fiscal quando é exibido.
`CRM_FiscalYearSuffixFormat`	Especifica se um sufixo é anexado ao ano fiscal quando é exibido.
`CRM_CurrencyDecimalPrecision`	A precisão decimal da moeda.
`CRM_CurrencySymbol`	O símbolo da moeda da organização.
`CRM_CurrencyPositivePattern`	O padrão de formatação para valores monetários positivos.
`CRM_CurrencyNegativePattern`	O padrão de formato para valores de moeda negativos.
`CRM_NumberDecimalDigits`	O número de casas decimais a utilizar no valores numéricos.
`CRM_NumberDecimalSeperator`	A cadeia de caracteres que é usada como um separador decimal em valores numéricos.
`CRM_NumberNegativePattern`	O padrão de formato para valores numéricos negativos.
`CRM_NumberGroupSizes`	O número de dígitos em cada grupo à esquerda do decimal em valores numéricos.
`CRM_NumberGroupSeperator`	A cadeia de caracteres que separa grupos de dígitos à esquerda do decimal em valores numéricos.
`CRM_DateSeparator`	A cadeia de caracteres que separa os componentes de uma data, como ano, mês e dia.
`CRM_TimeSeparator`	A cadeia de caracteres que separa os componentes do tempo, como hora, minutos e segundos.
`CRM_AMDesignator`	A cadeia de caracteres que separa os componentes do tempo, como hora, minutos e segundos
`CRM_PMDesignator`	O designador para horas que utilizam o formato "post meridiem" (PM).
`CRM_ShortDatePattern`	O padrão de formato para um valor de data abreviada que está associado ao padrão de formato "d".
`CRM_LongDatePattern`	O padrão de formato para um valor de data longa que está associado ao padrão de formato "D".
`CRM_ShortTimePattern`	O padrão de formato para um valor de hora abreviada que está associado ao padrão de formato "t".
`CRM_MonthDayPattern`	O padrão de formato padrão para valores do mês e dia que estão associados aos padrões de formato "m" e "M".

Ver também

Guia de relatórios e análises
Publicar relatórios