Plateformes pour CallAPIs

Les applications CallAPI sont prises en charge pour les plateformes BS2000, Java, NSK, OS/400, SAP, UNIX, VMS, Windows et z/OS. Les fichiers sont livrés avec Automation Engine et des exemples sont fournis pour chaque plateforme.

Cette rubrique contient les sujets suivants :

CallAPI pour BS2000

Définissez la table de codes à utiliser dans le fichier INI du CallAPI pour BS2000. Saisissez le nom de l'objet Table de codes dans le paramètre codetable= de la section [GLOBAL].

Utiliser votre propre programme

Vous pouvez affecter tous les paramètres requis avec votre programme. Il faut simplement inclure le module UCCALL3 ou le recharger à l'exécution de manière dynamique. Pour plus d'informations, voir Utiliser CallAPI avec votre propre programme.

Utiliser l'utilitaire

Le package fourni comprend l'utilitaire UCXBB2?C. Vous pouvez l'utiliser dans les jobs batch ou les procédures BS2000. Pour plus d'informations, voir Utilisez l'utilitaire CallAPI (ucxbxxxc)

L'utilitaire lit les données requises pour se connecter à Automation Engine via SYSDTA. Le script AE à exécuter peut provenir d'un fichier ou directement de SYSDTA. Si vous utilisez un fichier, vous devez l'affecter avant l'appel du programme, en utilisant le nom de lien UCSCRIPT.

Exemples

Dans le premier exemple, le nom de lien UCSCRIPT n'est pas affecté. Le script AE à exécuter est lu jusqu'à ce qu'il atteigne la commande SYSDTA /EOF.

/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

Le script à exécuter est disponible dans le fichier MY.SCRIPT.FILE :

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

L'exemple suivant renvoie le RunID, le code d'erreur et le message d'erreur de la CallAPI. Ces trois valeurs sont écrites dans une variable de job (JV). 

/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 pour Java

Utiliser votre propre programme

Vous pouvez utiliser la CallAPI pour Java avec votre propre programme. Pour plus d'informations, voir Utiliser CallAPI avec votre propre programme.

Utiliser l'utilitaire

Vous pouvez appeler le fichier UCCALL3.JAR à partir de la ligne de commande ou d'un fichier batch. Un exemple de fichier (UCCALL3.BAT) expliquant comment l'appeler à partir d'un fichier batch est fourni avec les fichiers AE. Pour plus d'informations, voir Utilisez l'utilitaire CallAPI (ucxbxxxc)

Exemple

La CallAPI est appelée avec les données de connexion du client 0098 et est accessible sans utilisation d'un mot de passe. L'exemple suivant illustre l'activation d'un script AE enregistré dans le fichier SCRIPT.TXT.

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

CallAPI pour NSK

Utiliser votre propre programme

Vous pouvez utiliser la CallAPI pour Java avec votre propre programme. Pour plus d'informations, voir Utiliser CallAPI avec votre propre programme.

Utiliser l'utilitaire

L'utilitaire UCXBNS1C fait partie du package AE. Vous pouvez l'appeler depuis la ligne de commande du système d'exploitation correspondant, depuis un script ou un job. Pour plus d'informations, voir Utilisez l'utilitaire CallAPI (ucxbxxxc)

Exemples

Dans le premier exemple, l'utilitaire est appelé avec les informations de connexion et d'authentification spécifiées sous forme de paramètres. L'utilitaire lit les instructions de traitement (script AE) dans le fichier "SCRFILE" également spécifié comme paramètre.

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

Dans le premier exemple, l'utilitaire est appelé avec le fichier de script spécifié comme paramètre. Les données de connexion et d'authentification, ainsi que les informations supplémentaires sont lues dans le fichier INI.

run ucxbns1c script=SRCFILE INI=UCXBNS1I

CallAPI pour OS/400

Utiliser votre propre programme

Vous pouvez utiliser la CallAPI pour OS/400 avec votre propre programme. Pour plus d'informations, voir Utiliser CallAPI avec votre propre programme.

Utiliser l'utilitaire

L'utilitaire UCXBO41C fourni est disponible dans la bibliothèque et peut être utilisé dans les scripts OS/400 CL. Pour plus d'informations, voir Utilisez l'utilitaire CallAPI (ucxbxxxc)

Le script AE à exécuter est lu par un membre fichier.

Exemple

Les bibliothèques sont adaptées à votre installation AE.

CALL PGM(UC4/UCXBO41C) +
PARM('INI=UC4/INI(UCXBO41C)' 'LOGON=<your four-digit client number>,<your user>,<your password>' 'SCRIPT=UC4/INI(SCRSAMP)')

CallAPI pour SAP

Le serveur RFC transfère le script vers le système AE. Il inclut un module fonctionnel appelé UC4 que vous pouvez appeler dans vos programmes ABAP.

Le dossier "sample" des fichiers fournis comprend des modèles de programmes expliquant comment l'utiliser. Pour plus d'informations, voir Utilisez l'utilitaire CallAPI (ucxbxxxc)

Module fonctionnel UC4

Une connaissance approfondie de ABAP/4 est nécessaire pour comprendre les descriptions suivantes :

Paramètres d'importation

Paramètres d'exportation

Tables

Exceptions

Exemple

Appelez le module fonctionnel :

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 pour UNIX

Utiliser votre propre programme

Le programme UCXBXXXC.c est disponible sous forme de code source C. Les définitions de structure correspondantes sont stockées dans le fichier UCCALL3.h. Ces fichiers et le fichier MakeFile permettant de compiler les exemples, sont disponibles dans le répertoire /src. Adaptez l'exemple fourni à vos données. Adaptez le fichier MakeFile MAKEFILE_EXAMPLE.??? à votre environnement. Renommez-le MAKEFILE, afin de pouvoir ensuite l'appeler avec make car MAKEFILE est le nom par défaut. Vous pouvez alors générer un fichier EXE et tester la CallAPI. Pour plus d'informations, voir Utiliser CallAPI avec votre propre programme.

Utiliser l'utilitaire

L'utilitaire UCXB???C est fourni avec les fichiers AE. Vous pouvez l'appeler à partir de la ligne de commande ou d'un fichier exécutable. Pour plus d'informations, voir Utilisez l'utilitaire CallAPI (ucxbxxxc)

Le script AE permet de définir la procédure entrée par défaut à l'appel du programme : L'entrée < nom de fichier lit le script AE à partir du fichier correspondant. L'entrée <<EOF_SCRIPT lit le script AE à partir de la ligne de commande jusqu'à ce que le texte "EOF_SCRIPT" soit détecté.

Exemples

Dans le premier exemple, l'utilitaire est appelé avec le script AE lu à partir du fichier script.txt. Les spécifications de connexion et d'authentification sont lues dans le fichier INI.

./UCXBUI5C SCRIPT=./script.txt

Dans le second exemple, les spécifications de connexion et d'authentification sont transmises par la Call API.

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

CallAPI pour VMS

Utiliser votre propre programme

Le programme UCXBXXXC.c est disponible sous forme de code source C. La définition de structure correspondante est enregistrée dans le fichier UCCALL3.H. Une commande permettant de compiler l'exemple est disponible dans MAKEXAMP.COM. Adaptez cet exemple à vos données et à votre environnement. Vous pouvez ainsi générer un fichier EXE et tester la CallAPI. Pour plus d'informations, voir Utiliser CallAPI avec votre propre programme.

Utiliser l'utilitaire

Le contenu du package comprend l'utilitaire UCXBV??C.EXE que vous pouvez appeler à partir d'un fichier de commande. Pour plus d'informations, voir Utilisez l'utilitaire CallAPI (ucxbxxxc)

La procédure définie avec le script AE est lue par l'entrée standard.

CallAPI pour Windows

Utiliser votre propre programme

Vous pouvez utiliser la CallAPI pour Windows avec votre propre programme. Pour plus d'informations, voir Utiliser CallAPI avec votre propre programme.

Utiliser l'utilitaire

L'utilisation de CallAPI ne nécessite aucune installation. Il suffit juste de vérifier que l'utilitaire peut accéder au fichier UCXBWI3C.DLL. Pour plus d'informations, voir Utilisez l'utilitaire CallAPI (ucxbxxxc)

Exemple

Dans l'exemple suivant, l'utilitaire est appelé avec les données de connexion du client 0098. L'accès est possible sans mot de passe. Le but est d'activer un script AE enregistré dans le fichier SCRIPT.TXT.

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

CallAPI pour z/OS

Définissez la table de codes à utiliser dans le fichier INI de la CallAPI pour z/OS. Saisissez le nom de l'objet Table de codes dans le paramètre codetable= de la section [GLOBAL]. Si ce paramètre n'est pas défini, c'est le code IBM par défaut qui est utilisé.

Utiliser votre propre programme

Vous pouvez utiliser la CallAPI pour z/OS avec votre propre programme. Pour plus d'informations, voir Utiliser CallAPI avec votre propre programme.

Utiliser l'utilitaire

Le contenu du package comprend l'utilitaire UCCALL4 que vous pouvez utiliser dans les jobs z/OS. Il se trouve dans la bibliothèque de chargement. Pour plus d'informations, voir Utilisez l'utilitaire CallAPI (ucxbxxxc)

Le script AE à traiter dans Automation Engine est lu dans SYSIN. Vous pouvez également utiliser la définition de données à la place des noms du jeu de données comme le montrent les exemples suivants.

Si l'utilitaire doit être utilisé dans un job, l'utilisateur doit être autorisé à communiquer via TCP/IP.

Le paramètre REGION= doit être au moins 65M, afin qu'aucune erreur ne se produise.

Exemples

Les noms du jeu de données doivent être adaptés à votre installation et configuration z/OS.

La dernière CallAPI, version 4, est écrite en LE C et prend en charge le chiffrement AES et IPv6 :

//UC4JOB   JOB ......
//UCCALL   EXEC PGM=UCCALL4,REGION=65M,
//    PARM='INI=FLQ.UCXBM25C.INI LOGON=<your four-digit client number>,<your user>,<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
/*
//

La précédente CallAPI, version 3, qui est écrite en Assembleur, est encore utilisable :

//UC4JOB   JOB ......
//UCCALL   EXEC PGM=UCXBM25C,REGION=65M,
//    PARM='INI=FLQ.UCXBM25C.INI LOGON=<your four-digit client number>,<your user>,<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
/*
//

Voir aussi :