Plattformen für CallAPIs

CallAPIs werden für die Plattformen BS2000, Java, NSK, OS/400, SAP, UNIX, VMS, Windows und z/OS unterstützt. Die erforderlich Dateien werden mit der Automation Engine geliefert und es werden Beispiele für jede Plattform bereitgestellt. Sie können alle Plattformen entweder mit Ihrem eigenen Programm oder mit dem entsprechenden Dienstprogramm aufrufen.

Wichtig! Ab Version 21 verwenden Java- und SAP-CallAPIs TLS/SSL für die Verbindung mit der Automation Engine. Sie richten eine Verbindung zum neuen Java-Kommunikationsprozess (JCP) ein und verwenden vertrauenswürdige Zertifikate, um ihre Identität gegenüber anderen Kommunikationspartnern nachzuweisen. Alle anderen CallAPIs erstellen weiterhin eine Verbindung mit dem CP.

Mehr Informationen:

Weitere Informationen zu den verschiedenen Zertifikattypen und ausführliche Anweisungen zur Erstellung und Verwendung finden Sie unter Welche Art von Zertifikaten sollte ich für Automic Automation v21 verwenden?

In Automic Automation Kubernetes Edition stellen CallAPIs eine Verbindung zu einem TCP-Load Balancer her. Die Adresse des Load Balancers muss auf beiden Seiten definiert sein: Automation Engine und CallAPI. Die einzigen Ausnahmen sind die CallAPIs für Java und SAP, die aktualisiert werden müssen, um TLS/SSL für die Verbindung mit der Automation Engine verwenden zu können. Diese beiden CallAPIs stellen eine Verbindung mit dem Java-Kommunikationsprozess (JCP) über einen Ingress/HTTPS-Load Balancer her.

Mehr Informationen:

Diese Seite beinhaltet Folgendes:

CallAPI für BS2000

Sie definieren die Codetabelle, die in der INI-Datei der CallAPI für den Agent BS2000 verwendet werden soll, indem Sie den Namen des CodeTable-Objekts in den Parameter codetable= des Abschnitts [GLOBAL] eingeben.

Eigenes Programm verwenden

Sie können alle Parameter zuordnen, die in Ihrem eigenen Programm benötigt werden. Die einzige Voraussetzung ist, dass Sie das UCCALL3-Modul einbinden oder es zur Laufzeit dynamisch neu laden. Weitere Informationen finden Sie unter Verwendung der CallAPI mit Ihrem eigenem Programm.

Dienstprogramm verwenden

Das mitgelieferte Paket enthält das Dienstprogramm UCXBB2?C. Sie können es in BS2000-Prozeduren oder Batch-Jobs verwenden. Weitere Informationen finden Sie unter Verwendung des CallAPI-Dienstprogramms (ucxbxxxc).

Das Dienstprogramm liest die Daten, die für die Anmeldung am Automation Engine über SYSDTA erforderlich sind. Das auszuführende AE Script kann entweder aus einer Datei oder direkt aus SYSDTA stammen. Wenn Sie eine Datei verwenden, müssen Sie diese vor dem Aufruf des Programms mit dem Linknamen UCSCRIPT zuordnen.

Beispiele

Im ersten Beispiel ist der Linkname UCSCRIPT nicht vergeben. Das auszuführende AE Script wird gelesen, bis es den SYSDTA-Befehl /EOF erreicht.

/FILE UCXBB22C.INI,LINK=INI
/EXEC UCXBB22C
04,RS,PROG,PASSWORD
:SET &RUNNR = ACTIVATE_UC_OBJECT(JOBS,EXAMPLE1)
:IF &RUNNR = '0000000'
: SET &ERROR = SYS_LAST_ERR_NR
: SET &ERROR = SYS_LAST_ERR_NR
: STOP MSG,51,'ACTIVATION ERROR: &ERROR'
:ELSE
: STOP NOMSG,50,'THE JOB WAS STARTED WITH RunID &RUNNR'
:ENDIF
/EOF

Das Script, das ausgeführt werden soll, befindet sich in der Datei MY.SCRIPT.FILE:

/FILE UCXBB22C.INI,LINK=INI
/FILE MY.SCRIPT.FILE,LINK=UCSCRIPT
/EXEC UCXBB22C
04,RS,PROG,PASSWORD

