inoxision ARCHIVE 2.5 Integrationsclient

Transkript

1 inoxision ARCHIVE 2.5 Integrationsclient

2 inoxision ARCHIVE Mit dem inoxision ARCHIVE Integrationsclient besteht die Möglichkeit eine Verbindung zwischen anderen kaufmännischen Softwarelösungen und der Archivierung zu schaffen. So können Sie z.b. direkt aus einer Warenwirtschaft-, CRM- oder Finanzbuchhaltungssoftware zu recherchieren oder einen Scanprozess zu starten. Der Integrationsclient besteht aus zwei Komponenten: ARCHIVEexecute und ARCHIVEsearch. Bei beiden Programmen handelt es sich um Kommandozeilen-orientierte Programme. Ihr Aufruf erfolgt unter der Angabe einer Steuerdatei, welche die Verarbeitungsbefehle beinhaltet. Das folgende Beispiel zeigt einen Aufruf von ARCHIVEexecute über die Windows Kommandozeilenumgebung CMD. Die Steuerdatei befindet sich dabei im Verzeichnis TEMP und lautet suche.ixs. c: cd "\Program Files\INOXISION ARCHIVEgate\" ARCHIVEexecute C:\TEMP\suche.ixs Listing 1: Ausführen von ARCHIVEexecute Der Dateiname der Steuerdatei kann beliebig gewählt werden. Tip 1 (Ausführen in). Beachten Sie beim Ausführen des Integrationsclients, dass das Ausgangsverzeichnis das inoxision ARCHIVEgate Programmverzeichnis ist. 1 ARCHIVEexecute 1.1 Verschlagwortung - Execute Zu Beginn einer Steuerdatei wird die Sektion bestimmt. Die Angabe erfolgt dabei in eckigen Klammern. Für die Verschlagwortung ist die Sektion Execute zuständig, womit die erste Zeile einer solchen Steuerdatei wie folgt lautet: [Execute] InputType=IMAGE InputPath=C:\Workflow\Server\Eingang InputPattern=*.BMP Listing 2: Beispiel Definition einer Skriptsektion Tip 2 (Mehrere Sektionen). Innerhalb einer Steuerdatei kann entweder nur eine Execute oder eine Search Sektion eingetragen werden. 1

3 inoxision ARCHIVE 1.1 Verschlagwortung - Execute InputType Tabelle 1: Sektion [Execute] Definiert den Ursprung der Dateien für die Verarbeitung. Mögliche Werte sind: IMAGE - Verarbeitung von vorhandenen Bilddateien. BINARY - Verarbeitung von vorhandenen Dateien. COLD - Über einen Rendere werden Druckerspooldateien verarbeitet. SCANNER - Dateien werden über den Scanner bereitgestellt. InputPath Gibt den Speicherort der Dokumente an. Quellverzeichnis muss entweder einen Laufwerkbuchstaben oder einen Pfad enthalten. InputPattern Dateinamenmuster für die suche nach Dokumenten im angegebenen Quellverzeichnis (z.b.: *.BMP;*.JPG;*.JPEG;... ). AutoExecute Bewirkt, dass die Verarbeitung nach Aufruf der Anwendung automatisch gestartet wird (1/0). SwapProcess Bewirkt, dass die Verarbeitung an einem Workflowserver ausgelagert wird (1/0). BatchEnabled Archivierung in Stapelverarbeitungsmodus (1/0). SearchPanelVisible Quellverzeichnis und Dateinamenmuster anzeigen (1/0). CreateFullTextChecked Bei archivieren Volltext über die einzelne Seiten generieren (1/0). ExtraFullTextVisible Dokumentenvolltext anzeigen (1/0). ExtraFullTextValue *f Vorbelegung für Dokumentenvolltext. KeywordGridVisible Schlagworttabelle anzeigen (1/0). KeywordValues *f Vorbelegung der Schlagwörter (z.b.: _belegdaten.adressnummer _belegdaten.belegnummer ) UsePreviousArchive Verwende zuletzt verwendetes Archiv (1/0). OutputType Zielsystem für die Verarbeitung. Mögliche Werte sind: ARCHIVE - Die Dokumente werden in das angegebene Archiv archiviert. OutputArchiveName OutputArchiveUser OutputArchivePass Archivname in das die Dokumente Archiviert werden. Benutzername für die Archivanmeldung. Passwort für die Archivanmeldung. Tip 3 (*f). Die mit *f gekennzeichneten Schlüssel können auch als Fragmente angegeben werden. Bei lesen der Parameterdatei werden die einzelne Schlüsselfragmente zu einem Wert zusammengefasst. Beispiel: KeywordValues=belegdaten.Adressnummer belegdaten.belegnummer KeywordValues#0=belegdaten.Adressnummer KeywordValues#1= belegdaten.belegnummer

