Dokument-Explorer

Die Ansicht 'Dokument-Explorer' zeigt Dokumente in referenzierten ECM-Ordnern und Dokumente in der Ordnerstruktur einer Prozessinstanz an Wenn Benutzer berechtigt sind, können sie Ordner suchen, erstellen, löschen und umbenennen. Sie können auch Dokumente hochladen, anzeigen, auschecken und entfernen.

Sie können die Coach-Ansicht 'Dokument-Explorer' konfigurieren, um einzelne Ordner hinzuzufügen, anzuzeigen oder zu löschen und Dokumente hinzuzufügen, anzuzeigen, auszuchecken, herunterzuladen und zu entfernen. Diese Funktionen werden vom Dokument-Explorer mithilfe von Services ausgeführt.

Wird von Benutzern ein Coach geöffnet, der eine Instanz des Dokument-Explorers enthält, wird von der Instanz der Inhalt des zugehörigen Stammordners angezeigt, wie über die Konfigurationsoptionen angegeben. Dieser Stammordner trägt die Bezeichnung Dokumente. Der Dokument-Explorer zeigt diesen Namen jedoch in einem Navigationspfad an, wenn Sie einen seiner Unterordner durchsuchen. Der Stammordner für eine Instanz des Dokument-Explorers ist instanzspezifisch. Verschiedene Instanzen können über unterschiedliche Stammordner verfügen und diese Ordner können sich an einer beliebigen Stelle im Content-Management-System befinden. Der Stammordner für den Dokument-Explorer wird auf eine der folgenden Arten festgelegt:
  • Direkt über die Angabe des jeweiligen Ordners mithilfe der Konfigurationsoption Ordner-ID. Befindet sich dieser Ordner nicht im Standardserver für Content-Management, gibt die Konfigurationsoption Servername den Server an, der den Ordner enthält.
  • Abgeleitet, indem eine Instanz-ID angegeben wird, die über einen zugehörigen Ordner und Server im Content-Management-System verfügt.
  • Abgeleitet aus dem Benutzerservicekontext, der über einen zugehörigen Ordner im Content-Management-System verfügt.
Konfigurieren Sie beispielsweise den Dokument-Explorer:
  1. Informationen zum Konfigurieren des ECM-Servers finden Sie unter ECM-Server hinzufügen.
  2. Ziehen Sie eine Dokument-Explorer-Komponente auf den Coach.
  3. Wählen Sie die Komponente aus.
  4. Klicken Sie auf Konfigurationund wählen Sie Erweitertes Content-Managementaus. Informationen zum Konfigurieren der Eigenschaften finden Sie unter Konfigurationseigenschaften und in der Beschreibung:
    • Servername: Geben Sie den ECM-Servernamen ein, den Sie soeben hinzugefügt haben.
    • Ordner-ID: Rufen Sie die ECM-Ordner-ID ab, die Sie über ACCE verwalten möchten.
    Nach dem Speichern können Sie über die Seite auf die Dokumente im Verzeichnis zugreifen und diese verwalten.

Beim Bestimmen des Stammordners wird eine bestimmte Reihenfolge eingehalten. Ein Wert in der Ordner-ID überschreibt einen Wert in der Instanz-ID. Ein Wert in der Instanz-ID überschreibt einen unter Verwendung des Benutzerservicekontexts abgeleiteten Stammordner.

Der Stammordner enthält Ordner und Dokumente (Dateien und die zugehörigen Eigenschaften). Der Inhalt, der einem Benutzer im Dokument-Explorer angezeigt wird, und der Zugriff eines Benutzers auf diesen Inhalt richten sich nach den Berechtigungen des betreffenden Benutzers im Content-Management-System. Benutzer können neuen Ordner und Dokumente hinzufügen, wenn sie über die entsprechenden Berechtigungen verfügen. Über das Aktionsmenü eines Ordners oder eines Dokuments können Benutzer eine Aktion auswählen, die für den Ordner bzw. das Dokument ausgeführt werden soll.

