Vous êtes sur la page 1sur 36

VisualAge Pacbase

Guide dutilisation de lAPI COBOL


Version 3.5

VisualAge Pacbase

Guide dutilisation de lAPI COBOL


Version 3.5

Note
Avant dutiliser le prsent document et le produit associ, prenez connaissance des informations gnrales
figurant la section Notices la page v.
En application de votre contrat de licence, vous pouvez consulter ou tlcharger la documentation de
VisualAge Pacbase, rgulirement mise jour, partir de :
http://www.ibm.com/software/awdtools/vapacbase/productinfo_f.htm
La section Catalogue dans la page daccueil de la Documentation vous permet didentifier la dernire dition
disponible du prsent document.

Premire dition (Octobre 2003)


La prsente dition sapplique :
v VisualAge Pacbase Version 3.5
Vous pouvez nous adresser tout commentaire sur ce document (en indiquant sa rfrence) via le site Web de notre
Support Technique ladresse suivante : http://www.ibm.com/software/awdtools/vapacbase/support.htm ou en
nous adressant un courrier :
IBM Paris Laboratory
1, place JeanBaptiste Clment
93881 Noisy-le-Grand, France.
IBM pourra disposer comme elle lentendra des informations contenues dans vos commentaires, sans aucune
obligation de sa part.
Copyright International Business Machines Corporation 1983,2003. All rights reserved.

Table des matires


Notices .
Marques .

.
.

.
.

.
.

.
.

.
.

Chapitre 1. Introduction .

.
.

.
.

.
.

.
.

.
.

.
.

. v
. vii

. 1

Chapitre 2. Dclaration des zones de


working . . . . . . . . . . . . . 3
Introduction . . . . . . . . . . . . 3
Gestion des erreurs . . . . . . . . . . 4
Dclaration dune Application eBusiness . . . 5
Dclaration du buffer utilisateur . . . . . 5
Dclaration du buffer serveur . . . . . . 6
Dclaration des Dossiers . . . . . . . . 6
Dclaration des noeuds de Dossier . . . . . 7

Copyright IBM Corp. 1983,2003

Chapitre 3. Demandes de services sur un


Dossier . . . . . . . . . . . .
Introduction . . . . . . . . . . .
Service de mise jour . . . . . . . .
Service de lecture . . . . . . . . .
Lecture ramenant au plus une instance .
Lecture ramenant au moins une instance
Dfinition de la collection . . . .
Parcours de la collection . . . . .
Service utilisateur . . . . . . . . .
Services dinitialisation et de terminaison .
Chapitre 4. Chanages .

.
.
.
.
.
.
.
.
.

11
11
11
13
14
15
15
16
19
20

. 23

iii

iv

VisualAge Pacbase : Guide dutilisation de lAPI COBOL

Notices
Ce document peut contenir des informations ou des rfrences concernant
certains produits, logiciels ou services IBM. Cela ne signifie pas quIBM ait
lintention de les annoncer dans tous les pays o la compagnie est prsente.
Toute rfrence un produit, logiciel ou service IBM nimplique pas que seul
ce produit, logiciel ou service puisse tre utilis. Tout autre lment
fonctionnellement quivalent peut tre utilis, sil nenfreint aucun droit
dIBM. Il est de la responsabilit de lutilisateur dvaluer et de vrifier
lui-mme les installations et applications ralises avec des produits, logiciels
ou services non expressment rfrencs par IBM.
IBM peut dtenir des brevets ou des demandes de brevet couvrant les
produits mentionns dans le prsent document. La remise de ce document ne
vous donne aucun droit de licence sur ces brevets ou demandes de brevet. Si
vous dsirez recevoir des informations concernant lacquisition de licences,
veuillez en faire la demande par crit ladresse suivante : IBM Director of
Licensing, IBM Corporation, North Castle Drive, Armonk NY 105041785,
U.S.A.
Les dtenteurs de licences du prsent produit souhaitant obtenir des
informations sur celui-ci des fins : (i) dchange dinformations entre des
programmes dvelopps indpendamment et dautres programmes (y compris
celui-ci) et (ii) dutilisation mutuelle des informations ainsi changes doivent
sadresser : IBM Paris Laboratory, SMC Department, 1 place J.B.Clment,
93881 Noisy-Le-Grand Cedex, France. De telles informations peuvent tre
mises la disposition du Client et seront soumises aux termes et conditions
appropris, y compris dans certains cas au paiement dune redevance.
IBM peut modifier ce document, le produit quil dcrit ou les deux.

