Korzystanie z procedury obsługi zdarzeń dla programu FileNet Content Manager

Edytuj w trybie z połączeniem
Można wdrożyć procedurę obsługi zdarzeń w systemie IBM® FileNet® Content Manager i skonfigurować ją tak, aby udostępniała zdarzenia powiadomień procesom produktu Business Automation Workflow .

Omówienie

Procedura obsługi zdarzeń jest przeznaczona dla programu IBM FileNet Content Manager w wersji 5.1 lub nowszej.

Obsługiwane zdarzenia

W poniższej tabeli przedstawiono wszystkie zdarzenia systemu ECM, które są obsługiwane przez produkt Business Automation Workflow, oraz odpowiednie zdarzenia produktu FileNet Content Manager . Tabela służy do identyfikowania zdarzeń programu FileNet Content Manager , które mają być subskrybowane, oraz nazw używanych w komponencie Process Designer do identyfikowania tych samych zdarzeń w produkcie Business Automation Workflow.

Tabela 1. Odwzorowanie między obsługiwanymi zdarzeniami ECM i zdarzeniami produktu FileNet Content Manager
Zdarzenia ECM obsługiwane przez produkt Business Automation Workflow (com.ibm.bpm.BPMEventType) Typy obiektów, do których może mieć zastosowanie zdarzenie Odpowiednie zdarzenia programu FileNet Content Manager (com.filenet.api.events)
CheckedIn Dokument CheckinEvent
CheckedOut Dokument CheckoutEvent
CheckOutCancelled Dokument CancelCheckoutEvent
ClassChanged Folder lub dokument ChangeClassEvent
ClassifyCompleted Dokument ClassifyCompleteEvent
Created Folder lub dokument CreationEvent
Deleted Folder lub dokument DeletionEvent
Filed Folder FileEvent
Frozen Dokument FreezeEvent
Locked Folder lub dokument LockEvent
PublishCompleted Dokument PublishCompleteEvent
PublishRequested Dokument PublishRequestEvent
SecurityUpdated Folder lub dokument UpdateSecurityEvent
StateChanged Dokument ChangeStateEvent
Unfiled Folder UnfileEvent
Unlocked Folder lub dokument UnlockEvent
Updated Folder lub dokument UpdateEvent
VersionDemoted Dokument DemoteVersionEvent
VersionPromoted Dokument PromoteVersionEvent

Definiowanie procesu do używania zdarzeń systemu ECM

Przed skonfigurowaniem procedury obsługi zdarzeń w celu generowania powiadomień o zdarzeniach w systemie Business Automation Workflow można utworzyć proces testowy, który będzie odbierać powiadomienia. W przypadku prostego kompleksowego testu weryfikującego należy rozważyć zasubskrybowanie jednego zdarzenia, które nie jest zbyt często wyzwalane, na przykład zdarzenia Updated dla folderów. Szczegółowe informacje na temat subskrybowania zdarzeń dokumentów i folderów zawiera sekcja Subskrybowanie zdarzeń dokumentów i folderów.
Wskazówka: W komponencie Process Designer, jeśli używany jest element sterujący integracji treści, wartość określona w polu Typ obiektu musi być zgodna z nazwą klasy dokumentu lub folderu wybraną podczas tworzenia subskrypcji na serwerze FileNet Content Manager .

Kopiowanie procedury obsługi zdarzeń na serwer FileNet Content Manager

Procedura obsługi zdarzeń znajduje się w następującym miejscu na serwerze Business Automation Workflow :
  • install_root/BPM/EventHandlers/ECM/FileNet/filenet-bpm-event-handler-51.jar
  • install_root\BPM\EventHandlers\ECM\FileNet\filenet-bpm-event-handler-51.jar
Skopiuj procedurę obsługi zdarzeń do odpowiedniego miejsca na serwerze FileNet Content Manager .

Tworzenie dokumentu z informacjami o połączeniu

Informacje o połączeniu wymagane przez procedurę obsługi zdarzeń ECM do nawiązania połączenia z systemem Business Automation Workflow są przechowywane jako dokument w repozytorium produktu FileNet Content Manager . Aby utworzyć dokument z informacjami o połączeniu, wykonaj następujące kroki:

  1. Na serwerze FileNet Content Manager utwórz plik właściwości.
    Wskazówka: Jeśli wymaganych jest wiele subskrypcji, które powiadamiają różne serwery Business Automation Workflow o zdarzeniach, potrzebny jest jeden plik właściwości dla każdego serwera Business Automation Workflow . Chociaż plikowi właściwości można nadać dowolną nazwę, sensowne jest uwzględnienie nazwy serwera w nazwie pliku właściwości, na przykład bpmserver1.properties.
    • Jeśli na serwerze aplikacji, na którym działa program FileNet Content Manager , zdefiniowano odpowiedni alias uwierzytelniania J2C , można zdefiniować plik właściwości połączenia, aby używał tego aliasu uwierzytelniania. Na przykład:
      bpm.server.authalias=scope/my_authentication_alias
bpm.server.uri=https\://bpm_server_name\:9443
      Gdzie zasięg jest zasięgiem aliasu uwierzytelniania mój_alias_uwierzytelniania, a nazwa_serwera_bpm jest nazwą hosta lub adresem IP serwera Business Automation Workflow , na przykład bpm1.example.com.
    • Jeśli alias uwierzytelniania nie jest używany, plik właściwości połączenia z serwerem musi określać odpowiednią nazwę i hasło użytkownika produktu Business Automation Workflow . Na przykład:
      bpm.server.username=bpm_user
bpm.server.password=bpm_user_password
bpm.server.uri=https\://bpm_server_name\:9443
      Gdzie użytkownik_bpm_user jest identyfikatorem użytkownika, który jest autoryzowany do uzyskania dostępu do produktu Business Automation Workflow, hasło_użytkownika jest hasłem dla identyfikatora użytkownika, a nazwa_serwera_bpm jest nazwą hosta lub adresem IP serwera Business Automation Workflow , na przykład bpm1.example.com.
    • Produkt Business Automation Workflow domyślnie używa kontekstowego katalogu głównego /rest/bpm/wle/ dla swojego interfejsu API REST. Jeśli używany jest przedrostek niestandardowego kontekstowego katalogu głównego, dodaj następujący wiersz do pliku właściwości połączenia:
      bpm.server.contextRoot=/myCustomContextRoot/rest/bpm/wle/
  2. Zapisz plik właściwości w systemie ECM. Plik właściwości można zapisać na kilka sposobów. Na przykład można użyć konsoli IBM Administration Console for Content Platform Engine , aby zapisać plik właściwości, wykonując następujące czynności:
    1. Korzystając z przeglądarki, zaloguj się do programu Administration Console for Content Platform Engine pod adresem URL http://filenet_server_host_name:port/acce.
    2. Wybierz składnicę obiektów, w której ma zostać zapisany plik konfiguracyjny.
    3. Rozwiń składnicę obiektów, a następnie dodaj folder lub wybierz odpowiedni istniejący folder, w którym ma zostać zapisany plik właściwości.
    4. Wybierz opcję Nowy dokument z listy rozwijanej Działania folderu.
    5. Określ wartość w polu Tytuł dokumentu. Można wybrać nazwę identyfikującą system BPM, którego będzie dotyczyć ten dokument połączenia. Następnie kliknij przycisk Next (Dalej).
    6. W sekcji Elementy treści kliknij opcję Dodaj. W oknie dialogowym Dodawanie elementów treści kliknij opcję Przeglądaj i wybierz utworzony plik właściwości. Kliknij opcję Dodaj treść. Kliknij przycisk Dalej.
    7. Na kolejnych stronach (Właściwości obiektu, Treść i wersja dokumentu, Określanie ustawień zachowania obiektów i Opcje zaawansowane) można zachować wartości domyślne. Kliknij przycisk Dalej na każdej stronie.
    8. Na stronie Podsumowanie kliknij przycisk Zakończ.
    9. Dokument został utworzony. Kliknij przycisk Otwórz , aby go otworzyć.
    10. Na karcie Właściwości wyszukaj właściwość ID i zapisz jej wartość. Zaznacz i skopiuj ją do schowka lub pliku tekstowego. Będzie ona potrzebna podczas tworzenia subskrypcji zdarzeń.
    11. Na karcie Zabezpieczenia można sprawdzić, które dokumenty mogą być odczytywane i modyfikowane wyłącznie przez administratorów (dzięki temu nie wszyscy użytkownicy mogą wyświetlić te informacje o połączeniu).

