IBM FileNet P8, 5.2 版            

自訂 Workplace XT 動作

對於可以從蹦現功能表或從 IBM® FileNet® Workplace XT 的瀏覽和搜尋模式存取的物件,應用程式會提供一組作業或動作,供一般使用者對特定物件類型執行。例如,文件物件可用的動作包括移出、下載、變更為複合及移動;若為資料夾物件,則包括新增物件、移動和刪除。

身為管理者,您可以針對出現在 Workplace XT 使用者介面中的物件,自訂可執行的動作。 您也可以執行外觀上的變更,例如從使用者介面完全移除動作。您也可以使用過濾準則,定義出現動作的條件。例如,您可以定義下載動作只在使用者按一下特定類別說明、版本狀態和內容類型的文件時才出現。

本主題指出 Workplace XT 介面中向使用者顯示動作的位置, 並說明您可用來配置那些動作的功能表動作描述子 XML 檔

註: 如果您先前曾修改 Workplace 應用程式的 Actions.xml 檔來自訂其中的動作,而您現在想要在 Workplace XT 中使用那些相同的自訂動作,則必須手動將 Workplace 相關的自訂新增到 Workplace XT Actions.xml 檔。

Workplace XT 使用者介面中的動作

動作會在蹦現功能表、動作功能表、工具功能表和內容資訊頁面中提供給使用者。 (「內容」資訊頁面和「我的工作區」蹦現功能表中的動作是由 Actions.xml 檔定義;MenuActions.xml 檔定義所有其他動作)。當使用者在清單視圖中的某物件上或路徑視圖中的某項目上按一下滑鼠右鍵時,會出現蹦現功能表。 可用的動作清單取決於所選取的物件類型。 相同的動作會出現在該物件的「內容」資訊頁面上。當使用者選取清單視圖中的一個或多個項目,然後按一下「動作」按鈕,「動作」功能表就會開啟。如果選取了多個項目,只有對所有選取項目都有效的動作,才會顯示在功能表中。

在 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 遵循工作區喜好設定 XML 綱目 Preferences.xsd(位在 <XT_deploy_path>\FileNet\WebClient\WorkplaceXT\WEB-INF\xml中)。

附註:  
  • 先備份 MenuActions.xml 然後再加以修改。
  • 如果您修改 MenuActions.xml 檔來併入任何延伸字元,請將該檔案另存為 UTF-8。
  • 修改 MenuActions.xml 之後,請從 Workplace XT 重新載入它,以避免重新啟動已部署該應用程式的 Web 伺服器。
檔案結構
如下面的清單所示,MenuActions.xml 是由五個區段組成:multiSelectActionstoolbarActionsfolderToobarActionstopLevelActionsactionDefinitions
topLevelActions 陣列和 multiSelectActions 陣列中,您可定義這些動作出現在使用者介面中的順序。 也就是說,在 topLevelActions 陣列中,值元素的順序會反映在蹦現功能表和資訊頁面上。 在 multiSelectActions 陣列中,值元素的順序會反映在複選功能表上。 您可以註銷動作來隱藏它們。
multiSelectActions 陣列中,您可以將動作指定為只能複選;也就是說,複選動作不必列在 topLevelActions 陣列中。
toolbarActionsfolderToolbarActions 區段中,您可定義工具列按鈕,當瀏覽或搜尋文件和資料夾時,這些按鈕會出現在工具列的「動作」按鈕旁邊。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>
如果有此設定,會使用 Records Manager 應用程式的基本 URL,而非 Workplace XT 基本 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 個字元)。"?" 代表一個字元。
註: 如果有此設定,請勿設定 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(預設值),則物件的版本狀態將決定此動作是否出現在頁面上。此鍵僅適用於promoteVersiondemoteVersion 動作定義。預設值為 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
  • 資料夾
  • 文件
  • storedsearch
  • searchtemplate
  • link
  • event
註: 如果有此設定,請勿設定 excludedObjectTypes
onclick
<setting key="onclick">
 return FNActions.open(event, this) </setting>
定義當使用者在使用者介面中按一下動作時要呼叫的 JavaScript 事件動作。
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>
定義對此動作有效的存取角色清單。只有身為所列一或多個角色成員的使用者,才能看到此動作。存取角色定義在 Content Engine 中。預設值為「每個人」。
註: 您也可以在「網站喜好設定」的「動作角色存取」頁面中設定角色。
shortId
<array key="shortId">
 addDocument</array>
定義動作的簡短 ID。
註: 只能從工具列和「動作」按鈕使用。
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
註: 您只能有一個子功能表層次;subActions 陣列中列出的任何動作都不能有它自己的子功能表。
title
<setting key="title">
 TEST ACTION</setting>
定義動作的標籤,其出現在使用者介面中。此設定是必要的。
titleForSitePreferences
<setting key="titleForSitePreferences">
 Download Documents</setting>
當動作出現在「網站喜好設定」的「動作角色存取」頁面時的動作標題。如果已排除此設定,則使用 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。如需這些值的相關資訊, 請參閱「版本化內容」。

URL 型樣巨集

下表的巨集用於動作定義的 url 設定中。 它們定義實作此動作之頁面的 URL,以及傳遞至 URL 的該頁面的參數。 巨集將由實際 URL 中的對應值取代。例如,如果型樣是 operations/Test.jsp?id={OBJECT_ID},且呼叫此作業的物件含有 {A73BEEB2-B0B7-11D2-8853-0000F80883E3} 的 ID,則作業 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。


意見

前次更新: 2013 年 3 月
wpxt_menuactions_config.htm

© Copyright IBM Corp. 2013.
這個資訊中心採用 Eclipse 技術。(http://www.eclipse.org)