Erste Schritte

Erste Schritte zur Programmierung
Allgemeine Hinweise und erste Schritte bei der Programmierung mit der ArcFlow-API

Ist die Installation der ArcFlow-API abgeschlossen (siehe Installation) kann die Programmierung der Schnittstelle zwischen der Applikation und ArcFlow beginnen. Im Lieferumfang befindet sich eine Beispielapplikation, aus der Hinweise zur Programmierung entnommen werden können. Dieser Abschnitt der Dokumentation beschäftigt sich mit den ersten Schritten der Programmierung.

Alle Befehle der ArcFlow-API werden aus der Prozedur AF.API aufgerufen. Das bedeutet, dass allen Funktionsaufrufen der Name der Prozedur zusammen mit einem Doppelpunkt vorangehen muss. Um die ArcFlow-API-DLL zu laden muss folglich der Befehl AF.API:Open('c:\ArcFlow\API') aufgerufen werden.

Um die Möglichkeiten von ArcFlow in der eigenen Applikation nutzen zu können, müssen zunächst zwei Befehle ausgeführt werden:

1. AF.API:AFOpen('c:\arcflow\api')

   Mit diesem Befehl wird die ArcFlow-API-DLL geladen. Als Übergabeparameter wird der Pfad, in der sich die Datei af_api.dll befindet angegeben.

   Das Laden der DLL muss nicht unmittelbar vor der Anmeldung an ArcFlow erfolgen. Die DLL kann zum Beispiel schon beim Starten der eigenen Applikation geladen werden.

2. AF.API:AFUserLogin('TCP:AF_SERVER','ArcFlow','app_user',)

   Wenn die DLL geladen wurde, kann die Anmeldung an ArcFlow erfolgen. Dazu wird das zu verwendende Protokoll (in diesem Fall TCP/IP) und der Name oder die IP-Adresse des Servers angegeben, auf dem der ArcFlow-Server läuft. Als zweiten Parameter wird der Name angegeben, mit dem die Datenbank beim Server eingetragen ist. In der Regel ist dies "ArcFlow".

   In den weiteren Parametern wird der Benutzer und sein Passwort eingetragen. Dieser Benutzer muss in ArcFlow vorhanden sein.

Von den Funktionen werden Fehlerwerte zurückgegeben, die in jedem Fall überprüft werden müssen.

Ab diesem Zeitpunkt können alle Funktionen der API verwendet werden. Unter der Voraussetzung, dass die Rechte des angemeldeten Benutzers für die entsprechenden Funktion ausreichend sind.

Im folgenden Beispiel wird eine Arbeitsmappe angelegt.

// Arbeitsmappe anlegen
tErg # AF.API:AbmCreate(0,'Bewerbungen','',var tAbmNo);

Konnte die Arbeitsmappe angelegt werden, steht die Nummer der Arbeitsmappe in der Variablen tAbmNo. Als nächstes kann eine automatische Archivzuordnungen definiert werden:

// Begriff für die automatische Archivzuordnung definieren
tErg # AF.API:AbmStwCreate(tAbmNo,'Bewerbung',0,10,false);

Alle Dokumente, die ab diesem Zeitpunkt archiviert werden und in denen in den ersten 10 Zeilen das Wort "Bewerbung" vorkommt, werden automatisch der Arbeitsmappe "Bewerbungen" zugeordnet. Die Wirkung der Befehle kann in ArcFlow sofort überprüft werden, indem in den Einstellungen die Arbeitsmappen kontrolliert werden.

Soll die Verbindung zu ArcFlow beendet werden, muss lediglich der angemeldete Benutzer mit dem Befehl AFUserLogout() abgemeldet werden. Ist auch eine weitere Benutzung der API nicht mehr erforderlich, sollte die API-DLL mit dem Befehl AFClose() entladen werden.

tErg # AF.API:UserLogout();
tErg # AF.API:Close();