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

Transcription

1 IBM API Connect 開発者ポータル構成ガイド 1. 開発者ポータルの一般的な構成 2016/10/01 日本アイ ビー エム株式会社

2 はじめに 当資料の位置づけ 当資料は API Connect の開発者ポータルの主要なカスタマイズ方法についてまとめたものです V5.0.1 を前提としています 注意事項 当資料に含まれる情報は可能な限り正確を期しておりますが 当資料に記載された内容に関して何ら保証するものではありません ここでの記載内容はあくまでも支援情報であり 使用者の責任において取扱われるものとし 資料の内容によって受けたいかなる損害に関して一切の保証をいたしません 製品の新しいリリース 修正などによって動作 / 仕様が変わる可能性がありますので 必ずマニュアル等で最新の情報をご確認ください 2

3 開発者ポータルの構成 / カスタマイズ 1. 開発者ポータルの一般的な構成 2. 開発者ポータルの外観の制御 3. 開発者ポータルのコンテンツの制御 4. 開発者ポータルのセキュリティーの管理 5. 開発者ポータルのユーザーの管理 6. 開発者ポータルでのフォーラムの制御 3

4 開発者ポータルの構成 / カスタマイズ 1. 開発者ポータルの一般的な構成 1-1. WYSIWYG リッチ テキスト エディターに表示されるボタンの構成 1-2. 使用可能な言語の構成 1-3. サイトのデフォルト タイム ゾーンの構成 1-4. 日時の構成 1-5. サポート チケット システムの構成 1-6. スケジュールされたタスクを実行するクーロンの構成 1-7. サイト状況レポートの確認 1-8. 使用可能な更新の表示 1-9. 追加モジュールのインストール 機能を拡張するためのカスタム モジュールの作成 モジュールの無効化 サーバー キャッシュのクリア サイトの保守モードの切り替え サイトのエラー処理の構成 管理者ダッシュボードの構成 開発者ポータルでの検索オートコンプリート 4

5 逆引き開発者ポータルの構成 / カスタマイズ 開発者ポータル等のエディター画面の表示を変更したい 開発者ポータルの画面表示言語を変更したい 文書作成の日時 ( 時差 ) を日本の時刻に変えたい デフォルトの日時を変更したい サポートのチケット システムの構成を変更したい スケジュールされたタスクの実行頻度を変更したい システム管理者がサイトの稼働状況を確認したい システム管理者が最新の適用可能な最新の fix を照会したい ( ただし API Connect は Drupal の Fix を適用することを推奨はしません ) 機能拡張のためのモジュールを追加したい 機能拡張のためのカスタム モジュールを作成したい 不要なモジュールは無効化したい キャッシュ情報に不整合が発生して 適切に表示できない場合 キャッシュをクリアしたい 開発者ポータルの運用保守のため保守モードのメッセージを表示したいサイトで発生するエラー処理 ( ログ出力 ) をカスタマイズしたい管理者ダッシュボードを表示してユーザーのログイン状況を確認したい 開発者ポータルのオートコンプリート機能を有効にしたい 1-1. WYSIWYGリッチ テキスト エディターに表示されるボタンの構成 1-2. 使用可能な言語の構成 1-3. サイトのデフォルト タイム ゾーンの構成 1-4. 日時の構成 1-5. サポート チケット システムの構成 1-6. スケジュールされたタスクを実行するクーロンの構成 1-7. サイト状況レポートの確認 1-8. 使用可能な更新の表示 1-9. 追加モジュールのインストール 機能を拡張するためのカスタム モジュールの作成 モジュールの無効化 サーバー キャッシュのクリア サイトの保守モードの切り替え サイトのエラー処理の構成 管理者ダッシュボードの構成 開発者ポータルでの検索オートコンプリート 5

6 1. 開発者ポータルの一般的な構成 1-1. WYSIWYG リッチ テキスト エディターに表示されるボタンの構成 6

7 1-1. WYSIWYGリッチ テキスト エディターに表示されるボタンの構成 設定手順 管理メニューより [ 環境設定 ] > [ コンテンツ作成 ] > [Wiswig profiles] を選択 7

