Application Remote Control (ARC)

Application Remote Control
Steuerung der ArcFlow-Applikation aus anderen Programmen

Mit Hilfe der in diesem Abschnitt vorgestellten Funktionen kann eine ArcFlow-Applikation von einem anderen Programm aus gesteuert werden. Auf diese Weise kann über eine Fremdsoftware unter anderem Archive eingescannt, Archivdaten manipuliert und Termine für den Workflow gesetzt werden. Damit eine Fernsteuerung erfolgen kann, müssen bestimmte Voraussetzungen bei ArcFlow und auch bei der Fremdsoftware erfüllt sein.

Voraussetzungen für die Application Remote Control

Der ArcFlow-Client muss mit dem zusätzlichen Argument /socket= gestartet werden. In dem Argument muss ein freier IP-Port zwischen 51750 und 52750 angegeben werden. Andere Ports werden nicht akzeptiert:

c16_winc.exe /socket=51750

Die Angabe des Sockets kann mit den Übergabeparametern /USER und /PASSWORD kombiniert werden.

ArcFlow überwacht nach der Anmeldung mit einem gültigen Benutzer diesen Port auf eingehende Anweisungen. Die Steuerung von ArcFlow funktioniert nur dann, wenn der ArcFlow-Client (der Agent alleine reicht nicht aus) gestartet ist und eine korrekte Anmeldung an ArcFlow erfolgt ist.

Sind die Voraussetzungen beim Start von ArcFlow erfüllt, kann von einem anderen Programm aus eine Verbindung zu ArcFlow hergestellt werden. Dazu wird die IP-Adresse des Computers, auf dem der ArcFlow-Client gestartet ist und die angegebene Port-Nummer benötigt. Anschließend kann eine Zeichenkette übermittelt werden. Die Zeichenkette hat immer den gleichen Aufbau:

/USER=<user> /PASSWORD=<password> /ACTION=<action>

Die Benutzeridentifikation ist nur notwendig, wenn in den Einstellungen "Überprüfung von Benutzer und Passwort" gesetzt ist. Ist eine Authentifizierung erforderlich, muss der angegebene Benutzer über ausreichende Rechte zum Durchführen der Aktion verfügen. Da nach der Übermittlung der Zeichenkette die Verbindung wieder getrennt wird, muss der Benutzer und das Kennwort bei jeder Anweisung erneut mit übertragen werden.

Die Application Remote Control kann auch über ein Shell-Kommando verwendet werden (siehe Af_RmtControl). In diesem Fall wird die Zeichenkette dem Shellkomando übergeben. Das Kommando baut dann die Verbindung zum ArcFlow-Client auf (gegebenenfalls wird ein Client auf dem gleichen System gestartet) und übermittelt die Zeichenkette.

Anweisungen an ArcFlow

Als Aktion können folgende Anweisungen übergeben werden:

• TEST

  Bei der Übergabe der Aktion TEST wird geprüft, ob der angegebene Benutzer Administrationsrechte besitzt. Die Funktion entspricht dem Aufruf von TEST mit dem Script-Benutzer.

  Beispiel:

  /USER=admin /PASSWORD=troja /ACTION=test
  

• STOP_OFFICE

  Der Office-Server wird angehalten (siehe STOP_OFFICE).

  Beispiel:

  /USER=admin /PASSWORD=troja /ACTION=STOP_OFFICE
  

• STOP_IDXSERVER

  Der Index-Server wird angehalten und nach zwei Minuten wieder gestartet (siehe STOP_IDXSERVER). Eine andere Wartezeit kann mit /logindelay angegeben werden.

  Beispiel:

  /USER=admin /PASSWORD=troja /ACTION=STOP_IDXSERVER /LOGINDELAY=240
  

• STOP_JOBSERVER

  Der Job-Server wird angehalten und nach zwei Minuten wieder gestartet (siehe STOP_JOBSERVER). Eine andere Wartezeit kann mit /logindelay angegeben werden.

  Beispiel:

  /USER=admin /PASSWORD=troja /ACTION=STOP_JOBSERVER /LOGINDELAY=60
  

• STOP_ALLSERVER

  Alle Services werden angehalten und nach zwei Minuten wieder gestartet (siehe STOP_ALLSERVER). Eine andere Wartezeit kann mit /logindelay angegeben werden.

  Beispiel:

  /USER=admin /PASSWORD=troja /ACTION=STOP_ALLSERVER
  

• OPEN_DIALOG

  Mit dieser Aktion wird ArcFlow veranlasst ein Archiv-Fenster anzuzeigen. In dem Fenster wird entweder eine Arbeitsmappe, ein Archiv oder eine Anhangdatei angezeigt. Die Arbeitsmappe wird mit /FNC=AFAbmPos, das Archiv wird mit /FNC=AFArcPos gefolgt von einem Parameter mit der Arbeitsmappen- oder Archivnummer, die Anhangdatei wird mit /FNC=AFArcFileShow gefolgt von Archivnummer, Anhangdateinummer und Seitennummer angegeben. Einige Funktionen erwarten ebenfalls die Anzeige eines neuen Fensters. Die ausführbaren Anweisungen sind im Abschnitt Befehle der Application Remote Control aufgelistet.

  Die Anzeige erfolgt im kompletten Arbeitsmappenbaum. Soll eine Arbeitsmappe als Wurzel des Baums angegeben werden, kann die Wurzel mit dem Parameter /ABMROOT= angegeben werden.

  Beispiel:

  /USER=admin /PASSWORD=troja /ACTION=OPEN_DIALOG /FNC=AFAbmPos /ABMNR=600123
  /USER=admin /PASSWORD=troja /ACTION=OPEN_DIALOG /FNC=AFArcPos /ARCNR=2010.0000009
  /USER=admin /PASSWORD=troja /ACTION=OPEN_DIALOG /FNC=AFArcFileShow /ARCNR=2011.0000028 /ARCFILENR=3 /ARCFILEPAGE=2
  /USER=admin /PASSWORD=troja /ACTION=OPEN_DIALOG /FNC=AFAbmPos /ABMROOT=12 /ABMNR=600123
  /USER=admin /PASSWORD=troja /ACTION=OPEN_DIALOG /FNC=AFArcPos /ABMROOT=12 /ARCNR=2010.0000009
  

• FNC

  Mit dieser Aktion kann eine Funktion oder ein Skript von ArcFlow aufgerufen werden. Zur Ausführung wird der ArcFlow-Client gestartet, die Oberfläche aber nicht angezeigt. Eine Beschreibung der Funktionen befindet sich im Abschnitt Programmierschnittstelle (API). Die Befehle, die hier angegeben werden können, sind mit dem Symbol gekennzeichnet.

  Beispiel:

  /USER=admin /PASSWORD=troja /ACTION=FNC /FNC=AFArcCreate 
  

• SHOWFILE

  Mit dieser Anweisung wird ein neuer Task gestartet, in dem die angegebene Anhangdatei angezeigt wird. Mit der Anweisung OPEN_DIALOG erfolgt die Anzeige im gleichen Task. Die Archivnummer, die Nummer der Anhangdatei und die Seitennummer werden in den Parametern /ARCNR, /ARCFILENR und /ARCFILEPAGE angegeben. In dem Parameter /VIEWOBJ kann definiert werden, mit welchem Anzeige-Objekt die Anhangdatei angezeigt werden soll. Folgende Anzeige-Objekte stehen zur Verfügung:

  VIEWOBJ	Anzeige-Objekt
  1	Bild oder Scan
  2	Web-Navigator
  3	nicht auszuführende Dokumente
  4	Text (*.txt, *.log, *.cfg, ...)
  5	auszuführende Dokumente
  6	RTF und ADO
  7	PDF (CTX-Objekt)
  8	Office-Dokumente (CTX-Objekt)
  9	Virtuelle Dokumente (E-Mail-Anhänge oder Inhalt aus einer ZIP-Datei)
  10	E-Mails
  11	DocView
  12	mit externem Programm öffnen
  13	mit internem RtfEditor öffnen
  14	in HTML gewandelt (nur Microsoft Word oder Excel)

  Beispiel:

  /USER=admin /PASSWORD=troja /ACTION=SHOWFILE /ARCNR=2012.0001234 /ARCFILENR=2 /ARCFILEPAGE=4 /VIEWOBJ=7
  

Bei den Aktionen zum Anhalten und Neustarten der Service-Programme gelten die gleichen Regeln, wie beim Script-Benutzer. Es werden nur die Service-Programme neu gestartet, die als Dienst eingerichtet wurden.

Bei den Aktionen OPEN_DIALOG und FNC können zusätzlich Optionen mit dem Parameter /FLAGS= angegeben werden:

Wert	Beschreibung
0	Keine Option angegeben
1	Es wird nur ein Teil des Arbeitsmappenbaumes angezeigt. Die angegeben Arbeitsmappe ist die erste angezeigte Mappe des Baumes.
2	Alle untergeordneten Arbeitsmappen werden aufgeklappt.
64	Der ArcFlow-Client wird im Vordergrund angezeigt.

Die verschiedenen Optionen können miteinander kombiniert werden. Dazu werden die einzelnen Werte addiert.

Bei dem Aufrufen von Funktionen mit Parametern, werden die Parameter als Name=Wert-Paare übergeben. Auf diese Weise ist die Reihenfolge der Parameter unerheblich. Die Namen der Parameter stehen in der Beschreibung der entsprechenden Befehle. Vor dem Namen des Parameters muss ein / stehen. Enthält der Wert ein oder mehrere Leerzeichen oder /, muss die Zeichenkette in " " eingeklammert werden.

Einige Anweisungen erwarten die Aktion OPEN_DIALOG, da sie das Ergebnis der Funktion in einem ArcFlow-Fenster anzeigen. Dies betrifft alle Funktionen, die eine Arbeitsmappe, ein Archiv oder eine Anhangdatei anzeigen. Bei den Funktionen ist das entsprechend vermerkt.

Nach der Durchführung eines Aufrufs wird eine Resultat-Datei erzeugt. Der Name der Datei wird bei dem Aufruf im Parameter /RsltPath=... mit angegeben. Der Aufbau der Resultat-Datei ist bei allen Befehlen gleich. In der ersten Zeile wird die übermittelte Zeichenkette geschrieben. In der zweiten Zeile befindet sich der Rückgabewert der aufgerufenen Funktion. Ab der dritten Zeile werden spezielle Rückgaben der Funktionen geschrieben. Hier befinden sich in der Regel die Rückgabewerte, die von den Funktionen als VAR-Parameter oder CTE-Listen zurückgegeben werden. Details zu den Inhalten der Datei sind bei den entsprechenden Funktionen beschrieben.

Die Resultat-Datei wird vom ArcFlow-Client nach der Ausführung einer Anweisung geschrieben. D. h. die Datei wird auf dem gleichen Rechner angelegt, auf dem der Client läuft.