Eksplorator dokumentów

Widok Eksplorator dokumentów wyświetla dokumenty w przywoływanych folderach ECM i dokumentach w strukturze folderów instancji procesu. Jeśli użytkownicy są autoryzowani, mogą wyszukiwać, tworzyć, usuwać i zmieniać nazwy folderów. Mogą one także przesyłać, wyświetlać, sprawdzać i usuwać dokumenty.

Widok formatki eksploratora dokumentów można skonfigurować w taki sposób, aby dodawać, wyświetlać i usuwać poszczególne foldery, a także dodawać, wyświetlać, pobierać i usuwać dokumenty oraz usuwać je. Eksplorator dokumentów używa usług do wykonywania tych funkcji.

Po otwarciu przez użytkownika formatki uwzględniającej instancję eksploratora dokumentów w instancji będzie widoczna zawartość jej folderu głównego, zgodnie z ustawieniami konfiguracyjnymi. Ten folder główny nosi nazwę Dokumenty. Jednak w eksploratorze dokumentów nazwa ta jest wyświetlana w ścieżce nawigacyjnej podczas przeglądania jednego z jego podfolderów. Folder główny instancji eksploratora dokumentów jest specyficzny dla tej instancji. Różne instancje mogą zawierać różne foldery główne, które mogą znajdować się w dowolnym miejscu w systemie zarządzania treścią. Folder główny elementu Eksplorator dokumentów można:
  • Określić bezpośrednio, identyfikując konkretny folder przy użyciu opcji konfiguracji Identyfikator folderu. Opcja konfiguracji Nazwa serwera umożliwia zidentyfikowane serwera zawierającego folder, jeśli folder nie znajduje się na domyślnym serwerze zarządzania treścią.
  • Uzyskać, identyfikując identyfikator instancji, do której przypisano folder i serwer w systemie zarządzania treścią.
  • Uzyskać z kontekstu usługi personelu, do którego przypisano folder w systemie zarządzania treścią.
Na przykład skonfiguruj eksplorator dokumentów:
  1. Informacje na temat konfigurowania serwera ECM zawiera sekcja Dodawanie serwera ECM (Enterprise Content Management).
  2. Przeciągnij komponent eksploratora dokumentów do formatki.
  3. Wybierz komponent.
  4. Kliknij opcję Konfiguracja i wybierz Zaawansowane zarządzanie treścią. Aby skonfigurować właściwości, patrz sekcja Właściwości konfiguracyjne i opis:
    • Nazwa serwera: wprowadź nazwę serwera ECM, który właśnie został dodany.
    • ID folderu: uzyskaj identyfikator folderu ECM, który ma być zarządzany z ACCE.
    Po zapisaniu dokumentów można ze strony uzyskać dostęp do tych dokumentów i zarządzać nimi w katalogu.

Istnieją pewne zasady określania folderu głównego. Wartość w polu Identyfikator folderu nadpisuje każdą wartość w polu Identyfikator instancji. Każda wartość w polu Identyfikator instancji przesłania użycie kontekstu usługi personelu użyte do wyznaczenia folderu głównego.

Folder główny zawiera foldery oraz dokumenty (pliki i powiązane z nimi właściwości). Mogą istnieć różnice w rzeczywistej treści widocznej dla poszczególnych użytkowników w elemencie Eksplorator dokumentów oraz w działaniach, które mogą oni wykonywać względem tej treści. Zależą one od uprawnień przypisanych użytkownikom w systemie zarządzania treścią. Zakładając, że użytkownikom przypisano odpowiednie uprawnienia, mogą oni dodawać nowe foldery i dokumenty. Ponadto mogą oni z menu czynności folderu lub dokumentu wybierać czynności do wykonania względem folderu albo dokumentu.

Tabela 1. Czynności dotyczące folderu
Działanie Opis
Otwórz Umożliwia wyświetlenie zawartości folderu. W elemencie Eksplorator dokumentów zostanie dodana ścieżka nawigacyjna, dzięki której użytkownik będzie mógł wrócić do folderu macierzystego.
Zmień nazwę Umożliwia zmianę nazwy folderu.
Skasuj lub usuń Umożliwia skasowanie folderu lub odwołania z serwera ECM. Działanie usuwania kasuje tylko odwołanie z eksploratora dokumentów. Odwołanie pozostaje na serwerze ECM.
Tabela 2. Czynności dotyczące dokumentu
Działanie Opis
Wyświetl Umożliwia wyświetlenie treści dokumentu w przeglądarce lub pobranie dokumentu (jeśli przeglądarka nie obsługuje danego formatu pliku).
Pobierz Umożliwia pobranie dokumentu.
Właściwości Wyświetla właściwości, które są powiązane z dokumentem. Typ dokumentu pełni rolę szablonu służącego do określania właściwości danego dokumentu.
Pobierz Blokuje plik. Po pobraniu pliku można wprowadzić inną jego wersję lub zmienić jego właściwości.
Wprowadź lub anuluj wprowadzenie Odblokowuje plik. Użyj działania wprowadzania, aby zastąpić treść pliku i zaktualizować jego właściwości. Te czynności są dostępne jedynie w przypadku zablokowanych plików.
Usuń Umożliwia usunięcie dokumentu z folderu. Dokument będzie nadal istniał w systemie zarządzania treścią.