8 1-1. WYSIWYGリッチ テキスト エディターに表示されるボタンの構成 設定手順 Full HTMLプロファイルの [ 編集 ] をクリック [Buttons and plugins] を展開し 表示したいボタンをカスタマイズ 8

9 1-1. WYSIWYGリッチ テキスト エディターに表示されるボタンの構成 設定手順 [Emotions] のチェックをOFFする Full editor 画面 ( 基本ページの作成画面 ) で ボタン表示が変更 9

10 1. 開発者ポータルの一般的な構成 1-2. 使用可能な言語の構成 10

11 1-2. 使用可能な言語の構成 設定手順 管理メニューより [ 環境設定 ] > [ 地域と言語 ] > [ 言語 ] を選択 11

12 1-2. 使用可能な言語の構成 設定手順 言語設定画面で 使用できる言語の有効 デフォルトを変更可能 12

13 1-2. 使用可能な言語の構成 設定手順 日本語の [ 有効 ] のチェックをはずし 設定を保存すると 表記が英語になる ( 英語表記になるのは デフォルトの言語設定が英語のため ) 言語切り替えの設定リストからも日本語表記がなくなる 13

14 1. 開発者ポータルの一般的な構成 1-3. サイトのデフォルト タイム ゾーンの構成 14

15 1-3. サイトのデフォルト タイム ゾーンの構成 設定手順 管理メニューより [ 環境設定 ] > [ 地域と言語 ] > [ 地域の設定 ] を選択 15

16 1-3. サイトのデフォルト タイム ゾーンの構成 設定手順 [ タイムゾーン ]>[ デフォルトのタイムゾーン ] で タイムゾーンの切り替え 16

17 1-3. サイトのデフォルト タイム ゾーンの構成 設定手順 アカウントごとにタイムゾーン設定が変更された場合の表示例 (JST) (UTC) フォーラム記事の表示 17

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

19 1-4. 日時の構成 設定手順 管理メニューより [ 環境設定 ] > [ 地域と言語 ] > [ 地域の設定 ] を選択 日付型のフォーマットを変更可能 19

20 1. 開発者ポータルの一般的な構成 1-5. サポート チケット システムの構成 20

21 1-5. サポート チケット システムの構成 設定手順 管理メニューより [Support ticketing System] を選択し設定画面を表示 チケット通知で使用するメール テンプレートを編集可 21

22 1-5. サポート チケット システムの構成 設定手順 管理メニューより [ モジュール ] を選択 有効にする 22

23 1-5. サポート チケット システムの構成 設定手順 有効にされるモジュール 図表のサポートメール送信コマンドのサポートサポートの概要プロジェクト管理のサポート参照サポート Support charting Support Mail Commands Support Overview Support Project Management Support Reference メニューも追加 23

24 1. 開発者ポータルの一般的な構成 1-6. スケジュールされたタスクを実行するクーロンの構成 24

25 1-6. スケジュールされたタスクを実行するクーロンの構成 設定手順 管理メニューより [ 環境設定 ] > [ システム ] > [cron] を選択 25

26 1-6. スケジュールされたタスクを実行するクーロンの構成 設定手順 cron が設定されているモジュールの一覧表示 [ 操作 ] から ログの確認 設定を編集 26

27 1-6. スケジュールされたタスクを実行するクーロンの構成 編集画面 ログ表示 27

28 1. 開発者ポータルの一般的な構成 1-7. サイト状況レポートの確認 28

29 1-7. サイト状況レポートの確認 設定手順 管理メニューより [ レポート ] >[ サイトの状態 ] を選択 29

30 1-7. サイト状況レポートの確認 サイト状態を表示 30

31 1. 開発者ポータルの一般的な構成 1-8. 使用可能な更新の表示 31

32 1-8. 使用可能な更新の表示 設定手順 管理メニューより [ レポート ] >[ 利用可能なアップデート ] を選択 ただし Drupal の個別のモジュールのアップデート適用は推奨されない 32

33 1. 開発者ポータルの一般的な構成 1-9. 追加モジュールのインストール 33

34 1-9. 追加モジュールのインストール 設定手順 管理メニューより [ モジュール ] >[ 新しいモジュールをインストール ] を選択 次の URL からインストールするまたは インストールするモジュールやテーマの圧縮ファイルをアップロードするを選択 34

35 1. 開発者ポータルの一般的な構成 機能を拡張するためのカスタム モジュールの作成 35

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 36

37 1. 開発者ポータルの一般的な構成 モジュールの無効化 37

38 1-11. モジュールの無効化 設定手順 管理メニューより [ モジュール ] を選択 モジュールの一覧から 無効にしたいモジュールを x に変更 38

39 1. 開発者ポータルの一般的な構成 サーバー キャッシュのクリア 39

40 1-12. サーバー キャッシュのクリア 設定手順 管理メニューより [ 開発環境 ]>[ 開発 ]>[ パフォーマンス ] を選択 パフォーマンス画面で [ すべてのキャッシュをクリアー ] を選択 c 40

41 1. 開発者ポータルの一般的な構成 サイトの保守モードの切り替え 41

42 1-13. サイトの保守モードの切り替え 設定手順 管理メニューより [ 開発環境 ]>[ 開発 ]>[ メンテナンスモード ] を選択 42

43 1-13. サイトの保守モードの切り替え 設定手順 メンテナンス状態のメッセージを編集可能 この状態で 開発者ポータルにアクセスすると メンテナンスモードメッセージが表示される パスを含むサイトでポータルを構築した場合には ログインできずにこの表示もされない 43

44 1-13. サイトの保守モードの切り替え 設定 OFF 管理者 ID でログインすると 以下の画面が表示され オンラインモードに切り替え可能 44

45 1. 開発者ポータルの一般的な構成 サイトのエラー処理の構成 45

46 1-14. サイトのエラー処理の構成 設定手順 管理メニューより [ 開発環境 ]>[ 開発 ]>[ ログとエラーメッセージ ] を選択 46

47 1-14. サイトのエラー処理の構成 設定項目 syslog の識別 ID Syslog ファシリティー ログフォーマットの設定が可能 47

48 1-14. サイトのエラー処理の構成 設定項目 48

49 1-14. サイトのエラー処理の構成 設定例 設定項目表示するエラーメッセージ Syslogの識別 ID Syslogファシリティ 設定値すべてのメッセージ drupal_orgsb LOG_LOCAL7 OS の rsyslog 設定 /etc/rsyslog.conf の最下行に以下を追加 local7.* /var/log/drupal.log サービスの再起動 $ sudo service rsyslog restart 出力例 (/var/log/drupal.log) Aug 11 02:45:14 devportal drupal_orgsb: ibm_apim_cron Background sync ran successfully. Returned 7 products, 11 APIs, 10 Apps, 2 Developer Organizations Aug 11 02:46:07 devportal drupal_orgsb: serial_launcher Cron thread 1 started 49 Syslog module

50 1. 開発者ポータルの一般的な構成 管理者ダッシュボードの構成 50

51 1-15. 管理者ダッシュボードの構成 設定手順 管理メニューより [ ダッシュボード ] を選択 [ ダッシュボードをカスタマイズ ] ボタンが表示 51

52 1-15. 管理者ダッシュボードの構成 設定手順 表示したい項目を移動 52

53 1-15. 管理者ダッシュボードの構成 画面表示例 [ オンライン状況 ] および [ 新しいユーザー ] 53

54 1. 開発者ポータルの一般的な構成 開発者ポータルでの検索オートコンプリート 54

55 1-16. 開発者ポータルでの検索オートコンプリート 設定手順 管理メニューより [ 環境設定 ]>[ 検索とメタデータ ]>[Search Autocomplete settings] を選択 55

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

57 1-16. 開発者ポータルでの検索オートコンプリート 設定例 最小キーワードサイズが 3( デフォルト ) の場合 最小キーワードサイズが 6 の場合 3 文字入力時に検索候補の表示 6 文字入力時に検索候補の表示 57