Anwendungsintegration > CallAPI > CallAPI und eigenes Programm > C, C++

C, C++

Das CallAPI bietet Ihnen die Möglichkeit aus Ihren eigenen C und C++ Programmen heraus, Scripts im Automation Engine System auszuführen.

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.

In der Auslieferung sind auch Programmbeispiele enthalten, die Ihnen zeigen wie eine Script-Aktivierung implementiert werden kann.

Die Datei uccall3.h gibt genauen Aufschluss über die Struktur und die Funktionen.

Allgemeines

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

Anmeldung am Automation Engine System
Übergabe des Scriptes an das Automation Engine System
Abmeldung vom Automation Engine System

Natürlich können sie sich gleichzeitig an verschiedene Automation Engine Systeme anmelden und mehrere Scripts ausführen. Für jede einzelne Verbindung wird eine Dialog-Lizenz verwendet.

Funktionalitäten

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.

Beschreibung	Datentyp des Rückgabewertes	Funktion
Anmelden am Automation Engine System	long	UCCALL3_Logon (Struktur, Anmeldedaten, Verbindung) Datentyp der Struktur: UCCALL_PARAMS* Datentyp der Anmeldedaten: char* Datentyp der Verbindung: char* Format für die Anmeldedaten: Mandant, Benutzer, [Abteilung, [Passwort]] Format für die Verbindungsdaten zum Kommunikationsprozess: DNS-Name:Portnummer bzw. TCP/IP-Adresse:Portnummer
Aktivieren eines Scriptes	long	UCCALL3_ActivateScript (Struktur, Script) Datentyp der Struktur: UCCALL_PARAMS* Datentyp des Scriptes: char*
Abmelden vom Automation Engine System	long	UCCALL3_Logoff (Struktur) Datentyp der Struktur: UCCALL_PARAMS*
Universelle Funktion	long	UCCALL3 (Strukturen) Anstatt der zuvor genannten Funktionen können Sie auch UCCALL3 aufrufen. Allerdings ist es dann erforderlich den Opcode in der Struktur anzugeben, damit die gewünschte Operation durchgeführt wird. Datentyp der Struktur: UCCALL_PARAMS*

Variablen

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

Datentyp	Variable	Beschreibung
char [4]	cOpCode	Operationscode Diese Variable muss bei der Verwendung der universellen Funktion gesetzt werden. Erlaubte Werte: "OPC_LOGON" - Anmelden am Automation Engine System "OPC_LOGOFF " - Abmelden vom Automation Engine System "OPC_ACTIVATE_SCRIPT" - Aktivieren eines Scriptes
char	cErrorCode	Der Fehlercode in cErrorCode wird automatisch gesetzt und kann einen der folgenden Werte enthalten: " " - Es ist kein Fehler aufgetreten. "P" - Ungültige(r) Parameter "O" - Ungültiger Opcode "Q" - Anmeldung ist fehlgeschlagen "R" - Speicheranforderung ist fehlgeschlagen "L" - Speicherfreigabe ist fehlgeschlagen "S" - Socketfehler "T" - Timeout "U" - Fehlermeldung vom Automation Engine System
char [3]	cInterface	Die Interfacenummer muss immer den Wert 3 enthalten.
char [8]	cSystemName	Name des Automation Engine Systems, zu dem die Verbindung aufgebaut werden soll
unsigned short	sTimeout	Zeitdauer in Sekunden, die das CallAPI auf eine Quittung vom Automation Engine System wartet
char	cLanguage	Sprache in der die Meldungen ausgegeben werden
unsigned char	cFlag1	Dieses Kennzeichen bewirkt je nach gesetztem Wert eine der folgenden Verarbeitungsoptionen: "CALL_FLAG1_INI_SERVER" - Die Verbindung zum Kommunikationsprozess wird aus der INI-Datei ermittelt. "CALL_FLAG1_INI_LOGIN" - Die Anmeldedaten werden aus der INI-Datei ermittelt. "CALL_FLAG1_INI_USEMSL" - Wandelt die variablen Meldungsteile auf eine ganzen Meldungstext um. "CALL_FLAG1_INI_USEALL" - Die Einstellungen der Sektion [GLOBAL] in der INI-Datei werden verwendet. "CALL_FLAG1_TRC_HANDLE" - nur für die interne CallAPI-Verarbeitung "CALL_FLAG1_LOG_HANDLE" - nur für die interne CallAPI-Verarbeitung "CALL_FLAG1_INI_FILE" - Name für die INI-Datei "CALL_FLAG1_TRC_OUTPUT" - nur für die interne CallAPI-Verarbeitung
unsigned long [4]	lUnused1	nicht in Verwendung
unsigned long	Ausgaben	nicht in Verwendung
unsigned long [4]	lUnsued2	nicht in Verwendung
unsigned long	lScriptRunNr	RunID des Scriptes
unsigned long	lRetCode	Rückgabewert der Scriptausführung
char [256]	cRetText	Variabler Teil der Meldung, der den Hintergrund des Rückgabewertes erläutert
char*	pIniFile	Pfad und Name der INI-Datei
unsigned long	hZuLog	nur für die interne CallAPI-Verarbeitung
unsigned long	hZuTrc	nur für die interne CallAPI-Verarbeitung
unsigned long	hZuHlp	nur für die interne CallAPI-Verarbeitung
unsigned long [11]	lUnused3	nicht in Verwendung
void*	pOwnPointer	nur für die interne CallAPI-Verarbeitung

Siehe auch:

Allgemeines zum CallAPI

Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support