IBM FileNet P8, Wersja 5.1.+            

Dostosowywanie menu dodatkowych Plik, Wstaw i Pomoc

Program IBM® FileNet P8 Application Integration udostępnia możliwość dostosowywania menu podręcznych Plik, Wstaw i Pomoc dla programów Microsoft® Outlook, Word, Excel i PowerPoint. Program Application Integration korzysta z dodatków COM w celu rozszerzania tych aplikacji przez dodawanie niestandardowych menu dodatkowych. Te menu niestandardowe mogą być modyfikowane przez programistów za pomocą udostępnionych plików XML, które zawierają informacje używane przez program Application Integration do konfigurowania treści menu dla aplikacji Microsoft.

Po zainstalowaniu programu Application Integration programiści mogą ręcznie mogą modyfikować zawartość plików XML w celu dostosowania menu dodatkowych tak, by spełniały wymagania aplikacji. Dostosowane pliki XML mogą być następnie kopiowane do pozostałych systemów w organizacji w celu udostępnienia środków sterowania środowiskiem aplikacji oraz dostępności funkcji na potrzeby określonego użytkownika lub klasy użytkowników. Gdy tylko konieczna jest nowa zmiana w konkretnej aplikacji, możliwe jest zaktualizowanie odpowiedniego pliku XML i skopiowanie go ponownie do odpowiednich systemów.

Techniki dostosowywania pliku XML

Programiści mogą dostosowywać menu dodatkowe w następujący sposób:
Tabela 1. Zawiera listę i opisy różnych sposobów dostosowywania menu dodatkowych.
Dostosuj... Opis
Widoczność Określ komendy komponentu Application Integration oraz podmenu podręczne, które powinny być widoczne w menu. Technika ta pozwala całkowicie usunąć podmenu lub komendę z menu w ramach sterowania dostępnością konkretnych funkcji.
Stan włączenia Określ komendy komponentu Application Integration oraz podmenu podręczne, które powinny być widoczne, ale wyłączone (wyszarzone). Ta technika umożliwia programistom decydowanie, czy możliwe jest otwarcie określonego menu lub wykonanie konkretnej komendy.
Etykieta lub podpis Określ etykiety lub opisy komend komponentu Application Integration oraz podmenu podręcznych, tak jak powinny być one wyświetlane dla użytkownika. Na przykład, programista może zmienić nazwę komendy "Wprowadź" na "Zapisz dokument", lub pogrupować pewne komendy w podmenu o nazwie "Tworzenie".
Działanie komendy Określ działanie komponentu Application Integration, które powinno zostać wykonane po wybraniu komendy Application Integration.
Uwaga: Nie można wskazać komend dostawcy.
Hierarchia menu Określ rozmieszczenie komend Application Integration w menu, w tym kolejność komend oraz ich występowanie w hierarchii folderu podmenu podręcznego.

Nazwy i lokalizacja plików XML

W trakcie instalacji komponentu Application Integration pliki XML są zapisywane w katalogu instalacyjnym (domyślnie jest to C:\Program Files\FileNet\AppInt\). Gdy tylko otwarta jest jedna z obsługiwanych aplikacji Microsoft, komponent Application Integration wyszukuje odpowiedniego pliku XML w katalogu instalacyjnym, a następnie konfiguruje menu dodatków dla tej aplikacji zgodnie ze specyfikacją zawartą w pliku XML. Jeśli komponent Application Integration nie może zlokalizować plików XML w katalogu instalacyjnym, podejmuje próbę zgromadzenia plików z katalogu Module. (Katalog Module znajduje się w lokalizacji, w której najczęściej zapisywane są aplikacje pakietu Microsoft Office, tj. domyślnie w ścieżce C:\Program Files\Microsoft Office\Office.)

