IBM API Connect 開発者ポータル構成ガイド　1章

(1)

2016/10/01

日本アイ・ビー・エム株式会社

IBM API Connect 開発者ポータル構成ガイド

(2)

2  当資料の位置づけ



当資料は、API Connectの開発者ポータルの主要なカスタマイズ方

法についてまとめたものです。



V5.0.1を前提としています。

 注意事項



当資料に含まれる情報は可能な限り正確を期しておりますが、当資

料に記載された内容に関して何ら保証するものではありません。こ

こでの記載内容はあくまでも支援情報であり、使用者の責任におい

て取扱われるものとし、資料の内容によって受けたいかなる損害に

関して一切の保証をいたしません。



製品の新しいリリース、修正などによって動作／仕様が変わる可能

性がありますので、必ずマニュアル等で最新の情報をご確認くださ

い。

はじめに

(3)

3 1. 開発者ポータルの一般的な構成

2. 開発者ポータルの外観の制御

3. 開発者ポータルのコンテンツの制御

4. 開発者ポータルのセキュリティーの管理

5. 開発者ポータルのユーザーの管理

6. 開発者ポータルでのフォーラムの制御

開発者ポータルの構成/カスタマイズ

(4)

4 1. 開発者ポータルの一般的な構成

1-1. WYSIWYGリッチ・テキスト・エディターに表示されるボタンの構成

1-2. 使用可能な言語の構成

1-3. サイトのデフォルト・タイム・ゾーンの構成

1-4. 日時の構成

1-5. サポート・チケット・システムの構成

1-6. スケジュールされたタスクを実行するクーロンの構成

1-7. サイト状況レポートの確認

1-8. 使用可能な更新の表示

1-9. 追加モジュールのインストール

1-10. 機能を拡張するためのカスタム・モジュールの作成

1-11. モジュールの無効化

1-12. サーバー・キャッシュのクリア

1-13. サイトの保守モードの切り替え

1-14. サイトのエラー処理の構成

1-15. 管理者ダッシュボードの構成

1-16. 開発者ポータルでの検索オートコンプリート

開発者ポータルの構成/カスタマイズ

(5)

5 逆引き開発者ポータルの構成/カスタマイズ

開発者ポータル等のエディター画面の表示を変更したい

1-1. WYSIWYGリッチ・テキスト・エディターに表示されるボタンの構成

開発者ポータルの画面表示言語を変更したい

1-2. 使用可能な言語の構成

文書作成の日時(時差)を日本の時刻に変えたい

1-3. サイトのデフォルト・タイム・ゾーンの構成

デフォルトの日時を変更したい

1-4. 日時の構成

サポートのチケット・システムの構成を変更したい

1-5. サポート・チケット・システムの構成

スケジュールされたタスクの実行頻度を変更したい

1-6. スケジュールされたタスクを実行するクーロンの構成

システム管理者がサイトの稼働状況を確認したい

1-7. サイト状況レポートの確認

システム管理者が最新の適用可能な最新のfixを照会したい

（ただし、API Connectは、DrupalのFixを適用することを

推奨はしません）

1-8. 使用可能な更新の表示

機能拡張のためのモジュールを追加したい

1-9. 追加モジュールのインストール

機能拡張のためのカスタム・モジュールを作成したい

1-10. 機能を拡張するためのカスタム・モジュールの作成

不要なモジュールは無効化したい

1-11. モジュールの無効化

キャッシュ情報に不整合が発生して、適切に表示できない場

合、キャッシュをクリアしたい

1-12. サーバー・キャッシュのクリア

開発者ポータルの運用保守のため保守モードのメッセージを

表示したい

1-13. サイトの保守モードの切り替え

サイトで発生するエラー処理(ログ出力)をカスタマイズした

い

1-14. サイトのエラー処理の構成

管理者ダッシュボードを表示してユーザーのログイン状況を

確認したい

1-15. 管理者ダッシュボードの構成

開発者ポータルのオートコンプリート機能を有効にしたい

