Referência de parâmetro de acesso à URL

  • Artigo

Você pode usar parâmetros como parte de uma URL para configurar a aparência de seus relatórios do SSRS 2016 (13.x) (SQL Server Reporting Services) ou posterior. Este artigo descreve os parâmetros mais usados.

Os parâmetros não diferenciam maiúsculas de minúsculas. Eles exigem um prefixo:

  • rs:: destina-se ao servidor de relatório.
  • rc:: destina-se a um visualizador de HTML.
  • rv:: destina-se à a web part do Visualizador de Relatórios.

Você também pode especificar parâmetros que são específicos de dispositivos ou extensões de renderização. Para obter mais informações sobre parâmetros específicos do dispositivo, confira Especificar as configurações de informações do dispositivo em uma URL.

Importante

Para um servidor de relatório no modo do SharePoint, é importante que a URL inclua a sintaxe do proxy _vti_bin para encaminhar a solicitação por meio do SharePoint e do proxy HTTP do Reporting Services. O proxy adiciona o contexto à solicitação HTTP que é necessário para garantir a execução adequada do relatório para servidores de relatório no modo do SharePoint. Para obter exemplos, confira Acessar itens do servidor de relatório usando o acesso à URL.

A integração do Reporting Services ao SharePoint não está mais disponível após o SQL Server 2016.

Comandos do Visualizador de HTML (rc:)

Direcione o Visualizador de HTML usando o prefixo rc:.

Comando Parâmetro Descrição
Toolbar True Exibe a barra de ferramentas. O valor padrão é true.

Observação: se você omitir esse parâmetro, a barra de ferramentas será exibida automaticamente para renderizar formatos que dão suporte a ele.
Toolbar False Oculta a barra de ferramentas. Se esse parâmetro for false, todas as demais opções serão ignoradas.
Toolbar Navigation exibe apenas a paginação na barra de ferramentas.
Parameters True Exibe a área de parâmetros da barra de ferramentas. O valor padrão é true.

Exemplos:

Modo Nativo: https://myrshost/reportserver?/Sales&rc:Parameters=Collapsed

Modo SharePoint: https://myspsite/subsite/_vti_bin/reportserver?https://myspsite/subsite/Sales&rc:Parameters=Collapsed
Parameters False Oculta a área de parâmetros, e o usuário não pode exibi-la.
Parameters Collapsed Oculta a área de parâmetros, mas o usuário pode alternar para vê-la.

Exemplos:

Modo Nativo: https://myrshost/reportserver?/Sales&rc:Parameters=Collapsed

Modo SharePoint: https://myspsite/subsite/_vti_bin/reportserver?https://myspsite/subsite/Sales&rc:Parameters=Collapsed
Zoom Page Width Defina o zoom do relatório para caber na largura da página.

Exemplos:

Modo Nativo: https://myrshost/reportserver?/Sales&rc:Zoom=Page%20Width

Modo SharePoint: https://myspsite/subsite/_vti_bin/reportserver?https://myspsite/subsite/Sales&rc:Zoom=Page%20Width
Zoom Whole Page Defina o zoom do relatório para caber em toda a página.
Zoom <integer percentage> Defina o zoom do relatório para uma porcentagem específica. O valor padrão é 100.
Section <page number> Define qual página do relatório será exibida. Qualquer valor maior que o número de páginas do relatório exibe a última página. Qualquer valor inferior a 0 exibe a página 1 do relatório. O valor padrão é 1.

Exemplos:

Modo Nativo: https://myrshost/reportserver?/Sales&rc:Section=2

Modo SharePoint: https://myspsite/subsite/_vti_bin/reportserver?https://myspsite/subsite/Sales&rc:Section=2
FindString <text> Pesquisa um relatório para um conjunto de texto específico e realça o texto. Observação: rc:FindString não funcionará a menos que você inclua rc:Toolbar=false na string de acesso à URL.

Exemplos:

Modo Nativo: https://myrshost/reportserver?/Sales&rc:Toolbar=false&rc:FindString=Mountain-400

Modo SharePoint: https://myspsite/subsite/_vti_bin/reportserver?https://myspsite/subsite/Sales&rc:Toolbar=false&rc:FindString=Mountain-400
StartFind <start page> Especifique a primeira seção a ser pesquisada. O valor padrão é a primeira página do relatório.

Exemplo:

Modo Nativo: https://server/Reportserver?/SampleReports/Product Catalog&rs:Command=Render&rc:StartFind=1&rc:EndFind=5&rc:FindString=Mountain-400
EndFind <end page> Define o número da última página a ser usada na pesquisa. O valor padrão é o número da página atual. Use esse parâmetro com o parâmetro StartFind.

Exemplo: Veja o exemplo StartFind.
FallbackPage <page number> Defina o número da página a ser exibido em caso de falha em uma pesquisa ou em uma seleção do mapa do documento. O valor padrão é o número da página atual.
GetImage <icon name> Obtém uma imagem específica para a interface de usuário do Visualizador de HTML.
Icon <icon name> Obtém o ícone de uma extensão de renderização específica.
Stylesheet <stylesheet file name> Especifique uma folha de estilos que deseja aplicar ao Visualizador de HTML.
Configuração de informações de dispositivo Especifique uma configuração de informações do dispositivo no formato rc:tag=value, em que tag é o nome de uma configuração de informações do dispositivo específica da extensão de renderização. Para obter mais informações, consulte a descrição do comando Format.

Você pode usar a configuração de informações do dispositivo OutputFormat para que a extensão de renderização de IMAGE renderize o relatório em uma imagem JPEG usando os seguintes parâmetros na cadeia de caracteres de acesso à URL: ...&rs:Format=IMAGE&rc:OutputFormat=JPEG. Para obter mais informações sobre todas as configurações de informações do dispositivo específicas da extensão, confira Configurações de informações do dispositivo para extensões de renderização (Reporting Services).

Comandos do servidor de relatório (rs:)

Direcione o servidor de relatório usando o prefixo rs:.

Comando Parâmetro Descrição
Command ListChildren e GetChildren Exiba o conteúdo de uma pasta. Os itens dessa pasta são exibidos em uma página da navegação de item genérica.

Exemplos:

Modo Nativo: https://myrshost/reportserver?/Sales&rs:Command=GetChildren

Uma instância nomeada no modo nativo: https://myssrshost/Reportserver_THESQLINSTANCE?/reportfolder&rs:Command=listChildren

Modo SharePoint:https://myspsite/subsite/_vti_bin/reportserver?https://myspsite/subsite/Sales&rs:Command=GetChildren
Command Render O relatório é renderizado no navegador para que você possa exibi-lo.

Exemplos:

Modo Nativo:https://myrshost/reportserver?/Sales/YearlySalesByCategory&rs:Command=Render

Modo SharePoint:https://myspsite/subsite/_vti_bin/reportserver?https://myspsite/subsite/Sales/YearlySalesByCategory&rs:Command=Render
Command GetSharedDatasetDefinition Exiba a definição de XML associada a um conjunto de dados compartilhado. As propriedades do conjunto de dados compartilhado são salvas na definição. Essas propriedades incluem a consulta, parâmetros do conjunto de dados, valores padrão, filtros do conjunto de dados e opções de dados, como agrupamento e diferenciação de maiúsculas e minúsculas. É necessário ter a permissão Ler Definição de Relatório em um conjunto de dados compartilhado para usar esse valor.

Exemplo:

Modo Nativo: https://localhost/reportserver/?/DataSet1&rs:command=GetShareddatasetDefinition
Command GetDataSourceContents Exiba as propriedades de determinada fonte de dados compartilhada como XML. Se houver suporte para XML no navegador e se você for um usuário autenticado com a permissão Ler Conteúdo na fonte de dados, a definição de fonte de dados será exibida.

Exemplos:

Modo Nativo: https://myrshost/reportserver?/Sales/AdventureWorks2022&rs:Command=GetDataSourceContents

Modo SharePoint: https://myspsite/subsite/_vti_bin/reportserver?https://myspsite/subsite/Sales/AdventureWorks2022&rs:Command=GetDataSourceContents
Command GetResourceContents Renderiza um recurso e o exibe em uma página HTML se o recurso for compatível com o navegador. Caso contrário, você será solicitado a abrir ou salvar o arquivo ou recurso em disco.

Exemplos:

Modo Nativo: https://myrshost/reportserver?/Sales/StorePicture&rs:Command=GetResourceContents

Modo SharePoint: https://myspsite/subsite/_vti_bin/reportserver?https://myspsite/subsite/Sales/StorePicture.jpg&rs:Command=GetResourceContents
Command GetComponentDefinition Exiba a definição de XML associada a um item de relatório publicado. É necessário ter a permissão Ler Conteúdo em um item de relatório publicado para usar esse valor.
Format HTML5
PPTX
ATOM
HTML4.0
MHTML
IMAGE
EXCEL (para .xls)
EXCELOPENXML (para .xlsx)
WORD (para .doc)
WORDOPENXML (para .docx)
CSV
PDF
XML		 Especifique o formato no qual um relatório deve ser renderizado e exibido. O valor padrão é HTML5. Para obter mais informações, confira Exportar um relatório usando o acesso à URL. Para obter uma lista completa, confira a seção da extensão \<Render> do arquivo rsreportserver.config do servidor de relatório. Para obter mais informações, consulte Arquivo de configuração RsReportServer.config.

Exemplos:

Modo Nativo: https://myrshost/ReportServer?/myreport&rs:Format=PDF

Modo do SharePoint: https://myspsite/subsite/_vti_bin/reportserver?https://myspsite/subsite/myrereport.rdl&rs:Format=PDF
ParameterLanguage en-us, de-DE etc. Forneça um idioma para os parâmetros transmitidos em uma URL que não depende do idioma do navegador. O valor padrão é o idioma do pesquisador.

Exemplo:

Modo Nativo: https://myrshost/Reportserver?/SampleReports/Product+Line+Sales&rs:Command=Render&StartDate=4/10/2008&EndDate=11/10/2008&rs:ParameterLanguage=de-DE
Snapshot Renderize um relatório com base em um instantâneo de histórico de relatório. Para obter mais informações, confira Renderizar um instantâneo de histórico de relatórios usando o acesso à URL.

Exemplo:

Modo Nativo: https://myrshost/reportserver?/SampleReports/Company Sales&rs:Snapshot=2003-04-07T13:40:02
PersistStreams true
false		 Renderize um relatório em um único fluxo persistido. O renderizador de imagens usa esse parâmetro para transmitir o relatório renderizado um pedaço de cada vez. depois de usar esse parâmetro em uma cadeia de caracteres de acesso à URL, use a mesma cadeia de caracteres de acesso à URL com o parâmetro GetNextStreamem vez do parâmetro PersistStreams para obter a próxima parte do fluxo persistido. Esse comando de URL acaba retornando um fluxo de 0 byte para indicar o fim do fluxo persistente. O valor padrão é false.
GetNextStream true
false		 Obtenha a próxima parte de dados em um fluxo persistente acessado com o parâmetro PersistStreams. Para obter mais informações, consulte a descrição do comando PersistStreams. O valor padrão é false.
SessionID Especifique uma sessão de relatório ativa estabelecida entre o aplicativo cliente e o servidor de relatório. O valor desse parâmetro é definido como o identificador de sessão.

Você pode especificar a ID da sessão como um cookie ou como parte da URL. Quando o servidor de relatório é configurado para não usar cookies de sessão, a primeira solicitação sem uma ID de sessão especificada resultará no redirecionamento com uma ID de sessão. Para obter mais informações sobre as sessões do servidor de relatório, confira Identificar o estado de execução.
ClearSession true
false		 Remova todas as instâncias de relatório associadas a um usuário autenticado da sessão de relatório. Uma instância de relatório é definida, já que o mesmo relatório é executado várias vezes com valores de parâmetro de relatório diferentes. O valor padrão é false. Os valores válidos são true e false.
ResetSession true
false		 Redefina a sessão do relatório removendo a associação da sessão do relatório com todos os instantâneos do relatório. O valor padrão é false. Os valores válidos são true e false.
ShowHideToggle <positive integer> Alterna o estado de mostrar e ocultar de uma seção do relatório. Especifique um número inteiro positivo para representar a seção a ser alternada.

Comandos da web part do Visualizador de Relatórios (rv:)

Direcione a web part do Visualizador de Relatórios que se integra ao SharePoint usando o prefixo rv:. A web part do Visualizador de Relatórios também aceita o parâmetro rs:ParameterLanguage.

Comando Parâmetro Descrição
Toolbar Full exibe a barra de ferramentas completa. O valor padrão é Completo.
Toolbar Navigation exibe apenas a paginação na barra de ferramentas.

