uCosminexus Portal Framework　ポートレット開発ガイド

[目次][用語][索引][前へ][次へ]

3.13.2　デプロイ定義ファイル（hportlet.xml）の作成

デプロイ定義ファイルを作成します。デプロイ定義ファイル（hportlet.xml）とは，ポートレットのタイトルやURLなど，uCosminexus Portal Frameworkで使用するポートレットの情報を設定するファイルです。デプロイ定義ファイルのサンプル，デプロイ定義ファイルで使用するタグの一覧およびデプロイ定義ファイル作成時の注意事項を次に示します。なお，この要素で指定する内容は，ポートレット定義ファイル（jetspeed-config.jcfg）の各ポートレット定義のparameter要素で指定する内容に対応しています。ポートレット定義ファイル（jetspeed-config.jcfg）については，マニュアル「uCosminexus Portal Framework　システム管理者ガイド」の「ポートレット定義ファイル（jetspeed-config.jcfg）」の説明を参照してください。

＜この項の構成＞
(1)　サンプルのデプロイ定義ファイル
(2)　デプロイ定義ファイルで使用するタグの一覧
(3)　デプロイ定義ファイル作成時の注意事項

(1)　サンプルのデプロイ定義ファイル

サンプルのデプロイ定義ファイルを次に示します。このデプロイ定義ファイルは，uCosminexus Portal Frameworkがサンプルとして提供している「sampleforum.par」に格納されているデプロイ定義ファイル（hportlet.xml）に，太字の要素（<windowtitle>，<support>および<timeout>）を追加した内容になっています。

「sampleforum.par」については，「10.3　ナビゲーションメニュー対応ポートレットの開発例」を参照してください。

サンプルのデプロイ定義ファイル
　
<?xml version="1.0" encoding="Shift_JIS" ?>
<portlet-app>
  <portlet>
    <portlet-name>sampleforum</portlet-name>
    <portlet-type>ref</portlet-type>
    <portlet-parent>MultiJSP</portlet-parent>
    <title>Sample forum</title>
    <description>This is the Sample forum portlet.</description>
    <windowtitle lang="ja">Sample forum</windowtitle>
    <config-param>
      <param-name>hptl.module.action</param-name>
      <param-value>jp.co.hitachi.soft.portal.accessories.sampleforum.SampleForumActionModule</param-value>
      <param-name>hptl.portlet.defaulticon</param-name>
      <param-value>images/forum.gif</param-value>
      <param-name>hptl.inbox.support</param-name>
      <param-value>true</param-value>
      <param-name>hptl.inbox.filtering.support</param-name>
      <param-value>true</param-value>
      <param-name>hptl.navigationbar.support</param-name>
      <param-value>true</param-value>
    </config-param>
    <support>
      <timeout>10</timeout>
    </support>
    <allows>
      <maximize />
    </allows>
    <device media="HTML">
      <url>index.jsp</url>
      <supports>
        <personalize />
      </supports>
    </device>
  </portlet>
</portlet-app>
　

(2)　デプロイ定義ファイルで使用するタグの一覧

タグの一覧を次の表に示します。

表3-11　デプロイ定義ファイルのタグ一覧

タグ名 タグの出現回数 属性の出現回数 説明
<portlet-app> 1回 − デプロイ定義ファイルのルートタグ。
　 <portlet> 1回 − ポートレット定義情報の親タグ。
　 <portlet-name> 1回 − ポータルプロジェクト内で一意となるポートレット名。
指定できる最大文字数は，半角英数字32文字です。
<portlet-type> 1回 − 常に「ref」を指定します。
<portlet-parent> 1回 − ポートレットの種類。
日立APIポートレットの場合，「MultiJSP」を指定します。
<title lang="言語種別"> 0回以上 0または1回 ポートレットのタイトルバーおよび利用者用レイアウトカスタマイズ画面の［ポートレット選択画面］に表示されるポートレットのタイトル。※1※2
全角および半角の文字列を使用できます。ただし，エンコード依存文字，機種依存文字，外字および制御コードの文字列は使用できません。
指定できる最大文字数は，全角でも半角でも80文字です。
省略した場合のデフォルト値は，「No Title Set」です。
属性langで言語種別を指定できます。※3
<description lang="言語種別"> 0回以上 0または1回 ポートレットの説明文。※1
全角および半角の表示可能文字列を使用できます。
全角および半角の文字列を使用できます。ただし，エンコード依存文字，機種依存文字，外字および制御コードの文字列は使用できません。
指定できる最大文字数は，全角でも半角でも80文字です。
省略した場合のデフォルト値は，「No description found. Generic portlet」です。
属性langで言語種別を指定できます。※3
<windowtitle lang="言語種別"> 0回以上 0または1回 新規ウィンドウを表示する場合のウィンドウのタイトル。※1※2
全角および半角の文字列を使用できます。ただし，エンコード依存文字，機種依存文字，外字および制御コードの文字列は使用できません。
指定できる最大文字数は，全角でも半角でも80文字です。
省略した場合のデフォルト値は，<portlet-name>で指定したポートレット名です。
属性langで言語種別を指定できます。※3
<config-param> 0または1回 − ポートレット起動時のパラメタ（ポートレットの固有の情報）についての定義。
　 <param-name> 0回以上 − パラメタのプロパティ名。※4
プロパティ名は，ポートレット単位で決められます。ただし，「hptl」で始まる名称は予約語のため指定できません。
<param-value> 0回以上 − パラメタのプロパティ値。※4
<param-name>に指定したプロパティ名に対応する値を指定します。
プロパティ値は，ポートレット単位で決められます。ただし，「hptl」で始まる値は予約語のため指定できません。
</config-param> 0または1回 − 終了タグ。
<supports> 0または1回 − <timeout>の親タグ。
　 <timeout> 0または1回 − ポートレットの無応答監視時間。※5
指定する値の単位は秒です。指定できる値の範囲は，0〜86,400（整数）です。0を指定した場合，無応答監視は行いません。
ポートレットの実行時間が無応答監視時間を超えた場合，エラー画面を表示します。
</supports> 0または1回 − 終了タグ。
<allows> 0または1回 − 画面表示モードの親タグ。
　 <minimize /> 0または1回 − ポートレットの最小化表示の許可。
ポートレットがタイトル表示の場合，ポートレットの最小化ボタンを表示し，最小化できるようにします。
ポートレットに最小化表示を許可する場合，空要素タグ<minimize />を記述します。なお，値を指定する必要はありません。
<close /> 0または1回 − ポートレットの閉じるボタンの許可。
ポートレットがタイトル表示の場合，かつ強制表示ポートレットでない場合，ポートレットの閉じるボタンを表示し，閉じることができるようにします。
ポートレットに閉じるボタンを許可する場合，空要素タグ<close />を記述します。なお，値を指定する必要はありません。
<maximize /> 0または1回 − ポートレットの最大化表示の許可。
ポートレットがタイトル表示の場合，ポートレットの最大化ボタンを表示し，最大化できるようにします。
ポートレットに最大化表示を許可する場合，空要素タグ<maximize />を記述します。なお，値を指定する必要はありません。
</allows> 0または1回 − 終了タグ。
<device media="デバイス種別"> 0または
3回まで		 0または1回 デバイス種別単位の情報についての定義。
属性mediaでデバイス種別を指定できます。デバイス種別を指定するには，デバイス種別に次のどれかを指定します。
  • HTML：PC向けコンテンツ
  • CHTML：ｉモード向けコンテンツ
  • HDML：EZweb向けコンテンツ