1-16. 開発者ポータルでの検索オートコンプリート

(6)

6 1. 開発者ポータルの一般的な構成

1-1. WYSIWYGリッチ・テキスト・エディター

に表示されるボタンの構成

(7)

7  設定手順



管理メニューより、[環境設定] > [コンテンツ作成] > [Wiswig

profiles]を選択

1-1. WYSIWYGリッチ・テキスト・エディターに表示される

ボタンの構成

(8)

8  設定手順



Full HTMLプロファイルの[編集]をクリック



[Buttons and plugins]を展開し、表示したいボタンをカスタマイ

ズ

1-1. WYSIWYGリッチ・テキスト・エディターに表示される

ボタンの構成

(9)

9  設定手順



[Emotions]のチェックをOFFする



Full editor画面(基本ページの作成画面)で、ボタン表示が変更

1-1. WYSIWYGリッチ・テキスト・エディターに表示される

ボタンの構成

(10)

10 1. 開発者ポータルの一般的な構成

(11)

11  設定手順



管理メニューより、[環境設定] > [地域と言語] > [言語]を選択

(12)

12  設定手順



言語設定画面で、使用できる言語の有効、デフォルトを変更可能

(13)

13  設定手順



日本語の[有効]のチェックをはずし、設定を保存すると、表記が英

語になる。(英語表記になるのは、デフォルトの言語設定が英語の

ため)



言語切り替えの設定リストからも日本語表記がなくなる

1-2. 使用可能な言語の構成

(14)

14 1. 開発者ポータルの一般的な構成

(15)

15  設定手順



管理メニューより、[環境設定] > [地域と言語] > [地域の設定]を

選択

1-3. サイトのデフォルト・タイム・ゾーンの構成

(16)

16  設定手順



[タイムゾーン]>[デフォルトのタイムゾーン]で、タイムゾーンの

切り替え

1-3. サイトのデフォルト・タイム・ゾーンの構成

(17)

17  設定手順



アカウントごとにタイムゾーン設定が変更された場合の表示例





フォーラム記事の表示

1-3. サイトのデフォルト・タイム・ゾーンの構成

(18)

18 1. 開発者ポータルの一般的な構成

(19)

19  設定手順



管理メニューより、[環境設定] > [地域と言語] > [地域の設定]を

選択。日付型のフォーマットを変更可能

1-4. 日時の構成

(20)

20 1. 開発者ポータルの一般的な構成

(21)

21  設定手順



管理メニューより、[Support ticketing System]を選択し設定画面

を表示。チケット通知で使用するメール・テンプレートを編集可

(22)

22  設定手順



管理メニューより、[モジュール]を選択、有効にする

(23)

23  設定手順



有効にされるモジュール



メニューも追加

1-5. サポート・チケット・システムの構成

図表のサポート

Support charting

メール送信コマンドのサポート

Support Mail Commands

サポートの概要

Support Overview

プロジェクト管理のサポート

Support Project Management

参照サポート

Support Reference

(24)

24 1. 開発者ポータルの一般的な構成

1-6. スケジュールされたタスクを実行する

クーロンの構成

(25)

25  設定手順



管理メニューより、[環境設定] > [システム] > [cron]を選択

(26)

26  設定手順



cronが設定されているモジュールの一覧表示



[操作]から、ログの確認、設定を編集

1-6. スケジュールされたタスクを実行するクーロンの構成

(27)

27  編集画面

 ログ表示

(28)

28 1. 開発者ポータルの一般的な構成

(29)

29  設定手順



管理メニューより、[レポート] >[サイトの状態]を選択

(30)

30  サイト状態を表示

(31)

31 1. 開発者ポータルの一般的な構成

(32)

32  設定手順



管理メニューより、[レポート] >[利用可能なアップデート]を選択

1-8. 使用可能な更新の表示

ただし、Drupalの個別のモジュー

ルのアップデート適用は推奨され

ない

(33)

