ࡱ > #` 0I bjbj 6 @ \ L L L L L L L ` D/ D/ D/ 8 |/ 80 T ` u 2 0 V4 : 4 4 4 o5 18 8 h Tu Vu Vu Vu Vu Vu Vu $ w h oy D zu L e9 k5 o5 e9 e9 zu L L 4 4 u : : : e9 | L 4 L 4 Tu : e9 Tu : : j l L L po 4 0 PǍ D/ 9 | n 2 Tu u 0 u n z ]: | z d po z L po e9 e9 : e9 e9 e9 e9 e9 zu zu : e9 e9 e9 u e9 e9 e9 e9 ` ` ` D/ ` ` ` D/ ` ` ` L L L L L L u TITLE \* Caps \* MERGEFORMAT Service Xmlite
Table des matires
TOC \o "1-3" \h \z \u HYPERLINK \l "_Toc214875164" 1 But du document PAGEREF _Toc214875164 \h 1
HYPERLINK \l "_Toc214875165" 2 Traitement batch XMLite PAGEREF _Toc214875165 \h 2
HYPERLINK \l "_Toc214875166" 2.1 Concept PAGEREF _Toc214875166 \h 2
HYPERLINK \l "_Toc214875167" 2.2 Paramtrage PAGEREF _Toc214875167 \h 2
HYPERLINK \l "_Toc214875168" 2.3 Numrotation mailbox PAGEREF _Toc214875168 \h 2
HYPERLINK \l "_Toc214875169" 2.4 Accs et contrles PAGEREF _Toc214875169 \h 2
HYPERLINK \l "_Toc214875170" 2.4.1 Autorisations PAGEREF _Toc214875170 \h 2
HYPERLINK \l "_Toc214875171" 2.4.2 Contrle de structure mailbox entrant PAGEREF _Toc214875171 \h 3
HYPERLINK \l "_Toc214875172" 2.4.3 Contrle de structure mailbox sortant PAGEREF _Toc214875172 \h 3
HYPERLINK \l "_Toc214875173" 2.5 Logging PAGEREF _Toc214875173 \h 3
HYPERLINK \l "_Toc214875174" 2.6 Structure dun fichier mailbox XMLite PAGEREF _Toc214875174 \h 3
HYPERLINK \l "_Toc214875175" 2.6.1 Le schma Mailbox PAGEREF _Toc214875175 \h 3
HYPERLINK \l "_Toc214875176" 2.6.2 Le schma Message PAGEREF _Toc214875176 \h 4
HYPERLINK \l "_Toc214875177" 3 Traitement on-line XMLite PAGEREF _Toc214875177 \h 6
HYPERLINK \l "_Toc214875178" 3.1 Concept PAGEREF _Toc214875178 \h 6
HYPERLINK \l "_Toc214875179" 3.2 Accs et contrles PAGEREF _Toc214875179 \h 6
HYPERLINK \l "_Toc214875180" 3.3 Logging PAGEREF _Toc214875180 \h 6
HYPERLINK \l "_Toc214875181" 3.4 Structure du service XMLite on-line PAGEREF _Toc214875181 \h 6
HYPERLINK \l "_Toc214875182" 3.5 La demande PAGEREF _Toc214875182 \h 6
HYPERLINK \l "_Toc214875183" 3.6 La rponse PAGEREF _Toc214875183 \h 6
HYPERLINK \l "_Toc214875184" 1. Rponse sans partie donnes PAGEREF _Toc214875184 \h 6
HYPERLINK \l "_Toc214875185" 2. Rponse avec partie donnes PAGEREF _Toc214875185 \h 7
HYPERLINK \l "_Toc214875186" 3. Rponse type time-out PAGEREF _Toc214875186 \h 7
HYPERLINK \l "_Toc214875187" 4 Numro de ticket PAGEREF _Toc214875187 \h 8
HYPERLINK \l "_Toc214875188" 5 Rfrences PAGEREF _Toc214875188 \h 8
But du document
Ce document prsente le service XMLite tel quil est propos aux acteurs du rseau de la scurit sociale.
Traitement batch XMLite
Concept
Le traitement batch en format XMLite est conu comme une couche supplmentaire par rapport au traitement batch classique de messages A1 sur le mainframe. Lorsquun utilisateur envoie un fichier mailbox avec des messages XML, ce fichier est dabord envoy un prprocesseur. Ce prprocesseur convertit le fichier XML en mailbox A1. Ce dernier est alors trait par le systme classique de traitement de mailboxes A1
Un utilisateur peut aussi opter de recevoir les fichiers mailbox en format XMLite (voir Paramtrage pour plus de dtails). Dans ce cas, le rsultat dun traitement mailbox classique (un fichier mailbox A1) est envoy un post-processeur, qui convertit le fichier mailbox A1 en fichier XML au format XMLite. Le rsultat de cette conversion est transmis lutilisateur.
Il est noter que les deux types de conversion peuvent tre utiliss indpendamment lun de lautre. Un metteur peut envoyer des messages XML, tandis que le destinataire peut recevoir des fichiers mailbox A1 et vice-versa.
Important: La BCSS nassume aucune responsabilit supplmentaire en ce qui concerne l'exactitude des parties donnes changes l'aide de messages XML.
Paramtrage
Un utilisateur peut opter dutiliser la fois des mailboxes A1 classiques et des mailboxes de messages XML. Les rgles et restrictions suivantes sont applicables:
un fichier mailbox contient soit uniquement des messages A1, soit uniquement des messages XML;
pour les destinataires, le formulaire est le niveau de paramtrage le plus dtaill. Les messages dun formulaire dtermin (p.ex. R300) sont tous reus soit sous forme de message A1, soit sous forme de message XML. Cette restriction ne sapplique pas aux metteurs.
Les adaptations techniques ncessaires ce paramtrage (rgles daffectation des noms, localisations des serveurs, type d'institution, ...) doivent tre discutes avec le service exploitation.
Numrotation mailbox
Les dtails de la numrotation de mailboxes XMLite doivent tre convenus de manire bilatrale entre lutilisateur et le service exploitation de la BCSS.
Accs et contrles
Autorisations
L'utilisateur ne doit obtenir aucune autorisation supplmentaire pour pouvoir travailler avec des messages XML en mode batch. Le systme sous-jacent de traitement batch classique assure le traitement correct. Un utilisateur autoris envoyer ou recevoir un message dtermin sous forme de message A1, peut galement envoyer ou recevoir le message XML correspondant.
Contrle de structure mailbox entrant
Avant de traiter un mailbox XMLite entrant, il est vrifi si le fichier est conforme sur le plan de la structure:
La totalit du document doit tre un document XML dment tabli (well-formed). Il en est de mme des parties donnes XML ventuelles des messages.
Le document doit tre conforme aux schmas XML Mailbox.xsd et Message.xsd (voir infra). Seule la partie spcifique XMLite est contrle et non les parties donnes des messages. La structure du prfixe ou dune partie donnes en format inhouse ne sont pas non plus contrls.
Si ces conditions ne sont pas remplies, le fichier entrant ne peut pas tre converti en fichier mailbox A1 quivalent. L'ensemble du mailbox est alors refus.
Contrle de structure mailbox sortant
En cas de conversion inverse, cest--dire dun mailbox A1 en mailbox XMLite, le point de dpart est toujours un mailbox A1 valide cr par la BCSS. Celui-ci doit en tout cas pouvoir tre converti en mailbox XMLite.
Le seul problme qui puisse se produire cest quun message A1 avec une partie donnes XML ne soit pas tabli correctement (well-formed) (ceci nest pas contrl lors du traitement classique). Dans ce cas, la partie donnes XML errone ne sera pas affiche sous llment XML (qui peut uniquement contenir un XML correct), mais sera place dans l'lment IHN sous forme d'une srie de caractres. Les caractres spciaux seront galement convertis de la manire standard (p.ex. < devient <). Pour la lecture et la sauvegarde des fichiers, le codage UTF-8 est employ.
Logging
Dans tous les cas, les mailboxes XML et les mailboxes A1 correspondants sont archivs sur le mainframe.
Structure dun fichier mailbox XMLite
Le schma Mailbox
Llment racine dun fichier batch XML est compos dun lment Mailbox avec plusieurs attributs qui contiennent des informations sur le fichier dans son ensemble. Llment Mailbox contient un ou plusieurs blocs #any. Chacun de ces blocs correspond un enregistrement. La structure et lemploi de llment Mailbox sont expliqus en dtail dans [REF01].
Namespace XML utilis ( mentionner obligatoirement): http://www.ksz-bcss.fgov.be/XSD/Mailbox
Schma pour llment racine du fichier batch:
Le schma Message
Namespace XML utilis ( mentionner obligatoirement): http://www.ksz-bcss.fgov.be/XSD/Message
Schma pour lenregistrement XMLite:
Chaque mailbox XML est compos au moins de l'lment racine (Mailbox) et d'un lment Message. Llment Message est plac dans llment any dans le schma Mailbox.
Cet lment Message est dfini dans le namespace HYPERLINK "http://www.ksz-bcss.fgov.be/XSD/Message" http://www.ksz-bcss.fgov.be/XSD/Message. Ce namespace doit tre mentionn obligatoirement.
Message
Un Message reprsente un message XML qui sera trait par la BCSS.
Llment Message est compos des lments suivants:
Header
Llment header contient l'en-tte dun lment Message individuel et contient un lment enfant ClassicPrefix.
ClassicPrefix
Un prfixe A1 classique prsent comme une simple srie de caractres. Les anciens prfixes A0 ne sont plus soutenus.
Data
Les donnes proprement dites du message sont places dans cet lment. Un lment Data est chaque fois compos dun des lments suivants.
IHN
Partie donnes inhouse prsente comme une srie de caractres. Ce champ peut galement tre utilis pour des messages en format plat.
XML
Partie donnes en format XML. Cet lment est dfini comme un lment any XML. Le contenu de cet lment est la partie donnes XML du message A1. La partie donnes doit en tout cas tre en format XML correct (well-formed), sinon le mailbox ne peut pas tre trait.
Exemple :
Classic A1 prefix. Can contain all types of A1 prefixes as a simple string. Older A0 prefixes are not supported.
Inhouse data part as a string
XML data part. Can contain both flux data parts and service bodies
Replaced by the actual message body
Traitement on-line XMLite
Concept
Le service on-line XMLite permet lutilisateur dutiliser, au moyen dun service web, des messages XML pour les flux classiques. Tout comme dans le traitement batch, le service est conu comme un emballage (wrapper) autour du systme existant, en l'occurrence le traitement A1 on-line par le CICS de la BCSS. Le service prend un message XML comme input, le convertit en message A1, le fait traiter par le CICS, emballe la rponse A1 sous forme de message XML et lenvoie lutilisateur.
Il est noter que toutes les fonctionnalits du traitement classique sont disponibles. Si lutilisateur transmet par exemple un message XML, qui est trait par le CICS en relais diffr, il recevra un rponse intermdiaire sous forme de message XML. La rponse dfinitive est place dans un fichier mailbox pour le destinataire (sous forme de message XML ou non, en fonction du paramtrage du traitement batch).
Accs et contrles
Tout comme pour le traitement batch, aucune autorisation supplmentaire nest ncessaire. Le systme de traitement classique effectuera tous les contrles applicables. Les contrles de structure sont galement comparables ceux du traitement batch.
Logging
Dans tous les cas, les messages XML entrants et sortants tout comme les messages A1 utiliss en interne font lobjet dun logging.
Structure du service XMLite on-line
Le service on-line XMLite est implment sous forme dun service dans le framework SSDN de la BCSS. Les demandes et rponses de ce service suivent ds lors la structure gnrale respectivement des schmas SSDNRequest et SSDNReply. Pour plus d'informations concernant ces schmas, voir [REF02].
La partie spcifique du service XMLite, cest--dire la partie place dans le bloc any du SSDNRequest/SSDNReply, est compose dun lment Message, comme dcrit pour le traitement batch XMLite.
Paramtres du service:
ServiceId XMLite
Version: 20051206
La demande
Comme dcrit ci-dessus dans un schma SSDNRequest.
La rponse
Trois types de rponses sont possibles.
Rponse sans partie donnes
Quand aucune erreur ne sest produite dans le service web, la rponse sera un SSDNReply avec dans la partie any un lment Message. Cet lment Message contiendra uniquement le prfixe A1 avec un code retour classique (voir lment ClassicPrefix). Llment Data est vide dans ce cas.
Rponse avec partie donnes
La rponse peut aussi tre un SSDNReply avec un prfixe A1 dans llment ClassicPrefix et une partie donnes dans l'lment Data.
Voir le traitement batch pour un exemple.
Rponse type time-out
Si le CICS na pas rpondu lissue de l'intervalle time-out (p.ex. en cas de rponse tardive du CICS lors d'un code retour 6002), la rponse sera un SSDNReply avec un ResultSummary comme suit:
Attribut OK = NO
ReturnCode = 10000
Llment dtail contient les lments suivants:
Severity =ERROR
ReasonCode =32000001
Diagnostic =Access to the data is temporarily blocked.
2 information fields:
FieldName = Resource
FieldValue = backend timeout...
FieldName = Data
FieldValue = le prfixe A1 de la demande
Exemple :
10000
ERROR
30000001
At least one service request has generated an error.
CBSS
xxxxxxxxxxxx
test@test.com
yyyyyyyyyyyy
zz
yy
ticket
timestamp1
timestamp2
timestamp3
10000
ERROR
32000001
Access to the data is temporarily blocked.
CBSS
Resource
backend timeout...
Data
X25TA1xxx000kNvCW6iiKABCSSc009xxx00362O0L L9500001 0810021343M03S003000 20060101 012000
XMLite
20051206
Numro de ticket
Lorsque le numro de rfrence interne nest pas prsent dans la soumission, il sera quand mme complt dans la rponse avec le numro de ticket de la BCSS. Ceci permet de faciliter les recherches en cas de problme.
Rfrences
[REF01] :
Standardisation des fichiers batch XML.doc
[REF02] :
01_KSZ-BCSS Webservices Document Fil Conducteur FR.doc
02_KSZ-BCSS Webservices Plan de la Documentation FR.doc
03_KSZ-BCSS Webservices Modes de connexion Extranet_NL.doc
04_KSZ-BCSS Webservices Environnements FR.doc
05_KSZ-BCSS Webservices Autorisations_FR.doc
06_KSZ-BCSS Webservices Tester la connexion_FR.doc
07_KSZ-BCSS Webservices HTTPS-SOAP-WSDL FR.doc
08_KSZ-BCSS Webservices SSDN request-reply envelope definition FR.doc
09_KSZ-BCSS Webservices SSDN common status messages FR.doc
FILENAME \* MERGEFORMAT Service_XMLite.doc PAGE 2/ NUMPAGES 8
! " 0 1 2 4 H I ` a b c ۽wggKwgg; h hG mH nH sHu 6j h hYl >*B*UmH nH ph sHu h hG 0J mH nH sHu(j h hG 0J UmH nH sHu h hG mH nH sHu$j h hG UmH nH sHu h hzi 5mH nH sHu h hzi mH nH sHuh h} aJ mH nH sHuh hzi aJ mH nH sHu(j h hzi UaJ mH nH sHu 2 3 4 G H _
e
) Q
c
X d
"
"
"
H /I
/ 0 밢v`밢 *jw h hYl UmH nH sHu 6j h hYl >*B*UmH nH ph sHu h hG 0J mH nH sHuh hG mH nH sHu(j h hG 0J UmH nH sHu *j} h hYl UmH nH sHu h hG mH nH sHu 'j h hG UmH nH sHu 0 1 2 5 6 = > ? Y Z [ \ ] ^ _ ` a } ~ ϿwϱϿ[Ͽ 6j h hYl >*B*UmH nH ph sHu *jq h hYl UmH nH sHu 'j h hG UmH nH sHuh hG mH nH sHu h hG mH nH sHuh hG 0J mH nH sHu(j h hG 0J UmH nH sHu 6j h hYl >*B*UmH nH ph sHu
*
+
ֱwaֱ *je h hYl UmH nH sHu 6j h hYl >*B*UmH nH ph sHu h hG 0J mH nH sHuh hG mH nH sHu(j h hG 0J UmH nH sHu h hG mH nH sHu 'j h hG UmH nH sHu*jk h hYl UmH nH sHu+
,
-
0
1
C
D
E
_
`
a
b
c
d
e
f
g
ϿwϱϿ[Ͽ 6j h hYl >*B*UmH nH ph sHu *j_ h hYl UmH nH sHu 'j h hG UmH nH sHuh hG mH nH sHu h hG mH nH sHuh hG 0J mH nH sHu(j h hG 0J UmH nH sHu 6j h hYl >*B*UmH nH ph sHu
# $ % & ' ( ) * + G H ֱwaֱ *jS h hYl UmH nH sHu 6j h hYl >*B*UmH nH ph sHu h hG 0J mH nH sHuh hG mH nH sHu(j h hG 0J UmH nH sHu h hG mH nH sHu 'j h hG UmH nH sHu*jY h hYl UmH nH sHuH I J O P u v w ϿwϱϿ[Ͽ 6j h hYl >*B*UmH nH ph sHu *jM h hYl UmH nH sHu 'j h hG UmH nH sHuh hG mH nH sHu h hG mH nH sHuh hG 0J mH nH sHu(j h hG 0J UmH nH sHu 6j h hYl >*B*UmH nH ph sHu
/ 0 1 K L M N O P Q R S o p ֱwaֱ *jA
h hYl UmH nH sHu 6j h hYl >*B*UmH nH ph sHu h hG 0J mH nH sHuh hG mH nH sHu(j h hG 0J UmH nH sHu h hG mH nH sHu 'j h hG UmH nH sHu*jG h hYl UmH nH sHup q r w x ϿwϱϿ[Ͽ 6j h hYl >*B*UmH nH ph sHu *j; h hYl UmH nH sHu 'j h hG UmH nH sHuh hG mH nH sHu h hG mH nH sHuh hG 0J mH nH sHu(j h hG 0J UmH nH sHu 6j
h hYl >*B*UmH nH ph sHu
#
$
%
&
'
(
A
B
C
]
^
_
`
a
b
c
d
e
ֱwaֱ *j/
h hYl UmH nH sHu 6j h hYl >*B*UmH nH ph sHu h hG 0J mH nH sHuh hG mH nH sHu(j h hG 0J UmH nH sHu h hG mH nH sHu 'j h hG UmH nH sHu*j5 h hYl UmH nH sHu
ϿwϱϿ[Ͽ 6j h hYl >*B*UmH nH ph sHu *j) h hYl UmH nH sHu 'j h hG UmH nH sHuh hG mH nH sHu h hG mH nH sHuh hG 0J mH nH sHu(j h hG 0J UmH nH sHu 6j
h hYl >*B*UmH nH ph sHu
( ) * + . / 6 7 8 R S T U V W X Y Z v w ֱwaֱ *j h hYl UmH nH sHu 6j h hYl >*B*UmH nH ph sHu h hG 0J mH nH sHuh hG mH nH sHu(j h hG 0J UmH nH sHu h hG mH nH sHu 'j h hG UmH nH sHu*j# h hYl UmH nH sHuw x y | }
ϿwϱϿ[Ͽ 6j h hYl >*B*UmH nH ph sHu *j h hYl UmH nH sHu 'j h hG UmH nH sHuh hG mH nH sHu h hG mH nH sHuh hG 0J mH nH sHu(j h hG 0J UmH nH sHu 6j h hYl >*B*UmH nH ph sHu
1 2 3 4 7 8 B C D ^ _ ` a b c d e f ֱwaֱ *j h hYl UmH nH sHu 6j h hYl >*B*UmH nH ph sHu h hG 0J mH nH sHuh hG mH nH sHu(j h hG 0J UmH nH sHu h hG mH nH sHu 'j h hG UmH nH sHu*j h hYl UmH nH sHu ϿwϱϿ[Ͽ 6j h hYl >*B*UmH nH ph sHu *j h hYl UmH nH sHu 'j h hG UmH nH sHuh hG mH nH sHu h hG mH nH sHuh hG 0J mH nH sHu(j h hG 0J UmH nH sHu 6j h hYl >*B*UmH nH ph sHu ! " # $ % & ' ( D E F G I J _ ` a { | } ~ ֱwaֱ *j h hYl UmH nH sHu 6j| h hYl >*B*UmH nH ph sHu h hG 0J mH nH sHuh hG mH nH sHu(j h hG 0J UmH nH sHu h hG mH nH sHu 'j h hG UmH nH sHu*j h hYl UmH nH sHu & % ' ( ) 9 d V b f q 3 H t
&