属性mediaに「HTML」を指定した場合の開始タグ例を次に示します。
　　<device media="HTML">
属性mediaの指定は省略できません。<device>を記述する場合は必ず指定してください。
　 <url> 1回 − <device>のmedia属性で指定したデバイス種別に対応するコンテンツのエントリポイント。
エントリポイントには，ポートレットディレクトリからの絶対パスを指定します。
<supports> 0または1回 − <personalize />の親タグ。
　 <personalize /> 0または1回 − 編集画面の存在についての定義。
<device>のmedia属性で指定したデバイス種別に対応するポートレットが，編集画面（EDITモード）を所有する場合，空要素タグ<personalize />を記述します。なお，値を指定する必要はありません。
</supports> 0または1回 − 終了タグ。
</device> 0または
3回まで		 − 終了タグ。
</portlet> 1回 − 終了タグ。
</portlet-app> 1回 − 終了タグ。

（凡例）
−：該当しません。

注※1　タイトルに日本語を使用する場合は，xml宣言文のencoding属性に文字コードを指定する必要があります。

注※2　各タグで指定したタイトルが，最大化画面，および新規ウィンドウ画面で表示される場所を「(a) 最大化画面，および新規ウィンドウ画面で表示されるタイトル」に示します。

注※3　属性langで言語種別を指定するには，言語種別に次の形式で指定します。

　言語コード［-国コード［-バリアント］］
日本語で表示するポートレットのタイトル（<title>タグ）を指定する場合は，次のように設定します。
　　<title lang="ja">
　
また，中国語（香港）で表示するポートレットのタイトル（<title>タグ）を指定する場合は，次のように設定します。
　　<title lang="zh-HK">
　

属性langの指定を省略した場合のデフォルト値は，「ja」です。言語の優先順位については，「(b) 言語の優先順位」を参照してください。

注※4　パラメタは，<param-name>および<param-value>を対にして，必要な数だけ<config-param>〜</config-param>間に設定できます。パラメタを設定すると，次の形式で定義されます。

　　（<param-name>の設定内容）=（<param-value>の設定内容）

パラメタ（<param-name>および<param-value>）の記述方法については，「(1) サンプルのデプロイ定義ファイル」を参照してください。

設定できるパラメタを「(c) 設定できるパラメタ」に示します。

ポートレットイベントにポートレットを対応させたい場合は，「8.3.3　ポートレットのデプロイ」を参照し，パラメタを設定してください。ナビゲーションメニューにポートレットを対応させたい場合は，「10.1.2　デプロイ定義ファイルの設定」を参照し，パラメタを設定してください。

注※5　Cosminexus Portal Framework　06-10から，iframeモードやアクションモジュール内の処理に対しても無応答監視が適用になりました。


(a)　最大化画面，および新規ウィンドウ画面で表示されるタイトル

各タグで指定したタイトルが，最大化画面，および新規ウィンドウ画面で表示される場所を次に示します。ここでは，「(1) サンプルのデプロイ定義ファイル」のデプロイ定義ファイルで設定したタイトル（<title>で指定したタイトルおよび<windowtitle>で指定したタイトルはどちらも「Sample forum」）を表示しています。

図3-14　<title>で指定したタイトルが表示される場所（最大化画面の場合）

[図データ]

図3-15　<title>および<windowtitle>で指定したタイトルが表示される場所（新規ウィンドウ画面の場合）

[図データ]

(b)　言語の優先順位

uCosminexus Portal Frameworkは，クライアントからアクセスされた際，クライアントが要求する言語種別と属性"lang"の指定値を比較し，クライアントに応答する最適な言語を決定します。次の条件を上から順に評価し，条件を満たす定義が存在したらその定義内容（タイトルや説明文）を応答します。

なお，言語コード・国コード・バリアントがすべて一致しない場合，ポータル画面上では「No Title Set」が，ポータルの利用者用レイアウトカスタマイズ画面の［ポートレット選択画面］，および運用管理ポートレットでは，ポートレット名称（<portlet-name>タグ）が表示されます。

(c)　設定できるパラメタ

デプロイ定義ファイルでは，ポートレットの起動時のパラメタを設定できます。パラメタは，<param-name>および<param-value>を対にして，必要な数だけ<config-param>〜</config-param>間に設定します。uCosminexus Portal Frameworkが提供する機能で設定できるパラメタの一覧を次の表に示します。

表3-12　設定できるパラメタの一覧

<param-name>に設定するパラメタ名※1 <param-value>に設定するパラメタ値※1 設定内容
Cache-Enable Cache-Enable キャッシュについて設定します。
  • true：キャッシュを使用します（デフォルト値）。
  • false：キャッシュを使用しません。
hptl.help.url hptl.help.url ポートレットアクションのヘルプのURLを指定します。
hptl.help.url.ja hptl.help.url.ja ポートレットアクションの日本語ヘルプのURLを指定します。
hptl.help.url.en hptl.help.url.en ポートレットアクションの英語ヘルプのURLを指定します。
hptl.help.url.言語コード［-国コード［-バリアント］］ hptl.help.url.言語コード［-国コード［-バリアント］］ ポートレットアクションの日本語と英語以外のヘルプのURLを指定します。国コードとバリアントは省略可能です。
hptl.EditMode hptl.EditMode 編集モードを設定します。
  • true：編集モードを設定します。
  • false：編集モードを設定しません（デフォルト値）。
なお，空要素タグ<personalize />を指定するとtrueが設定されます。
hptl.MinimizeMode hptl.MinimizeMode ポートレットがタイトル表示の場合，ポートレットの最小化ボタンを表示し，最小化できるようにするか指定します。
  • true：ポートレットの最小化をサポートします。
  • false：ポートレットの最小化をサポートしません（デフォルト値）。※2
なお，空要素タグ<minimize />を指定するとtrueが設定されます。
hptl.CloseMode hptl.CloseMode ポートレットがタイトル表示の場合，かつ強制表示ポートレットでない場合，ポートレットの閉じるボタンを表示し，閉じることができるようにするか指定します。
  • true：ポートレットのクローズをサポートします。
  • false：ポートレットのクローズをサポートしません（デフォルト値）。※2
なお，空要素タグ<close />を指定するとtrueが設定されます。
hptl.MaximizeMode hptl.MaximizeMode ポートレットがタイトル表示の場合，ポートレットの最大化ボタンを表示し，最大化できるようにするか指定します。
  • true：ポートレットの最大化をサポートします（デフォルト値）。
  • false：ポートレットの最大化をサポートしません。※2
なお，空要素タグ<maximize />を指定するとtrueが設定されます。
hptl.NewWindowMode hptl.NewWindowMode ポートレットがタイトル表示の場合，ポートレットの別画面表示ボタンを表示し，新規ウィンドウにポートレットを表示できるようにするか指定します。
  • true：ポートレットの新規ウィンドウ表示をサポートします。
  • false：ポートレットの新規ウィンドウ表示をサポートしません（デフォルト値）。
hptl.Size hptl.Size ポートレットの大きさを指定します。レイアウトパターンの設定をしている場合に指定できます。指定できる項目を次に示します。なお，次の項目以外を指定した場合，そのポートレットは表示されません。
  • large：大きいサイズ
  • medium：中サイズ
  • small：小さいサイズ
  • 指定無し：レイアウトパターンの設定で指定したサイズ（デフォルト値）
hptl.MultiJSP.tags.watch timeout 無応答監視時間を指定します。指定する値の単位は秒です。指定できる値の範囲は，0〜86,400（整数）です。0を指定した場合，無応答監視は行いません。
なお，<timeout>タグでも無応答監視時間の指定ができます。
hptl.portlet.nonresponse.timeout.trytimes hptl.portlet.nonresponse.timeout.trytimes 無応答監視がタイムアウトになったときに，uCosminexus Portal Frameworkが日立APIポートレットにinterruptを通知する回数を指定します。指定できる値の範囲は，1〜10（整数）です。interruptを通知する回数の指定がない場合（記述がない場合），1回だけinterruptを通知します。
hptl.module.action hptl.module.action ポートレットのイベント処理を記述するためのアクションモジュールのパッケージ名称を含めたクラスのフルパス名称を指定します。
hptl.navigationbar.support hptl.navigationbar.support ナビゲーションメニューに対応するかどうかを指定します。
  • true：ナビゲーションメニューに対応します。
  • false：ナビゲーションメニューに対応しません（デフォルト値）。
hptl.navigationbar.version hptl.navigationbar.version 対応しているナビゲーションメニューのAPIのバージョンを指定します。「01-00」を指定してください（デフォルト値は01-00）。
hptl.navigationbar.alltabflag hptl.navigationbar.alltabflag 連携ポートレットをデフォルトメニューに設定するかどうかを指定します。
  • true：ユーザにメニュー情報がない場合，デフォルトメニューとしてメニュー登録されます。
  • false：ユーザにメニュー情報がない場合，デフォルトメニューとしてメニュー登録されません（デフォルト値）。
hptl.portlet.defaulticon hptl.portlet.defaulticon ポートレットのデフォルトアイコンのURLを指定します。ポートレットのエントリのディレクトリからの相対パスで指定します。アイコンの画像サイズは16×16ピクセルとします。
hptl.portlet.directreq.support hptl.portlet.directreq.support uCosminexus Portal Frameworkにログインしていない状態から，ポートレットのダイレクト呼び出し（WebブラウザでポートレットのURLを直接指定して表示させる機能）ができるかどうかを指定します。
  • true：ダイレクト呼び出しができます。ログイン後に指定したポートレットが表示されます。
  • false：ダイレクト呼び出しできません。ログイン後にホーム画面が表示されます（デフォルト値）。
hptl.portlets.layout.hide hptl.portlets.layout.hide 利用者用レイアウトカスタマイズ画面の［ポートレット選択画面］のポートレット一覧から選択できないポートレットに設定するかどうか（レイアウトできないポートレットにするかどうか）を指定します。
  • true：レイアウトできないポートレットに設定します。
  • false：レイアウトできるポートレットに設定します（デフォルト値）。
hptl.portlets.layout.not.modified hptl.portlets.layout.not.modified 拡張レイアウト形式の変更不可エリアでだけ選択できるポートレットに設定するかどうかを指定します。運用管理者または部門管理者が変更不可エリアでポートレットを追加・変更するときにだけ管理者用レイアウトカスタマイズ画面の［ポートレット選択画面］のポートレット一覧に表示されます。
  • true：変更不可エリアにだけ追加・変更できるポートレットに設定します。
  • false：すべてのエリア，およびすべてのレイアウト形式でポートレットの追加・変更ができるポートレットに設定します（デフォルト値）。
hptl.portlet.parameters hptl.portlet.parameters 他のポートレットに設定情報などのパラメタを引き渡すためのインタフェースを提供するかどうかを定義します。インタフェースを提供する場合は，このインタフェースの実装クラスのFQCN（パッケージ名を含むクラス名）を指定します。

（凡例）
−：該当しません。

注※1　パラメタ名およびパラメタ値に「'」，「"」，「|」を含む文字列は入力できません。また，パラメタ名およびパラメタ値は，大文字小文字を区別します。

注※2　ポートレットのタイトルに各ボタンを表示させるには，Portal Managerの各ポートレットの設定で指定する必要があります。


(3)　デプロイ定義ファイル作成時の注意事項

[目次][前へ][次へ]

[他社商品名称に関する表示]

All Rights Reserved. Copyright (C) 2009, 2013, Hitachi, Ltd.
All Rights Reserved. Copyright (C) 2009, 2013, Hitachi INS Software, Ltd.