Ab der DocFarm Edition Standard ist die Nutzung der REST-Schnittstelle für externe Anwendungen möglich. Mit der REST-Schnittstelle können externe Anwendungen direkt auf DocFarm zugreifen und Dokumente archivieren, auflisten, anzeigen, suchen, Eigenschaften abrufen/ändern und Zusatzfelder anlegen und bearbeiten. Somit lässt sich ein Teil der DocFarm-Funktionen direkt in externe Anwendungen integrieren.
Damit ein externer Zugriff auf DocFarm möglich ist, muss in DocFarm die externe Anwendung zunächst eingerichtet werden.
Klicken Sie im System-Menü von DocFarm auf Einstellungen um den gleichnamigen Dialog zu öffnen. Auf der Lasche Sonstiges können Sie grundsätzliche Einstellungen des DocFarm Systems konfigurieren.
Klicken Sie im linken Bildschirmbereich auf den Eintrag Externe Anwendungen:
•Klicken Sie auf Neu um eine neue externe Anwendung anzulegen:
•Geben Sie den Namen der externen Anwendung ein.
•Mit der Option Aktiv können Sie festlegen, ob die externe Anwendung auf DocFarm zugreifen darf.
•Klicken Sie auf Speichern.
•DocFarm erzeugt daraufhin einen Schnittstellenschlüssel, der anschließend in der Liste der externen Anwendungen angezeigt wird.
•Wenn Sie die externe Anwendung noch einmal zur Bearbeitung öffnen, wird ebenfalls der Schnittstellenschlüssel angezeigt:
•Mit dem Button Kopieren 
können Sie den Schnittstellenschlüssel in die Zwischenablage kopieren.
•Der Schnittstellenschlüssel muss anschließend in Ihrer jeweils verwendeten externen Anwendung, welche DocFarm unterstützt, hinterlegt werden. Fragen Sie dazu den Anbieter der externen Anwendung.
|
Legen Sie in jedem Fall für jede einzelne externe Anwendung, die DocFarm unterstützt, einen separaten Schnittstellenschlüssel an. Dies dient einerseits für DocFarm zur Unterscheidung über welche Anwendung ein Dokument archiviert wurde und andererseits benötigen die verschiedenen externen Anwendungen ggf. unterschiedliche Zuordnungsmerkmale (z.B. Kundennummer, etc.) welche von Anwendung zu Anwendung unterscheidbar sein müssen.