33 1. 開発者ポータルの一般的な構成

(34)

34  設定手順



管理メニューより、[モジュール] >[新しいモジュールをインス

トール]を選択



次のURLからインストールする

または



インストールするモジュールやテーマの圧縮ファイルをアップロードす

る

を選択

1-9. 追加モジュールのインストール

(35)

35 1. 開発者ポータルの一般的な構成

1-10. 機能を拡張するためのカスタム・モジュール

の作成

(36)

36  設定手順



開発者ポータルでカスタムフックを使用



カスタム・モジュールを作成すると以下のカスタムフックを利用可

能

1-10. 機能を拡張するためのカスタム・モジュールの作成

hook_ibm_apim_application_create

hook_ibm_apim_application_delete

hook_ibm_apim_application_edit

hook_ibm_apim_application_clientsecret_reset

hook_ibm_apim_application_clientid_reset

hook_ibm_apim_application_unsubscribe

hook_ibm_apim_application_subscribe

hook_ibm_apim_application_creds_update

hook_ibm_apim_application_creds_create

hook_ibm_apim_application_creds_delete

(37)

37 1. 開発者ポータルの一般的な構成

(38)

38  設定手順



管理メニューより、[モジュール]を選択



モジュールの一覧から、無効にしたいモジュールを x に変更

1-11. モジュールの無効化

(39)

39 1. 開発者ポータルの一般的な構成

(40)

40  設定手順



管理メニューより、[開発環境]>[開発]>[パフォーマンス]を選択



パフォーマンス画面で、[すべてのキャッシュをクリアー]を選択

1-12. サーバー・キャッシュのクリア

ｃ

(41)

41 1. 開発者ポータルの一般的な構成

(42)

42  設定手順



管理メニューより、[開発環境]>[開発]>[メンテナンスモード]を選

択

1-13. サイトの保守モードの切り替え

(43)

43  設定手順



メンテナンス状態のメッセージを編集可能



この状態で、開発者ポータルにアクセスすると、メンテナンスモー

ドメッセージが表示される

1-13. サイトの保守モードの切り替え

パスを含むサイトでポータル

を構築した場合には、ログイ

ンできずにこの表示もされな

い

(44)

44  設定OFF



管理者IDでログインすると、以下の画面が表示され、オンライン

モードに切り替え可能

1-13. サイトの保守モードの切り替え

(45)

45 1. 開発者ポータルの一般的な構成

(46)

46  設定手順



管理メニューより、[開発環境]>[開発]>[ログとエラーメッセージ]

を選択

1-14. サイトのエラー処理の構成

(47)

47  設定項目



syslogの識別ID、Syslogファシリティー、ログフォーマットの設定

が可能

1-14. サイトのエラー処理の構成

(48)

48  設定項目

(49)

49  設定例

 OSのrsyslog設定



/etc/rsyslog.confの最下行に以下を追加

local7.* /var/log/drupal.log



サービスの再起動

$ sudo service rsyslog restart

 出力例 (/var/log/drupal.log)

 Syslog module



https://www.drupal.org/documentation/modules/syslog

1-14. サイトのエラー処理の構成

設定項目

設定値

表示するエラーメッセージ

すべてのメッセージ

Syslogの識別ID

drupal_orgsb

Syslogファシリティ

LOG_LOCAL7

Aug 11 02:45:14 devportal drupal_orgsb:

http://org.sb.devportal.domain.com:443|1470883514|ibm_apim_cron|127.0.0.1|https://devportal.domain.com/index.php||1||Background sync ran successfully. Returned 7 products, 11 APIs, 10 Apps, 2 Developer Organizations

Aug 11 02:46:07 devportal drupal_orgsb:

http://org.sb.devportal.domain.com:443|1470883567|serial_launcher|127.0.0.1|https://devportal.domain.com/index.php||0||Cron thread 1 started

IBM API Connect 開発者ポータル構成ガイド 1章

2016/10/01

日本アイ・ビー・エム株式会社