Quick BI:レポートの埋め込みデータ権限制御とパラメーター送信のためのセキュリティ強化ソリューション

背景情報

Quick BI は、チケットベースのレポート埋め込みソリューションとして知られる、セキュリティが強化された埋め込み分析ソリューションを提供します。Quick BI Professional Edition を使用すると、リンク、アクセス、データ表示に対する包括的なセキュリティ制御を実装できます。このソリューションは、低コストで企業の業務システムと統合し、ブランドを反映したデータプロダクトを効率的に構築するのに役立ちます。

注意事項

チケットベースのレポート埋め込みソリューションを使用する際は、次の項目に注意してください:

• ダッシュボード、ワークブック、データダッシュボード、アドホック分析レポート、データ入力レポート、またはダウンロードからのレポートのみを他のシステムに埋め込むことができます。

• グローバルパラメーター機能を試すには、Quick BI の運用担当者にお問い合わせください。

• Quick BI Professional Edition は拡張ソリューションをサポートしています。Pro エディションは基本ソリューションのみをサポートしています。

  基本ソリューションと拡張ソリューションは、異なる機能を提供します。詳細については、次の表をご参照ください。

  機能	基本ソリューション	強化ソリューション
  アタッチされたユーザー	レポートのオーナー。この値は変更できません。	カスタマイズ可能。これにより、異なるユーザーに異なるビューを提供できます。
  アクセス数	チケットあたり最大 100,000 回。	無制限。アクセス数をカスタマイズできます。
  透かし	サポートされていません。	サポートされています。 (大画面がウォーターマークをサポートしていない場合は適用されません。)
  有効期間	最大 240 分。	カスタマイズ可能。
  グローバルパラメーター	サポートされていません。	サポートされています。
  ブロック埋め込み	サポートされていません。	サポートされています。
  リダイレクト数 説明 リダイレクト先のレポートでも埋め込みを有効にする必要があります。	リダイレクトは 1 回のみ許可されます。 たとえば、レポート A がレポート B にリダイレクトされた場合、レポート B をレポート C にリダイレクトすることはできません。	無制限のリダイレクトがサポートされています。 たとえば、レポート A がレポート B にリダイレクトされた場合、レポート B はレポート C にリダイレクトでき、レポート C は別のレポートにリダイレクトできます。

ステップ 1: レポートの埋め込みを有効にする

レポートが公開済みの状態の場合にのみ、レポートの埋め込み機能を設定できます。

ステップ 2: API 操作を使用して AccessTicket を生成する

1. CreateTicket API 操作を呼び出して、レポートの埋め込みに必要なチケットを生成します。

   次の表に、AccessTicket の生成時に設定できるパラメーターを示します。

   パラメーター	タイプ	説明
   WorksId	文字列	埋め込みが有効になっているレポートの ID。 ダッシュボード、ワークブック、データダッシュボード、ダウンロードからのレポート、アドホック分析レポート、データ入力レポートがサポートされています。
   CmptId	文字列	前述のレポートのいずれかにあるウィジェットの ID。 ウィジェット ID を取得するには、QueryWorksBloodRelationship API 操作を呼び出します。
   TicketNum	整数	チケットを使用できる回数。 デフォルト値: 1。 推奨値: 1。 最大値: 99999。 チケットがアクセスに使用されるたびに、チケットを使用できる残りの回数が 1 ずつ減少します。
   UserId	文字列	Quick BI ユーザーの ID。Alibaba Cloud アカウント ID ではありません。 ユーザー ID を取得するには、QueryUserInfoByAccount API 操作を呼び出します。例: fe67f61a35a94b7da1a34ba174a7****。 説明 [UserId] または [AccountName] のいずれかに値を入力します。両方を空のままにすると、デフォルトでレポートのオーナーが使用されます。行レベルの権限を設定するには、「付録 1: 行レベルの権限を設定する」をご参照ください。
   AccountName	文字列	ユーザーアカウントの名前。 ユーザーが wangwu などの Alibaba Cloud アカウントを使用する場合、フォーマットは [Alibaba Cloud アカウント] です。例: wangwu。 ユーザーが zhangsan**@aliyun.cn などの RAM ユーザーを使用する場合、フォーマットは [Alibaba Cloud アカウント:RAM ユーザー] です。例: wangwu:zhangsan**。 説明 [UserId] または [AccountName] のいずれかに値を入力します。両方を空のままにすると、デフォルトでレポートのオーナーが使用されます。行レベルの権限を設定するには、「付録 1: 行レベルの権限を設定する」をご参照ください。
   AccountType	整数	ユーザーアカウントのタイプ。 1: Alibaba Cloud アカウント 3: Quick BI 固有のアカウント 5: RAM ユーザー 説明 AccountName を指定する場合は、AccountType も指定する必要があります。
   ExpireTime	整数	有効期限。 単位: 分。 デフォルト値: 240。これはページデバッグの最大値です。API 操作を使用してこの値をカスタマイズできます。最大値は Integer 型の最大値です。
   WatermarkParam	文字列	レポートの透かしパラメーター。 値の長さは 50 文字を超えることはできません。
   GlobalParam	文字列	レポートのフィルター条件のグローバルパラメーター。 値は JSON 文字列です。 説明 グローバルパラメーター機能を使用するには、Quick BI の運用担当者にお問い合わせください。

   説明

   • リンクの共有を防ぐには、TicketNum を 1 に設定します。この設定は、生成されたサードパーティの埋め込みリンクに 1 回しかアクセスできないことを意味します。

   • レポートを埋め込むときに、[WatermarkParam] ウォーターマークパラメーターをアタッチできます。

2. AccessTicket を生成します。

   サンプルコードについては、「SDK の例」をご参照ください。

   次のコードは、返された結果の例を示しています:

   {
     "requestId" : "7D784AB0-5B77-077E-B628-E782B58D3898", // リクエストID
     "result" : "fd138bcb-****-4fde-b413-81bcee59bdb6", // AccessTicket
     "success" : true // 成功かどうか
   }

   説明

   result フィールドの値は、この API 呼び出しによって生成された AccessTicket です。この例では、AccessTicket は fd138bcb-****-4fde-b413-81bcee59bdb6 です。

ステップ 3: シングルサインオン URL を連結する

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

1. Quick BI ドメイン名を取得します。

   たとえば、中国 (香港) リージョンの Quick BI サイトのドメイン名は bi-cn-hongkong.data.aliyun.com です。ご自身の特定の環境のドメイン名を使用する必要があります。

2. レポートプレビュー URL を取得します。

   次のリストに、さまざまな種類のレポートのプレビューページ URL を示します。必要な URL を選択してください。

   • ダッシュボード: token3rd/dashboard/view/pc.htm

   • ワークブック: token3rd/report/view.htm

   • データ ダッシュボード: token3rd/screen/view/pc.htm

   • ダウンロード: token3rd/offline/view/pc.htm

   • アドホック分析: token3rd/analysis/view/pc.htm

   • データ入力: token3rd/dataform/view.htm

3. レポート編集ページで、レポート ID を取得します。

   • ダッシュボード ID。例: d01****c5f。

     ダッシュボード編集ページで、アドレスバーから pageId の値を取得します。

     

   • ワークブック ID。例: d0****3ba88。

     ワークブック編集ページで、アドレスバーからワークブック ID を取得します。

   • データダッシュボード ID。例: 3c****26b。

     データダッシュボード編集ページで、アドレスバーから pageId の値を取得します。

     

   • ダウンロード ID。例: b2****47。

     ダウンロード編集ページで、アドレスバーから pageId の値を取得します。

     

   • アドホック分析 ID。例: 7f****da。

     アドホック分析編集ページで、アドレスバーから pageId の値を取得します。

     

   • データ入力 ID。例: 29****53。

     データ入力編集ページで、アドレスバーから pageId の値を取得します。

     

4. Quick BI ドメイン名、レポートプレビュー URL、レポート ID、およびステップ 2 の AccessTicket を連結して、リクエスト URL を作成します。

   • ダッシュボード URL のフォーマット: https://<Quick BI ドメイン名>/<レポートプレビュー URL>?pageId=<レポート ID>&accessTicket=<AccessTicket>

   • ワークブック URL のフォーマット: https://<Quick BI ドメイン名>/<レポートプレビュー URL>?id=<レポート ID>&accessTicket=<AccessTicket>

   • データダッシュボード URL のフォーマット: https://<Quick BI ドメイン名>/<レポートプレビュー URL>?pageId=<レポート ID>&accessTicket=<AccessTicket>

   • ダウンロード URL のフォーマット: https://<Quick BI ドメイン名>/<レポートプレビュー URL>?pageId=<レポート ID>&accessTicket=<AccessTicket>

   • アドホック分析 URL のフォーマット: https://<Quick BI ドメイン名>/<レポートプレビュー URL>?id=<レポート ID>&accessTicket=<AccessTicket

   • データ入力 URL のフォーマット: https://<Quick BI ドメイン名>/<レポートプレビュー URL>?id=<レポート ID>&accessTicket=<AccessTicket>

付録 1: 行レベルの権限を設定する

UserId および accountName パラメーターを指定しない場合、埋め込みレポートの表示権限は、デフォルトでレポートのオーナーの権限になります。特定のユーザーの権限をアタッチするには、次の図の手順に従って行レベルの権限を設定し、UserId または AccountName パラメーターを設定します。詳細については、「行レベルおよび列レベルの権限」をご参照ください。

付録 2: グローバルパラメーターの生成

対象のダッシュボードまたはワークブックで必要なグローバルパラメーターを設定します。これらのグローバルパラメーターは、レポートをアタッチして AccessTicket を生成するときに使用されます。

[
  {
    "paramKey": "price", // グローバルパラメーターキー
    "joinType": "and",   // 結合タイプ。'and' を使用します。
    "conditionList": [
      {
        "operate": "=", // 演算子。以下の説明をご参照ください。
        "value": "1"    // 値。複数の値の場合は、["1", "2"] のような配列を使用します。
      },
      {
        "operate": "=", // 演算子。以下の説明をご参照ください。
        "value": "2"    // 値。複数の値の場合は、["1", "2"] のような配列を使用します。
      }
    ]
  },
  {
    "paramKey": "area", // グローバルパラメーターキー
    "joinType": "and",   // 結合タイプ。'and' を使用します。
    "conditionList": [
      {
        "operate": "in",          // 演算子
        "value": ["North China","South China"]    // 値。複数の値の場合は、配列を使用します。
      }
    ]
  }
]

付録 3: 埋め込み可能なレポートの数