Cognos Analytics カスタマイズ機能の解説

#1.概要
Cognos Analytics のユーザー・インターフェースは、カスタマイズすることができます。
Cognos BI 10.2.2までは、system.xml ファイルを編集することで、「ようこそ」画面やCognos Connection メイン・ヘッダーの変更などを行うことができました。
Cognos Analytics では、カスタマイズを定義する spec.json ファイルを含めた圧縮ファイルとしてパッケージ化してアップロードし、変更を適用します。													
													
カスタマイズ可能なものは、次の3つです。
**・テーマ**
**・ビュー**
ホーム、サインイン、オーサリング、ダッシュボード、モデリングなどのビューをカスタマイズすることができます。
**・拡張機能**
拡張機能を作成して、既存のビューを変更したり、新規ビューを作成したりできます。拡張機能で実行できるアクションを次に示します。
①ボタンまたはメニュー項目の追加
②メニューの追加
③ユーザー・インターフェース要素の削除
④ダッシュボード形状の追加(v11.0.5～)
⑤ダッシュボード・ウィジェットの追加(v11.0.5～)

・ポータル画面
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/147246/22b2cf62-bc7f-8eca-1b3d-0b948c340479.png)

・ダッシュボード編集画面
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/147246/46b6d67d-7162-19e5-528d-29e173ecd1e4.png)

カスタマイズは、「管理」 > 「カスタマイズ」パネルで管理します。 
このパネルで、カスタマイズを Cognos Analytics サーバーにアップロードしたり、使用するカスタマイズを選択したりすることができます。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/147246/c0e47a1a-21bc-30d3-1488-29016a44efed.png)

#2.テーマのカスタマイズ
**2.1 テーマのアップロード**
テーマをアップロードするには、「テーマ」タブで、「テーマのアップロード」アイコンをクリックし、アップロードするファイルを選択します。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/147246/809f3e0f-6f9f-3bff-182d-a1800eee8851.png)
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/147246/5b284d7c-5664-bf3d-fdce-ddde480604a1.png)

**2.2 デフォルトのテーマの設定**
すべてのユーザー用のデフォルトのテーマにするテーマを選択できます。
「管理」 > 「カスタマイズ」スライドアウト・パネルの「テーマ」タブで、テーマの横のチェック・ボックスを選択し、「適用」をクリックします。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/147246/91d07b1c-a743-f037-a562-927a08c40957.png)
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/147246/fdf579ad-5767-a761-c8f3-601ef5f18a43.png)

ブラウザを更新すると新しいテーマに変更されます。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/147246/97ab1b31-fc74-9160-1e77-8ac7977f11dc.png)

#3.拡張機能およびビューのカスタマイズ
**3.1 拡張機能およびビューのアップロード**
拡張機能またはビューをアップロードするには、「拡張」タブで、「拡張機能のアップロード」アイコンをクリックし、アップロードするファイルを選択します。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/147246/72f81711-7226-4854-1607-aac279f3f8e4.png)

アップロードが完了すると、リストに表示されます。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/147246/585901c4-e488-bf3c-fc03-c07d13059d66.png)
上記例では、ホームビュー用のサンプル(SampleWelcome.zip)をアップロードしています。

**3.2 デフォルトのホーム・ビューの設定**
「管理」 > 「カスタマイズ」スライドアウト・パネルの「ビュー」タブで、デフォルトのホーム・ビューの横にある 「＞」をクリックし、ビューを選択し、「適用」をクリックします。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/147246/ad3f3266-a15b-81f0-e5cb-938c0e4be04d.png)
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/147246/45d4cf9e-4c24-49ce-4a75-05a8d02ef8eb.png)

#4.役割のカスタマイズ
テーマやホーム･ページは、全てのユーザーに適用されるデフォルト設定の他に、特定の役割のユーザーにカスタマイズを適用することができます。
特定の役割のユーザーが Cognos Analytics を開いた場合に、カスタマイズされたホーム・ページまたは特定のレポートやダッシュボードが表示されるように指定することができます。

「管理」 > 「アカウント」で、ネームスペースをクリックしてそのネームスペースの役割のリストを表示します。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/147246/d0646eab-8931-c97a-f83a-b41d48f17c27.png)

役割をクリックし、その役割のスライドアウト・パネルの「カスタマイズ」タブを表示します。
事前にアップロードしておいたビューまたはテーマを選択して、適用します。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/147246/309a5238-568e-f735-f3bb-a8d9a7954119.png)

#5.ユーザー・インターフェース・オブジェクトの ID の確認
機能や項目を除外する拡張機能や、既存のメニューにメニュー項目を追加する拡張機能を作成する場合は、既存のユーザー・インターフェース要素の ID を調べる必要があります。	
	
既存のユーザー・インターフェース要素の ID を調べる方法を紹介します。

1. Cognosサービスを停止します。

2. \<installation_location>¥wlp¥usr¥servers¥cognosserver¥bootstrap.properties ファイルに以下の行を追加し、Cognosサービスを起動します。
**disableXSRFCheck=true**

3. Cognos® Analytics サーバーにサインインします。

4. Web ブラウザーのURL欄に以下を入力します。
**http://\<server_name>:\<port>/bi/v1/perspectives/\<view>**
※\<view> は、対象のユーザー・インターフェース・オブジェクトが含まれているビュー (home、authoring、dashboard、または modeller) です。 

例：ホーム・ビューのIDを確認する場合
**http://xxx.xxx.xxx.xxx:9300/bi/v1/perspectives/home**

5. ビュー内のすべてのユーザー・インターフェース要素が記述された JSON ファイルが返されます。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/147246/e1f6dd0c-1829-e6fa-a95b-df2887c124ee.png)
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/147246/69d4fde6-75b4-bfe2-7c1a-f95c00fc7948.png)

#6.カスタマイズした拡張機能とビューを無効にして Cognos Analytics を実行する
アップロードした拡張機能やビューにエラーが含まれていると、Cognos Analytics を使用できなくなる可能性があります。
そのような場合に、カスタマイズした拡張機能とビューを無効にして Cognos Analytics にアクセスする方法を紹介します。

ブラウザを起動し、Cognos AnalyticsにアクセスするURLの後ろに「?factoryMode=true」 を追加します。

カスタマイズした拡張機能とビューが無効になった状態でCognos Analyticsにアクセスできます。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/147246/b406c077-1fcd-3b4f-e7aa-32b01e78f102.png)

#7.カスタマイズ・サンプル
テーマ、拡張機能、ビューの作成方法を示したカスタマイズ・サンプルが用意されています。それらのサンプルを変更して独自のカスタマイズを作成できます。
これらのサンプルは、\<installation_location>/samples フォルダーにインストールされています。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/147246/6b4a1bca-59ca-315d-c990-ee6a4f2d00f7.png)
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/147246/3b9eea4d-5862-9c0a-1172-f90d0e71b5fd.png)

#8.spec.json ファイル説明
spec.json ファイルの定義についてはリンク先を参照してください。
https://www.ibm.com/support/knowledgecenter/ja/SSEP7J_11.0.0/com.ibm.swg.ba.cognos.ag_manage.doc/c_ag_manage_json.html
	
ここでは、拡張機能の作成の「Webページを開くボタンを追加」する場合のサンプルを記載します。
※「Webページを開くボタンを追加」のサンプルファイル名は、SampleExtensionButtonWebsite.zip です。	
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/147246/165310ae-f64c-8640-260b-f0961300f439.png)

上記spec.jsonファイルでボタンを追加した例
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/147246/9eb503cd-b024-aa07-a916-01b133a129b3.png)

#参考情報
**Cognos Analytics 特定のアイコンやメニューを非表示にしたい**
https://qiita.com/shinyama/items/c66dc52f2e088fbe8d4b