Das folgende Beispiel gibt die RunID, den Fehlercode und die Fehlermeldung von der CallAPI zurück. Diese drei Werte werden in eine Job-Variable (JV) geschrieben.

/CREATE-JV JV-NAME=#UC.RETCODE
/SET-JV-LINK LINK-NAME=UCRETC,JV-NAME=#UC.RETCODE
/CREATE-JV JV-NAME=#UC.RETTEXT
/SET-JV-LINK LINK-NAME=UCRETT,JV-NAME=#UC.RETTEXT
/CREATE-JV JV-NAME=#UC.RUNID
/SET-JV-LINK LINK-NAME=UCRUNID,JV-NAME=#UC.RUNID
/EXEC UCXBB23C
*INI
:SEND_MSG RS,DEV,'MESSAGE FROM THE BS2000 CALL INTERFACE &NAME.'
/EOF
/SHOW-JV JV-CONTENTS=*LINK(LINK-NAME=UCRUNNR)
/STEP
/SHOW-JV JV-CONTENTS=*LINK(LINK-NAME=UCRETC)
/SHOW-JV JV-CONTENTS=*LINK(LINK-NAME=UCRETT)

CallAPI für Java

Wichtig! Ab Version 21 verwendet die CallAPI für Java TLS/SSL und stellt eine Verbindung zum neuen Java-Kommunikationsprozess (JCP) her. Weitere Informationen finden Sie unter Verbindungen zur AE sichern (TLS/SSL)

Eigenes Programm verwenden

Siehe Verwendung der CallAPI mit Ihrem eigenem Programm.

Dienstprogramm verwenden

Sie können die Datei UCCALL3.JAR über die Kommandozeile oder aus einer Batch-Datei aufrufen. Eine Beispieldatei (UCCALL3.BAT), die erklärt, wie Sie sie aus einer Batch-Datei aufrufen, wird mit den AE-Dateien geliefert. Weitere Informationen finden Sie unter Verwendung des CallAPI-Dienstprogramms (ucxbxxxc).

Beispiel

Die CallAPI wird mit den Login-Daten des Mandanten 0098 aufgerufen und kann ohne Passwort aufgerufen werden. Das folgende Beispiel aktiviert ein AE Script, das in der Datei SCRIPT.TXT gespeichert ist.

java -jar uccall3.jar script=script.txt logon=98,smith,uc4

CallAPI für NSK

Eigenes Programm verwenden

Siehe Verwendung der CallAPI mit Ihrem eigenem Programm.

Dienstprogramm verwenden

Das Dienstprogramm UCXBNS1C ist Teil des AE-Pakets. Sie können es von der Kommandozeile des jeweiligen Betriebssystems, von einem Script oder einem Job aus aufrufen. Weitere Informationen finden Sie unter Verwendung des CallAPI-Dienstprogramms (ucxbxxxc).

Beispiele

Das erste Beispiel ruft das Dienstprogramm mit den Verbindungs- und Anmeldeinformationen auf, die in Form von Parametern angegeben werden. Das Dienstprogramm liest die Verarbeitungsanweisungen (AE-Script) aus einer Datei mit dem Namen SCRFILE.

run ucxbns1c script=SRCFILE LOGON=1000,SMITH,UC4

Im zweiten Beispiel wird das Dienstprogramm mit der angegebenen Script-Datei aufgerufen. Verbindungs- und Anmeldedaten sowie weitere Informationen werden aus der INI-Datei gelesen.

run ucxbns1c script=SRCFILE INI=UCXBNS1I

CallAPI für OS/400

Eigenes Programm verwenden

Siehe Verwendung der CallAPI mit Ihrem eigenem Programm.

Dienstprogramm verwenden

Das mitgelieferte Dienstprogramm UCXBO41C ist in der Bibliothek verfügbar und kann in OS/400 CL-Scripts werden. Weitere Informationen finden Sie unter Verwendung des CallAPI-Dienstprogramms (ucxbxxxc).

Das AE-Script, das ausgeführt werden soll, wird aus einem Filemember gelesen.

Beispiel

Die Bibliotheken sind an Ihre AE Installation anzupassen.

CALL PGM(UC4/UCXBO41C) +
PARM('INI=UC4/INI(UCXBO41C)' 'LOGON=<Ihre vierstellige Mandantennummer>,<Ihr Benutzer>,<Ihre Abteilung>,<Ihr Passwort>' 'SCRIPT=UC4/INI(SCRSAMP)')

CallAPI für SAP

Wichtig! Ab Version 21 verwendet die CallAPI für SAP TLS/SSL und stellt eine Verbindung zum neuen Java-Kommunikationsprozess (JCP) her, siehe Verbindungen zur AE sichern (TLS/SSL)

Der RFC-Server überträgt das Skript an das AE-System. Er enthält einen Funktionsbaustein namens UC4, den Sie in Ihren ABAP-Programmen aufrufen können.

Der Ordner SAMPLE des ausgelieferten Pakets enthält Beispielprogramme, die erklären, wie Sie sie verwenden können. Weitere Informationen finden Sie unter Verwendung des CallAPI-Dienstprogramms (ucxbxxxc).

Funktionsbaustein UC4

Für das Verständnis der folgenden Beschreibungen sind gute ABAP/4-Kenntnisse erforderlich:

Import Parameter

client(4) Typ n

AE Mandant
trcflg(1) type c

Trace-Flag
userabtl(200) type c

Abteilung des AE-Benutzers
username(200) type c

Name des AE-Benutzers
queue(200) type c
(Optional) Name der Queue, z. B. CLIENT_QUEUE
userpass(32) type c

Passwort des AE-Benutzers

Export Parameter

msg(255) type c

Meldung
run(10) type c
RunID der Scripts

Tabellen

script

Script-Tabelle (je Zeile insgesamt 255 Zeichen)

Beispiel

TYPES:
BEGIN OF scriptline,
script(255) TYPE c,
END OF scriptline.

DATA:
uc4_script TYPE TABLE OF scriptline WITH HEADER LINE.

Ausnahmen

logon-failed

Einloggen bei AE war nicht erfolgreich
others

Sonstiger Fehler

Beispiel

Funktionsbaustein aufrufen:

call function 'UC4' destination 'UC4'
exporting
client = p_clint
trcflg = '0'
userabtl = p_usera
username = p_usern
userpass = p_userp
importing
msg = omessg
run = orunnr
tables
script = uscript
exceptions
logon_failed = 1
others = 99.

CallAPI für UNIX

Eigenes Programm verwenden

Das Programm UCXBXXXC.c liegt als C-Quellcode vor. Die dazugehörigen Strukturdefinitionen sind in der Datei UCCALL3.h hinterlegt. Sie finden diese Dateien sowie das MakeFile zum Kompilieren des Beispiels im Verzeichnis /src. Aktualisieren Sie das mitgelieferte Beispiel mit Ihren Daten. Passen Sie die MAKEFILE_EXAMPLE.??? an. MakeFile für Ihre Umgebung. Benennen Sie sie in MAKEFILE um, dann können Sie sie mit make aufrufen, da MAKEFILE der Standardname ist. Nun können Sie eine EXE-Datei erzeugen und die CallAPI testen. Weitere Informationen finden Sie unter Verwendung der CallAPI mit Ihrem eigenem Programm.

Dienstprogramm verwenden

Das Dienstprogramm UCXB???C wird mit den AE-Dateien geliefert. Sie können es entweder von der Kommandozeile oder aus einer ausführbaren Datei aufrufen. Weitere Informationen finden Sie unter Verwendung des CallAPI-Dienstprogramms (ucxbxxxc).

Das AE-Script wird verwendet, um Verarbeitungsschritte zu definieren, die beim Aufruf des Programms als Standardeingabe zugewiesen werden: der Eintrag < Dateiname liest das AE-Script aus der entsprechenden Datei. Der Eintrag <<EOF_SCRIPT liest das AE-Script von der Kommandozeile, bis der Text EOF_SCRIPT erkannt wird.

Beispiele

Im ersten Beispiel wird das Dienstprogramm so aufgerufen, dass das AE-Script aus der Datei script.txt gelesen wird. Verbindungs- und Anmeldedaten kommen komplett aus der INI-Datei.

./UCXBUI5C SCRIPT=./script.txt

Im zweiten Beispiel werden die Verbindungs- und Anmeldespezifikationen von der CallAPI übergeben.

./ucxblx6c SCRIPT=script.txt LOGON=0001,SMITH,DEV, aerox

CallAPI für VMS

Eigenes Programm verwenden

