Etnic_PrimverPopulation_v2 0 2_Manuel d`utilisation_rev2.0

PRIMVER – Population

Bâtiment ‘Le Zénith’

Boulevard du Roi Albert II, 37

1030 Bruxelles

Produit :

Service :

Version du service :

Type de document :

Révision du document :

Date du document :

PRIMVER

Population

2.0.2

Manuel d’utilisation

2.0

22-04-2015


Historique

Révision Description

1.0 Version initiale

1.1

2.0

- Ajout de la description de l’erreur 13618, 13623

- Ajout de la description de l’erreur 13624 dans le cadre de la gestion plus efficace du « timeout »

Ajout du mode consultation

Ecrit par

P. Rouxhet

P. Rouxhet

P. Rouxhet

Date

13-05-2014

15-10-2014

18-11-2014

22-04-2015

Objectifs du document

Ce document est destiné aux partenaires qui souhaitent utiliser les Services Web de la Fédération

Wallonie-Bruxelles et plus particulièrement celui qui gère les populations globalisées des écoles dans l’enseignement fondamental ordinaire au sein de l’application PRIMVER.

Public cible

Ce document s’adresse principalement aux architectes, analystes et développeurs.

Contacts

Pour toute question ou demande d’assistance technique veuillez contacter le helpdesk de l’Etnic.

Support général

Email : [email protected]

Tél : 02 / 800 10 10

Manuel d'utilisation_PrimverPopulation_v2.0.2_rev2.0

© copyright ETNIC Édité le 22/04/2015 Page 1/14



1030 Bruxelles



Table des matières

1.

CADRE ............................................................................................................................................. 3

1.1.

O

BJET DU SERVICE

...................................................................................................................... 3

1.2.

I

DENTIFICATION DES

C

HANGEMENTS PAR RAPPORT A LA DERNIERE VERSION

.................................. 3

1.2.1.

Objet du changement ....................................................................................................................... 3

1.2.2.

Description des changements .......................................................................................................... 3

2.

SPECIFICATIONS GLOBALES ...................................................................................................... 3

2.1.

PLATEFORME DES

S

ERVICES

W

EB

................................................................................................ 3

2.2.

I

NTERFACE

.................................................................................................................................. 4

2.3.

B

LOC

R

ETOUR

............................................................................................................................ 4

3.

DESCRIPTION DES OPERATIONS ............................................................................................... 6

3.1.

P

RIMVER

P

OPULATION

................................................................................................................. 6

3.1.1.

Description fonctionnelle ................................................................................................................ 6

3.1.2.

Adressage ........................................................................................................................................ 6

3.1.3.

Paramètres de la requête ................................................................................................................ 7

3.1.4.

Réponse ........................................................................................................................................... 8

4.

DESCRIPTION DES ERREURS .................................................................................................... 13





1030 Bruxelles



1 .

.

C A D R

E

1.1. O

BJET DU SERVICE

Ce service permet à l’école de consulter la population globalisée et de faire parvenir celle-ci à la

DGEO. Il permet également de vérifier l’état du dossier Population.

La liste exhaustive des opérations est la suivante :

•

PrimverPopulation : 3 actions sont possibles : o

« Etat » : fournit l’état d’un dossier Population o

« Lecture » : fournit le contenu d’un dossier Population o

« Transfert » : envoie le dossier Population à la DGEO

1.2. I

DENTIFICATION DES

C

HANGEMENTS PAR RAPPORT A LA DERNIERE VERSION

1.2.1. Objet du changement

L'adaptation du Service Web Population fait suite à l'ajout d'un nouveau mode d'accès au Service via une authentification par login et mot de passe.

1.2.2. Description des changements

Les nouveautés sont identifiées par l’image :

2 .

.

S P E C

I

I F

I

I C A T

I

I O N S G L O

B

A

L

E

S

2.1.

PLATEFORME DES

S

ERVICES

W

EB

Le service PRIMVER Population est disponible à travers la « Plateforme de Services Web » de l’ETNIC. Le point d’accès de la plateforme est unique par environnement. Le routage vers le service demandé est dès lors effectué selon la spécification WS-Addressing. Pour chaque requête, une

SOAP Action et une adresse « To » doivent être définies pour spécifier le service à adresser.

La communication est sécurisée en transitant à travers un canal SSL implémenté par TLS 1.0.

L'authentification se base sur la spécification WS-Security. Deux types de profils sont disponibles pour le service PRIMVER Population: l'authentification en signant les messages avec certificat X.509 ou l'authentification avec login / mot de passe. Ces deux modes permettent d'accéder respectivement aux versions complètes et "de consultation" du service. Les paramètres WS-Addressing changent en fonction du mode utilisé (voir section 3.1.2 pour les détails des paramètres).

La communication se fait de manière asynchrone pour le service complet et de manière synchrone pour le service "de consultation".






1030 Bruxelles


Veuillez vous référer au document « Plateforme Services Web ETNIC – Spécifications techniques » disponible dans le catalogue de services SOA sur le site Internet de l’ETNIC pour les détails techniques. Toutes les informations techniques et les procédures d’accès sur la plateforme sont détaillées dans le document « Plateforme Services Web ETNIC – Spécifications techniques » disponible dans le catalogue de services SOA sur le site Internet de l’ETNIC.

2.2. I

NTERFACE

Le service PRIMVER Population est compatible avec le protocole SOAP 1.1.

Le contrat WSDL et les schémas XSD sont téléchargeables à partir de la fiche du service dans le catalogue de services SOA sur le site Internet de l’ETNIC.

Les URLs des endpoints dans les différents environnements sont les suivantes :

TQ https://services-web.tq.etnic.be/ecole

PROD https://services-web.etnic.be/ecole

2.3. B

LOC

R

ETOUR

Chaque service renvoie une réponse composée d’un bloc retour générique et de la réponse en tant que telle du service. Le bloc retour sert à indiquer si la requête a été exécutée avec succès ou pas, et un ou plusieurs messages d’information, d’avertissement ou d’erreur en fonction du déroulement. Le type de ce bloc retour est ServiceMessageCT.

Les codes et libellés des messages sont listés à la section 4.

ServiceMessageCT

CodeRetour, CodeRetourST, obligatoire : Code indiquant l’aboutissement de la requête.

Message, de 0 à plusieurs : Message renvoyé.

CodeRetourST, short, min -1, max 1 : Type Code retour (-1 Erreur, 0 avertissement, 1 ok).

Message

Type, TypeMessageST, obligatoire : Type de message.

Code, string, obligatoire : Identifiant du message, maximum 10 caractères.

Libelle, string, obligatoire : Libellé du message, maximum 80 caractères.

Zone, anyType, obligatoire : Zone concernée par le message.





1030 Bruxelles

TypeMessageST, string enum : Type de message.

•

information

•

avertissement

•

erreur







1030 Bruxelles



3 .

.

D E S C R I

I

P T

I

I O N D E S O P E R A

T I

I

O

N

S

3.1. P

RIMVER

P

OPULATION

3.1.1. Description fonctionnelle

Le Service Web Population peut être appelé selon deux modes, définis par le type d'authentification :

- Le mode d'appel en Consultation permet à un utilisateur de l'application Web Primver, dans lequel il gère ses dossiers, de pourvoir récupérer les informations validées des populations de son

établissement sous forme électronique.

- Le mode d'appel "complet" met à disposition toutes les fonctionnalités du Service Web aux utilisateurs gérant les informations populations de leur établissement par le seul biais de ce Service

Web.

Cette opération regroupe l’ensemble des actions possibles sur un dossier Population de PRIMVER, à savoir :

- action « Etat » : fournit uniquement l’état d’un dossier Population;

- action « Lecture » : cette action permet de récupérer toutes les données sauvegardées dans le dossier Population;

- action « Transfert » : effectue le transfert du dossier Population de l’école/PO à l’administration.

Selon le mode d'appel du Service Web choisit, les actions possibles sont limitées de la manière suivante :

Action

Etat

Lecture

Transfert

Mode complet autorisée

autorisée

autorisée

Mode Consultation

autorisée

autorisée (si Dossier validé)

Non

Le message de retour contient les informations du dossier Population PRIMVER selon l’action demandée.

3.1.2. Adressage

Paramètres WS-Addressing

Service Complet

Action

To

primver:population?mode=async http://www.etnic.be/janus/primver2

Service de "Consultation"

Action primver:populationConsultation?mode=sync

To http://www.etnic.be/janus/primver2






1030 Bruxelles

3.1.3. Paramètres de la requête


3.1.3.1. Description

La requête du WS Population est assez simple.

1. Les différentes actions doivent être utilisées de manière structurée, liées logiquement à la gestion des dossiers dans PRIMVER. L’enchainement des actions à utiliser n’est donc pas quelconque.

2. La valeur de la donnée « Acteur » dépend de l’action choisie :

Action

Acteur possible

E

ECOLE, PO

L

ECOLE, PO, ADM

T

ECOLE, PO

3. L'action est conditionné selon le mode d'appel choisi :

Action

Mode d'appel Complet

E autorisé

L autorisé

T autorisé

Non autorisé

(requête rejetée)

Mode d'appel Consultation autorisé Autorisé si dossier validé

La structure générale de la requête « Population» est la suivante :

PrimverPopulationRequeteCT

Action, TypeST, obligatoire : Type d’action du le dossier

Population

.

Population, PopulationReqCT, obligatoire : Données relatives à la population.

TypeST, string enum

•

E : Etat

•

L : Lecture

•

T : Transfert

PopulationReqCT

Date, date, obligatoire : Date du dossier

Population

.

Acteur, ActeurST, obligatoire : Version du dossier ciblée par la requête.

EtabId, int, obligatoire : Identifiant de l’établissement.





1030 Bruxelles



ActeurST, string enum

•

ECOLE

•

PO

•

ADM

3.1.3.2. Exemple de requête

< prim:PrimverPopulationRequete >

< prim:Action > L </ prim:Action >

< prim:Population

<

<

> prim:Date > prim:Acteur

2012-09-30

> ECOLE </

</ prim:Date prim:Acteur

>

>

< prim:EtabId > 105555 </ prim:EtabId >

</ prim:Population >

</ prim:PrimverPopulationRequete >

3.1.4. Réponse

3.1.4.1. Description

Selon l’action choisie, Les informations renvoyées sont plus ou moins complètes. Ainsi, si l’action initiale de la requête est « transfert » ou « Lecture », l’utilisateur recevra toutes les informations de l’établissement. Pour l’action « Etat », seules les données « Date », « Acteur », « EtabID » et

« EtatDossier » seront renvoyés à l’utilisateur.

Les données renvoyées dans la réponse respectent la structure d’établissement définie dans FASE.

La structure générale de la réponse Population est la suivante :

PrimverPopulationReponseCT

Action, TypeST, obligatoire : Type d’action sur le dossier

Population

.






1030 Bruxelles


Population, PopulationRepCT, obligatoire : Données relatives à

Population de l’établissement

.

BlocRetour, ServiceMessageCT, obligatoire : Bloc indiquant l’aboutissement de la requête et les messages éventuels de retour.

PopulationRepCT

Date, date, obligatoire : Date du dossier

Population

.

Acteur, ActeurST, obligatoire : Version du dossier ciblée par la requête.

EtabId, int, obligatoire : Identifiant de l’établissement.

EtatDossier, EtatDossierST, facultatif : Statut du dossier Primver.

Maternel, MaternelRepCT, facultatif : Population Maternel de l’établissement.

Primaire, PrimaireRepCT, facultatif : Population Primaire de l’établissement.

ALE, ALERepCT, facultatif : Population d’adaptation à la langue de l’enseignement de l’établissement.

RLMO, RLMORepCT, facultatif : Population des cours philosophiques de l’établissement.

EtatDossierST, string enum

•

A traiter

•

Administration : En cours de traitement par l’administration.

•

PO : En cours de traitement par le PO.

•

Ecole : En cours de traitement par l’école.

•

Valide : Validé par l’administration.

•

Bloque : Bloqué par l’administration.

MaternelRepCT

MaternelPopImpl, MaternelPopImplCT, obligatoire : Population maternel.

MaternelPopImplCT

Implantation, ImplantationPopMatCT, 1 à plusieurs : Implantations maternelles.

ImplantationPopMatCT

ImplId, int, obligatoire : Identifiant de l’implantation.






1030 Bruxelles

NbrElevesPhys, int, obligatoire :


Nbre d’élèves physique dans l’implantation.

NbrElevesX1, int, obligatoire : Nbre d’élèves « X1 » dans l’implantation.

NbrElevesPlaces, int, obligatoire : Nbre d’élèves placés dans l’implantation.

NbrElevesPrimo, int, obligatoire : Nbre d’élèves primo dans l’implantation.

NbrElevesM1, int, obligatoire : Nbre d’élèves en 1

ère

année maternel dans l’implantation.


ème



ème


PrimaireRepCT

PrimairePopImpl, PrimairePopImplCT, obligatoire : Population Primaire.

PrimairePopImplCT

Implantation, ImplantationPopPrimCT, 1 à plusieurs : Implantations primaires.

ImplantationPopPrimCT


NbrElevesPhys, int, obligatoire :

Nbre d’élèves physique dans l’implantation.

NbrElevesX1, int, obligatoire : Nbre d’élèves « X1 » dans l’implantation.

NbrElevesPlaces, int, obligatoire : Nbre d’élèves placés dans l’implantation.

NbrElevesP1, int, obligatoire : Nbre d’élèves en 1

ère

année primaire dans l’implantation.


ème



ème



ème



ème



ème






1030 Bruxelles



ALERepCT

ALEPopImpl, ALEPopImplCT, obligatoire : Population en adaptation à la langue de l’enseignement (ALE).

ALEPopImplCT

Implantation, ImplantationPopALECT, 1 à plusieurs : Implantations de l’établissement.

ImplantationPopALECT


NbrElevesX1, int, obligatoire : Nbre d’élèves comptant pour 1 en ALE dans l’implantation.



RLMORepCT

RLMOImplantations, RLMOImplantationsRepCT, obligatoire : Population des cours philosophiques.

RLMOImplantationsRepCT

Implantation, ImplantationPopRLMOCT, 1 à plusieurs : Implantations de l’établissement.

ImplantationPopRLMOCT


PopRLMOAnnee, PopRLMOAnneeRepCTCT, 1 à plusieurs : Année d’étude dans l’implantation.

ImplantationPopALECT

Annee, AnneeEtudeFondSt, obligatoire : Années d’étude organisées.

NbrElevesMO, int, obligatoire : Nbre d’élèves en cours de morale.

NbrElevesRC, int, obligatoire : Nbre d’élèves en cours de religion catholique.

NbrElevesRI, int, obligatoire : Nbre d’élèves en cours de religion israélite.

NbrElevesIS, int, obligatoire : Nbre d’élèves en cours de religion islamique.

NbrElevesRP, int, obligatoire : Nbre d’élèves en cours de religion protestante.






1030 Bruxelles


NbrElevesRO, int, obligatoire : Nbre d’élèves en cours de religion orthodoxe.

AnneeEtudeFondST, string enum

•

P 1 : 1

ère

année primaire

•

P 2 : 2

ème

année primaire

•

P 3 : 3

ème

année primaire

•

P 4 : 4

ème

année primaire

•

P 5 : 5

ème

année primaire

•

P 6 : 6

ème

année primaire

3.1.4.2. Exemple

< PrimverPopulationReponse

xmlns="http://www.etnic.be/janus/primver" xmlns:ens="http://www.cfwb.be/enseignement/commun" xmlns:msg="http://www.cfwb.be/commun/message" xmlns:prim="http://www.cfwb.be/enseignement/primver" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

<

<

Action > L </

Population

Action

>

>

< Date > 2012-09-30 </ Date >

< Acteur > ECOLE </ Acteur >

< EtabId > 5096 </ EtabId >

< EtatDossier > Administration </ EtatDossier >

< Maternel >

< MaternelPopImpl

<

>

Implantation >

< ImplId > 5043 </ ImplId >

< NbrElevesPhys > 79 </ NbrElevesPhys >

< NbrElevesX1 > 79 </ NbrElevesX1 >

< NbrElevesPlaces > 0 </ NbrElevesPlaces >

< NbrElevesPrimo > 0 </ NbrElevesPrimo >

< NbrElevesM1 > 28 </ NbrElevesM1 >



</ Implantation >

< Implantation >




</

<

<

<

<

<

<

Implantation

Implantation

<

<

<

NbrElevesPlaces

NbrElevesPrimo

NbrElevesM1

NbrElevesM2

NbrElevesM3

>

>

ImplId > 5045 </

NbrElevesM1

>

>

>

>

>

23

21

28

>

0

</

</

</

0 </

</

NbrElevesM1

NbrElevesM2

NbrElevesM3

ImplId

NbrElevesPrimo >

10

0

</

</

NbrElevesPrimo

>

</ Maternel >

< Primaire >

</ Implantation >

</ MaternelPopImpl >

< PrimairePopImpl

<

>

Implantation

<

>

ImplId > 5043 </ ImplId >

NbrElevesPlaces

>

>

>

>



< NbrElevesPlaces > 0 </ NbrElevesPlaces

NbrElevesPrimo

NbrElevesM1


>


>

>

>






1030 Bruxelles


</ Message >

</ BlocRetour >

</ PrimverPopulationReponse >




< NbrElevesP1 > 43 </ NbrElevesP1 >






</ Implantation >

< Implantation >











</ Implantation >

</ PrimairePopImpl >

</ Primaire >

< ALE >

< ALEPopImpl >

< Implantation >





</ Implantation >

< Implantation >

<

<

ImplId > 5044

NbrElevesX1

</

>

ImplId

8 </

>

NbrElevesX1 >

<

<

NbrElevesX2

NbrElevesX3

</ Implantation >

</ ALEPopImpl >

>

>

0

0

</

</

NbrElevesX2

NbrElevesX3

>

>

</ ALE >

</ Population >

< BlocRetour >

< CodeRetour > 0 </ CodeRetour >

< Message >

< Type > erreur </ Type >

<

<

<

Code

Libelle

Zone

> 13604

>

></ Zone

</

>

Code >

Encodage erroné par année d'études </ Libelle >

4 .

.

D E S C R I

I

P T

I

I O N D E S E

R

R E U

R

S

CodeRetour Code

1

0 15007+

13998

Description

Exécution de la requête sans erreur

Le certificat n’est pas lié à un établissement autorisé




0

0

0

0

0

0



1030 Bruxelles

0 15004

0

0

0

0

0

0

0

0

0

0

0

0

0004

15005

13524

13527

15001

13612

15002

13616

13601

13605

13602

13603

13604

15003

00204

13610

13606

13618

13623


Ecole non « Web Service ». L’école ne peut utiliser les Services Web pour intervenir sur les dossiers PRIMVER car c’est une école définie dans

Primver étant « Manuelle », PRIMVER ou SIEL-PRIMVER

Date de dossier incorrecte

Le code action demandé n’est pas valide (L, E, T)

La gestion du dossier population nécessite que les dossiers structures soient préalablement traités.

Transfert d’un dossier vide impossible

Aucune population trouvée dans SIEL

Contrôle de la cohérence entre la demande et le statut du dossier. Ex : il est impossible de lire le dossier de l’administration alors que le dossier est encore à l’école

Le transfert du dossier Primver entraine celui de SIEL. Il faut que celui-ci soit aussi dans les conditions d’être transféré pour que l’action aboutisse

Contrôle de cohérence des populations : L’année d’étude n’est pas organisée pour l’implantation.

Contrôle de cohérence des populations : Les implantations dans élève sont interdites

Contrôle de cohérence des populations : Les populations encodées ne sont pas cohérentes

Contrôle de cohérence des populations : Le nombre d’élèves ALE par implantation est supérieur à la population de(s) implantation(s)

Contrôle de cohérence des populations : Encodage erroné par année d’études

Le dossier a déjà été transféré

La date minimum à partir de laquelle on peut transférer le dossier à l’administration n’a pas été atteinte.

Des populations de SIEL plus récentes sont disponibles car Siel a été modifié entre la dernière lecture des populations et la demande de transfert

La globalisation des populations a rencontré un problème technique

Les conditions de transfert du dossier SIEL ne sont pas remplies.

Veuillez modifier le dossier correspondant dans l'application SIEL.

Veuillez compléter les populations de vos implantations

0

0

…

13624

99100

la plateforme technique de l'Etnic subit actuellement une forte charge, veuillez réessayer dans quelques instants

L’établissement demandé n’est pas connu, soit il n’y a pas d’élève dans

SIEL, soit il n’y a pas d’élève dans SIEL pour au moins un des nivreaux d’enseignement d’une des implantations de l’établissement



Etnic_PrimverPopulation_v2 0 2_Manuel d`utilisation_rev2.0

Produit :

Service :

Version du service :

Type de document :

Révision du document :

Date du document :

PRIMVER

Population

2.0.2

Manuel d’utilisation

2.0

22-04-2015

Related manuals

Table of contents

Etnic_PrimverPopulation_v2 0 2_Manuel d`utilisation_rev2.0

Produit :

Service :

Version du service :

Type de document :

Révision du document :

Date du document :

PRIMVER

Population

2.0.2

Manuel d’utilisation

2.0

22-04-2015

Related manuals

GROHE

13603BE0

Table of contents