CallAPI

CallAPIs werden verwendet, um Prozesse im AE-System von externen Systemen aus mit Hilfe der Automation Engine scripting language auszulösen. Verwenden Sie CallAPIs, um ausführbare Objekte zu starten, Inhalte von Variablenobjekten festzulegen oder zu lesen oder Statusdetails zu Aufgaben abzurufen. Als Administrator richten Sie die CallAPI ein, und Sie definieren die Anmeldeinformationen, die Verbindungsdaten zur AE und ihre plattformspezifischen Parameter. Sie können die CallAPI entweder mit Ihrem eigenen Programm oder mit einem Dienstprogramm verwenden. Eine CallAPI ist auf 32.000 Zeichen beschränkt, wie alle Scripts im Automation Engine scripting language.

Tipp: Ziehen Sie in einigen Fällen die Verwendung der REST-API anstelle der CallAPI in Betracht. Die REST-API hat einen /scripts-Endpunkt, der CallAPI-Funktionen abdeckt. Die Vorteile sind, dass Sie nicht mehrere Service Manager-Dienste verwenden müssen, wenn Sie Ihre eigenen Systeme mit mehreren AE-Systemen und/oder -Mandanten verbinden. Außerdem erfordert die REST-API keine Benutzeranmeldung, wenn sie aufgerufen wird. Dies ist in Situationen mit hoher Auslastung sehr hilfreich. Weitere Informationen finden Sie unter REST-API

Diese Seite beinhaltet Folgendes:

Allgemeine Informationen

Anmelden am AE- System

Für die Anmeldung am AE-System benötigt die CallAPI einen gültigen Benutzer. Dieser Benutzer muss die Berechtigung Anmeldung über CallAPI und Ausführen-Rechte 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.

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 verschlüsseln.

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. Weitere Informationen 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 diese Informationen 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 der Script-Anweisung :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 Scripts 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++

Im Auslieferungsverzeichnis sind auch Programmbeispiele enthalten, die Ihnen zeigen, wie Sie die CallAPI mit C oder C++ aufrufen. Die Datei uccall3.h gibt genauen Aufschluss über die Struktur und die Funktionen.

Sie müssen die Dateien uccall3. h und die entsprechende Bibliothek für Ihre Plattform integrieren. Beachten Sie, dass Ihr Programm Zugriff auf die erforderlichen Bibliotheken wie ucxbwi3c.dll (Windows) oder libucxblx6c.so (Linux) usw. benötigt.

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

Sie können das CallAPI mit dem Befehl CALL UCCALL3 aufrufen. 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

Um die CallAPI mit Java verwenden zu können, müssen Sie die UCCALL3-Klasse importieren, die aus dem Paket com.uc4.uccall3 importiert werden soll.

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

CallAPI mit Visual Basic

Um die CallAPI mit Ihren eigenen Visual Basic-Programmen zu verwenden, müssen Sie das COM-Objekt AE.Call3 registrieren.

Beispiel

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

Verwenden Sie das Beispielprogramm, das in unserem Lieferverzeichnis enthalten ist. Hier finden Sie eine detaillierte Beschreibung, 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 Script-Ausführung werden automatisch in den folgenden Variablen hinterlegt:

Verwendung des CallAPI-Dienstprogramms (ucxbxxxc)

Ein CallAPI-Dienstprogramm steht für jede unterstützte Plattform zur Verfügung. Für diesen Zweck sind keine Programmierkenntnisse erforderlich. 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,PASSWORD INI=C:\AUTOMIC\CallAPI\WINDOWS\ucxbxxxc.ini

Hinweise:

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

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

Scripts, die über eine CallAPI gestartet werden, werden in der Process Monitoring-Perspektive angezeigt. Ein statistischer Datensatz und ein Report werden erstellt.

Tipp: Verwenden Sie das Kontrollkästchen Deaktivierte Aufgaben einbeziehen oder ausschließen, um nach Ihrem Script zu suchen, und geben Sie den Aufgabentyp CallAPI an, oder geben Sie die Aufgaben-RunID des CallAPI-Scripts ein.

Plattformen für CallAPIs

Siehe auch: