CallAPI

CallAPIs werden verwendet, um Prozesse im AE-System von außen aus mit Hilfe der Automation Engine Scriptsprache auszulösen. Sie können beispielsweise ausführbare Objekte starten, den Inhalt von Variablen-Objekten setzen bzw. lesen, oder auch bestimmte Informationen über den Status von Aufgaben erhalten. Als Administrator richten Sie die CallAPI ein, geben Login-Daten an, verbinden sich mit der AE, und definieren Ihre plattformspezifischen Parameter. Sie können die CallAPI entweder mit Ihrem eigenen Programm oder mit einem Dienstprogramm verwenden. Automation Engine Scriptsprache ist in jedem Fall auf 32000 Zeichen begrenzt.

Dieses Thema beinhaltet Folgendes:

Allgemeines

Anmelden am AE- System

Für die Anmeldung am AE-System benötigt die CallAPI einen gültigen Benutzer. Dieser Benutzer muss das Privileg Anmeldung über CallAPI und die Rechte Ausführen besitzen. Ihre Zugangsdaten (Kunde, Benutzer, Abteilung und Passwort) können Sie in der INI-Datei der CallAPI angeben. Alternativ können Sie dies auch beim Aufruf der CallAPI angeben. Diese Daten werden bevorzugt, wenn die Anmeldedaten an beiden Stellen hinterlegt sind.

Sie können Ihr Passwort mit dem Programm UCYBCRYP.EXE verschlüsseln. Beachten Sie, dass der verschlüsselte String maximal 64 Zeichen lang sein darf. Siehe Passwörter codieren .

Wenn Sie Single-Logon für Ihre CallAPI verwenden, findet keine Passwortverifizierung statt. Speichern Sie dazu die relevanten Daten in der Systemvariablen UC_USER_LOGON. Details hierzu finden Sie unter: UC_USER_LOGON - Single Logon

Mit Automation Engine verbinden

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

Meldungen

Wenn Sie ein Job-Objekt verwenden, das das CallAPI-Dienstprogramm aufruft, können Sie die zugehörigen Meldungen im Job-Report sehen.

Mit dem Script-Sprachmittel :STOP ist es möglich, Meldungsnummern und Texte an die CallAPI zu übergeben. Diese werden in Script-Variablen gespeichert und können so mit Ihren eigenen Programmen ausgelesen werden. Die Namen dieser Variablen hängen von der verwendeten Programmiersprache ab. Abhängig vom Stoppmodus, den Sie in der Script-Anweisung :STOP definieren, bricht das Script entweder ab oder fährt mit der Ausführung fort.

Verwendung der CallAPI mit eigenem Programm

Mit der CallAPI können Sie Scripte im AE-System aus eigenen Programmen heraus verarbeiten, die in C, C++, Cobol, Java oder Visual Basic geschrieben sind. Gute Kenntnisse der Programmiersprache, in denen dieses Programm geschrieben wurde, werden dafür vorausgesetzt.

Der Ablauf zur Script-Aktivierung läuft immer in folgenden drei Schritten:

  1. Anmelden am AE- System.
  2. Übertragen des Scripts an das AE-System.
  3. Abmelden vom AE-System.

Natürlich können sie sich gleichzeitig an verschiedene AE-Systeme anmelden und mehrere Scripts ausführen.

CallAPI mit C, C++

Binden Sie dazu die Dateien uccall3.h und ucxbwi3c.lib ein. Achten Sie auch darauf, dass Ihr Programm auf die Bibliothek ucxbwi3c.dll zugreifen kann (Windows-Ordner).

In der Auslieferung sind auch Programmbeispiele enthalten, die Ihnen zeigen, wie Sie die CallAPI aufrufen. Die Datei uccall3.h gibt genauen Aufschluss über die Struktur und die Funktionen.

Funktionen

Die folgenden Funktionen können Sie in Ihrem Programm nutzen. Als Rückgabewert liefern die Funktionen entweder 0, wenn die Aktion erfolgreich war, oder eine Meldungsnummer im Fehlerfall. Der Datentyp aller Rückgabewerte ist long.

Variablen

Informationen wie z.B. der Systemname oder die zurückgegebene RunID des Scripts sind in der Struktur UCCALL_PARAMS gespeichert. Sie enthält folgende Variablen:

CallAPI mit Cobol

Rufen Sie die CallAPI mit dem Befehl CALL UCCALL3 auf. Als Rückgabewert liefert der Aufruf entweder 0, wenn die Aktion erfolgreich war, oder eine Meldungsnummer im Fehlerfall.

Variablen

Im ausgelieferten Beispielprogramm sehen Sie den Aufbau der Struktur AE-RECORD. Sie enthält folgende Variablen:

CallAPI für Java

Importieren Sie dazu die Klasse UCCALL3 aus dem Package com.uc4.uccall3.

Das Auslieferungsverzeichnis enthält Beispielprogramme, die Ihnen zeigen, wie Sie sich anmelden, Scripte aktivieren, sich mit verschiedenen Systemen verbinden, Verbindungsfehler finden, etc. Die mitgelieferte CallAPI-Dokumentation bietet aktuelle Informationen über die Java-Klasse, Methoden und verfügbare Funktionen.

CallAPI mit Visual Basic

Die Funktionalität befindet sich im COM-Objekt namens AE.Call3, das Sie registrieren müssen.

Beispiel

regsvr32 c:\AUTOMIC\callapi\windows\bin\ucxbwi3c.dll

In der Auslieferung ist auch ein Programmbeispiel enthalten, das Ihnen zeigt, wie Sie ein Script aktivieren können.

Methoden

Die folgenden Funktionen können Sie in Ihrem Programm nutzen. Als Rückgabewert liefern die Funktionen entweder 0, wenn die Aktion erfolgreich war, oder eine Meldungsnummer im Fehlerfall.

Attribute

Informationen über die Scriptausführung werden automatisch in den folgenden Variablen hinterlegt:

Beispiele werden als Teil des Lieferumfanges für alle unterstützten Plattformen geliefert.

Verwendung des CallAPI Dienstprogramms (ucxbxxxc)

Ein CallAPI-Dienstprogramm steht für jede unterstützte Plattform zur Verfügung. Sie müssen dafür keine Programmierkenntnisse haben. Abhängig von Ihrem Betriebssystem können Sie dieses Dienstprogramm aus Jobs, Prozeduren, ausführbaren Dateien oder direkt von der Kommandozeile aus aufrufen.

Schreiben Sie das gewünschte 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] [QUEUE=Name des Queue-Objekts]

Parameter:

(Windows) Beispiel

UCXBXXXC SCRIPT=C:\AUTOMIC\CallAPI\script.txt LOGON=98,SMITH INI=C:\AUTOMIC\CallAPI\WINDOWS\ucxbxxxc.ini

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

(SAP) Der Startparameter für den RFC-Server ist anders: -I ist der einzige Parameter und gibt den Pfad zur INI-Datei an:

Tipp: Verwenden Sie die Checkbox Deaktivierte Aufgaben inkludieren oder exkludieren, um nach Ihrem Script zu suchen, und geben Sie den Aufgabentyp CallAPI an, oder geben Sie die Task RunID des CallAPI-Scripts ein.

Plattformen für CallAPIs

Siehe auch: