{{ :blocks:logo-apl.png?nolink |}} ===== Onboarding (Gestion d'inscriptions locales) : Guide technique ===== ====Données interrogeable par l'attestation de formation (PDCertificate)==== Le module Onboarding implémente l'API d'interrogation de données permettant à une [[mod:pdcertificate|attestation de formation]] de puiser dans les données d'OnBoarding pour construire le document. La forme générale de l'API d'injection de données est documentée ici : [[https://docs.activeprolearn.com/doku.php?id=mod:pdcertificate:technique:placeholders]] ====Catalogue de données==== Ce qui suit décrit l'ensemble des données interrogeables sur le composant Onboarding. Les objets décrits ci-dessous sont extraits dans le contexte de l'attestation qui les demande (donc lié à l'identité du bénéficiaire de l'attestation, et au cours courant). Les données sont obtenues à partir de l'export pour les templates Mustache et notifications par email. Certaines données sont donc reformatées et retraitées sous leur forme "affichable", par rapport à leur forme stockée en base de données. Les listes ci-dessous se limitent aux données fonctionnellement "intéressantes", mais le schéma de base de données est intégralement accessible. * Objet : ''session'' (Session de formation) * ''session|idnumber'': Identifiant de session * ''session|timestart'': Date de début de session (ou date 1er jour) - Valeur affichable * ''session|timeend'': Date de fin de session (ou fin du dernier jour) - Valeur affichable * ''session|location'': Lieu * ''session|effectiveduration'': Code durée * ''session|duration'': Durée (valeur affichable du code durée) * ''session|mode'': Code modalité * ''session|modestring'': Valeur affichable de la modalité * Objet : ''institution'' (Institution validante) * ''institution|code'': Code externe institution * ''institution|name'': Nom institution * ''institution|address1'': Ligne d'adresse 1 * ''institution|address2'': Ligne d'adresse 2 * ''institution|zipcode'': Code zip * ''institution|city'': Ville * ''institution|zone'': zone institution (canton) * ''institution|type'': Type institution - A AJOUTER ULTERIEUREMENT * Objet : ''request'' (Demande de formation) * ''request|code'': code identifiant unique de demande * ''request|sessionid'': Identifiant de session (égal à ''session.idnumber'') * ''request|firstname'': Prénom demandeur * ''request|lastname'': Nom demandeur * ''request|address'': Adresse demandeur * ''request|zip'': Code ZIP demandeur * ''request|city'': Ville demandeur * ''request|email'': Email demandeur * ''request|statusstring'': Statut demandeur (valeur affichable) - A AJOUTER * ''request|statusfromyear'': Année d'obtention du statut * ''request|timecreated'': Date (affichable) du dépot de demande * ''request|validation0'': Date (affichable) de la confirmation demande * ''request|validation1'': Date (affichable) de la validation de demande * ''request|validation2'': Date (affichable) du traitement interne de demande (inscription) --------- [[:local:onboarding|Retour au sommaire de la solution]] - [[:plugins|Retour à l'index des plugins]] - [[:start|Retour au catalogue]]