The Onboarding module implements the data query API allowing a training certificate to draw from OnBoarding data to build the document.

The general form of the data injection API is documented here:

https://docs.activeprolearn.com/doku.php?id=mod:pdcertificate:technique:placeholders

The following describes all the data that can be queried on the Onboarding component. The objects described below are extracted in the context of the certificate requesting them (therefore tied to the identity of the certificate's beneficiary, and to the current course).

The data is obtained from the export for Mustache templates and email notifications. Some data is therefore reformatted and reprocessed into its “displayable” form, compared to its form stored in the database. The lists below are limited to the functionally “interesting” data, but the database schema is fully accessible.

• Object: session (Training session)
  • session|idnumber: Session identifier
  • session|timestart: Session start date (or 1st day date) - Displayable value
  • session|timeend: Session end date (or end of the last day) - Displayable value
  • session|location: Location
  • session|effectiveduration: Duration code
  • session|duration: Duration (displayable value of the duration code)
  • session|mode: Modality code
  • session|modestring: Displayable value of the modality
• Object: institution (Validating institution)
  • institution|code: Institution external code
  • institution|name: Institution name
  • institution|address1: Address line 1
  • institution|address2: Address line 2
  • institution|zipcode: Zip code
  • institution|city: City
  • institution|zone: institution zone (canton)
  • institution|type: Institution type - TO BE ADDED LATER
• Object: request (Training request)
  • request|code: unique request identifier code
  • request|sessionid: Session identifier (equal to session.idnumber)
  • request|firstname: Requester first name
  • request|lastname: Requester last name
  • request|address: Requester address
  • request|zip: Requester ZIP code
  • request|city: Requester city
  • request|email: Requester email
  • request|statusstring: Requester status (displayable value) - TO BE ADDED
  • request|statusfromyear: Year the status was obtained
  • request|timecreated: Date (displayable) the request was filed
  • request|validation0: Date (displayable) of the request confirmation
  • request|validation1: Date (displayable) of the request validation
  • request|validation2: Date (displayable) of the internal processing of the request (registration)

———

Back to the solution summary - Back to plugins index - Back to catalogue