Tabelle 1. Ordneraktionen
Aktion Beschreibung
Offen Zeigt den Inhalt des Ordners an. Vom Dokument-Explorer wird ein Navigationspfad hinzugefügt, sodass der Benutzer zu einem übergeordneten Ordner zurückkehren kann.
Umbenennen von Benennt den Ordner um.
Löschen oder entfernen Löscht den Ordner oder die Referenz auf dem ECM-Server. Die Option 'Entfernen' löscht nur die Referenzen im Dokument-Explorer. Die Referenz auf dem ECM-Server bleibt erhalten.
Tabelle 2. Dokumentaktionen
Aktion Beschreibung
Anzeigen Zeigt den Inhalt des Dokuments im Browser an oder lädt das Dokument herunter, wenn das jeweilige Dateiformat nicht vom Browser unterstützt wird.
Herunterladen Lädt das Dokument herunter.
Eigenschaften Zeigt die dem Dokument zugeordneten Eigenschaften an. Der Dokumenttyp dient als Schablone zum Bestimmen der Eigenschaften eines angegebenen Dokuments.
In Sperrt die Datei. Nachdem eine Datei ausgecheckt wurde, können Sie eine andere Version der Datei einchecken oder die zugehörigen Eigenschaften ändern.
Einchecken oder Einchecken abbrechen Entsperrt die Datei. Verwenden Sie die Check-in-Aktion, um den Dateiinhalt zu ersetzen und seine Eigenschaften zu aktualisieren. Diese Aktionen sind nur für gesperrte Dateien verfügbar.
Löschen Entfernt das Dokument im Ordner. Im Content-Management-System bleibt das Dokument weiterhin erhalten.

Integration mit ECM-Server (Enterprise Content Management)

Für die Integration der Ansicht 'Dokument-Explorer' mit einem ECM-Server (ECM = Enterprise Content Management) muss die Prozessanwendung mit dem betreffenden Server verbunden sein. Siehe ECM-Server (Enterprise Content Management) hinzufügen. Informationen zum Erstellen von ECM-Services finden Sie unter Service erstellen, der in ein ECM-System oder einen BPM -Speicher integriert wird. Weitere Informationen finden Sie in den Abschnitten unter Dokumentunterstützung aktivieren.

Einschränkungen

Diese Ansicht unterstützt nur die Sichtbarkeitseigenschaften Required, Hidden und None .

Datenbindung

Legen Sie die Datenbindung für die Ansicht auf der Eigenschaftsregisterkarte für Allgemein fest.
Tabelle 3. Datenbindung für den Dokument-Explorer
Beschreibung Datentyp
Jede Bindung ECMDocumentInfo enthält die URL für das Dokument. ECMDocumentInfo (List)

Konfigurationseigenschaften

Sie können Konfigurationseigenschaften (z. B. Verhaltens- und Darstellungseigenschaften) für die Ansicht über die Eigenschaftsregisterkarte für Konfiguration festlegen oder ändern.
Anzeigegröße
Eine Konfigurationseigenschaft mit dem Symbol für Anzeigegrößen Das Symbol für Anzeigegrößen neben dem Eigenschaftsnamen kann für jede Anzeigegröße unterschiedliche Werte aufweisen. Wenn Sie keinen Wert festlegen, wird der Wert der nächst größeren Anzeigegröße als Standardwert für die Anzeigegröße übernommen.

Die Content-Management-Konfigurationseigenschaften für die Ansicht 'Dokument-Explorer' werden in der folgenden Tabelle aufgeführt:

Tabelle 4. Content-Management-Eigenschaften für das Element 'Dokument-Explorer'
Content-Management-Eigenschaft Beschreibung Datentyp
Letzte aktualisierte Dokument-ID Die Dokument-ID des Dokument, das erstellt oder aktualisiert wurde. ECMID
Standardeigenschaften für ECM-Dokument Die mit diesem Dokument hochzuladenden entsprechenden Eigenschaften. ECMDefaultProperty[]
BPM-Eigenschaften hinzufügen Standardmäßig werden für neue BPM-Dokumente keine Eigenschaften hinzugefügt. Wenn Sie diese Konfigurationsoption aktivieren, werden die Eigenschaften hinzugefügt, die in der Konfigurationsoption BPM-Eigenschaften hochladen definiert sind. Wenn Sie steuern möchten, wann die Eigenschaften zu dem Dokument hinzugefügt werden, binden Sie diese Konfigurationsoption an eine Variable. Boolean
BPM-Eigenschaften hochladen Wenn Sie BPM-Eigenschaften hochladen ausgewählt haben, werden Sie voraussichtlich diese Eigenschaften dem Dokument zuordnen wollen. NameValuePair[]
Im Portal ausblenden Anzeige des Dokuments in Process Portalverhindern. Boolean

Die erweiterten Content-Management-Konfigurationseigenschaften für die Ansicht 'Dokument-Explorer' werden in der folgenden Tabelle aufgeführt:

Tabelle 5. Erweiterte Content-Management-Eigenschaften für das Element 'Dokument-Explorer'
Erweiterte Content-Management-Eigenschaft Beschreibung Datentyp
Instance ID Zeigt die Liste der Dokumente und Ordner zur Instanz-ID an. Wenn die Eigenschaft Ordner-ID konfiguriert ist, wird die Instanz-ID-Konfiguration ignoriert. Ist weder die Eigenschaft Ordner-ID noch die Eigenschaft Instanz-ID konfiguriert, wird die Ordner-ID vom Benutzerservicekontext abgeleitet. Für clientseitige Benutzerservices werden die Eigenschaften tw.system.processInstance.id und tw.system.processInstance.processInstanceFolderId für den Kontext verwendet. Für Heritage-Benutzerservices werden die Eigenschaften tw.system.currentProcessInstance.id und tw.system.currentProcessInstance.processInstanceFolderId für den Kontext verwendet. String
Server Name Ist eine Ordner-ID konfiguriert, dann verwenden Sie den Namen des externen ECM-Servers. Der Servername kann in das Feld eingegeben werden. Sie können auch eine Variable verwenden, die für den Servernamen steht, und die Variable zu diesem Feld hinzufügen. Überprüfen Sie bei dem Namen eines externen ECM-Servers die Seite 'Einstellungen für Prozessanwendungen', auf der die verfügbaren externen ECM-Systeme angezeigt werden.

Wenn Sie mit den internen ECM-Content-Repositorys arbeiten-dem verwalteten BPM -Speicher, dem BPM -Content-Storeoder dem BPM -Dokumentspeicher -sind Konstanten für sie verfügbar. Beispiel: ECMServerNames.IBM_BPM_MANAGED_STORE.

String
Ordner-ID Zeigt die Liste der Dokumente und Ordner zur Ordner-ID an. Ist diese Eigenschaft konfiguriert, wird die Instanz-ID ignoriert. Wenn die Eigenschaft Ordner-ID nicht konfiguriert ist, wird die Ordner-ID von der zugehörigen Instanz-ID-Konfiguration abgeleitet. Falls eine Instanz-ID nicht angegeben ist, wird die Ordner-ID vom Benutzerservicekontext abgeleitet. Für clientseitige Benutzerservices werden die Eigenschaften tw.system.processInstance.id und tw.system.processInstance.processInstanceFolderId für den Kontext verwendet. Für Heritage-Benutzerservices werden die Eigenschaften tw.system.currentProcessInstance.id und tw.system.currentProcessInstance.processInstanceFolderId für den Kontext verwendet. String
Übergeordneten Fallordner anzeigen Zeigen Sie den Inhalt der übergeordneten Fallinstanz an. Diese Option ist nur für Prozessinstanzen in einer Falllösung gültig, die über Case Builder erstellt wurden. Wenn diese Option ausgewählt ist, werden die Felder Servername, Instanz-ID und Ordner-ID ignoriert. Boolean

Die Verhaltenskonfigurationseigenschaften für die Ansicht 'Dokument-Explorer' werden in der folgenden Tabelle aufgeführt:

Tabelle 6. Verhaltenskonfigurationseigenschaften für 'Dokument-Explorer'
Verhaltenskonfigurationseigenschaft Beschreibung Datentyp
Fußzeile anzeigen Fußzeile anzeigen. Boolean
Tabellenstatistik anzeigen Tabellenstatistik anzeigen (Beispiel: Eintrag 1 bis 5 von 59 anzeigen). Boolean
Pager anzeigen Pager anzeigen. Boolean
Anfangsgröße der Seite Anfängliche maximale Anzahl von pro Seite anzuzeigenden Einträgen. Integer
Bestätigung beim Löschen Bestätigungsdialog vor dem Löschen von Dateien anzeigen. Boolean
Dokumentanzeigefunktion verwenden Öffnet Dokumente in einer integrierten Dokumentanzeige, wenn das Menüelement Ansicht ausgewählt ist. Wenn diese Option nicht aktiviert ist, werden Dokumente in einem neuen Fenster geöffnet. Boolean
Ausblendbar Die Ansicht 'Dokument-Explorer' kann ausgeblendet werden. Boolean
Anfänglich ausgeblendet Die Ansicht 'Dokument-Explorer' wird ausgeblendet, sobald die Ansicht geöffnet wird. Boolean
Aktualisierungsauslöser Gibt an, ob der Inhalt der Ansicht aktualisiert werden kann. Binden Sie diese Eigenschaft an eine private boolesche Variable. Wenn sich der Wert der gebundenen Variablen in 'true' ändert, wird die Ansicht aktualisiert. Nach Aktualisierung der Sicht ändert sich der Wert der Variablen wieder in 'false'. Boolean
Service für den Abruf zugehöriger ECM-Ordner Ruft die Ordnerinformationen für die ECM-Server ab, die auf der Seite 'Prozessanwendungseinstellungen' aufgelistet sind Default Get Related ECM Folders Service
Instance Status Gibt an, ob der Dokument-Explorer bearbeitbar oder schreibgeschützt ist. Laut Status aktive Instanzen können bearbeitet werden. Instanzen mit anderen Statuswerten, z. B. abgeschlossene, fehlgeschlagene, beendete oder ausgesetzte Instanzen, sind schreibgeschützt. String
Dokument-Explorer ausblenden Blendet die Ansicht 'Dokument-Explorer' aus. Beispielsweise für eine Geschäftsprozessdefinition (BPD). Boolean
Angeklicktes Dokument anzeigen Wählen Sie diese Option aus, um den Standard Viewer für Dokumente zu aktivieren, wenn Sie auf ihren Namen klicken. Boolean
Für angepasste Ansicht aktivieren Aktivieren Sie die Ausführung eines angepassten Scripts im Ereignis "Bei angepasster Ansicht", wenn die Menüaktion "Ansicht" ausgewählt ist. Boolean
Dokumentanzeige verwenden Wählen Sie diese Option aus, um Dokumente in einem integrierten Dokument Viewer zu öffnen, wenn die Menüaktion "Ansicht" ausgewählt ist. Wenn diese Option abgewählt ist, werden Dokumente in einem neuen Fenster geöffnet. Boolean

Die Darstellungskonfigurationseigenschaften für die Ansicht 'Dokument-Explorer' werden in der folgenden Tabelle aufgeführt:

Tabelle 7. Darstellungskonfigurationseigenschaften für das Element 'Dokument-Explorer'
Darstellungskonfigurationseigenschaft Beschreibung Datentyp
Tabellenstil Der Tabellenstil für diese Sicht String
Farbstil Der Farbstil für diese Ansicht. String
Breite Die Breite der Ansicht Sie können die Breite in px- (Pixel), %- (Prozent) oder em-Einheiten angeben. Beispiel: 50px, 20% oder 0.4em. Wenn kein Einheitentyp angegeben wird, wird px angenommen. String
Höhe Die Höhe der Ansicht in Pixel oder em-Einheiten. Wenn kein Einheitentyp angegeben wird, wird 'px' angenommen. String
Spalten Die in der Liste anzuzeigenden Spalten. FileListColumn[]
Ansichtsstil Der Stil der Ansicht (Standard, Modern)  
Spaltenüberschriften anzeigen Wählen Sie diese Option aus, um die Anzeige der Spaltenüberschriften für den Ansichtsstil 'Standard' zu aktivieren. Im Ansichtsstil 'Modern' wird diese Option zur Laufzeit automatisch aktiviert. Boolean

Ereignisse

Sie können die Ereignishandler für die Ansicht in den Eigenschaften für Ereignisse festlegen oder bearbeiten. Sie können Ereignisse festlegen, die programmgesteuert oder dann ausgelöst werden, wenn ein Benutzer mit der Ansicht interagiert. Informationen zum Definieren und Codieren von Ereignissen finden Sie unter Benutzerdefinierte Ereignisse. Die Ansicht 'Dokumentexplorer' verfügt über folgende Typen von Ereignishandlern:
  • On load: Aktivierung erfolgt beim Laden der Ansicht. Beispiel:
    me.getRecordCount();
  • On document clicked: Aktivierung erfolgt beim Klicken auf eine Datei. Beispiel:
    console.log(doc.fileName)
  • On folder clicked: Aktivierung erfolgt beim Klicken auf einen Ordner. Beispiel:
    console.log("Folder clicked: "+folder.name)
  • On delete: Aktivierung erfolgt beim Löschen eines Dokuments oder Ordners. Beispiel:
    console.log("Object is deleted: "+record.name)
  • On refreshed: Aktivierung erfolgt beim Aktualisieren der Ansicht. Beispiel:
    console.log("List refreshed")
  • On error: Aktivierung erfolgt bei einem Fehler während der Ausführung von Operationen in der Ansicht. Beispiel:
    console.log("There has been an error with the operation : "+error.action)
  • On folder rename: Aktivierung erfolgt beim Umbenennen eines Ordners. Beispiel:
    console.log("Folder Renamed: "+folder.name);
  • On remove from folder: Aktivierung erfolgt, wenn ein ECM-Ordner oder eine Dokumentreferenz aus einem BPM-Ordner entfernt wird Beispiel:
    console.log("Object removed from BPM : "+record.name)
  • On document upload complete: Aktivierung erfolgt beim Hochladen eines Dokuments. Beispiel:
    console.log("Uploaded document ID : "+documentId)
  • On reference created: Aktivierung erfolgt beim Erstellen einer Referenz auf einen externen Ordner oder ein externes Dokument. Beispiel:
    console.log("Reference created : "+reference.referenceName)
  • On custom view: Aktivierung erfolgt beim Klicken auf ein Dokument oder beim Klicken auf die Menüoption "Ansicht" im Dokument Ermöglicht die Anpassung zum Anzeigen von Dokumenten in einem benutzerdefinierten Dokumentviewer mithilfe eines benutzerdefinierten Scripts. Dieses Ereignis ist aktiviert, wenn die Konfigurationsoptionen 'Bei angepasstem Ansichtsereignis aktivieren' und 'Angeklicktes Dokument anzeigen ' ausgewählt sind. Zusätzlicher Parameter: doc. Beispiel:
    // 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);

Abhängig vom Ereignis können Sie JavaScript-Logik verwenden, um die Wirkungsweise der Ansicht zu ändern. Weitere Informationen zur Verwendung von Ereignissen mit Ansichten enthält der Abschnitt Benutzerdefinierte Ereignisse.

Methoden

Ausführliche Informationen zu den verfügbaren Methoden für das Element 'Dokumentexplorer ' finden Sie unter Dokument-Explorer JavaScript API.

Weitere Ressourcen

Informationen zum Erstellen eines Coach oder einer Seite finden Sie unter Coaches erstellen.
Informationen zu Standardeigenschaften (Allgemein, Konfiguration, Positionierung, Sichtbarkeitund HTML-Attribute) finden Sie unter Eigenschaften anzeigen.
Informationen zu anderen Ansichten für Benutzerschnittstelle und Content-Management finden Sie unter Benutzerschnittstellen-Toolkit und Content-Management-Toolkit.