Copyright IBM Corp. 1983,2003

vi

VisualAge Pacbase : Guide dutilisation de lAPI COBOL

Marques
IBM est une marque dInternational Business Machines Corporation, Inc. AIX,
AS/400, CICS, CICS/MVS, CICS/VSE, COBOL/2, DB2, IMS, MQSeries, OS/2,
VisualAge Pacbase, RACF, RS/6000, SQL/DS et VisualAge sont des marques
dInternational Business Machines Corporation, Inc. dans certains pays.
Java et toutes les marques et logos incluant Java sont des marques de Sun
Microsystems, Inc. dans certains pays.
Microsoft, Windows, Windows NT et le logo Windows sont des marques de
Microsoft Corporation dans certains pays.
UNIX est une marque enregistre aux Etats-Unis et/ou dans dautres pays et
utilise avec lautorisation exclusive de la socit X/Open Company Limited.
Dautres socits peuvent tre propritaires des autres marques, noms de
produits ou logos qui pourraient apparatre dans ce document.

Copyright IBM Corp. 1983,2003

vii

viii

VisualAge Pacbase : Guide dutilisation de lAPI COBOL

Chapitre 1. Introduction
Lobjet de ce guide est de vous prsenter toutes les informations ncessaires
lutilisation de lAPI COBOL partir de Developer workbench.
LAPI COBOL vous permet dutiliser les Dossiers et les Composants
Elmentaires non dans le cadre de Proxies mais de faon totalement ouverte,
lintrieur de programmes applicatifs. Ces programmes bnficient alors de la
hirarchie et de la rutilisation des informations du Dossier, du regroupement
de ses traitements. Vous utilisez donc le Dossier en lui apportant des entres
externes lApplication eBusiness.
Exemple : Pour grer les prlvements automatiques date fixe de ses clients,
une banque peut utiliser lentit Programme qui va exploiter les
informations du Dossier Clients.
Il est conseill dcrire le programme applicatif dans lentit Programme de
VA Pac. Cependant, il est aussi possible de lcrire dans lentit Composant
Elmentaire ou Ecran.
LAPI COBOL vous permet dindiquer des demandes de services (mise jour,
dition de listes...) sur le Dossier appel dans votre programme applicatif.
Vous bnficiez pour cela de facilits dcriture avec :
v des oprateurs en langage structur qui vont formater le message en entre
du Dossier,
v la description COBOL des donnes de la zone de communication en entre
du Dossier.
Pour gnrer le programme applicatif contenant lappel aux entits eBusiness,
vous devez excuter la procdure batch GPRC. Cette procdure est explique
dans le Guide du Dveloppeur spcifique votre plateforme, dans le
chapitre Editions-gnrations.

Copyright IBM Corp. 1983,2003

VisualAge Pacbase : Guide dutilisation de lAPI COBOL

Chapitre 2. Dclaration des zones de working


Introduction
La premire tape consiste dclarer lApplication eBusiness et ses Dossiers
dans la working de votre programme applicatif. Vous devez donc :
v dclarer loprateur qui va grer les erreurs retournes par les services,
v appeler lApplication eBusiness voulue,
v dclarer les buffers utiliss par cette Application, si celle-ci en utilise,
v appeler les Dossiers et noeuds de Dossier utiliss.
Vous devez effectuer toutes ces dclarations dans longlet Langage Structur
de votre programme applicatif, sous-onglet Zones de Working, sur des lignes
de type A.
La partie Description de ces lignes est divise en zones de 10 caractres.
Vous devez indiquer dans la premire zone le code de loprateur API
COBOL, puis dans les autres les paramtres ncessaires cet oprateur (le
nombre de paramtres change suivant loprateur).
Attention, pour un fonctionnement correct de lAPI COBOL, vous devez
respecter scrupuleusement ce cadrage.

Copyright IBM Corp. 1983,2003

Gestion des erreurs


Vous devez tout dabord dclarer loprateur qui va grer les erreurs
retournes par les services excuts :
A ERRORM

PARAM1

PARAM2

