Konfigurieren der Ergebnisliste in der "config.xml"-Datei

In diesem Thema finden Sie alles rund ums Konfigurieren der Ergebnisliste zum Anzeigen der relevanten Daten aus d.velop documents. Sie lernen die Standardstruktur der XML-Datei kennen und erhalten weitere Informationen mit Blick auf Ihre Konfiguration.

Sie finden die Datei config.xml im Ordner ../edoc SHCware d.velop documents connect/SHC_Link.API.

Wissenswertes zum Aufbau und den Konfigurationsblöcken in der XML-Datei

Die Datei besteht aus zwei Stammebenen (root levels):

D3Settings (Ebene): Geben Sie die entsprechenden Daten für d.velop documents an.
SHCSettings (Ebene): Übernehmen oder bearbeiten Sie die Daten für SHCware.

CODE

<?xml version="1.0" encoding="utf-8" ?>
<Config>
  <D3Settings>
  </D3Settings>
  <SHCSettings>
  </SHCSettings>
</Config>

Zu ignorierende d.velop documents-Eigenschaften im Abschnitt “IgnoredD3Values"

Im Abschnitt IgnoredD3Values können Sie Folgendes tun:

Im XML-Block Item können Sie Systemeigenschaften (allgemeine Eigenschaften) der Kategorien (Dokumentarten) angeben, die in der Ergebnisliste zu einem Dokument nicht angezeigt werden sollen. Standardmäßig werden folgende Eigenschaften ausgeblendet: lastModified, eTag, created, lastAccess, mimeType
Im XML-Block DisplayProperties können Sie allgemeine Eigenschaften angeben, die in der Ergebnisliste nicht als Spalten angezeigt werden sollen. Prüfen Sie für Ihren Anwendungsfall, welche Spalten nicht in der Ergebnisliste angezeigt werden sollen.

Beispiel für “IgnoredD3Values”

XML

...
<D3Settings>
  <IgnoredD3Values>
    <Item>
      LastModified,
      ETag,
      Created,
      LastAccess,
      MimeType
    </Item>
    <Properties>
      Editor
    </Properties>
  </IgnoredD3Values>

Beispiel für die JSON-Übergabe von d.velop documents

Das Beispiel zeigt Ihnen die möglichen Werte für IgnoredD3Values auf und zeigt beispielhafte Inhalte zum besseren Verständnis für Items und Properties.

JSON

...
  "lastModified": "2021-09-14T16:59:07.000+02:00",
  "eTag": "\"MjAyMS0wOS0xNFQxNjo1OTowNy4wMDArMDI6MDB8MjAyMS0wOS0xNFQxNjo1OTowNy4wMDArMDI6MDB8UmVsZWFzZWR8\"",
  "created": "2021-09-14T16:59:07.000+02:00",
  "lastAccess": "2021-09-14T16:59:07.000+02:00",
  "mimeType": "application/pdf",
  "displayProperties": [
    {
       "name": "Editor",
       "displayValue": "",
       "id": "property_editor",
       "dataType": 0,
       "value": ""
    },
...

Anzuzeigende d.velop documents-Eigenschaften im Abschnitt “WhitelistedD3Properties"

Im Abschnitt WhitelistedD3Properties können Sie pro Kategorie (Dokumentart) die erweiterten Eigenschaften angeben, die angezeigt werden sollen. Wenn Sie eine Einschlussliste verwenden, werden ausschließlich die gelisteten erweiterten Eigenschaften zur jeweiligen Kategorie in der Ergebnisliste angezeigt.

Sie können z.B. folgende Szenarien pro Kategorie implementieren:

Alle Dokumenteigenschaften anzeigen: In diesem Fall tragen Sie unter <WhitelistedD3Properties> nichts ein (der beispielhafte Eintrag bleibt auskommentiert).
Pro Kategorie nur bestimmte Dokumenteigenschaften anzeigen: In diesem Fall tragen Sie unter <WhitelistedD3Properties> in der <DisplayProperties documentType="XX">-Eigenschaftsliste das Kürzel der Dokumentart ein und listen die Eigenschaften auf, die Sie anzeigen möchten. Geben Sie pro Kategorie eine eigene <DisplayProperties documentType="XX">-Eigenschaftsliste ein.

Geben Sie in den jeweiligen XML-Blöcken die Feld-IDs der aufzulistenden erweiterten Eigenschaften aus d.velop documents an.

Beispiel für “WhitelistedD3Properties”

XML

...
</IgnoredD3Values>
<WhitelistedD3Properties>
  <DisplayProperties documentType="BE">
    1,
    10,
    12,
    15,
    17
  </DisplayProperties>
</WhitelistedD3Properties>

Beispiel für die JSON-Antwort von d.velop documents

JSON

...
"displayProperties": [
{
  "name": "Betrieb",
  "displayValue": "2067754",
  "id": "15",
  "dataType": 0,
  "value": "2067754"
},

Verhalten der Suche im Abschnitt “SearchOptionParameters"

Im Abschnitt SearchOptionsParameters können Sie einzelne SearchOptions-Parameter definieren, mit denen Sie das Verhalten der Suche global und pro Kategorie (Dokumentart) steuern.

Sie haben im Abschnitt SearchOptionsParameters folgende Optionen:

SearchOptions documentType: Der Optionsblock mit dem Optionstyp default muss immer vorhanden sein. Der Optionstyp steuert das globale Verhalten der Suche und Ergebnisliste beim Auffinden von Dokumenten unabhängig von der Kategorie. Erstellen Sie einen zweiten Optionsblock, wenn Sie das Verhalten für eine bestimmte Kategorie anders definieren möchten. Geben Sie statt default das Kürzel der Kategorie ein.
openSingleDocument: Dieser Optionstyp steuert, dass bei einer Suche mit nur einem Dokument im Ergebnis das Dokument sofort geöffnet wird, und zwar mit der bei defaultOpenDocument angegebenen Methode.
closeDocumentSurvey: Mit dieser Option wird die Ergebnisliste automatisch geschlossen, wenn nur ein Dokument in der Suche gefunden wurde. Diese Option können Sie in Kombination mit openSingleDocument nutzen.
defaultOpenDocument: Mit dieser Option legen Sie fest, mit welcher der Optionen das Dokument geöffnet wird, wenn ein Benutzer in der Ergebnisliste auf eine Ergebniszeile und nicht auf einen der Optionen unter Öffnen klickt. Sie können folgende Optionen verwenden:
- OpenD3One: Das Dokument wird in d.3one (d.velop documents-Webclient) geöffnet.
- OpenD3App: Das Dokument wird in d.3 smart explorer (d.velop documents-Desktopanwendung) geöffnet.
- ForceDownload: Das Dokument wird direkt heruntergeladen und im Browser geöffnet.

XML

...
</WhitelistedD3Properties>
<SearchOptionsParameters>
  <SearchOptions documentType="default">
    documentItems->{items},
    openSingleDocument,
    <!--closeDocumentSurvey,-->
    <!--defaultOpenDocument->OpenD3One-->
    <!--defaultOpenDocument->OpenD3App-->
    defaultOpenDocument->ForceDownload
  </SearchOptions>
  <SearchOptions documentType="LI">
    documentItems->{items},
    openSingleDocument,
    <!--closeDocumentSurvey,-->
    defaultOpenDocument->OpenD3One
    <!--defaultOpenDocument->OpenD3App-->
    <!--defaultOpenDocument->ForceDownload-->
  </SearchOptions>
</SearchOptionsParameters>

Weitere d.velop documents-Einstellungen im Abschnitt “D3Settings"

Im Abschnitt D3Settings finden Sie des Weiteren folgende Funktionen, die Sie übernehmen oder an Ihre Anforderungen anpassen können:

MaxSearchItems: Legen Sie mit dieser Option die maximale Anzahl der Ergebnisse fest, die in der Ergebnisliste angezeigt werden sollen. Standardwert: 50.
PropertySortField: Legen Sie das Feld fest, anhand dessen die Ergebnisse in der Ergebnisliste sortiert werden sollen. Standardwert ist das Datum, an dem das Dokument zuletzt bearbeitet wurde.
PropertySortingAsc: Geben Sie an, ob die Ergebnisse in der Ergebnisliste auf- oder absteigend sortiert werden sollen. Standardwert: false. In Kombination mit PropertySortField werden die zuletzt bearbeiteten Dokumente zuerst angezeigt.
D3RequestLogFolder: Geben Sie in dieser Option den Verzeichnisnamen an, in dem die Dateien zum Protokollieren der d.velop documents-Ergebnisse gespeichert werden. Das Verzeichnis wird automatisch unter SHC_Link.API erstellt. Die Dateien werden 24 Stunden gespeichert und sind z.B. bei einer Fehleranalyse hilfreich.

XML

...
  </SearchOptionsParameters>
  <MaxSearchItems>50</MaxSearchItems>
  <PropertySortField>property_last_modified_date</PropertySortField>
  <PropertySortingAsc>false</PropertySortingAsc>
  <GetAllPages>false</GetAllPages>
  <D3RequestLogFolder>D3RequestLogging</D3RequestLogFolder>
</D3Settings>

Einstellungen im Abschnitt “SHCSettings"

Im Abschnitt SHCSettings finden Sie folgende Funktionen, die Sie übernehmen oder an Ihre Anforderungen anpassen können:

SHCXSLFilePath: Geben Sie den Namen des Unterordners im Installationspfad für die XSL-Datei an, die für die Suche in d.velop documents verwendet wird. Mit dieser Funktion stellen Sie sicher, dass das Suchformular angezeigt wird.
SHCRequestLogFolder: Geben Sie in dieser Option den Verzeichnisnamen an, in dem die Dateien zum Protokollieren der SHCware-Ergebnisse gespeichert werden. Das Verzeichnis wird automatisch unter SHC_Link.API erstellt. Die Dateien werden 24 Stunden gespeichert und sind z.B. bei einer Fehleranalyse hilfreich.

CODE

<SHCSettings>
  <SHCXSLFilePath>SHCRequests</SHCXSLFilePath>
  <SHCRequestLogFolder>SHCRequestLogging</SHCRequestLogFolder>
</SHCSettings>