Cognos Analytics 12.0.3 レポート JavaScript APIの更新

概要

Cognos Analytics 12.0.3でレポートに組み込み可能なJavaScript APIの更新内容です。
JavaScriptで開発した機能をCognosに取り込み、レポートの機能でツールボックスから使用可能など、複数の更新があります。

参考情報

新機能 12.0.3 - レポート
https://www.ibm.com/docs/ja/cognos-analytics/12.0.0?topic=2024-reports

詳細説明

レポートの新機能をマニュアルで確認すると、以下のページが主要な内容なのですが、「スクリプト可能レポート」と「ネイティブ・カスタム・コントロール」って何のことだろうというのが読み込まないとわからなかったので、かみ砕いて紹介しようと思います。

JavaScript API の新規および更新された資料
https://www.ibm.com/docs/ja/cognos-analytics/12.0.0?topic=reports-new-updated-javascript-api-documentation

1).スクリプト可能レポート
https://public.dhe.ibm.com/software/data/sw-library/cognos/mobile/scriptable/index.html

スクリプト可能レポートは上記のページで簡易的なマニュアルが提供されており、これが何のことかというと、カスタム・コントロールでJavaScript APIを扱うマニュアルです。

カスタムコントロールで利用できるJavaScriptはRequireJSで、業界標準の技術を取り入れています。
D3のライブラリを取り込む等も容易で、Cognosをバージョンアップしても変わらず使用可能です。
https://public.dhe.ibm.com/software/data/sw-library/cognos/mobile/scriptable/tutorial-02-WhyBetter.html

プロンプトの拡張だけでなく、ブロックや画像、テキスト、視覚化など、幅広いオブジェクトに対して使用可能となりました。

https://public.dhe.ibm.com/software/data/sw-library/cognos/mobile/scriptable/tutorial-03-SupportedControls.html

これまでJavsScriptファイルはReport Serverノードに配置して、カスタム・コントロールのモジュール・パスで指定して呼び出していましたが、JavaScriptファイル自体をカスタマイズの拡張でzipファイルとして取り込み、図のような指定でzipファイル内のファイルを呼び出し可能となりました。

https://public.dhe.ibm.com/software/data/sw-library/cognos/mobile/scriptable/tutorial-06-HowToUseAnExtensionToHostJavaScript.html

カスタム・コントロールから呼び出されるJavaScriptは、保存済みレポートで実行された時にエラーとなってしまう事が多く報告されていました。
そのため、isSavedOutput()というレポートが保存済みかどうかを判定する関数が追加されました。
これにより、レポートが保存済みの場合は、カスタム・コントロールのJavaScriptを実行しないというコーディングが可能となりました。
https://www.ibm.com/docs/ja/cognos-analytics/12.0.0?topic=reports-custom-control-api-detect-saved-report-output

Cognos Analytics 12.0.3でサンプルを導入し、チーム・コンテンツ > サンプル > 機能別 > カスタム・コントロール に多数のサンプルがあるので参考に開発してみてください。

また、管理→カスタマイズ→拡張で、デフォルトで取り込まれている拡張zipファイルがダウンロード可能なので、ダウンロードして中身を確認すると参考になります。

2).ネイティブ・カスタム・コントロール
https://public.dhe.ibm.com/software/data/sw-library/cognos/mobile/native-custom-controls/index.html

こちらは概要で紹介した、JavaScriptをカスタム・コントロールから呼び出すのではなく、ツールボックスに一つのオブジェクトとして登録する新機能のマニュアルです。
カスタマイズ>拡張でzipファイルをアップロードする事で、登録を行います。

zipファイルの作成方法がこちらに記載されています。
アイコン表示のためのSVG symbolの指定など、記載内容に特徴があります。
https://public.dhe.ibm.com/software/data/sw-library/cognos/mobile/native-custom-controls/tutorial-01-Extension.html

作成したzipを拡張にアップロードすると、1つのオブジェクトとして誰もが使用可能となります。

サンプルとして、チーム・コンテンツ > サンプル > 機能別 > カスタム・コントロール > ネイティブ・カスタム・コントロールのポップアップ が提供されているので参考にしてください。
「Product Line」という文字をクリックすると、プロンプトがポップアップ表示されるサンプルです。

登録されたPopupオブジェクトのプロパティは、通常のカスタム・コントロールとは異なります。

https://public.dhe.ibm.com/software/data/sw-library/cognos/mobile/native-custom-controls/tutorial-04-TopLevelProperties.html

ツールボックスのアイコン表示の管理は、<CognosInstall>/webcontent/bi/pat/res/Toolbox.xml で行われます。
https://public.dhe.ibm.com/software/data/sw-library/cognos/mobile/native-custom-controls/tutorial-02-Toolbox.html

拡張zipファイルは、「Native_Custom_Control_Popup」からダウンロード可能なので、開発の参考にして下さい。

zipの中身は以下のようなものが含まれていました。