===== ETL Report: User guide =====

Handling extraction reports is only possible for administrator users, since these extractors have very global access to the data stored in Moodle.

==== Setting up extraction instances ====

For each extraction plugin, it is possible to configure several report instances, for example if several third-party applications need to use Moodle data. Be careful however that the extraction loads induced by each instance will then add up.

   * Navigate to ''Administration > Reports > ETL data extraction''
   * Activate the tab of the plugin you want to instantiate
   * Click the ''Add an ETL instance'' link at the bottom of the page
   * Fill in the configuration settings and save the instance

==== Accessing the data of an extraction plugin through web services ====

To access the extraction data, you can use the standard Moodle web services. The ETL report provides two web services described in the [[:reportetl:technicalguide|Technical guide]].

To do so you will need to: 

   * Prerequisites:
     * Enable Moodle web services (in general)
     * Enable the protocol matching what your client data application uses.
     * Identify a user carrying the web service requests in Moodle. This user must have the capabilities required to use web services on the chosen protocol.
     * Add the user designated above to the authorized users of the "Moodle ETL" service
     * Create a token for this user on this service

From that point on, the data extraction can be called by your client application in the form: 

   https://<mymoodle>/service/rest/server.php?wstoken=<token>&wsfunction=report_etl_get&plugin=<etlpluginname>&id=<etlplugininstance>&queryparams=<jsonparams>

Each plugin can request specific local parameters, presented in the ''queryparams'' parameter as an object serialized in JSON. It is preferable to URL-encode the expression of this JSON object.

[[:reportetl|Back to the component index]] - [[:plugins|Back to the plugin index]]