uCosminexus Portal Frameworkで使用するポートレットの情報を設定するファイルです。ポートレットの登録の設定と,Webポートレットの設定,およびMulti Web Portletのフォーム認証が設定できます。また,運用管理ポートレットの登録ができます。
(1) ポートレットの登録の設定
ポートレット定義ファイルに,ポートレットを登録するために必要な設定項目を定義します。Portal Managerを使用してポートレットを登録した際の設定内容が書き込まれるため,ポートレット定義ファイルを直接編集して定義する必要はありません。Portal Managerを使用したポートレットの登録方法については,「7. ポートレットの登録」を参照してください。
ポートレットの登録に関する設定の,ポートレット定義ファイルでの記述形式を次に示します。
<?xml version="1.0" encoding="UTF-8" ?>
<!-- ========================================================= -->
<!-- BEGIN Portlet Entries -->
<!-- ========================================================= -->
<portlet-entry type="ref" parent="adaptor" name="name">
<url>path</url>
<meta-info>
<title lang="lang">title</title>
<description lang="lang">description</description>
<windowtitle lang="lang">windowtitle</windowtitle>
</meta-info>
<parameter name="user-defined-name" value="user-defined-value" />
<parameter name="dont_remove_head" value="dont_remove_head" />
<parameter name="dont_remove_applet" value="dont_remove_applet" />
<parameter name="dont_remove_object" value="dont_remove_object" />
<parameter name="dont_remove_script" value="dont_remove_script" />
<parameter name="dont_remove_onsomething" value="dont_remove_onsomething" />
<parameter name="Cache-Enable" value="Cache-Enable" />
<parameter name="filter_type" value="filter_type" />
<parameter name="filter_params" value="filter_params" />
<parameter name="NameSpace-Resolution" value="NameSpace-Resolution" />
<parameter name="Inline-Object-Fetching" value="Inline-Object-Fetching" />
<parameter name="hptl.short-title" value="hptl.short-title" />
<parameter name="hptl.keywords" value="hptl.keywords" />
<parameter name="hptl.help.url" value="hptl.help.url" />
<parameter name="hptl.EditMode" value="hptl.EditMode" />
<parameter name="hptl.MinimizeMode" value="hptl.MinimizeMode" />
<parameter name="hptl.CloseMode" value="hptl.CloseMode" />
<parameter name="hptl.MaximizeMode" value="hptl.MaximizeMode" />
<parameter name="hptl.NewWindowMode" value="hptl.NewWindowMode" />
<parameter name="hptl.Size" value="hptl.Size" />
<parameter name="hptl.MultiJSP.tags.watch" value="timeout" />
<parameter name="hptl.portlet.nonresponse.timeout.trytimes" value="hptl.portlet.nonresponse.timeout.trytimes" />
<parameter name="hptl.MultiJSP.tags.iframe0100compat" value="hptl.MultiJSP.tags.iframe" />
<parameter name="hptl.module.action" value="hptl.module.action" />
<parameter name="hptl.navigationbar.support" value="hptl.navigationbar.support" />
<parameter name="hptl.navigationbar.version" value="hptl.navigationbar.version" />
<parameter name="hptl.navigationbar.alltabflag" value="hptl.navigationbar.alltabflag" />
<parameter name="hptl.portlet.defaulticon" value="hptl.portlet.defaulticon" />
<parameter name="hptl.portlets.layout.hide" value="hptl.portlets.layout.hide" />
<parameter name="hptl.portlets.layout.not.modified" value="hptl.portlets.layout.not.modified" />
</portlet-entry>
<!-- =========================================================== -->
<!-- END Portlet Entries -->
<!-- =========================================================== -->
設定項目と内容を次の表に示します。
表10-7 ポートレット登録の設定内容
設定項目 | デフォルト値 | 設定内容 |
---|---|---|
adaptor | - | ポートレットの種類を指定します。必須です。
|
name | - | ポートレット名を指定します。ポートレットの種類(adaptor)は使用できません。ほかのポートレットと異なるポートレット名を半角英数字で指定します。必須です。 |
path | - | 必須です。
|
title | No Title Set | ポータル画面でタイトルバーに表示するタイトルを指定します。日本語も使用できます。日本語を使用するには,xml宣言文のencoding属性に文字コードを指定する必要があります。 なお,lang属性で言語種別を指定する場合は,次の形式で指定します。 {言語コード}[-{国コード}[-{バリアント}]] 国コードおよびバリアントは省略できます。 |
description | No description found. Generic Portlet. | ポートレットの説明文です。日本語も使用できます。 日本語を使用するには,xml宣言文のencoding属性に文字コードを指定する必要があります。 なお,lang属性で言語種別を指定する場合は,次の形式で指定します。 {言語コード}[-{国コード}[-{バリアント}]] 国コードおよびバリアントは省略できます。 |
windowtitle | ポートレット名 | 新規ウィンドウを表示するときの,ウィンドウのタイトルを指定します。 なお,lang属性で言語種別を指定する場合は,次の形式で指定します。 {言語コード}[-{国コード}[-{バリアント}]] 国コードおよびバリアントは省略できます。 |
user-defined-value | - | 日立APIポートレットで使用します。ユーザ定義のパラメタについてのパラメタ値です。 |
dont_remove_head | no | head要素の削除を指定します。Webポートレットで使用します。
|
dont_remove_applet | no | applet要素の削除を指定します。Webポートレットで使用します。
|
dont_remove_object | no | object要素の削除を指定します。Webポートレットで使用します。
|
dont_remove_script | no | script要素の削除を指定します。Webポートレットで使用します。
|
dont_remove_ onsomething | no | "on"で始まるイベント属性の削除を指定します。Webポートレット,WebPageポートレットで使用します。
|
Cache-Enable | true | キャッシュについて設定します。
|
filter_type | - | コンテンツのフィルタリング方式およびディレクティブ形式を次の形式で指定します。Webポートレットで使用します。Web Page Portletでは削除とコメントでのフィルタリングだけ使用できます。 <parameter name="filter_type" value="delete, comment"/> 次のフィルタリング方式のどちらかを指定します。
|
filter_params | - | コンテンツフィルタリングのディレクティブを指定します。Webポートレットで使用します。Web Page Portletではコメントだけ使用できます。
|
NameSpace-Resolution | true | ネームスペース自動解決を設定します。Web App Portletおよび分散ポートレットで使用します。
|
Inline-Object-Fetching | direct | インラインオブジェクトの取得方法を設定します。Web App Portletで使用します。
|
hptl.short-title | - | ポートレットタイトルの略称を指定します。 |
hptl.keywords | - | ポートレットを検索する際のキーワードを指定します。 |
hptl.help.url | - | ポートレットアクションのヘルプのURLを指定します。 |
hptl.help.url.ja | - | ポートレットアクションの日本語ヘルプのURLを指定します。 |
hptl.help.url.en | - | ポートレットアクションの英語ヘルプのURLを指定します。 |
hptl.help.url.{言語コード}[-{国コード}[-{バリアント}]] | - | ポートレットアクションの日本語および英語以外の言語に対応するヘルプのURLを指定します。なお,国コードとバリアントは省略できます。 |
hptl.EditMode | false | 編集モードを設定します。
|
hptl.MinimizeMode | false | ポートレットがタイトル表示の場合,ポートレットの最小化ボタンを表示し,最小化できるようにするか指定します。
|
hptl.CloseMode | false | ポートレットがタイトル表示の場合,かつ強制表示ポートレットでない場合,ポートレットの閉じるボタンを表示し,閉じることができるようにするか指定します。
|
hptl.MaximizeMode | true | ポートレットがタイトル表示の場合,ポートレットの最大化ボタンを表示し,最大化できるようにするか指定します。
|
hptl.NewWindowMode | false | ポートレットがタイトル表示の場合,ポートレットの別画面表示ボタンを表示し,新規ウィンドウに表示できるようにするか指定します。
|
hptl.Size | - | ポートレットの大きさを指定します。レイアウトパターンの設定をしている場合に指定できます。指定できる項目を次に示します。なお,次の項目以外を指定した場合,そのポートレットは表示されません。
|
timeout | - | 無応答監視時間を指定します。指定する値の単位は秒です。指定できる値の範囲は,0~86,400(整数)です。0を指定した場合,無応答監視は行いません。 |
hptl.portlet.nonresponse.timeout.trytimes | - | 無応答監視がタイムアウトになったときに,uCosminexus Portal Frameworkが日立APIポートレットにinterruptを通知する回数を指定します。指定できる値の範囲は,1~10(整数)です。interruptを通知する回数の指定がない場合(デフォルト),1回だけinterruptを通知します。 |
hptl.MultiJSP.tags.iframe | false | <iframe>タグ内のコンテンツの取得先を設定します。
|
hptl.module.action | - | ポートレットのイベント処理を記述するためのアクションモジュールのパッケージ名称を含めたクラスのフルパス名称を指定します。 |
hptl.navigationbar.support | false | ナビゲーションメニューに対応するかどうかを指定します。
|
hptl.navigationbar.version | 01-00 | 対応しているナビゲーションメニューのAPIのバージョンを指定します。「01-00」を指定してください。 |
hptl.navigationbar.alltabflag | false | 連携ポートレットをデフォルトメニューに設定するかどうかを指定します。
|
hptl.portlet.defaulticon | -(デフォルトのアイコン) | ポートレットのデフォルトアイコンのURLを指定します。ポートレットのエントリのディレクトリからの相対パスで指定します。アイコンの画像サイズは16×16ピクセルとします。 ただし,メニューベースタイトルバーテンプレートを使用している場合は,Multi Web Portletだけ指定できます。 |
hptl.portlet.directreq.support | false | uCosminexus Portal Frameworkにログインしていない状態から,ポートレットのダイレクト呼び出し(WebブラウザでポートレットのURLを直接指定して表示させる機能)ができるかどうかを指定します。
|
hptl.portlets.layout.hide | false | レイアウトカスタマイズ機能の[ポートレットの選択]画面のポートレット一覧から選択できないポートレットとして設定するかどうか(レイアウトできないポートレットにするかどうか)を指定します。
|
hptl.portlets.layout.not.modified | false | 拡張レイアウト形式の変更不可エリアでだけ選択できるポートレットにするかどうか指定します。この設定を行ったポートレットは,変更不可エリアのポートレット追加・変更時にだけ[ポートレットの選択]画面に表示されます。
|
(凡例) -:該当しません。
注※1 ポートレットのタイトルに各ボタンを表示させるには,Portal Managerの各ポートレットの設定で指定する必要があります。
(2) ポートレットの設定
ポートレット定義ファイルに,ポートレットの種類ごとに前提となる項目を定義します。定義項目には,Portal Managerで定義した内容が書き込まれるものと,ポートレット定義ファイルを直接編集して定義するものがあります。Portal Managerを使用したポートレットの定義方法については,「7.8.1 共通定義(Webポートレット)」,または「7.9.1 共通定義(分散ポートレット)」を参照してください。
ポートレットの定義に関する設定の,ポートレット定義ファイルでの記述形式を次に示します。
(a) Multi Web Portlet
記述形式を次に示します。
<portlet-entry type="abstract" name="MultiWeb">
<classname>jp.co.hitachi.soft.portal.portal.portlets.MultiWebPortlet </classname>
<parameter name="MobileUrlMapSize" value="マップサイズ" />
<parameter name="CharSetUrlMapSize" value="マップサイズ" />
</portlet-entry>
パラメタの設定ができます。そのほかの項目は変更しないでください。
パラメタ名と値を次の表に示します。
表10-8 Multi Web Portletのパラメタ名と値
parameter-name | デフォルト値 | parameter-valueに設定する内容 |
---|---|---|
hptl.MultiWebPortlet.MobileUrlMapSize※ | 100 | 携帯電話で表示するWebブラウザのURLマップ個数を指定します。 |
hptl.MultiWebPortlet.CharSetUrlMapSize※ | 100 | 文字コードのURLマップ個数を指定します。 |
hptl.ProxyHost | - | プロキシサーバのホストを指定します。設定しない場合,Webサーバに直接接続します。 |
hptl.ProxyPort | 80 | プロキシサーバのポート番号を指定します。設定しない場合,Webサーバに直接接続します。 |
(凡例) -:該当しません。
注※ このパラメタは,Portal Managerでは定義できません。ポートレット定義ファイルを直接編集して定義してください。
(b) Web Page PortletおよびWeb App Portlet
記述形式を次に示します。
<portlet-entry type="abstract" name="WebPage">
<classname>jp.co.hitachi.soft.portal.portal.portlets.WebPagePortlet</classname>
<parameter name="parameter-name" value="parameter-value" />
</portlet-entry>
<portlet-entry type="abstract" name="WebApp">
<classname>jp.co.hitachi.soft.portal.portal.portlets.WebAppPortlet</classname>
<parameter name="parameter-name" value="parameter-value" />
</portlet-entry>
パラメタの設定ができます。そのほかの項目は変更しないでください。
パラメタ名と値を次の表に示します。
表10-9 Web Page Portletのパラメタ名と値
parameter-name | デフォルト値 | parameter-valueに設定する内容 |
---|---|---|
proxyHost | - | プロキシサーバのホストを指定します。設定しない場合,Webサーバに直接接続します。 |
proxyPort | 80 | プロキシサーバのポート番号を指定します。設定しない場合,Webサーバに直接接続します。 |
Cache-Control | max-age=3600 | コンテンツのデフォルトの有効期間を指定します。no-cacheまたはmax-age=secを指定します。max-ageには0以上の値を指定します。単位は秒です。 |
maxRedirect | 2 | HTTPリダイレクトの最大回数を指定します。設定できる範囲は0~10です。 |
hptl.WebApp.SetUserAgent | true | WebブラウザのUser-Agent情報をWeb App Portletに設定するかを指定します。Web App Portletだけ対応しています。
|
(凡例) -:該当しません。
(c) 分散ポートレット
記述形式を次に示します。
<portlet-entry type="abstract" name="DistributedWebApp">
<classname>jp.co.hitachi.soft.portal.portal.portlets.DistributedWebAppPortlet</classname>
<parameter name="parameter-name" value="parameter-value" />
<parameter name="proxyHost" value="proxyhost" />
<parameter name="proxyPort" value="proxyport" />
</portlet-entry>
分散ポートレットのパラメタの設定ができます。そのほかの項目は変更しないでください。
パラメタ名と値を次の表に示します。
表10-10 分散ポートレットのパラメタ名と値
parameter-name | デフォルト値 | parameter-valueに設定する内容 |
---|---|---|
proxyHost | - | プロキシサーバのホストを指定します。設定しない場合,Webサーバに直接接続します。 |
proxyPort | 80 | プロキシサーバのポート番号を指定します。設定しない場合,Webサーバに直接接続します。 |
(凡例) -:該当しません。
(3) Multi Web Portletの認証の設定
ポートレット定義ファイルに,Multi.Web Portletの認証に必要な設定項目を定義します。Portal Managerを使用してポートレットを登録した際の設定内容が書き込まれるため,ポートレット定義ファイルを直接編集して定義する必要はありません。Portal Managerを使用したポートレットの登録方法については,「7. ポートレットの登録」を参照してください。
Multi.Web Portletの認証に関する設定の,ポートレット定義ファイルでの記述形式を次に示します。
<portlet-entry application="false" admin="false" parent=" MultiWeb" hidden="false" type="ref" name="MultiWebPortlet1">
<url>デバイス定義ファイルへのURL</url>
<parameter value="プロキシサーバアドレス" name="hptl.ProxyHost"/>
<parameter value="プロキシポート番号" name="hptl.ProxyPort"/>
<parameter value="YES" name="hptl.MultiWebPortlet.AppletRemove"/>
<parameter value="YES" name="hptl.MultiWebPortlet.ObjectRemove "/>
<parameter value="YES" name="hptl.MultiWebPortlet.ScriptRemove"/>
<parameter value="Portal" name="hptl.MultiWebPortlet.BinaryDataFetching "/>
<parameter value=" refURL[コンマ]targetURL[コンマ]method(POST | GET)
[コンマ]filed1[コンマ]filed2, ..."
name="hptl.MultiWebPortlet.FromBaseAuth"/>
<parameter value="TRUE" name="hptl.EditMode "/>
<parameter name="hptl.MultiWebPortlet.filter_type" value="regexp/>
<parameter name=" hptl.MultiWebPortlet.filter_params"
value=" inbetween=日本語マッチ?,します。”/>
<parameter name="hptl.MultiWebPortlet.DefScreenHeight" value="400"/>
<parameter name="hptl.MultiWebPortlet.MaxScreenHeight" value="520"/>
<parameter name="hptl. MultiWebPortlet.AliasInternalPath"
value="http://wwwportal1.hitachi.co.jp/Portal/,
http://wwwportal2.hitachi.co.jp/Portal/,
http://wwwportal3.hitachi.co.jp/Portal/">
<meta-info>
<title>マルチポートレットタイトル</title>
</meta-info>
</portlet-entry>
パラメタの設定ができます。そのほかの項目は変更しないでください。
パラメタ名と値を次の表に示します。
表10-11 Multi Web Portletのパラメタ名と値
parameter-name | デフォルト値 | parameter-valueに設定する内容 |
---|---|---|
hptl.ProxyHost | - | プロキシサーバのホストを指定します。設定しない場合,Webサーバに直接接続します。ホスト名またはPort設定と併用したIPアドレスが必要となります。 |
hptl.ProxyPort | - | プロキシサーバのポート番号を指定します。設定しない場合,Webサーバに直接接続します。使用できる値は,Int型に変換できる数字です。 |
hptl.MultiWebPortlet.AppletRemove | YES | アプレット要素を削除するか指定します。 YES:削除します。 NO:削除しません。 |
hptl.MultiWebPortlet.ObjectRemove | YES | オブジェクト要素を削除するか指定します。 YES:削除します。 NO:削除しません。 |
hptl.MultiWebPortlet.ScriptRemove | YES | スクリプト要素を削除するか指定します。 YES:削除します。 NO:削除しません。 |
hptl.MultiWebPortlet.BinaryDataFetching | Direct | バイナリデータの取得方法を選択します。PortalまたはDirectを指定します。 |
hptl.MultiWebPortlet.FromBaseAuth | なし | フォーム認証について設定します。対象URL(query文字などを除く認証画面のURL),アクションターゲットURL(POST,GET先のURL),メソッド,認証に必要なフィールドを設定します。それぞれ[コンマ]で区切り,一つのパラメタとして定義します。 設定パターンの例 http://cosmiportal.com/formbase/index.html[コンマ]http://cosmiportal.com/actiontarget/auth.html[コンマ]POST[コンマ]j_username[コンマ]j_password |
hptl.EditMode | FALSE | 編集画面の表示を設定します。TRUEまたはFALSEを指定します。 |
hptl.MultiWebPortlet.filter_type | なし | コンテンツのディレクティブ形式を次の形式で指定します。ディレクティブ形式には,”regexp”(正規表現)を指定します。 指定パターンの例 <parameter name=" hptl.MultiWebPortlet.filter_type" value="comment"/> なお,フィルタタイプを指定する場合は,フィルタパラメタの指定を行ってください。 |
hptl.MultiWebPortlet.filter_params | なし | コンテンツフィルタリングのディレクティブを指定します。指定できるディレクティブ形式は正規表現を 「<」,「>」,「"」を指定する場合,文字参照で指定します。「<」は「<」,「>」は「>」,「"」は「"」と指定します。また,「/」は「¥/」とエスケープする必要があります。また,ディレクティブを複数指定できません。 パターンからパターンまで <parameter name="hptl.MultiWebPortlet.filter_params" value="inbetween=パターン文字列1,パターン文字列2"/> 指定パターンの例 <parameter name=” hptl.MultiWebPortlet.filter_params” value=” inbetween=日本語マッチ?,します。”/> パターンからラストまで <parameter name=" hptl.MultiWebPortlet.filter_params" value=" untiltail=ターン文字列"/> 指定パターンの例 <parameter name="filter_params" value=" untiltail=<a.*"http:¥/¥/w¥d¥.ins-hitachi¥.co¥.jp.*/a>" /> |
hptl.MultiWebPortlet. DefScreenHeight | 300 | 標準表示時の縦幅を設定します。設定できる値は1~9,999です。 |
hptl.MultiWebPortlet. MaxScreenHeigh | 460 | 最大表示の縦幅を設定します。設定できる値は1~9,999です。 |
hptl.MultiWebPortlet.AutoMaxChange | FALSE | 自動最大化表示を指定します。TRUEまたはFALSEを指定します。 |
(凡例) -:該当しません。
なお,Multi Web Portletで使用するURLの要素はマッピング定義ファイルで設定します。URLの要素には,{WebAppPortlet配下}のパスまたは,URLを指定します。Multi Web Portletのマッピング定義ファイルの例を次に示します。
<?xml version="1.0" encoding="UTF-8"?>
<file-mappings xmlns="http://portal.soft.hitachi.co.jp/portal/MultiDevice">
<mapping>
<media>HTML</media>
<url>http://www.hitachi.co.jp/cgi/index.cgi</url>
</mapping>
<mapping>
<media>CHTML</media>
<url>/portlets/sample/device/cdevice.html</url>
</mapping>
<mapping>
<media>HDML</media>
<url>http://www.ins-hitachi.co.jp/hdml_contents/index.html</url>
</mapping>
</file-mappings>