Etnic_PrimverACM_v2 1 0_Manuel d`utilisation_rev3.0
Contents
1. lt prim ACM gt lt prim PrimverACMRequete gt 3 1 3 3 Exemple de requ te de type calcul ou transfert lt prim PrimverACMRequete gt lt prim Action gt T lt prim Action gt lt prim ACM gt lt prim Date gt 2012 11 19 lt prim Date gt lt prim Acteur gt PO lt prim Acteur gt lt prim Etabld gt 2200 lt prim Etabld gt lt Optional gt lt prim Implantations gt lt 1 or more repetitions gt lt prim Implantation gt lt prim Implld gt 4432 lt prim Impllid gt lt prim NbrElevesX1 gt 80 lt prim NbrElevesX1 gt lt prim NbrElevesPlaces gt 1 lt prim NbrElevesPlaces gt lt prim NbrElevesPrimo gt 1 lt prim NbrElevesPrimo gt lt prim Implantation gt lt prim Implantation gt lt prim Implid gt 4433 lt prim Impllid gt lt prim NbrElevesX1 gt 125 lt prim NbrElevesX1 gt lt prim NbrElevesPlaces gt 0 lt prim NbrElevesPlaces gt lt prim NbrElevesPrimo gt 0 lt prim NbrElevesPrimo gt lt prim Implantation gt lt lprim Implantations gt lt prim ACM gt lt prim PrimverACMRequete gt 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 Calcul ou transfert ou Lecture l utilisateur recevra toutes les informations de l tablissement Pour l action Etat seules les donn es Date Acteur EtablD et EtatDossier2. lt Type gt erreur lt Type gt lt Code gt 15004 lt Code gt lt Libelle gt Vous ne pouvez pas utiliser ce Web Service lt Libelle gt lt Zone gt lt Message gt lt BlocRetour gt lt PrimverACMReponse gt 4 DESCRIPTION DES ERREURS CodeRetour Code Description 1 Ex cution de la requ te sans erreur 0 15007 Le certificat n est pas li un tablissement autoris 13998 Manuel copyright ETNIC dit le 22 04 2015 Page 10 11 d utilisation PrimverACM v2 1 0 rev3 0 B timent Le Z nith Boulevard du Roi Albert Il 37 1030 Bruxelles 15004 0004 13524 15001 15002 15003 00204 PRIMVER ACM Manuel d utilisation 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 La gestion du dossier population n cessite que les dossiers structures soient pr alablement trait s Transfert d un dossier vide impossible 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 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 Manuel d utilisation Pri
3. 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 ACM est la suivante i ACMRepCT i PrimverACMReponseCT Date 1 1 date re el Action 1 1 TypeST e Acteur 1 1 ActeurST E PrimverACMReponse SS LH E ACM 1 1 ACMRepCT S Etabld 1 1 int BlocRetour 1 1 ServiceMessageCT EtatDossier 0 1 EtatDossierST i Implantations 0 1 ImplantationsRepCT Manuel copyright ETNIC dit le 22 04 2015 Page 8 11 d utilisation PrimverACM v2 1 0 rev3 0 Be N C PRIMVER ACM B timent Le Z nith Manuel d utilisation Boulevard du Roi Albert Il 37 1030 Bruxelles PrimverACMReponseCT Action TypeST obligatoire Type d action du le dossier ACM ACM ACMRepCT obligatoire Donn es relatives ACM BlocRetour ServiceMessageCT obligatoire Bloc indiquant l aboutissement de la requ te et les messages ventuels de retour ACMRepCT Date date obligatoire Date du dossier ACM Acteur ActeursST obligatoire Version du dossier cibl e par la requ te Etabld int obligatoire Identifiant de l tablissement EtatDossier EtatDossierST facultatif Statut du dossier Primver Implantations ImplantationsRepCT facultatif Implantations co
4. int obligatoire Nbre d l ves physique dans l implantation NbrElevesEncadrement int obligatoire Nbre d l ves encadrement dans l implantation NbrEmploisAvantCpt EmploiST obligatoire Nbre d emplois avant comptage NbrEmploisSup EmploiST obligatoire Nbre d emplois suppl mentaires suite ACM NbrEmploisGenere EmploiST obligatoire Nbre d emplois g n r s apr s ACM NbrPeriodesPsychomotAvantCpt int facultatif obligatoire partir du 01 09 2014 sinon absent Nbre nou de p riodes de psychomotricit avant comptage NbrPeriodesPsychomotSup int facultatif obligatoire partir du 01 09 2014 sinon absent Nbre de ra p riodes de psychomotricit suppl mentaires suite l ACM NbrPeriodesPsychomotGenere int facultatif obligatoire partir du 01 09 2014 sinon absent Nbre nou de p riodes de psychomotricit g n r s apr s l ACM EmploiST decimal total digits 7 fraction digits 2 3 1 4 2 Exemple lt PrimverACMReponse xmins http wwvw etnic be janus primver xmins ens http www cfwb be enseignement commun xmins msg htto www cfwb be commun message xmins prim http wwvw cfwb be enseignement primver xmins soapenv htto schemas xmlsoap org soap envelope gt lt Action gt L lt Action gt lt ACM gt lt Date gt 2013 11 19 lt Date gt lt Acteur ADM lt Acteur gt lt Etabld gt 776 lt Etabld gt lt ACM gt lt BlocRetour gt lt CodeRetour 0 lt CodeRetour gt lt Message gt
5. quelconque 4 La valeur de la donn e Acteur d pend de l action choisie Action E L C T Acteur possible ECOLE PO ECOLE PO ADM ECOLE PO ECOLE PO 5 L action est conditionn selon le mode d appel choisi row Action E L C T Mode d appel Complet autoris autoris autoris autoris Mode d appel Consultation autoris Autoris si dossier Non autoris Non autoris valid requ te rejet e requ te rejet e 6 Le champ Implantations est obligatoire si l action est C ou T facultatif sinon La structure g n rale de la requ te ACM est la suivante Gel ACMReqCT 1 1 e Acteur DA el Etabld DA e Implantations 0 1 PrimverACMRequeteCT Date date ActeurST e Action 1 1 TypeST E ACM DA ACMReqCT e PrimverACMRequete int Li ImplantationsReqCT L PrimverACMRequeteCT Action TypeST obligatoire Type d action du le dossier ACM ACM ACMReqCT obligatoire Donn es relatives ACM TypeST string enum Manuel d utilisation PrimverACM v2 1 0 rev3 0 copyright ETNIC dit le 22 04 2015 Page 6 11 N C PRIMVER ACM B timent Le Z nith Manuel d utilisation Boulevard du Roi Albert Il 37 1030 Bruxelles e E Etat e L Lecture e C Calcul e T Transfert ACMReqCT Date date obliga
6. 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 Manuel copyright ETNIC dit le 22 04 2015 Page 3 11 d utilisation PrimverACM v2 1 0 rev3 0 efn C PRIMVER ACM B timent Le Z nith Manuel d utltsatton Boulevard du Roi Albert Il 37 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 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 ETNIC 2 2 INTERFACE Le service PRIMVER ACM 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 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 BLOC RETOUR Chaque service renvoie une r ponse compos e d un bloc re
7. CHANGEMENTS PAR RAPPORT A LA DERNIERE VERSION snssssssnnnnensssnsre1n1e 3 1 2 1 Objet dwchangement orai Eee EEE E E E EEE E TREE E ERE tentent 3 1 2 2 Description des changements orison e a e E E EERE 3 2 SPECIFICATIONS GLOBALES esereessrrennnsnneennnsnneennssnneennsnneeennssnneeenseneeennee 3 2 1 PLATEFORME DES SERVICES WEB 3 2 2 r A 2 3 BLOC RETOUR E A 3 DESCRIPTION DES OPERATIONS nnneninnnnnnnnninnnnnnnnnnnn nnana annn nR RRNA nnn Annn nnn Annn ANNARRA 5 3 15 PRIMVERAGC Mi Sur ant de fin gege a E a EAA R ARE NEE 5 3 1 1 Description fonctionnelle sense J 3 1 2 E 5 3 1 3 Parametr s d IA T QU IE siosaia n e sde nr ee mirent een ge 6 3 1 4 REPONSES RE Ee ee ET EE PS 8 4 DESCRIPTION DES ERREURS 3255 5520 ann e Seegen 10 Manuel copyright ETNIC dit le 22 04 2015 Page 2 11 d utilisation PrimverACM v2 1 0 rev3 0 efn C PRIMVER ACM B timent Le Z nith Manuel d utilisation Boulevard du Roi Albert Il 37 1030 Bruxelles 1 CADRE 1 1 OBJET DU SERVICE Ce service permet l cole de calculer son augmentation de cadre maternel et de faire parvenir celui ci la DGEO Il permet galement de consulter les dossiers ACM sauvegard s dans PRIMVER ainsi que le statut du dossier La liste exhaustive des op rations est la suivante e PrimverACM 4 actions sont possibles pour les augmentations de cadre maternel o Etat fournit
8. PRIMVER ACM B timent Le Z nith Manuel d utilisation Boulevard du Roi Albert Il 37 1030 Bruxelles Produit PRIMVER Service ACM Version du service 2 1 0 Type de document Manuel d utilisation R vision du document 3 0 Date du document 22 04 2015 Historique R vision Description Ecrit par Date 1 0 Version initiale P Rouxhet 13 05 2014 2 0 Rentr e scolaire 2014 2015 P Rouxhet 15 07 2014 3 0 Ajout du mode consultation P Rouxhet 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 augmentations de cadre dans l enseignement maternel 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 support etnic be T l 02 800 10 10 Manuel copyright ETNIC dit le 22 04 2015 Page 1 11 d utilisation PrimverACM _v2 1 0 rev3 0 ef N C PRIMVER ACM B timent Le Z nith Manuel d utilisation Boulevard du Roi Albert Il 37 1030 Bruxelles Table des mati res I CADRE en Nes 3 1 1 OBJET DU SERVICE geet AER nine dde pee tee E ed nn E 3 1 2 IDENTIFICATION DES
9. e retour contient les informations du dossier ACM PRIMVER selon l action demand e 3 1 2 Adressage nou Param tres WS Addressing Service Complet Action primver acm mode async To http www etnic be janus primver2 Service de Consultation Action primver acmConsultation mode sync To http www etnic be janus primver2 Manuel copyright ETNIC dit le 22 04 2015 Page 5 11 d utilisation PrimverACM v2 1 0 rev3 0 gt RS ef NIC PRIMVER ACM Manuel d utilisation B timent Le Z nith Boulevard du Roi Albert Il 37 1030 Bruxelles 3 1 3 Param tres de la requ te 3 1 3 1 Description La requ te du WS ACM peut tre assez complexe II y a essentiellement 6 raisons cela 1 Selon l action choisie la requ te n cessite que l utilisateur fournisse ou non les informations compl tes de l tablissement Ainsi si l action est Calcul ou Transfert l utilisateur doit fournir toutes les informations utiles au calcul de PACM Pour l action Etat et Lecture seules les donn es Date Acteur et EtablD doivent tre aliment es lors de l appel au WS 2 Les donn es fournies dans la requ te doivent respecter la structure de l tablissement d finie dans FASE 3 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 n est donc pas
10. ge e information e avertissement e erreur 3 DESCRIPTION DES OPERATIONS 3 1 PRIMVERACM 3 1 1 Description fonctionnelle nova Le Service Web ACM 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 augmentations de cadre maternel 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 ACM de leur tablissement par le seul biais de ce Service Web Cette op ration regroupe l ensemble des actions possibles sur un dossier ACM de PRIMVER savoir action Etat fournit uniquement l tat d un dossier ACM action Lecture cette action permet de r cup rer toutes les donn es sauvegard es dans le dossier ACM action Calcul r cup re les r sultats des calculs d un ACM action Transfert effectue le transfert du dossier ACM 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 Mode complet Mode Consultation Etat autoris e autoris e Lecture autoris e autoris e si Dossier valid Calcul autoris e Non De Transfert autoris e Non Le message d
11. l tat d un dossier ACM Lecture fournit le contenu d un dossier ACM O o Calcul calcul et valide fonctionnellement un dossier ACM o Transfert envoie le dossier ACM la DGEO 1 2 IDENTIFICATION DES CHANGEMENTS PAR RAPPORT A LA DERNIERE VERSION 1 2 1 Objet du changement L adaptation du Service Web ACM 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 nou 2 SPECIFICATIONS GLOBALES 2 1 PLATEFORME DES SERVICES WEB now Le service PRIMVER ACM 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 ACM 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
12. mverACM v2 1 0 rev3 0 copyright ETNIC dit le 22 04 2015 Page 11 11
13. ncern es par la r ponse 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 ImplantationRepCT Implid 1 1 int e NbrElevesX1 1 1 int e NbrElevesPlaces 1 1 int e NbrElevesPrimo 1 1 int ImplantationsRepCT minis par e NbrElevesEncadrement 1 1 int s e Implantation 1 ImplantationRepCT i ve E NbrEmploisAventCpt Li EmposT G e NbrEmploisSup 1 1 EmploiST l e NbrEmploisGenere 1 1 EmploiST l E NbrPeriodesPsychomotAvantCpt 0 1 int e NbrPeriodesPsychomotSup 0 1 int NbrPeriodesPsychomotGenere 0 1 int ImplantationsRepCT Implantation ImplantationRepCT 1 plusieurs Implantation ImplantationRepCT Implld int obligatoire Identifiant de 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 d utilisation PrimverACM v2 1 0 rev3 0 Manuel copyright ETNIC dit le 22 04 2015 Page 9 11 Be N C PRIMVER ACM B timent Le Z nith Manuel d utilisation Boulevard du Roi Albert Il 37 1030 Bruxelles NbrElevesPrimo int obligatoire Nbre d l ves primo dans l implantation NbrElevesPhys
14. toire Date du dossier ACM Acteur ActeurST obligatoire Version du dossier cibl e par la requ te Etabld int obligatoire Identifiant de l tablissement Implantations ImplantationsReqCT facultatif Implantations concern e par la requ te ActeurST string enum ECOLE e PO e ADM ImplantationReqCT e Implld 1 1 int e Nbr levesX1 1 1 int e NbrElevesPlaces 1 1 int e NbrElevesPrimo 1 1 int ImplantationsReqCT zen e Implantation 1 ImplantationReqCT ImplantationsReqCT Implantation ImplantationReqCT 1 plusieurs Implantation ImplantationReqCT Implid int obligatoire Identifiant de 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 3 1 3 2 Exemple de requ te de type tat ou lecture lt prim PrimverACMRequete gt lt prim Action gt L lt prim Action gt lt prim ACM gt lt prim Date gt 2012 11 20 lt prim Date gt lt prim Acteur ADM lt prim Acteur gt lt prim Etabld gt 2200 lt prim Etabld gt Manuel copyright ETNIC dit le 22 04 2015 Page 7 11 d utilisation PrimverACM v2 1 0 rev3 0 efn C PRIMVER ACM B timent Le Z nith Manuel d utltsatton Boulevard du Roi Albert Il 37 1030 Bruxelles
15. tour 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 5 MessageType E TypeMessageST ServiceMessageCT Type TypeMessageST iZ information e CodeRetour CodeRetourST E Message 0 MessageType Code CodeType Libelle LibelleType Zone anyType avertissement iZ erreur 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 Manuel copyright ETNIC dit le 22 04 2015 Page 4 11 d utilisation PrimverACM v2 1 0 rev3 0 of N C PRIMVER ACM B timent Le Z nith Manuel d utilisation Boulevard du Roi Albert Il 37 1030 Bruxelles TypeMessageST string enum Type de messa
Download Pdf Manuals
Related Search