Tworzenie czynności zdarzenia

Działanie zdarzenia w programie FileNet Content Manager reprezentuje kod, który jest wywoływany po wystąpieniu zdarzenia. Aby utworzyć działanie zdarzenia dla procedury obsługi zdarzeń produktu BPM , wykonaj następujące kroki w programie Administration Console for Content Platform Engine:
  1. W składnicy obiektów przejdź do opcji Czynności zdarzenia w obszarze Zdarzenia, czynności, procesy.
  2. Kliknij opcję Nowy.
  3. Wprowadź wartość w polu Nazwa wyświetlana, na przykład Czynność zdarzenia produktu BPM. Kliknij przycisk Dalej.
  4. Na stronie Określanie typu czynności zdarzenia podaj procedurę obsługi klas Java com.ibm.bpm.integration.filenet.BPMEventHandler. Zaznacz pole wyboru Konfiguruj moduł kodu. Kliknij przycisk Dalej.
  5. Na stronie Określanie modułu kodu podaj wartość w polu Tytuł modułu kodu, na przykład Moduł kodu procedury obsługi zdarzeń produktu BPM. Kliknij przycisk Przeglądaj i wybierz plik filenet-bpm-event-handler-51.jar. Kliknij przycisk Dalej.
  6. Na stronie Podsumowanie kliknij przycisk Zakończ.
Ta czynność zdarzenia nie jest specyficzna dla systemu Business Process Management (BPM). Oznacza to, że można go użyć na potrzeby subskrypcji zdarzeń przeznaczonych do różnych systemów BPM.

Tworzenie subskrypcji

Subskrypcja w programie FileNet Content Manager definiuje, które zdarzenia w określonym obiekcie mają być obsługiwane przez działanie zdarzenia.

W celu integracji z produktem Business Automation Workflownależy utworzyć wymagane subskrypcje w programie FileNet Content Manager , które są zgodne ze zdarzeniami potrzebnymi dla rozwiązania BPM :
  • Jeśli subskrypcje zdarzeń są definiowane w produkcie BPM, należy utworzyć odpowiednie subskrypcje w programie FileNet Content Manager przy użyciu powyższej tabeli odwzorowania zdarzeń.
  • W przypadku używania zdarzeń Początek dokumentu w procesach należy utworzyć subskrypcję na potrzeby zdarzenia Created (Utworzono) dla klasy dokumentu.
  • W przypadku używania warunków wstępnych działań na podstawie dokumentów, które zostaną dodane do folderu, należy utworzyć subskrypcję na potrzeby zdarzenia Filed (Umieszczono) dla klasy folderu.

Jeśli istnieje wiele systemów BPM , do których ma zostać wysłane zdarzenie, należy utworzyć subskrypcje w programie FileNet Content Manager dla każdego z nich osobno.

Subskrypcje w programie FileNet Content Manager można skonfigurować w taki sposób, aby zawierały również zdarzenia, które zdarzają się w podklasach. Dlatego w przypadku korzystania z tego ustawienia należy uważać, aby nie utworzyć wielu subskrypcji obsługujących to samo zdarzenie, co spowodowałoby wielokrotne wysyłanie zdarzenia do tego samego systemu BPM. Na przykład w systemie FileNet Content Manager istnieje następująca struktura klas:
  • Dokument
    • ClaimForm
    • Contract (kontrakt)

W systemie BPM jest subskrypcja zdarzeń zdefiniowana dla zdarzenia Document Created (Utworzono dokument) na podstawie klasy Document (Dokument) uwzględniającej podklasy. Dostępna jest również subskrypcja dla zdarzenia Document Created (Utworzono dokument) na podstawie klasy Contract (Kontrakt), która nie zawiera podklas. W tym scenariuszu potrzebna jest tylko jedna subskrypcja w systemie FileNet Content Manager : subskrypcja zdarzenia w klasie Document, która zawiera podklasy i subskrybuje zdarzenie Created (Utworzono). Ta subskrypcja wyśle wszystkie wymagane zdarzenia do systemu BPM. W przypadku utworzenia dodatkowej subskrypcji dla klasy Contract (Kontrakt), która dotyczy zdarzenia Created (Utworzono), utworzenie kontraktu spowodowałoby wyzwolenie jednocześnie obu subskrypcji. Następnie do systemu BPM zostałyby wysłane dwa zdarzenia.

Aby utworzyć subskrypcję, wykonaj następujące kroki w programie Administration Console for Content Platform Engine:
  1. W składnicy obiektów przejdź do opcji Subskrypcje w obszarze Zdarzenia, czynności, procesy.
  2. Kliknij opcję Nowy.
  3. Wprowadź Nazwę wyświetlaną i opcjonalnie Opis. Określ nazwę wyświetlaną i opis identyfikujące docelowy system BPM, którego zdarzenia są obsługiwane dla poszczególnych klas Document (Dokument) i Folder, a także, czy włączono opcję uwzględniania podklas. Ułatwi to zorientowanie się, które zdarzenia są obsługiwane przez poszczególne systemy BPM. Takie objaśnienie ułatwi też zapobieganie tworzeniu subskrypcji, które powodują wielokrotne wysyłanie tego samego zdarzenia do jednego systemu BPM. Kliknij przycisk Dalej.
  4. Na stronie Wybierz klasy wybierz opcję Dokument lub Folder jako Typ klasy. W polu Klasa wybierz klasę, która ma obsługiwać zdarzenia. Kliknij przycisk Dalej.
  5. Na stronie Określanie zachowania subskrypcji pozostaw wszystkie wartości domyślne i kliknij przycisk Dalej.
  6. Na stronie Wybór wyzwalaczy wybierz zdarzenia, które chcesz obsługiwać. Kliknij przycisk Dalej.
  7. Na stronie Wybór czynności zdarzenia wybierz utworzoną wcześniej czynność zdarzenia. Kliknij przycisk Dalej.
  8. Na stronie Określanie opcji dodatkowych usuń zaznaczenie pola wyboru Włącz tę subskrypcję dla opcji Stan początkowy. Zgodnie z potrzebami włącz pole wyboru Włącz podklasy. Nie zaznaczaj pola wyboru Uruchamianie synchronicznie. Zdarzenia synchroniczne są wysyłane do systemu BPM zanim transakcja zostanie zakończona. Ponieważ nie można propagować kontekstu transakcyjnego przy użyciu interfejsu REST API, mogłoby to spowodować wyzwalanie operacji w systemie BPM nawet wtedy, gdy operacja na treści zostanie następnie wycofana. Kliknij przycisk Dalej.
  9. Na stronie Podsumowanie kliknij przycisk Zakończ.
  10. Subskrypcja została utworzona. Kliknij przycisk Otwórz , aby go otworzyć.
  11. Na karcie Właściwości odszukaj właściwość Łańcuch użytkownika . Jako wartość podaj identyfikator dokumentu z dokumentu informacji o połączeniu. Opcjonalnie wyszukaj właściwość Włączono i zmień jej wartość na True. Kliknij przycisk Save (Zapisz).
Teraz powiadomienia o wszystkich zasubskrybowanych zdarzeniach są wysyłane do odpowiedniego serwera Business Automation Workflow .

Aktualizowanie modułu kodu czynności zdarzenia

Aby zaktualizować procedurę obsługi zdarzeń produktu BPM w celu korzystania z najnowszej wersji pliku filenet-bpm-event-handler-51.jar, należy zaktualizować moduł kodu i czynność zdarzenia, aby wskazywały na zaktualizowany moduł kodu. Wykonaj następujące kroki w programie IBM Administration Console for Content Platform Engine:

  1. Otwórz moduł kodu. Domyślnie moduły kodu są tworzone w folderze Code Modules (Moduły kodu) w folderze głównym składnicy obiektów. Alternatywnie można znaleźć moduł kodu, przechodząc do opcji Czynności zdarzenia w obszarze Zdarzenia, czynności, procesy. Otwórz Czynność zdarzenia produktu BPM, poszukaj właściwości Moduł kodu i kliknij jej wartość, aby otworzyć moduł kodu.
  2. Dla modułu kodu wykonaj działanie Wprowadź, pobierz, anuluj > Wyłączne pobieranie .... Zostanie utworzona rezerwacja, które jest otwierana automatycznie.
  3. Dla rezerwacji wykonaj działanie Wprowadź, pobierz, anuluj > Wprowadź ....
  4. W oknie dialogowym Wprowadzenie kliknij przycisk Dodaj i wybierz najnowszą wersję pliku filenet-bpm-event-handler-51.jar. Wybierz opcję Zaktualizuj wszystkie instancje klasy czynności, które odwołują się do wcześniejszej wersji tej klasy modułu kodu.
  5. Kliknij opcję Zwróć wersję główną.
Moduł kodu zostanie zaktualizowany i czynności zdarzenia zostaną zaktualizowane tak, aby wskazywały tę nową wersję.

Konfiguracja zaawansowana

Pewnymi zachowaniami procedury obsługi zdarzeń można sterować przy użyciu właściwości systemowych wirtualnej maszyny języka Java (JVM). Aby utworzyć lub zmodyfikować te właściwości, zaloguj się do konsoli WebSphere Integrated Solutions Console systemu FileNet Content Manager . Przejdź do opcji Serwery > Typy serwerów > WebSphere. Dla każdego serwera należącego do miejsca docelowego wdrażania, na którym jest wdrażana aplikacja mechanizmu FileNet Content Manager , przejdź do opcji Język Java i zarządzanie procesami > Definicja procesu > Wirtualna maszyna języka Java > Właściwości niestandardowe. Kliknij przycisk Nowy ... aby utworzyć nowe pozycje lub kliknąć istniejącą pozycję, aby zastosować do niej zmiany. Po wprowadzeniu zmian należy zapisać ustawienia, zsynchronizować węzły i zrestartować serwery.

Poniższa tabela zawiera właściwości, które można ustawić:
Tabela 2. Dostosowywanie właściwości wirtualnej maszyny języka Java
Nazwa właściwości Wartość domyślna Opis
com.ibm.bpm.integration.filenet.configurationExpiration 600000 Czas w milisekundach, przez który treść dokumentu informacji o połączeniu znajduje się w pamięci podręcznej.
com.ibm.bpm.integration.filenet.sendCreatedEventOnCheckOut Prawda Podczas pobierania dokumentu program FileNet Content Manager wywołuje zdarzenie tworzenia dla nowej wersji dokumentu. To zachowanie może nie być pożądane, jeśli zdarzenie ma następować tylko dla pierwszej wersji dokumentu. Aby czynność zdarzenia produktu BPM ignorowała zdarzenia tworzenia dokumentu w przypadku wersji, które nie są pierwsze (początkowe), należy ustawić wartość false (fałsz).