O
PARAM1=XXXX code du Segment gnr
PARAM2=nnnnn nombre de postes de cette structure
(nnnnn=00001)

Toutes les structures ncessaires la gestion des erreurs seront gnres dans
la working du programme applicatif o vous avez dclar cet oprateur.
Le code dfini par PARAM1 correspond au code Segment programme de la
structure identifiant les code et message derreur. Il est obligatoire et ne doit
pas tre identique au code dune structure qui existe dj dans le programme.
Dans le COBOL gnr, la structure dfinissant les erreurs retournes par les
services est la suivante :
01
05
05
10

XXXX.
XXXX-ERRNB
XXXX-WERR.
XXXX-ERR

VisualAge Pacbase : Guide dutilisation de lAPI COBOL

PICTURE 9(5) VALUE ZERO.


OCCURS nnnnn.

15
15

XXXX-ERRKEY
XXXX-LABEL
XXXX-ERRCOD.
XXXX-STATUS
XXXX-CODE
XXXX-TYPE

05
10
10
10

PICTURE X(25).
PICTURE X(67).
PICTURE X(09).
PICTURE X(27).
PICTURE X(02).

ERRNB correspond au nombre derreurs rendues par le Gestionnaire de


Dossier aprs lexcution dun service de lApplication eBusiness.
ERR contient ces erreurs, identifiants et messages.
ERRCOD contient les erreurs SQL.
CODE contient la valeur SQL ERRCODE.
TYPE et STATUS contiennent les codes erreur.

Dclaration dune Application eBusiness


Vous dclarez une Application eBusiness dans votre programme applicatif de
la faon suivante :
A EBAPPLI

PARAM1

O
PARAM1=XXXXXX Code rfrentiel (code court) de lApplication
eBusiness.

Un chanage sera cr sur lApplication eBusiness.


Vous ne pouvez appeler quune seule Application eBusiness par programme
applicatif.
Lensemble des structures ncessaires la dclaration de lApplication sera
gnr en working du programme applicatif o est dfinie cette instruction.

Dclaration du buffer utilisateur


Si lApplication eBusiness utilise un buffer utilisateur, vous devez dclarer ce
buffer de la faon suivante :
A BUFFERUSERPARAM1
O
PARAM1 = XXXX

Code Segment gnr

Ce code Segment est initialis au code Segment rfrentiel qui dfinit le buffer
utilisateur de lApplication eBusiness. Il peut tre modifi pour des raisons de
nommage dans le programme applicatif.
Chapitre 2. Dclaration des zones de working

Dans le COBOL gnr, la structure complte du buffer utilisateur de


lApplication eBusiness se prsente sous la forme :
01 XXXX.
10 XXXX-CORUB1.
15 XXXX-CORUB2 PIC X(nnn).
10 etc.

Dclaration du buffer serveur


Si lApplication eBusiness utilise un buffer serveur, vous devez dclarer ce
buffer de la faon suivante :
A BUFFERSERVPARAM1
O
PARAM1 = XX Code Structure gnr

Le code Structure de Donnes est initialis au code Structure de Donnes


rfrentiel qui dfinit la Structure de donnes du buffer serveur de
lApplication eBusiness. Il peut tre modifi pour des raisons de nommage
dans le programme.
Cette instruction permet de gnrer les structures du buffer serveur de
lApplication eBusiness sous la forme dun FILLER, ce buffer ntant utilis
que dans les Composants Elmentaires.
01 XX00.
05 FILLER

PICTURE X(nnnnn).

Dclaration des Dossiers


La dclaration des Dossiers dans le programme applicatif comprend, pour
chaque Dossier, la dclaration du Dossier ainsi que la dclaration des noeuds
utiliss.
Vous dclarez un Dossier de la faon suivante :
A FOLDER
O

PARAM1

PARAM2

PARAM1 = XXXXXX

Code rfrentiel (code court) dun


Dossier de lApplication eBusiness.
PARAM2 = XXXXXX Code gnr du Dossier.

Un chanage sera cr sur le code rfrentiel du Dossier.


PARAM2 est initialis au code rfrentiel. Il peut tre modifi pour des
raisons de nommage dans le programme applicatif.
Un mme Dossier peut tre dclar plusieurs fois dans le programme
condition de lutiliser sous des noms diffrents.