Integracja z serwerem ECM

Aby zintegrować widok Eksplorator dokumentów z serwerem ECM (Enterprise Content Management), aplikacja procesu musi mieć połączenie z tym serwerem. Więcej informacji na ten temat zawiera sekcja Dodawanie serwera ECM (Enterprise Content Management). Więcej informacji na temat budowania usług ECM zawiera sekcja Budowanie usługi integracji z systemem ECM lub składnicą produktu BPM. Dodatkowe informacje można znaleźć w tematach sekcji Włączanie obsługi dokumentów.

Ograniczenia

Ten widok obsługuje tylko właściwości widoczności Required, Hiddeni None.

Powiązanie danych

Powiązanie danych widoku należy ustawić na karcie właściwości Ogólne.
Tabela 3. Powiązanie danych eksploratora dokumentów
Opis Typ danych
Każde powiązanie ECMDocumentInfo zawiera adres URL dla dokumentu. ECMDocumentInfo (List)

Właściwości konfiguracyjne

Na karcie właściwości Konfiguracja można ustawiać i modyfikować właściwości konfiguracyjne wyglądu i zachowania widoku.
Wielkość ekranu
Właściwość konfiguracyjna, na której znajduje się ikona Rozmiarów ekranu Ikona wielkości ekranu obok nazwy właściwości, może mieć różne wartości dla każdej wielkości ekranu. Jeśli nie zostanie ustawiona wartość, wielkość ekranu dziedziczy wartość następnej większej wielkości ekranu jako swoją wartość domyślną.

Właściwości konfiguracyjne zarządzania treścią widoku Eksplorator dokumentów znajdują się w poniższej tabeli:

Tabela 4. Właściwości zarządzania treścią elementu Eksplorator dokumentów
Właściwość zarządzania treścią Opis Typ danych
Identyfikator ostatniego zaktualizowanego dokumentu Identyfikator dokumentu, który został utworzony lub zaktualizowany. ECMID
Domyślne właściwości dokumentu ECM Zgodne właściwości, które mają zostać przesłane z tym dokumentem. ECMDefaultProperty[]
Dodaj właściwości BPM Domyślnie właściwości nie są dodawane do nowych dokumentów produktu BPM. Włączenie tej opcji konfiguracyjnej powoduje dodanie właściwości, które są zdefiniowane w opcji konfiguracyjnej Prześlij właściwości BPM. Aby określać, kiedy właściwości są dodawane do dokumentu, należy powiązać tę opcję konfiguracji ze zmienną. Boolean
Prześlij właściwości BPM Jeśli została wybrana opcja Dodaj właściwości BPM, są to właściwości, które mają zostać powiązane z dokumentem. NameValuePair[]
Ukryj w portalu Aby zapobiec wyświetlaniu dokumentu w portalu Process Portal. Boolean

Zaawansowane właściwości konfiguracyjne zarządzania treścią widoku Eksplorator dokumentów znajdują się w poniższej tabeli:

Tabela 5. Zaawansowane właściwości zarządzania treścią elementu Eksplorator dokumentów
Zaawansowana właściwość zarządzania treścią Opis Typ danych
Identyfikator instancji Wyświetla listę dokumentów i folderów dla identyfikatora instancji. Jeśli właściwość Identyfikator folderu jest skonfigurowana, konfiguracja właściwości Identyfikator instancji jest ignorowana. Jeśli nie zostanie skonfigurowana właściwość Identyfikator folderu ani właściwość Identyfikator instancji, identyfikator folderu jest uzyskiwany z kontekstu usługi personelu. W przypadku usług personelu po stronie klienta właściwości tw.system.processInstance.id i tw.system.processInstance.processInstanceFolderId są używane w kontekście. W przypadku tradycyjnych usług personelu właściwości tw.system.currentProcessInstance.id i tw.system.currentProcessInstance.processInstanceFolderId są używane w kontekście. String
Nazwa serwera Jeśli skonfigurowano opcję Identyfikator folderu, użyj nazwy zewnętrznego serwera ECM. Nazwę serwera można wpisać w polu. Można także użyć zmiennej reprezentującej nazwę serwera i dodać ją do tego pola. W celu wyszukania nazwy zewnętrznego serwera ECM należy przejrzeć stronę Ustawienia aplikacji procesu zawierającą listę dostępnych zewnętrznych systemów ECM.

