Dieser Artikel beschreibt die Möglichkeiten und technischen Details für einen direkten Aufruf eines Dokuments oder einer Dokumentsuche.


INHALTSVERZEICHNIS


Basisdaten

Die Basis-URL beinhaltet den Servernamen und die Bezeichnung der IIS-Applikation (Standard "ArchivPortal"). Je nach IIS-Konfiguration sind Aufrufe per HTTP oder HTTPS möglich.


https://servername.domain.local/ArchivPortal


Authentifizierung

Standardmäßig werden die Anmeldedaten über den Login-Dialog abgefragt. Falls eine automatische Anmeldung per Windows-Authentifizierung gewünscht ist, muss der zusätzliche Parameter "auth=sso" angegeben werden.


https://servername.domain.local/ArchivPortal/?auth=sso


Aufruf eines einzelnen Dokuments

Für den direkten Aufruf eines Dokuments ist nur ein URL-Parameter "docid" notwendig. Diese Dokument-ID erhalten Sie z.B. bei der Übergabe eines Dokuments per API oder über die Module des Document Processor CORE. In der ArchivPortal-Oberfläche können Sie einen solchen Link inkl. Dokument-ID über den Menüpunkt "Teilen" erzeugen.


https://servername.domain.local/ArchivPortal/?documentID=e1faa4cb-27c9-495a-b2b7-688e7d3f07c8


Aufruf der einfachen Suche

Die Parameter "page=home" und "search=true" sind immer anzugeben. Zur Ausführung einer einfachen Suche muss der Suchbegriff über den Parameter "SearchValue" mitgegeben werden.


https://servername.domain.local/ArchivPortal/?page=home&search=true&searchvalue=Hase


Volltextsuche

Mit dem Parameter "Fulltextsearch=true" wird bewirkt, dass der Suchbegriff auch in den Inhalten der PDF-, TIFF- und E-Mail-Dokumente gesucht wird.


https://servername.domain.local/ArchivPortal/?page=home&search=true&searchvalue=Hase&fulltextsearch=true


Exakte Suche

Ist keine Teilwortsuche gewünscht, kann diese über den Parameter "exact=true" deaktiviert werden. Bei der Teilwortsuche darf ein Suchbegriff auch als Teil eines Begriffes in einem Attribut oder im Volltext vorkommen. Bei der exakten Suche muss der Suchbegriff für sich allein stehen.


https://servername.domain.local/ArchivPortal/?page=home&search=true&searchvalue=Hase&exact=true


Vor der Version 1.12 fand die einfache Suche standardmäßig "exakt" statt und musste bei Bedarf mit Platzhaltern (z.B. *) ergänzt werden. Diese Funktionalität wurde aus Gründen der Benutzerfreundlichkeit mit der Version 1.13 umgekehrt. D.h. es findet immer eine Teilwortsuche statt. Nur wenn dies explizit nicht gewünscht ist, kann und muss die exakte Suche aktiviert werden.


Aufruf der erweiterten Suche

Es können komplexe Suchen über einen URL-Aufruf geladen und gestartet werden. Hierfür stehen je nach gewünschter Funktionsweise unterschiedliche Parameter zur Verfügung. Die Parameter "page=home" und "search=true" sind immer anzugeben.


https://servername.domain.local/ArchivPortal/?page=home&search=true


Template-ID

Für den direkten Aufruf einer erweiterten Suche muss zwingend eine passende Suchvorlage vorhanden sein. Falls ein Aufruf von unterschiedlichen Anwendern genutzt werden soll, muss es sich um eine globale Suchvorlage handeln.


In der URL ist die ID der Suchvorlage anzugeben. Diese können Sie im Dialog der erweiterten Suche unten links ermitteln:



https://servername.domain.local/ArchivPortal/?page=home&search=true&searchtemplate=07ea689a-a99c-4096-89f1-73eb17038306 


Suchbegriffe

In einer Suchvorlage sind ein oder mehrere Attribute konfiguriert. Zum Füllen dieser Attribute mit den passenden Suchbegriffen muss in der URL je Attribut ein Parameter mitgegeben werden. Dabei entspricht der Name des Parameters der Bezeichnung des Attributs. Der Wert des Parameters enthält einen oder mehrere Suchbegriffe.


Die Angabe eines einzelnen Suchbegriffs erfolgt über die Angabe "Bezeichnung=Wert". Wenn in einem Attribut nach mehreren Begriffen gesucht werden soll, müssen diese Werte mit eckigen Klammern und kommasepariert angegeben werden ("Bezeichnung=[Wert,Wert2,Wert3]").


Wie mehrere Attribute und/oder Werte miteinander verknüpft werden sollen, ist über die entsprechenden Operatoren (Und/Oder) in der Suchvorlage zu konfigurieren.


https://servername.domain.local/ArchivPortal/?page=home&search=true&searchtemplate=07ea689a-a99c-4096-89f1-73eb17038306&Kreditornummer=70001&Projektnummer=[11111,22222,33333]


Die Suche nach mehreren Werten in einem Attribut steht erst ab Version 1.13 zur Verfügung.


Direkte Ausführung

Standardmäßig wird über die bisher aufgeführten Beispiel-Links nur der Dialog der erweiterten Suche geöffnet und die Attributfelder werden mit Werten gefüllt. Der Anwender kann diese Werte kontrollieren/anpassen und manuell die Suche starten.


Ist jedoch eine automatische Ausführung der Suche gewünscht, muss der Parameter "Execute=true" angegeben werden.


https://servername.domain.local/ArchivPortal/?page=home&search=true&searchtemplate=07ea689a-a99c-4096-89f1-73eb17038306&Kreditornummer=70001&Projektnummer=[11111,22222,33333]&execute=true


Dokument automatisch öffnen


Als Ergebnis werden wie gewohnt die Kategorien durchsucht und Suchergebnisse in Listenform angezeigt.


Für den Fall, dass genau 1 Dokument gefunden wird, kann über den Parameter "AutoOpen=true" gesteuert werden, ob dieses eine Dokument direkt geöffnet werden soll.


https://servername.domain.local/ArchivPortal/?page=home&search=true&searchtemplate=07ea689a-a99c-4096-89f1-73eb17038306&Kreditornummer=70001&Projektnummer=[11111,22222,33333]&execute=true&autoopen=true


Der Parameter "AutoOpen=true" steht erst ab Version 1.13 zur Verfügung.