4 Im folgenden Beispiel werden alle Bitmap Dateien aus dem angegebenen Verzeichnis automatisch verschlagwortet. Die Angabe von SwapProcess=1 sorgt dafür, dass eine die Erzeugung des Volltextes auf einen Workflow Server ausgelagert wird: [Execute] InputType=IMAGE InputPath=C:\Workflow\Server\Eingang InputPattern=*.BMP AutoExecute=1 OutputArchiveName=Adpt_Demo KeywordValues=KeywordValues=_belege.Belegnummer _belege.datum _belege. Belegart Lieferschein SwapProcess=1 CreateFullTextChecked=1 Listing 3: Beispiel einer automatischen Verschlagwortung 1.2 Recherche - Search Über die Sektion Search kann im Archiv recherchiert werden. Dabei sind sowohl vollautomatische Recherchen möglich, also auch manuelle Recherche mit Eingabe des Suchbegriffes. Die Verwendung von AutoExecute=1 bewirkt, dass eine Recherche sofort ausgeführt wird. Wird der Wert auf 0 gesetzt, so erscheint das gewohnte Eingabeformular einer Recherchemaske. 3

5 SearchType Tabelle 2: Sektion [Search] Definiert die Art der Suchanfrage für die Verarbeitung. Mögliche Werte sind: MASK - Eine eingeblendete Suchmaske ermöglicht eine gezielte Suche nach Werten in den entsprechenden Feldern. FULLTEXT - Recherche nach Dokumente über eine Volltextsuche. SearchArchiveName AutoExecute SearchFields *f SearchFieldsLabel *f HiddenSearchFields *f FullText Operator Archivname in das die Dokumente gesucht werden. Bewirkt, dass die Verarbeitung nach Aufruf der Anwendung automatisch gestartet wird (1/0). Vorbelegung der Schlagwörter (z.b.: _belegdaten.adressnummer _belegdaten.belegnummer ) mit der die Suche durchgeführt wird. Standardmäßig werden die Bezeichnungen für die Eingabefelder auf Basis der Schlagwörter gebildet. Über diesen Parameter können Abweichende Bezeichnung (z.b.: _belegdaten.adressnummer Adressnr. _belegdaten.belegnummer Belegnr. ) angegeben werden. Ausgeblendete Schlagwörter (z.b.: _belegdaten.belegart Rechnung _belegdaten.belegzeitraum 0 ) mit der die Suchanfrage ergänzt wird. Volltextsuchausdruck für eine Volltextrecherche. Der Operator gibt an wie die einzelne Schlagwörter für die Suche kombiniert werden. Mögliche Werte sind: AND - Eine UND Suche wird durchgeführt. UND -Suche bedeutet, dass alle Suchbegriffe im selben Dokument vorkommen müssen. OR - Eine ODER Suche wird durchgeführt. ODER -Suche bedeutet, dass mindestens ein Suchbegriff im Dokument vorkommen muss. *Standardwert = AND Geben Sie an, welche Schlagwörter ListFields *f (z.b.: _belegdaten.adressnummer _belegdaten.belegnummer ) im Ergebnisfenster dargestellt werden. ShowHiddenDocuments Auch versteckte Dokumente in die Recherche einbeziehen (1/0). UsePreviousArchive Verwende zuletzt verwendetes Archiv (1/0). Zielsystem für die Verarbeitung. Mögliche Werte sind: OutputType TABLE - Die Rechercheergebnisse werden in eine Tabelle angezeigt. MESSAGE - Über eine Nachricht werden die Rechercheergebnisse dem angegebenen Empfänger zugestellt. *Standardwert = TABLE 4