UWAGA:
Podczas gdy programiści mogą modyfikować zawartość plików XML, nie jest możliwa zmiana ich nazw; pliki muszą być zlokalizowane w katalogu instalacyjnym lub w katalogu module, aby możliwe było odszukanie i użycie plików XML przez komponent Application Integration na potrzeby konfigurowania menu dodatkowych.
W poniższej tabeli zidentyfikowano nazwy plików XML, aplikacje, na które poszczególne pliki XML mają wpływ, oraz obsługiwane wersje poszczególnych aplikacji Microsoft Office.
Tabela 2. Lista nazw plików SML wraz z odpowiednimi aplikacjami Microsoft Office oraz obsługiwanymi wersjami tych aplikacji.
Nazwa pliku XML Odpowiednia aplikacja Obsługiwane wersje
FnAppIntExcelMenus.xml Excel 2003, 2007, 2010
FnAppIntOutlookMenus.xml Outlook Explorer (okno przeglądania elementów)

Outlook Inspector (okno edycji elementów)

2003, 2007, 2010
FnAppIntPowerPointMenus.xml PowerPoint 2003, 2007, 2010
FnAppIntWordMenus.xml Word 2003, 2007, 2010

Uwagi dotyczące modyfikowania pliku XML

Przed przystąpieniem do modyfikowania plików XML należy rozważyć następujące kwestie:
  • Mimo że pliki XML są instalowane jako pliki tylko do odczytu, programiści mogą modyfikować uprawnienia do plików w celu udostępnienia ich do zapisu.
  • Pliki XML udostępnione przez IBM udostępniają właściwą składnię pozwalającą na określenie menu programów dodatkowych i ich zawartości. Programiści powinni ściśle przestrzegać formatowania XML oraz składni parametrów podanych w tych plikach. Ponadto programiści mogą wykonywać kopie zapasowe oryginalnych plików XML przed ich implementowaniem i modyfikowaniem. Pomaga to w debugowaniu oraz w rozwiązywaniu potencjalnych błędów składniowych w modyfikowanych plikach.
  • W celu skonfigurowania menu dodatkowych komponent Application Integration wyszukuje pliki XML wg nazw w katalogu instalacyjnym. Podczas gdy programiści mogą modyfikować zawartość plików XML, nie jest możliwa zmiana ich nazw; pliki muszą być zlokalizowane w katalogu instalacyjnym lub w katalogu module, aby możliwe było odszukanie i użycie plików XML przez komponent Application Integration na potrzeby konfigurowania menu dodatkowych.
  • Przy każdej instalacji komponentu Application Integration, włącznie z instalacją pakietów poprawek, oryginalne pliki XML są zapisywane w katalogu instalacyjnym. W efekcie może dojść do nadpisania plików XML juz dostosowanych do aktualnych potrzeb użytkownika. Programiści mogą więc tworzyć kopie zapasowe zmodyfikowanych plików XML i zapisywać je, korzystając z unikalnych nazw plików lub w unikalnym folderze. Pozwala to na szybkie przywrócenie plików XML odpowiednio do potrzeb.

Schemat XML menu dodatkowego

Podstawowa struktura schematu XML menu dodatkowych jest następująca:
  • addInMenusConfiguration - obiekt najwyższego poziomu w schemacie, identyfikujący następujące obiekty XML opisujące menu dodatkowe dla aplikacji. Ten obiekt określa również wersję (version) używanego schematu.
  • applicationName - identyfikuje docelową aplikację, na potrzeby której konfigurowane są menu dodatkowe.
  • applicationVersion - określa obsługiwane wersje aplikacji docelowej.
  • addInMenusDefinition - każdy obiekt addInMenusConfiguration składa się z jednego (lub więcej, w przypadku programu Microsoft Outlook) z tych obiektów, które zawierają obiekty określające sposób konfigurowania poszczególnych menu dodatkowych (Plik, Wstaw lub Pomoc) dla aplikacji. Obiekt ten określa również typ (type) menu dodatkowego, które ma zostać utworzone. Komponent Application Integration obsługuje następujące typy: main dla programów Word, Excel i PowerPoint, explorer oraz inspector dla programu Outlook.
  • addInMenuItem - każdy obiekt addInMenusDefinition składa się z jednego lub więcej takich obiektów, które opisują hierarchię podmenu oraz działanie przycisków komend dla każdego z menu. Uzyskuje się to przez zastosowanie znacznika itemType, który można ustawić na wartość popup lub button.
    • Jeśli itemType="popup", obiekt addInMenuItem może zawierać listę (list) własnych elementów podrzędnych obiektu addInMenuItem, umożliwiając tym samym utworzenie struktury podmenu. Tę strukturę hierarchiczną można powtórzyć na dowolnej głębokości odpowiednio do potrzeb i wymogów specyficznych dla danej organizacji.
    • Jeśli itemType="button", struktura XML kończy się, ponieważ tylko pozycje menu o atrybucie popup mogą mieć podrzędne pozycje menu.
  • setting - każdy obiekt addInMenuItem (popup lub button) zawiera pewną liczbę znaczników setting definiujących wygląd i działanie podmenu lub przycisku, np. opis pozycji menu, widoczność etykiety lub podpisu, pozycję wstawiania menu oraz odpowiednie działanie komponentu Application Integration do wykonania po otwarciu lub wybraniu pozycji menu. W sekcji Znaczniki Setting udostępniono pełny, szczegółowy opis znaczników setting.

Na przykład, informacje na temat sposobu użycia tych znaczników w schemacie XML zawiera sekcja Przykładowy schemat XML.

Znaczniki Setting

Każdy obiekt addInMenuItem korzysta ze znaczników setting w celu zdefiniowania wyglądu i działania podmenu menu dodatkowego lub przycisków komend. Składnia znacznika różni się w zależności od definiowanego klucza (key). Na przykład, niektóre klucze (key) wymagają pola type, inne zaś nie:

<setting key="itemType">popup</setting>
<setting key="parent"
type="menuId">30002</setting>

W poniższej tabeli, w sytuacji gdy klucz (key) nie wymaga użycia pola type lub określonej wartości, wpis w kolumnie Typ lub Wartość brzmi "Nie dotyczy". Jeśli wartość dla klucza (key) nie jest znaną zmienną komponentu Application Integration, taką jak popup czy button, wpis w kolumnie Wartość jest pisany kursywą; przykład: 30002. Ponadto, jeśli klucz (key) nie jest wymagany, wpis w kolumnie Opis zawiera wskaźnik [Opcjonalny].

Komponent Application Integration obsługuje następujące znaczniki setting.
Tabela 3. Zawiera listę kluczy wraz z ich typami, wartościami i opisami.
Klucz Typ Wartość Opis
itemType Nie dotyczy popup Wskazuje, ze pozycja menu dodatkowego to podmenu podręczne z elementami podrzędnymi, które mogą obejmować przyciski komend oraz podmenu dodatkowe.
  Nie dotyczy button Wskazuje, że pozycja menu dodatkowego to przycisk komendy bez elementów podrzędnych.
description Nie dotyczy Menu Plik P8 [Opcjonalny] Udostępnia opis pozycji menu dodatkowego wyłącznie do celów informacyjnych; opis ten nie jest widoczny dla użytkownika.
label enum eOpenSubMenuName Dostarcza widoczną etykietę lub podpis dla pozycji menu dodatkowego z zastosowaniem jednej z następujących stałych wyliczeniowych:
  • eFileMenuName
  • eOpenButtonName
  • eOpenSubMenuName
  • eOpenMyCheckoutsButtonName
  • eOpenSelectItemButtonName
  • eAddDocumentButtonName
  • eAddDocumentSubMenuName
  • eAddDocumentUseWizardButtonName
  • eAddDocumentSelectTemplateButtonName
  • eAddFolderButtonName
  • eCheckinSubMenuName
  • eCheckinQuickButtonName
  • eCheckinUseWizardButtonName
  • eTasksMyInboxButtonName
  • eSaveButtonName
  • eCancelCheckoutButtonName
  • ePropertiesButtonName
  • eLogoffButtonName
  • eInsertMenuName
  • eInsertButtonName
  • eInsertHyperlinkButtonName
  • eInsertPropPageButtonName
  • eInsertPropertyButtonName
  • eRefreshPropertyButtonName
  • eDeletePropertyButtonName
  • eHelpButtonName
  resourceID 119 Dostarcza widoczną etykietę lub podpis dla pozycji menu dodatkowego przez określenie wartości całkowitej odpowiadającej identyfikatorowi zasobu zdefiniowanemu w pliku lokalizacji zasobu.
  text Wprowadź/zwróć... Dostarcza widoczną etykietę lub podpis dla pozycji menu dodatkowego, udostępniając rzeczywisty łańcuch tekstowy.
visible Nie dotyczy true Określa widoczność dla użytkownika pozycji menu dodatkowego (oraz wszelkich menu podręcznych, jeśli pozycja menu stanowi podmenu podręczne).
    false Określa, że pozycja menu dodatkowego (oraz wszelkich elementów podrzędnych, jeśli pozycja menu stanowi podmenu podręczne) jest niewidoczna dla użytkownika (to znaczy, pozycja menu nie pojawia się w menu dodatkowym).
enabled Nie dotyczy true Określa, że pozycja menu dodatkowego jest włączona, co umożliwia użytkownikowi otwarcie podmenu podręcznego lub wybór przycisku komendy.
    False Określa, że użytkownik nie może wybrać ani otworzyć pozycji menu dodatkowego (oznacza to, że pozycja menu jest wyłączona w menu dodatkowym).
parent menuId 30002 Udostępnia wartość "menuId" dla menu nadrzędnego pozycji menu dodatkowego. Jeśli pozycja menu stanowi podmenu podręczne, wartość ta jest zwykle identyfikatorem sterującym istniejącego menu podręcznego Microsoft Office. Więcej informacji na temat identyfikatorów menu w aplikacjach Microsoft Office zawiera dokumentacja Microsoft Office Developers Guide for Office 2003/XP/2007.
  topLevel Nie dotyczy Jeśli pozycja menu dodatkowego jest podmenu podręcznym, wówczas ta para klucz-typ wskazuje, że to podmenu znajduje się w menu najwyższego poziomu aplikacji.
Uwaga: Ta para klucz-typ obowiązuje wyłącznie dla podmenu podręcznych.
  Nie dotyczy Nie dotyczy Jeśli menu dodatkowe jest przyciskiem komendy, element nadrzędny jest przyjmowany w określonym pliku XML za pośrednictwem znacznika <list key="children">. Dlatego nie jest wymagana żadna specyfikacja nadrzędna w tej lokalizacji setting w pliku XML.
Uwaga: Ta para klucz-typ obowiązuje wyłącznie dla przycisków komend.
location Nie dotyczy 4 Określa miejsce wstawiania dla tej pozycji menu dodatkowego w menu nadrzędnym. Wartość -1 określa, że element menu jest dodawany w dolnej części istniejącego menu.
Uwaga: Ta wartość określa żądane położenie pozycji menu w nadrzędnym menu podręcznym.
command standard
OfficeAdd-In.
OpenSelection
Określa operację komponentu Application Integration do wykonania po wybraniu przez użytkownika przycisku komendy. Można wskazać jedną z następujących stałych wyliczeniowych:
  • OfficeAdd-In.AddFolderUseAddWizard
  • OfficeAdd-In.OpenMyCheckouts
  • OfficeAdd-In.OpenSelectItem
  • OfficeAdd-In.AddDocumentUseAddWizard
  • OfficeAdd-In.AddDocumentSelectTemplate
  • OfficeAdd-In.CheckinDocumentUseCheckinWizard
  • OfficeAdd-In.CheckinDocumentQuickCheckin
  • OfficeAdd-In.Save
  • OfficeAdd-In.CancelCheckout
  • OfficeAdd-In.GetInfo
  • OfficeAdd-In.TasksMyInbox
  • OfficeAdd-In.Logoff
  • OfficeAdd-In.Help
  • OfficeAdd-In.InsertItem
  • OfficeAdd-In.InsertProperty
  • OfficeAdd-In.RefreshProperties
  • OfficeAdd-In.DeleteProperties
  • OfficeAdd-In.InsertHyperlink
  • OfficeAdd-In.InsertPropertiesPage
  standard Nie dotyczy Jeśli pozycja menu dodatkowego stanowi podmenu podręczne, kliknięcia menu są ignorowane. Dlatego żadne specyfikacje komend nie są wymagane w tej lokalizacji setting w pliku XML.
Uwaga: Ta para klucz-typ obowiązuje wyłącznie dla podmenu podręcznych.

Na przykład, informacje na temat sposobu użycia tych znaczników w schemacie XML zawiera sekcja Przykładowy schemat XML.

Przykładowy schemat XML

Poniższy fragment kodu ilustruje podstawową strukturę schematu XML na potrzeby menu dodatkowych dla aplikacji Excel:
<?xml version="1.0" ?>
 <!-- Menu dodatkowe IBM FileNet P8 Application Integration 4.0 dla programu Excel-->
 <!-- Menu dodatkowe - Informacje dotyczące konfiguracji -->
 <object key="addInMenusConfiguration" version="1.0">
 <setting key="applicationName">Excel</setting>
 <array key="applicationVersion">
 <value>2003</value>
 <value>2007</value>
 <value>2010</value>
 </array>
 <!-- Menu dodatkowe - Definicje menu głównego -->
 <object key="addInMenusDefinition" type="main">
 <list key="children">
 <!-- Menu Plik P8 -->
 <object key="addInMenuItem">
 <setting key="itemType">popup</setting>
 ...
 <list key="children">
 <!-- Podmenu Otwórz dokument -->
 <object key="addInMenuItem">
 <setting key="itemType">popup</setting>
 <setting key="description">Podmenu komend otwierania dokumentów.</Setting>
 <setting key="label" type="text">Otwórz dokument</setting>
 <setting key="visible">true</setting>
 <setting key="enabled">true</setting>
 <setting key="location">3</setting>
 <setting key="command" type="standard"></setting>
 <list key="children">
 <!-- Otwórz dokument - Przycisk Moje pobrania... -->
 <object key="addInMenuItem">
 <setting key="itemType">button</setting>
 ...
 <list key="children" />
 </object>
 <!-- Otwórz dokument - Przycisk Wybierz element... -->
 <object key="addInMenuItem">
 <setting key="itemType">button</setting>
 ...
 <list key="children" />
 </object>
 </list>
 <list key="children" />
 </object>
 <!-- Podmenu Dodaj dokument -->
 <object key="addInMenuItem">
 <setting key="itemType">popup</setting>
 ...
 <list key="children" />
 </object>
 ...
 <!-- Przycisk Dodaj folder... -->
 <object key="addInMenuItem">
 <setting key="itemType">button</setting>
 <setting key="description">Uruchamia kreator Dodaj folder</setting>
 <setting key="label" type="enum">eAddFolderButtonName</setting>
 <setting key="visible">true</setting>
 <setting key="enabled">true</setting>
 <setting key="parent" type="menuId">30002</setting>
 <setting key="location">1</setting>
 <setting key="command" type="standard">OfficeAdd-In.AddFolderUseAddWizard</setting>
 <list key="children" />
 </object>
 ...
 </list>
 <list key="children" />
 </object>
 <!-- Menu Wstaw P8 -->
 <object key="addInMenuItem">
 <setting key="itemType">popup</setting>
 ...
 <list key="children">
 ...
 </list>
 <list key="children" />
 </object>
 <!-- Menu Pomoc P8 -->
 <object key="addInMenuItem">
 <setting key="itemType">popup</setting>
 ...
 <list key="children">
 ...
 </list>
 <list key="children" />
 </object>
 </list>
 </object>
 </object>
...


Opinia

Data ostatniej aktualizacji: Lipiec 2011


© Copyright IBM Corp. 2011.
To centrum informacyjne jest oparte na technologii Eclipse. (http://www.eclipse.org)