CallAPI

CallAPI est utilisé pour déclencher des processus dans le système AE depuis l'extérieur, en utilisant Langage de script Automation Engine. Vous pouvez lancer des objets exécutables, définir ou lire des contenus d'objets Variable, ou obtenir des informations spécifiques sur le statut des tâches. Si vous êtes administrateur, vous pouvez configurer CallAPI, spécifier des données de connexion, vous connecter à AE et définir les paramètres spécifiques à votre plateforme. Vous pouvez utiliser CallAPI soit avec votre propre programme, soit avec un utilitaire. Langage de script Automation Engine est limité à 32000 caractères dans tous les cas.

Cette rubrique contient les sujets suivants :

Informations générales

Se connecter au système AE

Pour se connecter au système AE, CallAPI a besoin d'un utilisateur valide. Cet utilisateur doit détenir le privilège Connexion par CallAPI et doit avoir les droits d'exécution. Vous pouvez spécifier vos données de connexion (client, utilisateur, département et mot de passe) dans le fichier INI de CallAPI. Vous pouvez également le spécifier lorsque vous appelez CallAPI. Ces données sont préférées lorsque vous spécifiez les données de connexion aux deux emplacements.

Vous pouvez chiffrer votre mot de passe en utilisant le programme UCYBCRYP.EXE. La chaîne chiffrée ne doit pas dépasser 64 caractères. Pour plus d'informations, voir Chiffrement des mots de passe.

Aucune vérification du mot de passe n'est effectuée lorsque vous utilisez la connexion unique pour votre CallAPI. Pour ce faire, enregistrez les données correspondantes dans la variable système UC_USER_LOGON. Pour plus d'informations, voir UC_USER_LOGON - Connexion unique.

Se connecter à Automation Engine

Pour activer votre script dans le système AE requis, CallAPI a besoin des informations de connexion des processus de communication correspondants. Saisissez ces informations de connexion dans le fichier INI (2217=localhost, par exemple). Dans les appels CallAPI provenant de vos propres programmes, vous pouvez les affecter directement.

Messages

Si vous utilisez un objet Job qui appelle l'utilitaire CallAPI, vous pouvez voir les messages associés dans le rapport du job.

Vous pouvez utilisez l'instruction de script :STOP pour affecter des numéros de messages et des textes à CallAPI. Ils sont enregistrés dans les variables de scripts et peuvent être lus avec vos propres programmes. Les noms de ces variables dépendent du langage de programmation que vous utilisez. Selon le mode d'arrêt que vous définissez dans l'instruction de script :STOP, soit le script s'interrompt, soit il continue son exécution.

Utiliser CallAPI avec votre propre programme

Vous pouvez utiliser CallAPI pour traiter des scripts dans le système AE à partir de vos propres programmes écrits en C, C++, Cobol, Java, ou Visual Basic. Il faut pour cela avoir de solides connaissances du langage de programmation dans lequel le programme est écrit.

Les scripts sont toujours activés selon les trois étapes suivantes :

  1. Connectez-vous au système AE.
  2. Transférez le script vers le système AE.
  3. Déconnectez-vous du système AE.

Vous pouvez vous connecter à plusieurs systèmes AE simultanément et traiter divers scripts.

CallAPI avec C, C++

Vous devez intégrer les fichiers uccall3.h et ucxbwi3c.lib. Notez que votre programme doit avoir accès à la bibliothèque ucxbwi3c.dll (dossier Windows).

Le répertoire de livraison contient des modèles de programmes fournissant une description détaillée sur la manière d'appeler CallAPI. Le fichier uccall3.h fournit des informations sur la structure et les fonctions.

Fonctions

Vous pouvez utiliser les diverses fonctions dans vos programmes. Elles renvoient le code retour 0 si l'action s'est terminée avec succès ou un numéro de message en cas d'erreur. Le type de données pour tous les codes retour est long.

Variables

Les informations, telles que le nom du système ou le RunID du script sont enregistrées dans la structure UCCALL_PARAMS. Elle contient les variables suivantes :

CallAPI avec Cobol

Appelez CallAPI via la commande CALL UCCALL3. Renvoie le code retour 0 en cas de succès de l'action ou un numéro de message en cas d'erreur.

Variables

Le modèle de programme fourni explique la structure AE-RECORD. Elle contient les variables suivantes :

CallAPI avec Java

Requiert que la classe UCCALL3 soit importée du package com.uc4.uccall3.

Le répertoire de livraison contient des modèles de programmes vous montrant comment vous connecter, activer des scripts, vous connecter aux différents systèmes, trouver des erreurs de connexion, etc.. Le documentation CallAPI fournie propose des informations actuelles sur les fonctions disponibles, les méthodes et la classe Java.

CallAPI avec Visual Basic

Cette fonction se trouve dans l'objet COM AE.Call3 qui doit être enregistré.

Exemple

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

Le répertoire de livraison contient un modèle de programme fournissant une description détaillée sur la manière d'activer un script.

Méthodes

Votre programme vous permet d'utiliser les fonctions suivantes. Elles renvoient le code retour 0 si l'action s'est terminée avec succès ou un numéro de message en cas d'erreur.

Attributs

Les informations relatives à l'exécution des scripts sont automatiquement enregistrées dans les variables de script suivantes :

Une partie du package livré fournit des exemples pour toutes les plateformes prises en charge.

Utilisez l'utilitaire CallAPI (ucxbxxxc)

Vous pouvez utiliser un utilitaire CallAPI fourni pour chaque plateforme prises en charge. Vous n'avez pas besoin de posséder des connaissances en programmation. Selon votre système d'exploitation, vous pouvez appeler cet utilitaire à partir de jobs, de procédures et de fichiers exécutables, ou directement à partir de la ligne de commande.

Écrivez le script que vous souhaitez utiliser dans un fichier texte et affectez ce fichier à l'appel de l'utilitaire. La syntaxe suivante s'applique à toutes les plateformes :

Fichier CallAPI SCRIPT=fichier de script [LOGON=client,utilisateur,[département[,mot de passe]]] [INI=fichier INI] [QUEUE=nom de l'objet Queue]

Paramètres :

Exemple (Windows)

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

L'utilitaire CallAPI fournit plusieurs codes retour permettant de surveiller l'activation des scripts :

(SAP) Le paramètre de démarrage du serveur RFC est différent. -I est le seul paramètre et il indique le chemain du fichier INI :

Conseil : Cochez la case Inclure ou exclure les tâches désactivées pour rechercher votre script et spécifiez le type de tâche CallAPI, ou saisissez le RunID de tâche du script CallAPI.

Plateformes pour CallAPI

Voir aussi :