Allgemeines zum CallAPI

CallAPI

Plattformen für die CallAPIs

---

 Verwendung des CallAPIs

Das CallAPI steht auf den verschiedensten Plattformen zur Verfügung und ist äußerst vielseitig. Lesen Sie im Folgenden wie es eingesetzt werden kann und welche Einstellungen dabei eine Rolle spielen.

Die Beschreibung zur Installation und zu den INI-Dateien der CallAPIs finden Sie im Administratorhandbuch.

Das CallAPI kann auf zwei verschiedene Arten genutzt werden. Für beide Verwendungsmöglichkeiten ist das AE Script auf eine Größe von 32000 Zeichen beschränkt.

CallAPI und eigenes Programm

Die erste Möglichkeit das CallAPI zu verwenden, ist jenes von ihren eigenen Programmen heraus aufzurufen. Diese können in den folgenden Programmiersprachen geschrieben sein:

• C, C++
• Cobol
• Java
• Visual Basic

Beispiele für diese Verwendung des CallAPIs werden für alle unterstützten Plattformen ausgeliefert.

CallAPI und das Dienstprogramm

Die zweite Möglichkeit, das CallAPI zu verwenden, erfordert keine Programmierkenntnisse. Ein Dienstprogramm steht für jede unterstützte Plattform zur Verfügung. Dieses kann beispielsweise aus Jobs, Prozeduren, ausführbaren Dateien oder direkt von der Kommandozeile aufgerufen werden. Die Möglichkeiten sind durch das Betriebssystem bestimmt.

Schreiben Sie das Script in eine Textdatei und übergeben Sie diese beim Aufruf des Dienstprogrammes. Für alle Plattformen gilt folgende Syntax:

CallAPI-Datei SCRIPT=Script-Datei [LOGON=Mandant, Benutzer, [Abteilung [, Passwort]]] [INI=INI-Datei]

Beispiel für den CallAPI-Aufruf unter Windows:

UCXBXXXC SCRIPT=C:\AUTOMIC\CALLAPI\script.txt LOGON=98, MEIER, DEV INI=C:\AUTOMIC\CALLAPI\WINDOWS\ucxbxxxc.ini

Das Dienstprogramm liefert Ihnen verschiedene Rückgabewerte mit denen Sie die Script-Aktivierung verfolgen können:

Beachten Sie, dass für den RFC-Server für SAP andere Startparameter gelten! Er besitzt nur einen Parameter namens -I, mit dem der Pfad zur INI-Datei angegeben werden kann.

• Beispiel für Windows:
  UCXBRXXC -IC:\AUTOMIC\CALLAPI\SAP\UCXSAPC.INI
   
• Beispiel für UNIX:
  nohup ./ucxsapc -I./ucxsapc.ini

Hinweis: Beachten Sie, dass der Rückgabewert 8 angezeigt wird, wenn die Aktivierung des AE Scripts aufgrund eines Fehlers abgebrochen wurde (z.B. falsche Schreibweise oder falsche Anzahl von Funktionsparametern) und nicht fortgesetzt werden kann. Es können auch Fehler auftreten, die zwar eine Ausgabe im Meldungsfenster des UserInterfaces und/oder im Report verursachen, aber das AE Script nicht abbrechen (z.B. Fehler in den Script-Funktionen ACTIVATE_UC_OBJECT und IMPORT). In diesem Fall endet das Dienstprogramm immer mit dem Rückgabewert 0.

Die RunID, die bei Ausführung des Dienstprogramms ausgegeben wird, ist die RunID des CallAPI Scriptes.

Login

Für die Anmeldung an das Automation Engine System benötigt das CallAPI einen gültigen AE-Benutzer. Die Anmeldedaten, die aus Mandant, Benutzername, Abteilung und Passwort bestehen, können entweder in der INI-Datei eingetragen oder direkt beim Aufruf des CallAPIs übergeben werden. Letztere Möglichkeit wird bevorzugt verwendet, wenn die Anmeldedaten an beiden Stellen hinterlegt sind.

Der Benutzer, mit dem die Anmeldung an das Automation Engine System per CallAPI erfolgt, muss das Privileg "Anmeldung über CallAPI" besitzen.

 Bei der Scriptausführung werden natürlich die Berechtigungen des AE-Benutzers geprüft.

Sie können das Passwort mit dem Programm UCYBCRYP verschlüsseln. Beachten Sie, dass der verschlüsselte String maximal 64 Zeichen haben darf.

Auf Wunsch kann das CallAPI ohne Passwortprüfung betrieben werden. Das hat den Vorteil, dass das Passwort nicht in Programmen oder Prozeduren gespeichert ist und diese jedes Mal geändert werden müssen, wenn ein neues Passwort vergeben wird. Sie können die automatische Anmeldung in der Variable UC_USER_LOGON hinterlegen.

Wie sie aus den bisherigen Beschreibungen ersehen, verhält sich das CallAPI wie eine manuelle Anmeldung an das Automation Engine System. Es verwendet daher für jede Verbindung eine freie Dialog-Lizenz. In der Variablen UC_SYSTEMS_SETTINGS, die sich im Systemmandant 0000 befindet, können Sie mit dem Key RESERVED_API_USERS eine Anzahl von Dialog-Lizenzen für CallAPI-Anmeldungen reservieren. Damit blockieren sich CallAPI- und manuelle Benutzeranmeldungen nicht gegenseitig.

Verbindung zur Automation Engine

Um das Script im gewünschten Automation Engine System aktivieren zu können, braucht das CallAPI die Verbindungsinformationen zum entsprechenden Kommunikationsprozess. Tragen Sie die Verbindungsinformationen in der INI-Datei ein. Bei CallAPI-Aufrufen aus Ihrem eigenen Programm lassen sich jene auch direkt übergeben.

Meldungen

Mit dem Script-Sprachmittel :STOP ist es möglich, Meldungsnummern und Texte an das CallAPI zu übergeben. Diese werden in Variablen gespeichert und können so in Ihren eigenen Programmen ausgelesen werden. Wie diese Variablen heißen, hängt von der Programmiersprache ab und lässt sich im Kapitel "CallAPI und eigenes Programm" nachschlagen.

Rufen Sie das Dienstprogramm des CallAPIs auf indem Sie ein Job-Objekt dazu verwenden, können Sie die Meldungen im Report einsehen.

Je nach der verwendeten Syntax der Script-Funktion :STOP bricht das Script ab oder läuft weiter.  

Siehe auch:

Allgemeines zum CallAPI
:STOP