6 1.2.1 Als verschicken - Message Neben der Darstellung in einer Tabelle könne die Rechercheergebnisse auch lokal gespeichert werden. Die nachfolgende Tabelle zeigt die Parameter, die nötig sind um ein Rechercheergebnis als CSV Datei zu verschicken. Die nachfolgende Tabelle zeigt die Einstellungen der Sektion [Message]: Tabelle 3: Sektion [Message] Type Nachrichtentyp, das erstellt werden soll. Mögliche Werte sind: - Eine mit dem angegebenen Parameter wird erstellt. *Standardwert = From.ID Absenderkennung für die Nachricht. From.Name Absendername für die Nachricht. To.ID Empfängerkennung für die Nachricht. Bei mehrere Empfänger bitte die Kennungen mit einem Semikolon trennen (z.b. ab@inoxision.com; cd@inoxision.com; ef@inoxision.com;...). To.Name Empfängernamen für die Nachricht. Subject Betreffszeile BodyType Parameter mit dem gesteuert wird ob es sich um eine HTML oder Text Nachricht handelt. Mögliche Werte sind: BodyCodepage BodyFile Smtp.Host Smtp.User Smtp.Pass HTML - Eine Nachricht mit HTML-Tags wurde angegebenen. TEXT - Die Nachricht beinhaltet keine Formatierungsanweisungen und ist rein Text. *Standardwert = TEXT Verwendete Kodierung für die Nachricht. *Standardwert = 1252 Geben Sie eine Datei an, in der sich die Nachricht befindet (z.b. C:\temp\ .txt). Geben Sie den Namen oder IP-Adresse des SMTP-Servers an, über dem die Nachricht versendet werden soll. Benutzername, das für die Anmeldung am SMTP-Server verwendet wird. Kennwort für den angegeben Benutzer. 5

7 Im folgenden Beispiel wird ein Rechercheergebnis über den Mailserver verschickt. Der Text der HTML Nachricht befindet sich dabei in der Datei C:\Temp\mail.txt. [Search] SearchType=MASK SearchArchiveName=Adpt_Demo SearchFields=_ s.Absender m* Operator=AND ListFields=_ s.Absender _ s.Empfaenger _ s.Datum OutputType=MESSAGE [Message] Type= From.Name=Inoxision ARCHIVE To.Name=Max Mustermann Subject=Daten Export BodyType=HTML BodyFile=C:\Temp\mail.txt Smtp.Host= Smtp.User= Smtp.Pass= Listing 4: Beispiel eines Datenexports via 6

8 1.2.2 Lokal speichern - File Neben dem Versand per ist auch eine lokale Speicherung der CSV Datei möglich. Die nötigen Angaben erfolgen hierfür in der Sektion [File] Type Name Path Codepage Delimiter Tabelle 4: Sektion [File] Dateityp, das erstellt werden soll. Mögliche Werte sind: CSV - Eine CSV-Datei mit dem angegebenen Parameter wird erstellt. *Standardwert = CSV Der Name der Datendatei. Eine Zeichenfolge, die den vollständigen Pfad des Verzeichnisses darstellt, im dem die Datendatei mit dem Angegebenen Namen geschrieben wird. Die zu verwendende Zeichenkodierung zur Erstellung der Datendatei. *Standardwert = Ein Zeichencode, das den Trennzeichen für die Datendatei festlegt. Der gültige Bereich liegt zwischen und *Standardwert = 59 bzw. &H3B Sollen die gefundenen Dokumente zusätzlich gespeichert werden, so ist die Angabe der Sektion [Document] notwendig: Export Compression NamePrefix Name Path Tabelle 5: Sektion [Document] Dokumente zu den Rechercheergebnissen exportieren (1/0). *Standardwert = 0 Ausgegebene Dokumente in ein Archiv zusammenfassen. Mögliche Werte sind: NONE - Die Dokumente werden einzeln ohne Kompression in das angegebene Verzeichnis kopiert. ZIP - Die Dokumente werden in ein ZIP-Archiv kopiert. *Standardwert = NONE Vorsilbe für die Dateinamen der Dokumente. Dateiname für das Archiv in dem die Dokumente zusammengefasst sind. *Standardwert = Document.zip Eine Zeichenfolge, die den vollständigen Pfad des Verzeichnisses darstellt, im dem die Dokumente bzw. das Archiv mit den Dokumente kopiert wird. 7

9 Das folgende Beispiel zeigt den Export eines Rechercheergebnisses in eine CSV Datei und den Export der gefundenen Dokumente in eine ZIP Datei: [Search] SearchType=MASK SearchArchiveName=Adpt_Demo SearchFields=_belege.Belegart Ausgangsrechnung Operator=AND ListFields=_belege.Belegart _belege.belegnummer _belege.datum OutputType=FILE [File] Type=CSV Name=Export.csv Path=C:\Temp\Export [Document] Export=1 Compression=ZIP NamePrefix=Dokument Path=C:\Temp\Export Listing 5: Beispiel eines Datenexports 8

10 inoxision ARCHIVE 2 ARCHIVEsearch Die zweite Komponente des Integrationsclients ist ARCHIVEsearch. Im Grunde entspricht ARCHIVEsearch der [Search] Sektion von ARCHIVEexecute, allerdings mit einigen Einschränkungen: Das angezeigte Fenster ist kompakter und lässt keine Abänderung der Suchparameter zu. Der Syntax unterscheidet sich bei der Angabe des Archivs. Das Ergebnisfenster wird im Vordergrund gehalten. Tabelle 6: Sektion [Search] SearchArchive AutoExecute SearchFields *f Operator Archivname in das die Dokumente gesucht werden. Bewirkt, dass die Verarbeitung nach Aufruf der Anwendung automatisch gestartet wird (1/0). Vorbelegung der Schlagwörter (z.b.: _belegdaten.adressnummer _belegdaten.belegnummer ) mit der die Suche durchgeführt wird. Der Operator gibt an wie die einzelne Schlagwörter für die Suche kombiniert werden. Mögliche Werte sind: AND - Eine UND Suche wird durchgeführt. UND -Suche bedeutet, dass alle Suchbegriffe im selben Dokument vorkommen müssen. OR - Eine ODER Suche wird durchgeführt. ODER -Suche bedeutet, dass mindestens ein Suchbegriff im Dokument vorkommen muss. ListFields *f Geben Sie an, welche Schlagwörter (z.b.: _belegdaten.adressnummer _belegdaten.belegnummer ) im Ergebnisfenster dargestellt werden. Das nachfolgende Beispiel zeigt eine Suche mit ARCHIVEsearch. [Search] SearchArchive=Adpt_Demo SearchFields=_belege.Belegart Ausgangsrechnung Operator=AND ListFields=_belege.Belegart _belege.belegnummer _belege.datum _belege.adressnummer _belege.name _belege.ort _belege.fremdbeleg _belege.belegwert _belege.ersteller AutoExecute=1 Listing 6: Beispiel einer Recherche mit ARCHIVEsearch 9