|
Généralités sur CallAPI |
CallAPI |
Plateformes pour les CallAPI |
|
Utilisation de CallAPI| CallAPI est disponible sur les plateformes les plus diverses et est très polyvalent. Pour en savoir plus sur son utilisation et sur les paramètres actifs, lisez les informations suivantes. |
La description de l'installation et des Fichiers INI du CallAPI se trouve dans le manuel administrateur.
CallAPI peut être utilisé de deux manières différentes. Dans les deux cas, le script AE est limité à 32000 caractères.
La première possibilité d'utilisation de CallAPI consiste à exécuter chacun de vos propres programmes. Ceux-ci peuvent être écrits dans les langages de programmation suivants :
Des exemples de cette utilisation de CallAPI sont fournis pour toutes les plateformes prises en charge.
La deuxième possibilité d'utilisation de CallAPI ne nécessite aucune connaissance de programmation. Un utilitaire est disponible pour chaque plateforme prise en charge. Il peut, par exemple, être exécuté à partir de Jobs, de procédures, de fichiers exécutables ou directement à partir de la ligne de commande. Les possibilités sont définies par le système d'exploitation.
Ecrivez le script dans un fichier texte et transmettez-le en exécutant 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]
|
Paramètres |
Description |
|---|---|
|
SCRIPT= |
Chemin et nom du fichier de script Vous pouvez ignorer les données de connexion à l'exécution si celles-ci ont été incluses dans le fichier INI. |
|
facultatif : |
|
|
LOGON= |
Données de connexion |
|
INI= |
Chemin et nom du fichier INI Si vous avez renommé le fichier INI ou que vous l'avez déplacé dans un autre répertoire, vous devez transmettre ce paramètre. |
Exemple d'exécution de CallAPI sous Windows :
UCXBXXXC SCRIPT=C:\AE\CALLAPI\script.txt LOGON=98, HENRI, AE INI=C:\AE\CALLAPI\WINDOWS\ucxbxxxc.ini
L'utilitaire propose divers codes retour vous permettant de suivre l'activation de script :
|
Code retour |
Description |
|---|---|
|
0 |
Le script AE a été activé sans erreur. |
|
4 |
Le script AE a été activé, mais s'est terminé avec l'instruction de script :STOP MSG, 50, "Texte libre". |
|
8 |
Erreur d'activation du script ou |
|
12 |
Erreur lors de la connexion à l'Automation Engine. |
|
16 |
Erreur fatale : le fichier de script ne peut être ouvert ou lu. |
Attention : d'autres paramètres de démarrage doivent s'appliquer au Serveur RFC pour SAP ! Ce Serveur ne possède qu'un paramètre nommé -I, qui permet d'indiquer le chemin vers le fichier INI.
UCXBRXXC -IC:\AE\CALLAPI\SAP\UCXBRXXC.INI
nohup ./ucxsapc -I./ucxsapc.ini
Veuillez noter que le code retour est affiché lorsque l'activation du script AE a été interrompue à cause d'une erreur (par ex. syntaxe ou nombre incorrect des paramètres de fonction). Certaines erreurs peuvent apparaître dans la Fenêtre des messages de l'Interface Utilisateur et/ou dans le rapport, et ne pas interrompre le script AE (par ex. erreur dans les fonctions de script ACTIVATE_UC_OBJECT et IMPORT). Dans ce cas, l'utilitaire s'achève toujours avec le code retour 0.
Le RunID indiqué lors de l'exécution de l'utilitaire est celui du script CallAPI.
CallAPI requiert un Utilisateur AE valide pour se connecter au système AE. Les données de connexion, qui se composent d'un Client, d'un nom d'utilisateur, d'un département et d'un mot de passe, peuvent être saisies dans le fichier INI ou être transmises directement lors de l'exécution de CallAPI. On utilise principalement cette dernière possibilité lorsque les données de connexion sont conservées aux deux emplacements.
L'Utilisateur qui permet au CallAPI de se connecter au système AE doit posséder le privilège "Connexion par le Call Interface".
Lors de l'exécution du script, les droits de l'Utilisateur AE sont bien sûr vérifiés.
Vous pouvez encrypter le mot de passe avec le programme UCYBCRYP. Attention : la chaîne encryptée ne doit pas dépasser 64 caractères.
Si vous le souhaitez, CallAPI peut être utilisé sans vérification du mot de passe. Avantage : le mot de passe n'est pas enregistré dans les programmes ou les procédures, ce qui évite de devoir les modifier à chaque fois qu'un nouveau mot de passe est attribué. Vous pouvez conserver la connexion automatique dans la Variable UC_USER_LOGON de l'Automation Engine.
Comme vous l'avez vu dans les descriptions précédentes, CallAPI se comporte comme une connexion manuelle au système AE. Il utilise donc une licence de dialogue libre pour chaque connexion. Dans la Variable UC_SYSTEMS_SETTINGS de l'Automation Engine, qui se trouve dans le Client système 0000, vous pouvez réserver de nombreuses licences de dialogue pour les connexions CallAPI à l'aide de la Clef RESERVED_API_USERS. Ainsi, les connexions manuelles de l'Utilisateur et celles de CallAPI ne se bloquent pas mutuellement.
Pour activer le script dans le système AE souhaité, CallAPI requiert les informations de connexion du processus de communication correspondant. Intégrez ces informations de connexion dans le fichier INI. Lors de l'exécution de CallAPI dans votre propre programme, elles sont également transmises directement.
L'élément de script :STOP permet de transmettre les numéros de message et les textes à CallAPI qui sont enregistrés dans la Variable et qui peuvent donc être lus dans vos propres programmes. Ceux-ci sont stockés dans des Variables et peuvent ainsi être lus à partir de vos propres programmes. L'appellation de cette Variable dépend du langage de programmation ; vous pouvez la rechercher dans le chapitre "CallAPI et son programme".
Exécutez l'utilitaire de CallAPI en utilisant un objet Job ; vous pouvez ainsi voir les messages dans le rapport.
Selon la syntaxe utilisée pour la fonction script :STOP, le script s'interrompt ou continue à être exécuté.
Rubriques connexes :