Quick BI:Incorpore relatórios com segurança usando autenticação baseada em ticket

Informações básicas

O Quick BI Professional Edition oferece uma solução de incorporação de relatórios baseada em ticket, com controles de segurança abrangentes para acesso a links, visualização de dados e permissões de usuário. Isso possibilita uma integração de baixo custo com sistemas empresariais, mantendo a consistência da marca.

Limites

Observe os seguintes limites para a incorporação de relatórios baseada em ticket:

• É possível incorporar apenas painéis, pastas de trabalho, painéis de dados, relatórios de análise ad hoc, relatórios de entrada de dados ou relatórios de Downloads em outros sistemas.

• Para testar o recurso de parâmetros globais, entre em contato com o responsável pelas operações do Quick BI.

• O Quick BI Professional Edition suporta a solução aprimorada. A edição Pro suporta apenas a solução básica.

  As diferenças entre a solução básica e a solução aprimorada são as seguintes.

  Capacidade	Solução básica	Solução aprimorada
  Usuário associado	Proprietário do relatório. Este valor não pode ser modificado.	Personalizável. Permite fornecer diferentes visualizações para diferentes usuários.
  Contagem de acessos	Até 100.000 vezes por ticket.	Ilimitada. Personalize a contagem de acessos.
  Marca d'água	Não suportado.	Suportado. (Não se aplica se a tela grande não suportar marcas d'água.)
  Período de validade	Até 240 minutos.	Personalizável.
  Parâmetros globais	Não suportado.	Suportado.
  Bloqueio de incorporação	Não suportado.	Suportado.
  Número de redirecionamentos Nota A incorporação também deve estar ativada para o relatório de destino do redirecionamento.	Apenas um redirecionamento permitido. Por exemplo, se o Relatório A for redirecionado para o Relatório B, o Relatório B não poderá ser redirecionado para o Relatório C.	Suporta um número ilimitado de redirecionamentos. Por exemplo, se o Relatório A for redirecionado para o Relatório B, este poderá ser redirecionado para o Relatório C, que por sua vez poderá ser redirecionado para outro relatório.

Etapa 1: Ativar a incorporação para um relatório

Configure o recurso de incorporação de relatórios apenas quando o relatório estiver no estado Publicado.

Etapa 2: Gerar um AccessTicket

1. Chame a operação de API CreateTicket para gerar o ticket necessário à incorporação do relatório.

   Nota

   As seguintes restrições aplicam-se às contas usadas para gerar AccessTickets:

   • Se a conta estiver desativada em Tenant Management > User Management, não será possível gerar novos AccessTickets. Contudo, os AccessTickets existentes permanecerão utilizáveis.

   • Se a conta for excluída em Tenant Management > User Management, não será possível gerar novos AccessTickets e os existentes tornar-se-ão inválidos.

   A tabela a seguir descreve os parâmetros configuráveis para gerar um AccessTicket.

   Nome do parâmetro	Tipo	Descrição
   WorksId	String	ID do relatório com incorporação ativada. Painéis, pastas de trabalho, painéis de dados, relatórios de Downloads, relatórios de análise ad hoc e relatórios de entrada de dados são suportados.
   CmptId	String	ID de um widget em um dos relatórios mencionados anteriormente. Para obter o ID do widget, chame a operação de API QueryWorksBloodRelationship.
   TicketNum	Integer	Quantidade de tickets. Valor padrão: 1. Valor recomendado: 1. Valor máximo: 99999. A cada uso do ticket para acesso, o número restante de utilizações permitidas diminui em uma unidade.
   UserId	String	ID do usuário do Quick BI. Não corresponde ao ID da sua conta Alibaba Cloud. Chame a operação de API QueryUserInfoByAccount para obter o ID do usuário. Exemplo: fe67f61a35a94b7da1a34ba174a7****. Nota Insira um valor para UserId ou AccountName. Se ambos forem deixados vazios, o proprietário do relatório será usado por padrão. Para configurar permissões no nível de linha, consulte o Apêndice 1: Configurar permissões no nível de linha.
   AccountName	String	Nome da conta do usuário. Se o usuário utilizar uma conta Alibaba Cloud, como wangwu, o formato é [conta Alibaba Cloud]. Exemplo: wangwu. Se o usuário utilizar um usuário RAM, como zhangsan@aliyun.cn, o formato é [conta Alibaba Cloud:usuário RAM]. Exemplo: wangwu:zhangsan. Nota Insira um valor para UserId ou AccountName. Se ambos forem deixados vazios, o proprietário do relatório será usado por padrão. Para configurar permissões no nível de linha, consulte o Apêndice 1: Configurar permissões no nível de linha.
   AccountType	Integer	Tipo da conta do usuário. 1: Conta Alibaba Cloud 3: Conta específica do Quick BI 5: Usuário RAM Nota Ao especificar AccountName, também especifique AccountType.
   ExpireTime	Integer	Tempo de expiração. Unidade: minutos. Valor padrão: 240. O máximo para depuração de página é 240. Via API, o máximo é o limite superior de Integer.
   WatermarkParam	String	Parâmetro de marca d'água para o relatório. Comprimento máximo: 50 caracteres.
   GlobalParam	String	Parâmetros globais para condições de filtro do relatório. Valor: string JSON. Nota Para usar o recurso de parâmetros globais, entre em contato com o responsável pelas operações do Quick BI.

   Nota

   • Para evitar o compartilhamento de links, defina TicketNum como 1. Essa configuração garante que o link de incorporação de terceiros gerado possa ser acessado apenas uma vez.

   • Ao incorporar um relatório, anexe o parâmetro de marca d'água WatermarkParam.

2. Gere o AccessTicket.

   Para exemplos de código, consulte o Exemplo de SDK.

   O código a seguir mostra um exemplo de resultado retornado:

   {
     "requestId" : "7D784AB0-5B77-077E-B628-E782B58D3898",
     "result" : "fd138bcb-****-4fde-b413-81bcee59bdb6",
     "success" : true
   }

   Nota

   O valor do campo result é o AccessTicket gerado por esta chamada de API. Neste exemplo, o AccessTicket é fd138bcb-****-4fde-b413-81bcee59bdb6.

Etapa 3: Concatenar a URL de Single Sign-on

https://bi-cn-hongkong.data.aliyun.com/token3rd/report/view.htm?id=<42****18ef6>&accessTicket=fd138bcb-****-4fde-b413-81bcee59bdb6&cmptId=XXX

1. Obtenha o nome de domínio do Quick BI.

   Por exemplo, o nome de domínio do Quick BI na região da China (Hong Kong) é bi-cn-hongkong.data.aliyun.com. Utilize o nome de domínio correspondente ao seu ambiente.

2. Obtenha a URL de visualização do relatório.

   URLs da página de visualização por tipo de relatório:

   • Painel: token3rd/dashboard/view/pc.htm

   • Pasta de trabalho: token3rd/report/view.htm

   • Painel de dados: token3rd/screen/view/pc.htm

   • Downloads: token3rd/offline/view/pc.htm

   • Análise ad hoc: token3rd/analysis/view/pc.htm

   • Entrada de dados: token3rd/dataform/view.htm

3. Na página de edição do relatório, obtenha o ID do relatório.

   • ID do painel. Exemplo: d01****c5f.

     Na página de edição do painel, obtenha o valor de pageId na barra de endereços.

     

   • ID da pasta de trabalho. Exemplo: d0****3ba88.

     Na página de edição da pasta de trabalho, obtenha o ID da pasta de trabalho na barra de endereços.

   • ID do painel de dados. Exemplo: 3c****26b.

     Na página de edição do painel de dados, obtenha o valor de pageId na barra de endereços.

     

   • ID de Downloads. Exemplo: b2****47.

     Na página de edição de Downloads, obtenha o valor de pageId na barra de endereços.

     

   • ID de análise ad hoc. Exemplo: 7f****da.

     Na página de edição de análise ad hoc, obtenha o valor de pageId na barra de endereços.

     

   • ID de entrada de dados. Exemplo: 29****53.

     Na página de edição de entrada de dados, obtenha o valor de pageId na barra de endereços.

     

4. Concatene o nome de domínio do Quick BI, a URL de visualização do relatório, o ID do relatório e o AccessTicket obtido na Etapa 2 para criar a URL de solicitação.

   • Formato de URL do painel: https://<Quick BI domain name>/<Report preview URL>?pageId=<Report ID>&accessTicket=<AccessTicket>

   • Formato de URL da pasta de trabalho: https://<Quick BI domain name>/<Report preview URL>?id=<Report ID>&accessTicket=<AccessTicket>

   • Formato de URL do painel de dados: https://<Quick BI domain name>/<Report preview URL>?pageId=<Report ID>&accessTicket=<AccessTicket>

   • Formato de URL de Downloads: https://<Quick BI domain name>/<Report preview URL>?pageId=<Report ID>&accessTicket=<AccessTicket>

   • Formato de URL de análise ad hoc: https://<Quick BI domain name>/<Report preview URL>?id=<Report ID>&accessTicket=<AccessTicket

   • Formato de URL de entrada de dados: https://<Quick BI domain name>/<Report preview URL>?id=<Report ID>&accessTicket=<AccessTicket>

Apêndice 1: Configurar permissões no nível de linha

Se você não especificar UserId ou accountName, o relatório incorporado utilizará as permissões do proprietário do relatório. Para associar as permissões de um usuário específico, configure as permissões no nível de linha conforme ilustrado na figura a seguir e, em seguida, defina UserId ou AccountName.Permissões no nível de linha e coluna.

Apêndice 2: Geração de parâmetros globais

Configure parâmetros globais no painel ou pasta de trabalho de destino. Esses parâmetros são utilizados durante a geração de AccessTickets.

[
  {
    "paramKey": "price", // Global parameter key
    "joinType": "and",   // Join type. Use 'and'.
    "conditionList": [
      {
        "operate": "=", // Operator. See the description below.
        "value": "1"    // Value. For multiple values, use an array, such as ["1", "2"].
      },
      {
        "operate": "=", // Operator. See the description below.
        "value": "2"    // Value. For multiple values, use an array, such as ["1", "2"].
      }
    ]
  },
  {
    "paramKey": "area", // Global parameter key
    "joinType": "and",   // Join type. Use 'and'.
    "conditionList": [
      {
        "operate": "in",          // Operator
        "value": ["North China","South China"]    // Value. For multiple values, use an array.
      }
    ]
  }
]

Apêndice 3: Quantidade de relatórios incorporáveis