VisualAge Pacbase : Guide dutilisation de lAPI COBOL

Cette instruction permet de gnrer toutes les zones de working utilises dans
les diffrentes demandes de service pour ce Dossier.

Dclaration des noeuds de Dossier


Aprs avoir dclar les Dossiers utiliss, vous devez spcifier quels en sont les
noeuds utiliss par votre programme applicatif.
Vous dclarez un noeud de Dossier de la faon suivante :
A NODE

PARAM1

PARAM2

O
PARAM1= XXXX Identifiant du noeud dans le Dossier associ
PARAM2= XXXX Code programme du noeud.

Le code programme du noeud est initialis par lidentifiant du noeud dans le


Dossier. Il peut tre modifi pour des raisons de nommage dans le
programme applicatif.
Vous pouvez faire rfrence plusieurs fois au mme noeud condition davoir
des codes programme diffrents.
Le COBOL gnr inclut alors :
v la structure des identifiants de la Vue Logique,
v la structure de la Vue Logique associe au noeud,
v la liste des mthodes dextraction associes la Vue Logique,
v la description dune instance de Vue Logique et du vecteur de prsence
correspondant,
v la liste des services utilisateur dfinis pour ce noeud.
STRUCTURE DES IDENTIFIANTS DE LA VUE LOGIQUE
Attention, ces informations sont prsentes pour consultation uniquement.
01

ID-xxxx-LEN

PIC 9(5) VALUE 00009.

Est indique ici la longueur des identifiants.


Premier niveau de sauvegarde des identifiants pour les slections :
01
10
10

1-ID-xxxx.
ID-xxxx-ident1 PICTURE nnnn
..

Deuxime niveau de sauvegarde des identifiants pour les slections :


01
10
10

2-ID-xxxx.
ID-xxxx-corub1 PICTURE nnnn
...
Chapitre 2. Dclaration des zones de working

STRUCTURE DE LA VUE LOGIQUE ASSOCIEE AU NOEUD


Cette structure contient les codes action, le vecteur de prsence, les
identifiants, les paramtres dextraction et les instances de la Vue Logique.
Cette partie correspond la structure que lon trouve en entre du Composant
Elmentaire.
01
02
05
10
10
02
05
10
02
10
10
02
10
02
15

xxxx.
A-xxxx.
Code action
A-xxxx-CATM.
A-xxxx-CA
PICTURE X.
A-xxx-CR
PICTURE X OCCURS nnnn.
CH-xxxx.
Vecteur de prsence
CH-xxxx-xxxx
OCCURS nnnn.
FILLER
PICTURE X(nnnnn).
ID-xxxx.
Identifiants
1-xxxx-ident1 PICTURE xxxx
..
EP-xxxx.
Paramtres dextraction
2-xxxx-param1 PICTURE nnnn
xxxx-xxxx
OCCURS nnnn.
Instances Vue Log.
FILLER
PICTURE X(nnnnn).

En cas de services de mise jour, lalimentation de la premire occurrence des


codes action, du vecteur de prsence et des champs de la Vue est votre
charge.
En cas de services de slection, vous devez alimenter les identifiants et les
paramtres dextraction.
LISTE DES METHODES DEXTRACTION ASSOCIEES A LA VUE LOGIQUE
01
05
05
10
10
05
10

EM-xxxx.
EM-xxxx-EXTNAM
PIC X(10).
EM-xxxx-CODES.
FILLER PIC X(10) VALUE "xxxxxxxxx ".
..
EM-xxxx-CODESR REDEFINES EM-xxxx-CODES.
EM-xxxx-VCODES PIC X(10) OCCURS nnnnn.

En cas de slection avec utilisation de mthodes dextraction, la zone


EXTNAM doit contenir le code de la mthode utilise.
DESCRIPTION DUNE INSTANCE DE VUE LOGIQUE ET DU VECTEUR DE
PRESENCE CORRESPONDANT
01
15
15
01
05
05

RE-xxxx-xxxx.
xxxx-corub1 PICTURE xxxxxx
...
RH-xxxx-xxx.
CH-xxxx-NUCLIE PICTURE X.
CH-xxxx-NOMCLI PICTURE X.

VisualAge Pacbase : Guide dutilisation de lAPI COBOL

LISTE DE SERVICES UTILISATEUR


01
05
05
10
10
05
10

US-xxxx.
US-xxxx-SRVUSR PIC X(25).
US-xxxx-CODES.
FILLER PIC X(25) VALUE "PRINT".
..
US-xxxx-CODESR REDEFINES US-xxxx-CODES.
US-xxxx-VCODES
PIC X(25) OCCURS nnnn.

En cas dutilisation de service utilisateur, la zone SRVUSR doit contenir le


code de ce ce service.

Chapitre 2. Dclaration des zones de working

10

VisualAge Pacbase : Guide dutilisation de lAPI COBOL

Chapitre 3. Demandes de services sur un Dossier


Introduction
LAPI COBOL vous permet de spcifier, dans votre programme applicatif, des
demandes de service sur le Dossier. Pour cela, vous indiquez des instructions
qui vont grer :
les mises jour,
les lectures ou les collections,
les services utilisateur,
les services dinitialisation et de terminaison.
Vous indiquez une instruction dans longlet Langage Structur de votre
programme applicatif, sous-onglet Source, avec un oprateur EXS.
La partie Oprande de la ligne sur laquelle vous indiquez loprateur EXS
est divise en zones de 10 caractres. Vous devez indiquer dans la premire
zone loprande, puis dans les suivantes les paramtres ncessaires cette
oprande (le nombre de paramtres change suivant loprande).
Attention, pour un fonctionnement correct de lAPI COBOL, vous devez
scrupuleusement respecter ce cadrage.

v
v
v
v

Service de mise jour


Vous indiquez un service de mise jour de la faon suivante :
EXS UPDATE

PARAM1

PARAM2

PARAM3

PARAM4

O
PARAM1
PARAM2
PARAM3
PARAM4

=
=
=
=

XXXXXX
Code programme du Dossier
XXXX
Code programme du noeud
1 ou blanc Option de contrle
1 ou blanc Option de rafrachissement

Pour un fonctionnement correct, lApplication eBusiness et le Dossier doivent


avoir t dfinis en working.
Vous devez vous-mme initialiser les structures ncessaires la bonne
excution du service, cest dire les vecteurs de prsence de la structure de la
Vue Logique concerne, le code action et ventuellement le buffer utilisateur.
Vous devez tester le bon droulement du service en vrifiant que le nombre
derreurs (zone ERRNB dans le gnr) nest pas suprieur 0 au retour du
service.

Copyright IBM Corp. 1983,2003

11

Le contrle de cohrence dun Dossier en cas de mise jour (contrle de


cardinalit par exemple) est votre charge, ainsi que les instructions commit
et rollback.
Si vous avez indiqu loption de rafrachissement, les vecteurs de prsence et
la structure de la Vue Logique associe au noeud sont initialiss au retour du
service.
A chaque excution dune instruction de cration sur un noeud dpendant, le
Gestionnaire de Dossier contrle que linstance mre existe. Si elle nexiste
pas, une erreur est renvoye et linstance propose nest pas cre. Vous devez
donc respecter la hirarchie des noeuds dans le Dossier.
En cas de suppression, ce service supprime systmatiquement linstance et
toutes celles qui en dpendent si loption Delete Cascade a t slectionne
dans le Composant Elmentaire.

VERROUILLAGE/DEVERROUILLAGE DUN DOSSIER

12

VisualAge Pacbase : Guide dutilisation de lAPI COBOL

EXS LOCK
EXS UNLOCK

PARAM1
PARAM1

PARAM2
PARAM2

O
PARAM1
PARAM2

= XXXXXX Code programme du Dossier


= XXXX
Code programme du noeud hirarchique

Pour un fonctionnement correct, lApplication eBusiness et le Dossier doivent


avoir t dfinis en working.
Vous devez initialiser les structures ncessaires la bonne excution du
service, cest--dire initialiser la structure des identifiants de la Vue Logique.
Vous devez tester le bon droulement du service en vrifiant que le nombre
derreurs (zone ERRNB dans le gnr) nest pas suprieur 0 au retour du
service.

Service de lecture
Il existe deux types de services de lecture :
v les services dont le rsultat correspond au plus une instance. Un seul
oprateur suffit pour spcifier ce type de service.
v les services dont le rsultat peut tre suprieur une instance. Ce type de
service ncessite deux oprateurs : le premier permet de dfinir les
Chapitre 3. Demandes de services sur un Dossier

13

proprits de la collection voulue tandis que le second permet de parcourir


cette collection de manire squentielle du dbut jusqu la fin.
Tous les services de lecture peuvent sexcuter en dehors dune phase de mise
jour.

Lecture ramenant au plus une instance


Vous indiquez un service de lecture ne pouvant ramener quune instance de la
faon suivante :
EXS READ

PARAM1

PARAM2

O :
PARAM1 = Code programme du Dossier
PARAM2 = Code programme du noeud

Cet oprateur lit une instance de noeud dun Dossier partir de sa cl et la


renvoie si elle existe dans la structure de la Vue Logique associe avec ses
vecteurs de prsence. En cas derreur ou si linstance nexiste pas, un message
derreur est positionn et la zone ERRNB est incrmente. Quel que soit ltat
de retour, le buffer utilisateur est initialis.
Pour un fonctionnement correct, lApplication eBusiness et le Dossier doivent
avoir t dfinis en working.
Vous devez initialiser les structures ncessaires la bonne excution du
service, cest dire la structure des identifiants de la Vue Logique et
ventuellement celle du buffer utilisateur.
Vous devez tester le bon droulement du service en vrifiant que le nombre
derreurs (zone ERRNB dans le gnr) nest pas suprieur 0 au retour du
service.

14

VisualAge Pacbase : Guide dutilisation de lAPI COBOL

Lecture ramenant au moins une instance


Pour ce service, vous devez indiquer deux oprateurs :
v le premier permet de dfinir la collection
v le second permet de la parcourir travers une boucle ou une succession de
performs.
La dclaration dune collection doit intgrer les paramtres ncessaires au
traitement des lectures dun ou de plusieurs noeuds.
Dfinition de la collection
Vous devez tout dabord dfinir la collection de la faon suivante :
EXS OPENCOLLECPARAM1

PARAM2

PARAM3

PARAM4

PARAM5

O
PARAM1 = XXXXXX
PARAM2 = XXXXXX
PARAM3 = XXXX
PARAM4 =

Code programme de la collection


Code programme du Dossier
Code programme du noeud

S
F
A

Option de slection
Single node
First children
All children

H
N

Option pour le rsultat de la slection


Hierarchical
By Node (valeur par dfaut)

PARAM5 =

Chapitre 3. Demandes de services sur un Dossier

15

PARAM1 doit tre unique dans le programme applicatif et sera utilis dans le
nommage des zones prives ncessaires la gestion de la collection.
Il est possible douvrir plusieurs collections sur le mme Dossier et le mme
noeud.
Ce premier oprateur prpare la lecture dune collection dinstances sur un
noeud dun Dossier partir dune cl de dpart ou lit un noeud dun Dossier
et toutes les instances associes ses noeuds fils de premier niveau ou tous
ses noeuds fils. La cl de dpart fournir correspond toujours celle dfinie
dans la structure associe au noeud dfini par PARAM3. Chaque noeud
concern dans la collection peut prendre en compte une mthode dextraction
dfinie dans la zone EM-param3-EXTNAM de la structure associe au noeud.
Les paramtres dextraction sont initialiser dans la structure correspondante.
Vous devez initialiser les structures ncessaire la bonne excution du service.
Loption hierarchical permet de rcuprer les instances de la collection dans
lordre hirarchique. Loption byNode rcupre les instances noeud par
noeud.
Le service ne tient pas compte du contenu de resultOptionList lorsque
loption singleNode est positionne.
Pour un fonctionnement correct, lApplication eBusiness et le Dossier doivent
avoir t dfinis en working.
Vous devez tester le bon droulement du service en vrifiant que le nombre
derreurs (zone ERRNB dans le gnr) nest pas suprieur 0 au retour du
service.
Parcours de la collection
Vous devez maintenant indiquer un second oprateur qui vous permettra de
parcourir la collection afin de restituer les instances slectionnes.
EXS FETCH
O
PARAM1

PARAM1
= XXXXXX Code dutilisation de la collection

Cet oprateur ramne une instance de noeud de la collection identifie par


PARAM1. Cette instance est transfre dans la structure de la Vue Logique
correspondant au noeud en cours de traitement.
A chaque instance rendue, le service initialise galement les vecteurs de
prsence de cette instance.