W przypadku pracy z wewnętrznymi repozytoriami treści ECM- składnica zarządzana produktuBPM, składnica treści produktuBPMlub składnica dokumentów produktuBPM -stałe są dostępne dla nich. Na przykład: ECMServerNames.IBM_BPM_MANAGED_STORE.

String
Identyfikator folderu Wyświetla listę dokumentów i folderów dla identyfikatora folderu. Jeśli ta właściwość jest skonfigurowana, identyfikator instancji jest ignorowany. Jeśli właściwość Identyfikator folderu nie jest skonfigurowana, identyfikator folderu jest uzyskiwany z powiązanej konfiguracji właściwości Identyfikator instancji. Jeśli identyfikator instancji nie jest określony, identyfikator folderu jest uzyskiwany z kontekstu usługi personelu. W przypadku usług personelu po stronie klienta właściwości tw.system.processInstance.id i tw.system.processInstance.processInstanceFolderId są używane w kontekście. W przypadku tradycyjnych usług personelu właściwości tw.system.currentProcessInstance.id i tw.system.currentProcessInstance.processInstanceFolderId są używane w kontekście. String
Wyświetl folder sprawy nadrzędnej Wyświetla zawartość instancji sprawy nadrzędnej. Ta opcja jest poprawna tylko w odniesieniu do instancji w rozwiązaniu sprawy utworzonym za pomocą aplikacji Case Builder. Gdy ta opcja jest wybrana, pola Nazwa serwera, Identyfikator instancji i Identyfikator folderu są ignorowane. Boolean

Właściwości konfiguracyjne zachowania widoku Eksplorator dokumentów znajdują się w poniższej tabeli:

Tabela 6. Właściwości konfiguracyjne zachowania elementu Eksplorator dokumentów
Właściwość konfiguracyjna zachowania Opis Typ danych
Pokaż stopkę Pokaż stopkę. Boolean
Pokaż statystykę dotyczącą tabeli Pokazywanie statystyki dotyczącej tabeli. Na przykład: Wyświetlanie pozycji: 1-5 z 59. Boolean
Pokaż paginator Pokazywanie paginatora. Boolean
Początkowa wielkość strony Początkowa maksymalna liczba pozycji do wyświetlenia na jednej stronie. Integer
Potwierdź przy usuwaniu Wyświetlanie okna dialogowego potwierdzenia przed usunięciem plików. Boolean
Korzystanie z przeglądarki dokumentów Umożliwia otwarcie dokumentu we wstawianej przeglądarce dokumentów po wybraniu pozycji menu Wyświetl. Jeśli ta opcja nie jest włączona, dokumenty są otwierane w nowym oknie. Boolean
Zwijalna Widok Eksplorator dokumentów jest zwijalny. Boolean
Początkowo zwinięte Widok Eksplorator dokumentów jest zwinięty po otwarciu widoku. Boolean
Wyzwalacz odświeżenia Wskazuje, czy można odświeżać zawartość widoku. Tę właściwość należy powiązać ze zmienną boolowską. Jeśli wartość powiązanej zmiennej zostanie zmieniona na true, widok zostanie odświeżony. Po odświeżeniu widoku wartość zmiennej zostanie zmieniona z powrotem na false. Boolean
Usługa ECM pobierania pokrewnych folderów Pobiera informacje o folderze dla serwerów ECM, które są wymienione na stronie Ustawienia aplikacji procesu. Default Get Related ECM Folders Service
Status instancji Określa, czy eksplorator dokumentów jest w trybie edycji, czy w trybie tylko do odczytu. Instancje o wartości statusu Aktywna będą dostępne do edycji. Instancje o innych wartościach statusu (Zakończona, Zakończona niepowodzeniem, Przerwana i Zawieszona) będą dostępne tylko do odczytu. String
Ukryj eksplorator dokumentów Widok Ukryj eksplorator dokumentów. Na przykład w definicji procesu biznesowego (BPD). Boolean
Wyświetl kliknięty dokument Wybierz tę opcję, aby włączyć domyślną przeglądarkę dla dokumentów po kliknięciu ich nazwy. Boolean
Włącz w widoku niestandardowym Włącz wykonywanie skryptu niestandardowego w zdarzeniu 'w przypadku zdarzenia niestandardowego widoku' po wybraniu działania menu Wyświetl. Boolean
Użyj przeglądarki dokumentów Wybierz tę opcję, aby otworzyć dokumenty we wbudowanej przeglądarce dokumentów po wybraniu działania menu Widok. Jeśli ta opcja jest wyczyszczona, dokumenty są otwierane w nowym oknie. Boolean

Właściwości konfiguracyjne wyglądu widoku Eksplorator dokumentów znajdują się w poniższej tabeli:

Tabela 7. Właściwości konfiguracyjne wyglądu elementu Eksplorator dokumentów
Właściwość konfiguracyjna wyglądu Opis Typ danych
Styl tabeli Styl tabeli tego widoku. String
Styl koloru Styl koloru tego widoku. String
Szerokość Szerokość widoku. Szerokość jest wyrażana w następujących jednostkach: px (piksele), % (wartość procentowa) lub em (firety). Na przykład: 50 px, 20% lub 0,4 em. Jeśli nie jest podana żadna jednostka, domyślnie jest używana jednostka px (piksele). String
Wysokość Wysokość widoku w px (pikslach) lub w jednostkach em. Jeśli nie jest podana żadna jednostka, domyślnie jest używana jednostka px (piksele). String
Kolumny Kolumny do wyświetlenia na liście. FileListColumn[]
Styl widoku Styl widoku (Domyślny, Nowoczesny).  
Pokaż nagłówki kolumn Wybierz tę opcję, aby włączyć wyświetlanie nagłówków kolumn dla stylu 'Domyślny'. W stylu 'Współczesny' ta opcja jest automatycznie włączana w środowisku wykonawczym. Boolean

Zdarzenia

We właściwościach Zdarzenia można ustawiać i modyfikować procedury obsługi zdarzeń widoku. Zdarzenia mogą być uruchamiane w sposób programowy lub w wyniku interakcji użytkownika z widokiem. Informacje na temat definiowania zdarzeń i kodu zdarzeń zawiera sekcja Zdarzenia zdefiniowane przez użytkownika. Widok Eksplorator dokumentów ma następujące typy procedur obsługi zdarzeń:
  • On load: aktywowano, jeśli widok został załadowany. Na przykład
    me.getRecordCount();
  • On document clicked: aktywowano po kliknięciu pliku. Na przykład
    console.log(doc.fileName)
  • On folder clicked: aktywowane po kliknięciu folderu. Na przykład
    console.log("Folder clicked: "+folder.name)
  • On delete: aktywowane po usunięciu dokumentu lub folderu. Na przykład
    console.log("Object is deleted: "+record.name)
  • On refreshed: aktywowano po odświeżeniu widoku. Na przykład
    console.log("List refreshed")
  • On error: aktywowane, gdy wystąpił błąd podczas wykonywania operacji w widoku. Na przykład
    console.log("There has been an error with the operation : "+error.action)
  • On folder rename: aktywowane po zmianie nazwy folderu. Na przykład
    console.log("Folder Renamed: "+folder.name);
  • On remove from folder: aktywowane, gdy z folderu BPM usunięto folder ECM lub odwołanie do dokumentu. Na przykład
    console.log("Object removed from BPM : "+record.name)
  • On document upload complete: aktywowane, gdy dokument został przesłany. Na przykład
    console.log("Uploaded document ID : "+documentId)
  • On reference created: aktywowane, gdy utworzono odwołanie do folderu lub dokumentu zewnętrznego. Na przykład
    console.log("Reference created : "+reference.referenceName)
  • On custom view: Aktywacja po kliknięciu dokumentu lub kliknięciu opcji menu Widok w dokumencie. Umożliwia dostosowanie widoku dokumentów w niestandardowym przeglądarce dokumentów przy użyciu skryptu niestandardowego. To zdarzenie jest włączone, jeśli wybrano opcje 'Włącz niestandardowe zdarzenie widoku' i 'Wyświetl kliknięte dokumenty'. Dodatkowy parametr: doc. Na przykład
    // This would open the document in Navigator viewer only for Case Client.
    var docObject = {};
    if(doc.id.includes("idd_")){
      docObject.id = doc.id.split("_")[1];
    }
    docObject.caseAction = "documentClicked";
    this.context.broadcastMessage(docObject);

W zależności od zdarzenia można użyć logiki JavaScript, aby zmodyfikować efekty działania widoku. Więcej informacji na temat używania zdarzeń z widokami zawiera sekcja Zdarzenia zdefiniowane przez użytkownika.

metody

Szczegółowe informacje na temat dostępnych metod dla Eksploratora dokumentów można znaleźć w sekcji Interfejs API języka JavaScript produktu Document Explorer.

Zasoby dodatkowe

Więcej informacji na temat sposobu tworzenia formatki lub strony zawiera sekcja Budowanie formatek.
Informacje na temat standardowych właściwości (Ogólne, Konfiguracja, Pozycjonowanie, Widocznośći Atrybuty HTML) można znaleźć w sekcji Właściwości widoku.
Informacje na temat innych widoków interfejsu użytkownika i zarządzania treścią znajdują się w sekcji Pakiet interfejsu użytkownika i Pakiet narzędzi do zarządzania treścią.