Portal Administration Console のカスタマイズ

     前  次    目次     
ここから内容

Portal Administration Console の拡張

Administration Console の拡張は、既存の Administration Console に統合する Web アプリケーションです。コンソール内のページにポートレットを追加する、複数のブックとページを含むエディタ モジュールの全体を追加などの簡単な作業には、拡張を利用できます。

拡張を作成するには、EAR 内で Administration Console Web アプリケーションを再度作成して、関連するライブラリをインポートします。これによって Web アプリケーションに機能を追加または削除することができます。

追加した拡張をすべて含むカスタム Administration Console を作成したら、この新しいカスタム Administration Console を J2EE ライブラリとしてパッケージ化します。このライブラリを既存の Web アプリケーションに追加して、これまでポータルに関連付けられていた Administration Console と置き換えます。

この節では、次のトピックについて説明します。

 


Administration Console の拡張とは

既存の Administration Console 内のブックやページにブック、ページ、ポートレットを追加して Administration Console を拡張できます。たとえば、Administration Console にログイン ポートレットを追加することができます。これにより、ユーザは Network Operations Center (NOC) などの別の管理アプリケーションにログインできるようになります。

Portal Administration Console を拡張する場合、最初に拡張に必要なアプリケーション ファイル (新しいブック、ページ、JSP、およびポートレットなど) を構築する必要があります。次に Portal Administration Console がリソースを探し、通信できるように拡張をコンフィグレーションします。

最も簡単な拡張は Administration Console のホーム ページ (デスクトップ) にコンテンツを追加することです。このような拡張用の JAR ファイルには、以下が含まれます。

 


開発環境の設定

開発環境の設定では、EAR に 2 つの追加 web プロジェクトを作成する必要があります。1 つのプロジェクトは、Administration Console をそのライブラリ全体と共に再度作成するために使用されます。このプロジェクトは新しい拡張された Administration Console になります。拡張を作成するには、追加 web プロジェクトを使用します。

Administration Console Web プロジェクトの作成

カスタム Administration Console web プロジェクトの作成。

  1. EAR プロジェクトを右クリックし、[新規|ポータル Web プロジェクト] を選択して Web プロジェクトを作成します。
  2. [新しいポータル Web プロジェクト] ダイアログで、ポータル Web アプリケーションが関連付けられているのと同じ EAR に Web プロジェクトを関連付けられます。
  3. [Project Facets] ダイアログで、Portal 訪問者ツールのファセットを選択解除します。
  4. [終了] をクリックします。

拡張プロジェクトへの Administration Console J2EE ライブラリの追加

Administration Console には以下の J2EE モジュールが必要です。コンソールの 1 ページのみをカスタマイズする場合でも、これらのモジュールをすべて Web プロジェクトにインポートします。デプロイメントの一貫性を保つため、Administration Console 全体を再度作成します。

注意 : WebLogic Portal をアップグレードする場合は、Web プロジェクトにインポートされていない J2EE ライブラリを上書きできます。ほとんどの場合、こうすることが望ましいためです。ただしライブラリをアップグレードすると、Administration Console をカスタマイズおよび拡張した部分が削除されます。

Web プロジェクトに J2EE モジュールをコピーするには、以下の手順に従います。

  1. Project Explorer で、[//web_project_name/WebLogic Deployment Descriptor|J2EE Libraries] フォルダを右クリックして [Add Multiple] を選択します。
  2. [WebLogic J2EE ライブラリの選択] で、必要なモジュールを選択します。図 3-1 に必要なライブラリを示します。
  3. 表 3-1 必要な Administration Console J2EE ライブラリ
    必要な Administration Console J2EE ライブラリ
    wlp-tools-common-web-lib
    wlp-tools-content-web-lib
    wlp-tools-framework-web-lib
    wlp-tools-im-web-lib
    wlp-tools-portal-web-lib
    wlp-tools-serviceadmin-web-lib
    wlp-tools-ugm-web-lib

  4. [OK] をクリックします。

拡張 Web プロジェクトの作成

拡張を組み込む場所に web プロジェクトを作成します。拡張には、ブック、ページ、ポートレット、またはポータル全体を含めることができます。

拡張 Web プロジェクトを作成するには、以下の手順に従います。

  1. EAR プロジェクトを右クリックし、[新規|ポータル Web プロジェクト] を選択して Web プロジェクトを作成します。
  2. [新しいポータル Web プロジェクト] ダイアログで、ポータル Web アプリケーションが関連付けられているのと同じ EAR に Web プロジェクトを関連付けられます。
  3. [Project Facets] ダイアログで、Portal 訪問者ツールのファセットを選択解除します。
  4. [終了] をクリックします。
  5. 拡張に含めるブック、ページおよびその他のリソースを作成します。ポータル リソースの構築方法の詳細については、『ポータル開発ガイド』を参照してください。

 


拡張モジュールの構築

拡張に使うリソースの作成が完了したら、作成した Administration Console に拡張を統合するために必要なコンフィグレーション ファイルを作成する準備が整いました。プロジェクトに含める 2 つのコンフィグレーション ファイルを作成し、プロジェクトをパッケージ化して Administration Console Web プロジェクトに追加する必要があります。

拡張用のコンフィグレーション ファイルの作成

拡張を作成する場合は、新しい Web アプリケーション を作成します。この Web アプリケーションは、拡張アプリケーション自体に含まれるnetuix-extension.xm ファイルを通じて Administration Console で使用できます。拡張に Administration Console のメイン メニューからアクセスするには、editors.xml ファイルも作成する必要があります。

拡張の格納場所の決定

Administration Console はコンソール でサポートされる機能を持つ複数のライブラリ モジュールを使用して構築されています。Administration Console のメイン ポータルは wlp-tools-common-web-lib にあります。この主な portal.portal ファイルは、後続の各ライブラリ モジュールで拡張されます。ポータルを拡張するには、各ライブラリでそのリソースを参照するnetuix-extension.xml を使用して portal.portal を拡張する場所を指定します。

Administration Console は、ブックやページ レベルで拡張できます。拡張するブックを決定するには、各ライブラリ モジュールの netuix-extension.xml ファイルを使用して、Administration Console がどのように構成されているかを理解します。

拡張する Administration Console のブックとページを決定した後で、拡張を Administration Console のどこに表示されるかを指定するには、拡張モジュールの netuix-extension.xml にある各モジュールのブックとページの定義ラベルを参照します。

これらの定義ラベルを表示するには、拡張ポイントに関連付けられたブックを含む各 *.war ファイルを開きます。既存の Administration Console ファイルやモジュールは変更しないように注意してください。代わりに、既存のファイルを指す拡張を作成します。表 3-2 に、一般的に使用される拡張ポイントの定義ラベルを含むブックを示します。

表 3-2 Administration Console の一般的な拡張
ブック
拡張ポイント
netuix-extension.xml の場所
/im/interactionToolsMainBook.book
対話管理のメイン ブック
拡張する後続のブックの定義ラベルについては、このブックの XML ファイルを参照。
//WebLogic_Home/portal/lib/modules/wlp-im-web-lib.war
/ugm/TopLevelEditor.book
ユーザおよびグループ管理のメイン ブック
拡張する後続のブックの定義ラベルについては、このブックの XML ファイルを参照。
//WebLogic_Home/portal/lib/modules/wlp-ugm-web-lib.war
/portalTools/portalTopLevelEditorBook.book
ポータル管理のメイン ブック。
拡張する後続のブックの定義ラベルについては、このブックの XML ファイルを参照。
//WebLogic_Home/portal/lib/modules/wlp-pm-web-lib.war
/serverTools/serverToolsTopLevelEditorBook.book
サービス管理のメイン ブック。
拡張する後続のブックの定義ラベルについては、このブックの XML ファイルを参照。
//WebLogic_Home/portal/lib/modules/wlp-serviceadmin-web-lib.war
/content/contentTopLevelEditorBook_twoPageTree.book
ライブラリ サービスを使用するコンテンツ管理のメイン ブック。
拡張する後続のブックの定義ラベルについては、このブックの XML ファイルを参照。
//WebLogic_Home/portal/lib/modules/wlp-cm-web-lib.war
/content/contentTopLevelEditorBook_onePageTree.book
ライブラリ サービスを使用していない場合のコンテンツ管理のメイン ブック。
拡張する後続のブックの定義ラベルについては、このブックの XML ファイルを参照。
//WebLogic_Home/portal/lib/modules/wlp-cm-web-lib.war

netuix-extension.xml ファイルの作成

拡張アプリケーションに新しい netuix-extension.xml ファイルを作成して追加する最も簡単な方法は、ライブラリ モジュールにある *.war ファイルから既存のファイルを 1 つコピーすることです。netuix-extension.xml ファイルはプロジェクトの //WEB-INF/ ディレクトリ内に配置する必要があります。

これらの手順を開始する前に、新しいファイルで使用するテキストを既存の netuix-extension.xml からコピーします。コード リスト 3-1 に、ファイルの例を示します。

コード リスト 3-1 Administration Console のメイン ブックを拡張する netuix-extension ファイルの例
<?xml version="1.0" encoding="UTF-8" ?> 
<weblogic-portal-extension xmlns="http://www.bea.com/servers/portal/weblogic-portal/8.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.bea.com/servers/portal/weblogic-portal/8.0 netuix-extension-1_0_0.xsd">
< !-- The provider-info element allows you to enter a description for your extension -->
</provider-info>
	<title>BEA WebLogic Portal Administration Console - Content Management Extension</title> 
	<description>Content Management books that are inserted into theBEA WebLogic Portal Administration Console</description> 
	<author>BEA Systems, Inc.</author> 
</provider-info>
<! -- The portal-file element defines which portal file you are extending.To extend the Administration Console, the value of this element should be portal.portal -->
<portal-file>/portal.portal</portal-file>
<! -- Use the book-extension element and its children to define which book in the Adminstration Console you are extending.The <book-content content-uri> element is wehre you put that path to your extension.In the following example, content is the name of the web extension application that contains the contentTopLevelEditorBook-twoPageTree.book -->
<book-extension>
	<book-location>
  		<parent-label-location label="mainToolsBook" /> 
  		<book-insertion-point page-label="homeBook" action="append" /> 
	</book-location>
	<book-content content-uri="/content/contentTopLevelEditorBook_twoPageTree.book" /> 
</book-extension>
< ! -- This example file includes two extensions.Both of which extend the home book of the mainToolsBook of the Administration Console -->
<book-extension>
	<book-location>
  		<parent-label-location label="mainToolsBook" /> 
  		<book-insertion-point page-label="homeBook" action="append" /> 
  	</book-location>
  	<book-content content-uri="/content/contentTopLevelEditorBook_onePageTree.book" /> 
</book-extension>
</weblogic-portal-extension>

Web プロジェクトに netuix-extension.xml ファイルを作成するには、以下の手順に従います。

  1. 拡張 web プロジェクト内の [//WEB-INF] フォルダを右クリックし、[新規|その他] を選択します。
  2. [ウィザードを選択] ダイアログで、[XML|XML] を選択し、[次へ] をクリックします。
  3. [Create an XML File] ダイアログで、[Create XML File from Scratch] をマークし、[次へ] をクリックします。
  4. [XML ファイル名] ダイアログで、ファイル名に netuix-extension を入力し、[終了] をクリックします。
  5. パッケージ・エクスプローラーで、netxuix-extension.xml ファイルを右クリックして、[アプリケーションから開く|テキスト エディタ] を選択します。
  6. 有効な netuix-extension.xml ファイルからコピーしたテキストを貼り付けます。
  7. 作成された拡張モジュールと一致するようにテキストを変更してファイルを格納します。

editors.xml ファイルの作成

Administration Console のヘッダ メニューに拡張を追加するには (コードリスト 3-1 に表示)、拡張 Web プロジェクトに editors.xml ファイルを追加する必要があります。

図 3-1 Administration Console のヘッダ メニュー

Administration Console のヘッダ メニュー

editors.xml ファイルを使用すると、既存の メニュー エントリの拡張、または新しいメニュー エントリの追加ができます。

拡張アプリケーションに新しい editors.xml ファイルを作成して追加する最も簡単な方法は、ライブラリ モジュールにある *.war ファイルから既存のファイルを 1 つコピーすることです。editors.xml ファイルはプロジェクトの //WEB-INF/ ディレクトリ内に配置する必要があります。

注意 : WebLogic Portal 10.0 では、既存のメニューにエディタを追加する場合、システムへのパスにプロパティ ファイルを追加する必要があります。詳細については、「WebLogic Portal リリース ノート」を参照してください。

これらの手順を開始する前に、新しいファイルで使用するテキストを既存の editors.xml からコピーします。コード リスト 3-1 に、ファイルの例を示します。

editors.xml ファイルを作成するには、以下の手順に従います。

  1. 拡張 web プロジェクト内の [//WEB-INF] フォルダを右クリックし、[新規|その他] を選択します。
  2. [ウィザードを選択] ダイアログで、[XML|XML] を選択し、[次へ] をクリックします。
  3. [Create an XML File] ダイアログで、[Create XML File from Scratch] をマークし、[次へ] をクリックします。
  4. [XML ファイル名] ダイアログで、ファイル名に editors を入力し、[終了] をクリックします。
  5. パッケージ・エクスプローラーで、editors.xml ファイルを右クリックして、[アプリケーションから開く|テキスト エディタ] を選択します。
  6. 有効な editors.xml ファイルからコピーしたテキストを貼り付けます。
  7. 作成された拡張モジュールと一致するようにテキストを変更してファイルを格納します。コード リスト 3-2 に、有効な editors.xml ファイルの例を示します。
  8. コード リスト 3-2 editors.xml ファイルの例
    <?xml version="1.0" encoding="UTF-8"?>
    <!-- @name: the name of the top-level menu item.This is used as the key for getting the title from the properties file specified in the bundleName attribute.
    <!-- @defLabel: the definition label of the default book to show for this editor group.This is not currently used by the menu. --> 
    <!-- @defaultEditor: the name attribute of the default editor for this group -->
    <!-- @bundleName: the name of the applications scoped (EAR) properties file from which to retrieve the title for @name -->
    <edtrs:editor-group
        xmlns:edtrs="http://com.bea.portal/tools/admin/xsd/editors-1_0_0"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://com.bea.portal/tools/admin/xsd/editors-1_0_0 editors-1_0_0.xsd"
        name="myPAT" 
        defLabel="NOT_USED" 
        defaultEditor="myPATeditor" 
        bundleName="myPATeditor.i18n.myPATeditor" > 
    <!-- @name: the name of this editor which is used as a second level menu item.This is used as the key for getting the title from the properties file specified in the bundleName attribute. -->
    <!-- @landingDefLabel: the definition label of the landing page for this editor; IT MUST END WITH _landingPage -->
    <!-- @headerIcon: the icon to show for this editor -->
    <!-- @bundleName: the name of the applications scoped (EAR) properties file from which to retrieve the title for @name -->
    	<edtrs:editor name="myPATeditor" 
    		landingDefLabel="myPATeditor_landingPage" 
    		headerIcon="wlp-content-mgmt-24.gif" 
    		bundleName="myPATeditor.i18n.myPATeditor" > 
    <!--  tree builders are only used in the Administration Console editors.However, this entry is required.-->
    		<edtrs:tree-builder>
    			<edtrs:mode>NOT_USED</edtrs:mode>
    		</edtrs:tree-builder>        	
    	</edtrs:editor>
    </edtrs:editor-group>

Administration Console への拡張の追加

拡張リソースを構築し、必要なコンフィグレーション ファイル (netuix-extension.xml ファイルとオプションの editors.xml ファイル)の追加が完了したら、Administration Console のカスタム アプリケーションに拡張をエクスポートする必要があります。

注意 : 作成した Administration Console のカスタム プロジェクトに拡張を追加します。「Administration Console Web プロジェクトの作成」を参照してください。

Administration Console アプリケーションに拡張を追加するには、以下の手順に従います。

  1. Administration Console Web プロジェクトで、[WEB-INF] ディレクトリに [bea-ext] というフォルダを追加します。このディレクトリに拡張プロジェクトをエクスポートします。
  2. 拡張 Web プロジェクトで、拡張 Web プロジェクトのルート ディレクトリを右クリックして [エクスポート|WAR] を選択します。
  3. [Export WAR] ダイアログで [参照] をクリックして、Administration Console Web プロジェクトの \\WEB-INF\bea-ext ディレクトリに移動します。次に例を示します。c:\bea\user_projects\w4WP_workspaces\myWorkspace\adminConsoleWebProject\webContent\web-inf\bea-ext\
  4. [終了] をクリックします。
  5. Project Explorer を使用すると、カスタム Administration Console にエクスポートされた WAR ファイルに移動します。ディレクトリの コンテンツを更新するには、〔F5〕 を押します。
  6. *.war file (たとえば、myExtension.war) を右クリックし、[コピー] を選択します。
  7. [//WEB-INF/bea-ext] ディレクトリを右クリックして [貼り付け] を選択します。
  8. [Naming Conflict] ダイアログで WAR ファイルに同じ名前を付け、*.jar というファイル拡張子を追加します。 myExtension.jar がその例です。
  9. *.war ファイルを削除します。

 


拡張された Administration Console の使用

WebLogic Portal Administration Console にアクセスするのと同様、Administration Console にも URL からアクセスします。次に例を示します。http://localhost:7001/myCustomConsoleWebProject/portal.portal


ページの先頭       前  次