Exemplo:

Modo SharePoint: https://myspsite/_vti_bin/reportserver?https://myspsite002%fShared+Documents%2fmyreport.rdl&rv:DocMapMode=Displayed&rv:Toolbar=Navigation
Toolbar None não exibe a barra de ferramentas.
HeaderArea Full exibe o cabeçalho completo. O valor padrão é Completo.
HeaderArea BreadCrumbsOnly exibe apenas a navegação estrutural no cabeçalho para informar ao usuário a localização dele no aplicativo.

Exemplo:

Modo SharePoint: https://myspsite/_vti_bin/reportserver?https://myspsite002%fShared+Documents%2fmyreport.rdl&rv:DocMapMode=Displayed&rv:HeaderArea=BreadCrumbsOnly
HeaderArea None Oculta o cabeçalho.
DocMapAreaWidth Controla a largura de exibição, em pixels, da área de parâmetro na web part do Visualizador de Relatórios. O valor padrão é o mesmo do padrão da web part do Visualizador de Relatórios. O valor deve ser um inteiro não negativo.
AsyncRender true
false		 Controla se um relatório é renderizado de forma assíncrona. O valor padrão é true, que especifica que um relatório deve ser renderizado de forma assíncrona. O valor deve ser um booliano true ou false.
ParamMode Full exibe a área de aviso de parâmetros. O valor padrão é Completo.
Collapsed recolhe a área de aviso de parâmetros.

Exemplo:

Modo SharePoint: https://myspsite/_vti_bin/reportserver?https://myspsite002%fShared+Documents%2fmyreport.rdl&rv:DocMapMode=Displayed&rv:ParamMode=Collapsed
ParamMode Hidden oculta a área de aviso de parâmetros.
DocMapMode Full exibe a área de mapa do documento. O valor padrão é Completo.
DocMapMode Collapsed recolhe a área de mapa do documento.
DocMapMode Hidden oculta a área de mapa do documento.
DockToolBar Top Encaixa a barra de ferramentas na parte superior. O valor padrão é Top.
DockToolBar Bottom Encaixa a barra de ferramentas na parte inferior.

Exemplo:

Modo SharePoint: https://myspsite/_vti_bin/reportserver?https://myspsite002%fShared+Documents%2fmyreport.rdl&rv:DocMapMode=Displayed&rv:DockToolBar=Bottom
ToolBarItemsDisplayMode 1 (0x1) Botão Voltar
ToolBarItemsDisplayMode 2 (0x2) Controles de pesquisa de texto
ToolBarItemsDisplayMode 4 (0x4) Controles de navegação de página
ToolBarItemsDisplayMode 8 (0x8) Botão Atualizar
ToolBarItemsDisplayMode 16 (0x10) Caixa de listagem Zoom
ToolBarItemsDisplayMode 32 (0x20) Botão Feed Atom
ToolBarItemsDisplayMode 64 (0x40) Opção de menu Imprimir em Ações
ToolBarItemsDisplayMode 128 (0x80) Submenu Exportar em Ações
ToolBarItemsDisplayMode 256 (0x100) Opção de menu Abrir com o Report Builder em Ações
ToolBarItemsDisplayMode 512 (0x200) Opção de menu Assinar em Ações
ToolBarItemsDisplayMode 1024(0x400) Opção de menu Novo Alerta de Dados em Ações
ToolBarItemsDisplayMode Vários valores Controle quais itens da barra de ferramentas são exibidos. Esse é um valor de enumeração de bit a bit. Para incluir um item de barra de ferramentas, adicione o valor do item ao valor total. Por exemplo, para nenhum menu de Ações, use rv:ToolBarItemsDisplayMode=63 (ou 0x3F), que é 1 + 2 + 4 + 8 + 16 + 32. Somente para itens de menu Ações , use rv:ToolBarItemsDisplayMode=960 (ou 0x3C0). O valor padrão é -1, que inclui todos os itens da barra de ferramentas. Os valores válidos são:

Exemplo:

Modo SharePoint: https://myspsite/_vti_bin/reportserver?https://myspsite002%fShared+Documents%2fmyreport.rdl&rv:DocMapMode=Displayed&rv:ToolBarItemsDisplayMode=15

Conteúdo relacionado