IBM FileNet P8, バージョン 5.1.+            

Workplace XT のアクションのカスタマイズ

ポップアップ・メニューから、または IBM® FileNet® Workplace XT の参照モードおよび検索モードからアクセス可能なオブジェクトの場合は、特定のオブジェクト・タイプに対してエンド・ユーザーが実行できる操作またはアクション一式がアプリケーションに表示されます。例えば、ドキュメント・オブジェクトで実行可能なアクションには、チェックアウト、ダウンロード、複合オブジェクトへの変更、移動などがあります。フォルダー・オブジェクトの場合は、オブジェクトの追加、移動、削除などがあります。

管理者は、Workplace XT のユーザー・インターフェースに表示されるオブジェクトに対して実行可能なアクションをカスタマイズすることができます。 また、表面的な変更 (ユーザー・インターフェースからアクションを完全に削除するなど) を行うこともできます。 フィルター条件を使用すると、アクションが表示される条件を定義することもできます。例えば、特定のクラス記述、バージョン状況、およびコンテンツ・タイプのドキュメントをユーザーがクリックした場合のみに、ダウンロード・アクションが表示されるように定義することができます。

このトピックでは、Workplace XT インターフェース内でユーザーに対してアクションが表示される場所を示すと共に、これらのアクションの構成に使用する メニュー・アクション記述子 XML ファイルについて説明します。

注: Actions.xml ファイルを変更して Workplace アプリケーション内のアクションをカスタマイズした場合で、なおかつカスタマイズしたアクションを Workplace XT で使用したい場合は、Workplace 関連のカスタマイズ内容を Workplace XT Actions.xml ファイルに手動で追加する必要があります。

Workplace XT UI 内のアクション

アクションは、ポップアップ・メニュー、「アクション」メニュー、「ツール」メニュー、および「プロパティー」情報ページでユーザーに対して表示されます。(「プロパティー」情報ページおよび「マイ Workplace」ポップアップ・メニュー上のアクションは Actions.xml ファイルによって定義され、それ以外のアクションはすべて MenuActions.xml ファイルによって定義されます。) ポップアップ・メニューは、ユーザーがリスト・ビュー内のオブジェクトや、パス・ビュー内のアイテムを右クリックしたときに表示されます。使用可能なアクションのリストは、選択されたオブジェクトのタイプによって異なります。オブジェクトの「プロパティー」情報ページにも、同じアクションが表示されます。 ユーザーがリスト・ビューで 1 つ以上のアイテムを選択し、「アクション」ボタンをクリックすると、「アクション」メニューが開きます。複数のアイテムが選択されている場合は、選択されたすべてのアイテムに対して有効なアクションのみがメニューに表示されます。

Workplace XT では、コンテキスト・メニューを使用することで、新しいアクションを表示することもできます。 「アクション」メニューでアクションを有効にするには、カスタム JavaScript を ActionsMenu.js ファイルに追加する必要があります。

ActionsMenu.js 内の showActionsMenu 関数で、以下のコードを追加します。
if ($("ACTIONS_MENU__actionid"))
validActions.push("actionid");

ここで、「actionid」は、MenuActions.xml ファイル内で指定されたアクションの ID です。

メニュー・アクション記述子 XML ファイル

MenuActions.xml には、参照モードおよび検索モードのポップアップ・メニューと複数選択メニューに表示されるアクションの定義が含まれています。このファイルは <XT_deploy_path>¥FileNet¥Config¥WebClient フォルダーにあります。ここで、<XT_deploy_path> は、Workplace XT のデプロイ先のパスです。MenuActions.xml は、 Workplace 設定の XML スキーマ (Preferences.xsd) に従います。このファイルは、 <XT_deploy_path>¥FileNet¥WebClient¥WorkplaceXT¥WEB-INF¥xml にあります。

注:  
  • MenuActions.xml に変更を加える前に、バックアップを作成してください。
  • 外字を含めるように MenuActions.xml ファイルを変更した場合は、ファイルを UTF-8 形式で保存してください。
  • MenuActions.xml に変更を加えたら、アプリケーションがデプロイされている Web サーバーを再始動せずに済むように、そのファイルを Workplace XT から再ロードしてください。
ファイル構造
以下のリストに示すように、MenuActions.xmlmultiSelectActionstoolbarActionsfolderToobarActionstopLevelActionsactionDefinitions の 5 つのセクションで構成されます。
topLevelActions 配列と multiSelectActions 配列では、各アクションがユーザー・インターフェースに表示される順序を定義します。つまり、topLevelActions 配列では、value エレメントの順序がポップアップ・メニューと情報ページに反映されます。multiSelectActions 配列では、value エレメントの順序が複数選択メニューに反映されます。アクションをコメント化すると、そのアクションを非表示にすることができます。
multiSelectActions 配列では、アクションを複数選択に指定することのみ可能です。つまり、複数選択アクションを topLevelActions 配列にリストする必要はありません。
toolbarActions セクションと folderToolbarActions セクションでは、ドキュメントやフォルダーの参照時または検索時にツールバーの「アクション」ボタンの横に表示されるツールバー・ボタンを定義します。toolbarActions セクションはドキュメント関連のアクションを制御し、 folderToolbarActions セクションはフォルダー関連のアクションを制御します。
actionDefinitions リストは action オブジェクトで構成されます。各オブジェクトには、個々のオブジェクトに対してアクションが表示されるかどうかを定義する条件のリストが含まれます。なお、 トップレベルのアクションにはサブメニューを含めることができます。サブメニューが含まれる場合は、トップレベルのアクション定義に subActions 設定を含める必要があります。また、multiSelectActions 配列にリストされるアクションの定義に multiSelectURL 設定を含める必要もあります。すべての設定の説明については、 『MenuAction 定義の設定』を参照してください。
メニュー・アクション記述子 XML ファイル内の各セクション
<object key="actionsConfiguration" version="1.0">
...

 <array key="multiSelectActions">
 <value>download</value>
 <value>checkout</value>
 <value>cancelCheckout</value>
 <value>file</value>
 <value>delete</value>
 <value>assignSecurityPolicy</value>
 <value>sendMail</value>
 </array>

 <array key="toolbarActions">
 <value>download</value>
 <value>checkout</value>
 <value>quickCheckin</value>
 <value>cancelCheckout</value>
 <value>addToFavorites</value>
 <value>infoProperties</value>
 <value>sendMail</value>
 </array>

 <array key="folderToolbarActions">
 <value>addDocument</value>
 <value>addFolder</value>
 </array>

 <array key="topLevelActions">
 <value>view</value> <!-- for documents, publish templates -->
 <value>open</value> <!-- for folders, searches, object stores -->

 <value>download</value>
 <value>checkout</value>
 <value>quickCheckin</value>
 <value>cancelCheckout</value>
 <value>addToFavorites</value>
 <value>removeFavorite</value>
 <value>renameFavorite</value>
 <value>sendMail</value>
 <value>launch</value>
 <value>transfer</value>
 <value>addSubscription</value>
 <value>declareAsRecord</value>
 <value>declareVersionsAsRecord</value>

 <value>testFormTemplate</value>
 <value>modifyDocumentPolicy</value>
 <value>modifyWorkflowPolicy</value>
 <value>takeOffline</value>
 <value>modifyEntryTemplate</value>
 <value>modifyRecordEntryTemplate</value>

 <!-- RM changes start-->
 <value>requestchargeout</value>
 <value>viewDocumentInfo</value>
 <!-- RM changes end -->

 <value>infoProperties</value>
 <value>moreInformation</value>

 <value>documentActions</value>
 <value>folderActions</value>

 <!-- always in the end -->
 <value>addDocument</value>
 <value>addFolder</value>
 </array>

<list key="actionDefinitions">

...

 <object key="action">
 <setting key="id">download</setting>
 <setting key="title" localizationKey="server.MenuActions_xml.download">Download...</setting>
 <setting key="url">
 getContent?
 mode=download&amp;
 objectType={OBJECT_TYPE}&amp;
 id={OBJECT_ID}&amp;
 vsId={VERSION_SERIES_ID}&amp;
 objectStoreName={OBJECT_STORE_NAME}&amp;
 returnUrl={RETURN_URL}
 </setting>

 <setting key="multiSelectURL">
 operations/WcmMultiDownloadObject.jsp?
 returnUrl={RETURN_URL}
 </setting>
 <setting key="img">images/action/toolbar/Download23.gif</setting>
 <array key="objectTypes">
 <value>document</value>
 </array>
 <array key="excludedContentTypes">
 <!--RM Change start -->
 <value>application/x-filenet-rm-physicalrecord</value>
 <value>application/x-filenet-rm-electronicrecord</value>
 <value>application/x-filenet-rm-emailrecord</value>
 <!-- RM Change ends -->

 <!-- entry template mime types -->
 <value>application/x-filenet-entrytemplate</value>
 <value>application/x-filenet-documententrytemplate</value>
 <value>application/x-filenet-folderentrytemplate</value>
 <value>application/x-filenet-customobjectentrytemplate</value>
 <value>application/x-filenet-formdataentrytemplate</value>
 <value>application/x-filenet-declarerecordentrytemplate</value>
 <value>application/x-filenet-pageentrytemplate</value>
 <value>application/x-filenet-sectionentrytemplate</value>
 <value>application/x-filenet-cfwpageentrytemplate</value>
 <value>application/x-filenet-cfwsectionentrytemplate</value>
 <value>application/x-filenet-cfwtextentrytemplate</value>
 <value>application/x-filenet-localsectionentrytemplate</value>

 <!-- wcm mime types -->
 <value>application/x-filenet-sp-cr</value>
 <value>application/x-filenet-sp-target</value>
 <value>application/x-filenet-sp-page</value>
 <value>application/x-filenet-sp-section</value>
 <!-- Form policies -->
 <value>application/x-filenet-documentpolicy</value>
 <value>application/x-filenet-workflowpolicy</value>

 <!-- external documents (pointing to an URL) -->
 <value>application/x-filenet-external</value>
 </array>
 <setting key="isPopup">false</setting>
 <setting key="popupHeight">600</setting>
 <setting key="popupWidth">750</setting>
</object>

メニュー・アクション定義の設定

以下の表で、MenuActions.xml 内の各アクション定義設定について説明します。 各設定は、キー属性によって識別されます。特に指定のない限り、設定はオプションです。オプション設定が指定されない場合は、そのデフォルト値が使用されます。
表 1. 以下の表で、MenuActions.xml 内の各アクション定義設定について説明します。
キー 設定
baseURLKey
<setting key="baseURLKey">
 rm
</setting>
この設定を指定した場合は、Workplace XT のベース URL (デフォルト) ではなく Records Manager アプリケーションのベース URL が使用されます。有効な値は「rm」のみです。
classes
<array key="classes">
 <value>{63F8AA94-E2B9-11D0
 -ADF6-00C04FB66DAD}</value>
 <value>{A73BEEB2-B0B7-11D2
 -8853-0000F80883E3}</value>
</array>
このアクションに対して有効なクラスのリストを定義します。値は GUID フォーマットにする必要があります。リストされたクラスに対してのみ、アクションが使用可能になります。
注: この設定を指定した場合は、excludedClasses を設定しないでください。
.
contentTypes
<array key="contentTypes">
 <value>image/jpeg</value>
 <value>image/tiff</value>
 <value>text/*</value>
 <value>application/??-word</value>
</array>
このアクションに対して有効な MIME タイプとコンテナー・タイプのリストを定義します。 指定されたコンテンツ・タイプのオブジェクトに対してのみ、アクションが使用可能になります。この設定を指定しない場合は、すべてのコンテンツ・タイプに対してアクションが使用可能になります。この設定の値には、「*」および「?」のワイルドカード文字を使用できます。「*」は、任意の数の文字 (0 文字も含む) を意味します。"?" は 1 文字を意味します。
注: この設定を指定した場合は、excludedContentTypes を設定しないでください。
excludedClasses
<array key="excludedClasses">
 <value>{d24d4450-1f01-11d1
 -8e63-006097d2df48}</value>
 <value>{f81e9010-6ea4-11ce
 -a7ff-00aa003ca9f6}</value>
</array>
このアクションに対して無効なクラスのリストを定義します。値は GUID フォーマットにする必要があります。 リストされたクラスに対してのみ、アクションが使用不可になります。
注: この設定を指定した場合は、classes を設定しないでください。
excludedContentTypes
<array key="excludedContentTypes">
 <value>text/xml</value>
 <value>text/plain</value>
</array>
このアクションに対して無効な MIME タイプとコンテナー・タイプのリストを定義します。リストされたコンテンツ・タイプと一致しないすべてのオブジェクトに対して、アクションが使用可能になります。この設定の値にも、「*」および「?」のワイルドカード文字を使用できます。
注: この設定を指定した場合は、contentTypes を設定しないでください。
excludedObjectTypes
<array key="excludedObjectTypes">
 <value>storedsearch</value>
 <value>publishtemplate</value>
 <value>securitytemplate</value>
</array>
このアクションに対して無効なオブジェクト・タイプのリストを定義します。
注: この設定を指定した場合は、objectTypes を設定しないでください。
favoritesOnly
<setting key="favoritesOnly">
 true
</setting>
値が true の場合は、アクションが「お気に入り」ページのみに表示されます。デフォルト値は false です。
hideBasedOnVersionStatusConditions
<setting key="hideBasedOnVersionStatusConditions">
 true
</setting>
値が true (デフォルト) の場合は、オブジェクトのバージョン状況によって、アクションがページに表示されるかどうかが決まります。このキーは promoteVersion および demoteVersion アクション定義のみに適用可能です。デフォルト値は false です。
hideForFavorites
<setting key="hideForFavorites">
 true
</setting>
値が true の場合は、アクションが「お気に入り」ページに表示されません。このキーは addToFavorites アクション定義のみに適用可能です。デフォルト値は false です。
hideForVersions
<setting key="hideForVersions">
 true
</setting>
値が true の場合は、情報ページにあるオブジェクトのバージョンに対してはこのアクションが表示されません。 つまり、あるオブジェクトの情報ページから「バージョン」プロパティー・ページに移動した後、特定のオブジェクトの情報ページに移動すると、アクションは使用不可になります。デフォルト値は true です。
hideInSitePreferences
<setting key="hideInSitePreferences">
 true
</setting>
値が true の場合は、アクションが「サイト設定」ユーザー・インターフェースに表示されません。デフォルト値は false です。
hideWhenCheckedOut
<setting key="hideWhenCheckedOut"> true </setting>
値が true の場合は、ドキュメントのチェックアウト時にアクションが表示されません。デフォルト値は false です。
id
<setting key="id"> download </setting>
アクションの固有 ID を定義します。値は必須です。
img
<setting key="img">
 images/action/TestAction16.gif
</setting>
アクションのアイコンを定義します。この設定は不要です。この値は、16x16 ピクセル・サイズのイメージを指す有効なパスでなければなりません。
注: url と同様に、相対パスを使用することができます。
isPopup
<setting key="isPopup">
 true
</setting>
値が true の場合は、いずれかのオブジェクトが選択されると、このアクションが新しいウィンドウに開きます。デフォルト値は false です。
multiSelectPopupHeight
<setting key="multiSelectPopupHeight">
 250
</setting>
新しいウィンドウの高さ (ピクセル) を定義します。isPopup が false に設定されている場合、または multiSelectURL が使用されていない場合は、この設定が無視されます。デフォルト値は 600 です。
multiSelectPopupWidth
<setting key="multiSelectPopupWidth">
 550
</setting>
新しいウィンドウの幅 (ピクセル) を定義します。isPopup が false に設定されている場合、または multiSelectURL が使用されていない場合は、この設定が無視されます。デフォルト値は 800 です。
multiSelectURL
<setting key="multiSelectURL">
 operations/WcmMultiDownloadObject.jsp?
 returnUrl={RETURN_URL}
</setting>
複数選択 URL を定義します。この設定は、複数選択アクションを実装するページの URL を定義します。 複数選択をサポートするアクションには、この設定が必須となります。また、そのアクションを MenuActions.xml の multiSelectActions セクションに含める必要もあります。
objectTypes
<array key="objectTypes">
 <value>document</value>
 <value>folder</value>
</array>
このアクションに対して有効なオブジェクト・タイプのリストを定義します。 この設定を指定しない場合は、すべてのオブジェクト・タイプが有効になります。有効な値は以下のとおりです。
  • objectstore
  • folder
  • document
  • storedsearch
  • searchtemplate
  • link
  • event
注: この設定を指定した場合は、excludedObjectTypes を設定しないでください。
onclick
<setting key="onclick">
 return FNActions.open(event, this)
</setting>
ユーザーがユーザー・インターフェースでアクションをクリックしたときに呼び出されるイベント・アクションを定義します。
popupHeight
<setting key="popupHeight">
 250
</setting>
新しいウィンドウの高さ (ピクセル) を定義します。isPopup が false に設定されている場合は、この設定が無視されます。デフォルト値は 600 です。
popupWidth
<setting key="popupWidth">
 600
</setting>
新しいウィンドウの幅 (ピクセル) を定義します。isPopup が false に設定されている場合は、この設定が無視されます。デフォルト値は 800 です。
renderSeparatorAbove
<setting key="renderSeparatorAbove">
 true
</setting>
値が true の場合は、このアクションによってアクション・リストの上に区切り線が引かれます。デフォルト値は false です。
returnParameters
<setting key="returnParameters">
 eventName=StateChanged&op=checkin
</setting>
アクションの処理が完了したときに含める URL パラメーターを定義します。アクションの完了後にメインページをリフレッシュするメカニズムを提供する場合に使用されます。
rmHideIfAlreadyDeclared
<setting key="rmHideIfAlreadyDeclared">
 true
</setting>
値が true の場合は、ドキュメントがレコードとして宣言されていない場合のみに、このアクションが表示されます。デフォルト値は false です。
注: この設定が有効になるのは、「サイト設定」で Records Manager が選択されている場合のみです。
rmOnly
<setting key="rmOnly">
 false
</setting>
値が true の場合は、「サイト設定」で Records Manager が選択されている場合のみに、このアクションが表示されます。デフォルト値は false です。
roles
<array key="roles"> <value>PSDesigner</value> <value>PWAdministrator</value> </array>
このアクションに対して有効なアクセス・ロールのリストを定義します。リストされた 1 つ以上のロールのメンバーになっているユーザーに対してのみ、アクションが表示されます。アクセス・ロールは、Content Engine で定義されます。デフォルト値は「全員」です。
注: ロールの設定は、「サイト設定」の「アクションのロール・アクセス (Actions Role Access)」ページでも行うことができます。
shortId
<array key="shortId">
 addDocument
</array>
アクションの簡略識別子を定義します。
注: ツールバーおよび「アクション」ボタンからのみ使用可能です。
showInActionsMenuOnly
<setting key="showInActionsMenuOnly"> true </setting>
値が true の場合は、「ドキュメントの追加」、「拡張 - ドキュメントの追加」、「フォルダーの追加」の各アクションが「アクション」メニューのみに表示されます。選択したアイテムのポップアップ・メニューには表示されません。デフォルト値は false です。
showOnlyWhenCheckedOut
<setting key="showOnlyWhenCheckedOut"> true </setting>
値が true の場合は、ドキュメントのチェックアウト時のみにアクションが表示されます。デフォルト値は false です。
subActions
<array key="subActions">
 <value>infoProperties</value>
 <value>infoSystemProperties</value>
 <value>infoSecurity</value>
 <value>infoFolders</value>
</array>
サブメニューに表示されるアクションのリストを定義します。なお、subActions 配列内の値ごとに actionDefinition を定義する必要があります。
注: サブメニューのレベルは 1 つのみです。subActions 配列にリストされるアクション自体がサブメニューを持つことはできません。
title
<setting key="title">
 TEST ACTION 
</setting>
ユーザー・インターフェースに表示される、アクションのラベルを定義します。この設定は必須です。
titleForSitePreferences
<setting key="titleForSitePreferences">
 Download Documents
</setting>
「サイト設定」の「アクションのロール・アクセス (Actions Role Access)」ページにアクションが表示される際のアクション・タイトル。この設定が除外される場合は、title の値が使用されます。
url
<setting key="url">
 operations/MyOperation.jsp?
 id={OBJECT_ID}&amp;
 classId={CLASS_ID}&amp;
 label={OBJECT_LABEL}&amp;
 objectStoreName={OBJECT_STORE_NAME}&amp;
 minorVersion={MINOR_VERSION}&amp;
 objectType={OBJECT_TYPE}&amp;
 vsId={VERSION_SERIES_ID
</setting>
アクションを実装するページの URL と、この URL 上のページに渡されるパラメーターを定義します。この文字列のフォーマットについては、『URL パターン・マクロ』を参照してください。

この設定は必須です。

注: 便宜上、値にスペースや改行を入れることができます。MenuActions.xml の読み取り時には、スペースと改行 (無効な URL 文字) は自動的にこの文字列から削除されます。
useToken
<setting key="useToken"> 
 true
</setting>
値が true の場合は、リダイレクトの前にユーザー・トークンが URL に付加されます。これが行われるのは、 「サイト設定」でトークンのサポートが選択されている場合のみです。デフォルト値は false です。
versionStatusConditions
<array key="versionStatusConditions">
 <value>released</value>
 <value>superseded</value>
</array>
アクションに対して有効なバージョン状況の値を定義します。 この設定を指定しない場合は、バージョン状況の任意の値が有効になります。有効な値は以下のとおりです。
  • released
  • reserved
  • superseded
  • inprocess
  • inprocessNoMajor

メジャー・バージョンを持つバージョン・シリーズの場合は、inprocess を使用します。 メジャー・バージョンを持たないバージョン・シリーズの場合は、inprocessNoMajor を使用します。これらの値については、『バージョン管理プロパティー (Versioning Properties)』を参照してください。

URL パターン・マクロ

以下の表に示すマクロは、アクション定義の url 設定に使用します。これらは、アクションを実装するページの URL と、この URL 上のページに渡されるパラメーターを定義します。各マクロは、実際の URL 内で対応する値に置き換えられます。例えば、パターンが operations/Test.jsp?id={OBJECT_ID} で、操作の呼び出し対象オブジェクトの ID が {A73BEEB2-B0B7-11D2-8853-0000F80883E3} の場合、この操作の URL は operations/Test.jsp?id={A73BEEB2-B0B7-11D2-8853-0000F80883E3} になります。
表 2. 以下の表で、アクション定義の URL 設定に使用するマクロについて説明します。
マクロ
{OBJECT_STORE_NAME} オブジェクト・ストア名 (例:「TEST_OS」)。
{OBJECT_ID} GUID またはパス・フォーマット内のオブジェクト ID。
{OBJECT_LABEL} ラベルがユーザー・インターフェースに表示される際のオブジェクト・ラベル。
{OBJECT_TYPE} 文字列型のオブジェクト・タイプ (例: 「document」、「folder」)。
{VERSION_SERIES_ID} GUID フォーマット内のバージョン・シリーズ ID。
{CLASS_ID} GUID フォーマット内のクラス ID。
{CONTENT_TYPE} 文字列型、URL エンコード形式のコンテンツ・タイプ。
{MAJOR_VERSION} メジャー・バージョン (例: 「1」)。
{MINOR_VERSION} マイナー・バージョン (例: 「2」)。
{VERSION_STATUS} 数値形式のバージョン状況 (例:「1」)。
{RETURN_URL} URL エンコード形式の戻り URL (例: "http://<server>:<port>/WorkplaceXT/Browse.jsf")
{TIME_ZONE} タイム・ゾーン ID。


フィードバック

最終更新: 2011 年 7 月


© Copyright IBM Corp. 2011.
このインフォメーション・センターでは Eclipse テクノロジーが採用されています。詳しくは、http://www.eclipse.org を参照してください。