16

VisualAge Pacbase : Guide dutilisation de lAPI COBOL

La fin de liste sur un noeud est renvoye dans la structure recevant les
messages derreur en mme temps que la dernire instance du noeud.
Vous devez tester le bon droulement du service en vrifiant que le nombre
derreurs (zone ERRNB dans le gnr) nest pas suprieur 0 au retour du
service.

Chapitre 3. Demandes de services sur un Dossier

17

ZONES DE TRAVAIL GENEREES


Les zones de travail indiques ci-dessous sont gnres pour le parcours
dune collection. Elles sont votre disposition en consultation uniquement ;
vous ne devez en aucun cas les modifier. Ce sont des donnes techniques
utilises par le Dossier et ses Composants Elmentaires.
ENDCOL est lindicateur de fin de collection. Il prend la valeur 1 quand la
fin de la collection est atteinte, ou une autre valeur sinon.
ENDNOD est lindicateur de fin de noeud. Il prend la valeur 1 la fin du
noeud ou une autre valeur sinon.
VIEWI reprsente la Vue Logique initiale.
VIEWC reprsente la Vue Logique courante.
NODEI reprsente le noeud initial.
NODEC reprsente le noeud courant.
OCCNUM reprsente le nombre dinstances retournes dans la table des Vues
Logiques.

18

VisualAge Pacbase : Guide dutilisation de lAPI COBOL

NBREC reprsente le nombre total denregistrements lus pour une collection.

Service utilisateur
Vous indiquez une demande de service utilisateur de la faon suivante :
EXS EXUS

PARAM1

PARAM2

O
PARAM1 = Code programme du Dossier
PARAM2 = Code programme du noeud

Pour un fonctionnement correct, lApplication eBusiness et le Dossier doivent


avoir t dfinis en working.
Vous devez initialiser les structures ncessaires la bonne excution du
service : les vecteurs de prsence de la structure de la Vue Logique concerne,
ventuellement le buffer utilisateur, et la zone US-xxxx-SRVUSR (xxxx tant le
code du noeud correspondant au service).
Le contenu de la zone US-xxxx-SRVUSR doit correspondre lun des services
disponibles sur le noeud concern.
Le retour du service initialise les vecteurs de prsence et la structure de la Vue
Logique ou la structure des messages derreur.
Vous devez tester le bon droulement du service en vrifiant que le nombre
derreurs (zone ERRNB dans le gnr) nest pas suprieur 0 au retour du
service.

Chapitre 3. Demandes de services sur un Dossier

19

Services dinitialisation et de terminaison


Grce ces services, vous dfinissez une unit de travail cohrente. Pour cela,
vous devez appeler un Serveur dInitialisation, qui ouvre lunit de travail, et
un Serveur de Terminaison qui ferme cette unit.
Vous indiquez les services dinitialisation et de terminaison de la faon
suivante :
EXS BEGINFWORKPARAM1
EXS ENDFWORK PARAM1
O
PARAM1

= XXXXXX

Code programme du Dossier

Le premier service assure lappel du Serveur dInitialisation associ ce


Dossier et le deuxime assure lappel du Serveur de Terminaison.
Vous devez tester le bon droulement du service en vrifiant que le nombre
derreurs (zone ERRNB dans le gnr) nest pas suprieur 0 au retour du
service.

20

VisualAge Pacbase : Guide dutilisation de lAPI COBOL

Chapitre 3. Demandes de services sur un Dossier

21

22

VisualAge Pacbase : Guide dutilisation de lAPI COBOL

Chapitre 4. Chanages
Pour faciliter lutilisation de lAPI COBOL, des chanages associent les entits
eBusiness (Application eBusiness et Dossier) et le programme applicatif dans
lequel elles sont appeles, sur des lignes de Working de type A.
Des chanages sont donc disponibles entre :
v Application eBusiness et Programme, Composant Elmentaire, Ecran.
v Dossier et Programme, Composant Elmentaire, Ecran.
La recherche des chanages est disponible aussi bien pour la recherche locale
que serveur.

Copyright IBM Corp. 1983,2003

23

24

VisualAge Pacbase : Guide dutilisation de lAPI COBOL


Rfrence : DDAPI000351F - 6436

Imprim en France

Vous aimerez peut-être aussi