Das Programm UCXBVXXC.C liegt als C-Quellcode vor. Die dazugehörigen Strukturdefinitionen sind in der Datei UCCALL3.H hinterlegt. Ein Befehl zum Kompilieren des Beispiels ist in MAKEXAMP.COM verfügbar. Aktualisieren Sie dieses Beispiel mit Ihren Daten und passen Sie es an Ihre Umgebung an. Dabei können Sie eine EXE-Datei erzeugen und die CallAPI testen. Weitere Informationen finden Sie unter Verwendung der CallAPI mit Ihrem eigenem Programm.

Dienstprogramm verwenden

Im Lieferumfang ist das Dienstprogramm UCXBV??C.EXE enthalten, das Sie aus einer Befehlsdatei aufrufen können. Weitere Informationen finden Sie unter Verwendung des CallAPI-Dienstprogramms (ucxbxxxc).

Die mit AE Script definierten Verarbeitungsschritte werden vom Standard-Input gelesen.

CallAPI für Windows

Eigenes Programm verwenden

Siehe Verwendung der CallAPI mit Ihrem eigenem Programm.

Dienstprogramm verwenden

Für die Verwendung des CallAPI ist keine Installation erforderlich. Sie müssen jedoch sicherstellen, dass das Hilfsprogramm auf die Datei UCXBWI3C.DLL zugreifen kann. Weitere Informationen finden Sie unter Verwendung des CallAPI-Dienstprogramms (ucxbxxxc).

Beispiel

Das folgenden Beispiel wird das Dienstprogramm mit Anmeldedaten des Mandanten 0098 aufgerufen. Der Zugang erfolgt ohne Angabe eines Passwortes. Es soll ein AE Script aktiviert werden, das in der Datei SCRIPT.TXT hinterlegt ist.

UCXBXXXC SCRIPT=SCRIPT.TXT LOGON=98,SMITH,UC4

CallAPI für z/OS

Sie können die Code-Tabelle angeben, die in der INI-Datei der CallAPI für z/OS verwendet werden soll. Geben Sie den Namen des CodeTable-Objekts in den Abschnitt [GLOBAL] ein, Parameter codetable=. Wenn dieser Parameter leer ist, wird die IBM-Standardcodetabelle verwendet.

Eigenes Programm verwenden

Siehe Verwendung der CallAPI mit Ihrem eigenem Programm.

Dienstprogramm verwenden

Im Lieferumfang ist das Dienstprogramm UCCALL4 enthalten, das Sie in z/OS-Jobs verwenden können. Sie finden es in der Ladebibliothek. Weitere Informationen finden Sie unter Verwendung des CallAPI-Dienstprogramms (ucxbxxxc).

Das AE-Script, das im Automation Engine verarbeitet werden soll, wird aus SYSIN gelesen. Sie können auch die Datendefinition anstelle der Dataset-Namen verwenden, wie Sie in den folgenden Beispielen sehen können.

Wenn das Dienstprogramm in einem Job verwendet werden soll, muss der Benutzer berechtigt sein, über TCP/IP zu kommunizieren.

Der Parameter REGION= sollte mindestens auf 65M gesetzt werden, da sonst Fehler auftreten.

Beispiele

Die Dataset-Namen müssen an Ihre Installation und z/OS-Konfiguration angepasst werden.

Die neueste CallAPI, Version 4, ist in LE C geschrieben und unterstützt AES-Verschlüsselung und IPv6:

//UC4JOB   JOB ......
//UCCALL   EXEC PGM=UCCALL4,
//    PARM='INI=FLQ.UCXBM25C.INI LOGON=<your four-digit client number>,<your user>,<your department>,<your password>'
//STEPLIB DD DSN=FLQ.UCXJM25.LOAD,DISP=SHR
//*        You can use the following command
//*        instead of the PARM INI=AE-inifile
//*UCINI    DD DSN=AE-inifile,DISP=SHR
//SYSIN    DD *
:SET &RUNNR = ACTIVATE_UC_OBJECT(JOBS,ExampleL1)
:IF &RUNNR = '0000000'
:   SET &ERROR = SYS_LAST_ERR_NR
:   STOP MSG,51,'ACTIVATION ERROR: &ERROR'
:ELSE
:   STOP NOMSG,50,'JOB WAS STARTED WITH RunID &RUNNR'
:ENDIF
/*
//

Siehe auch: