This provider exports data related to Blendedx training courses classroom events.
Available columns
Name |
Type |
Description |
catalogVisibility |
enum(Y, N) |
"Y" if the training course associated with the current context is visible in the public catalogue, "N" otherwise. |
eventAllDay |
enum(true, false) |
'true' if the event lasts the whole day, false otherwise. |
eventClassRoomCapacity |
int |
The room capacity of the event. |
eventClassRoomDescription |
longtext |
The room description of the event. |
eventClassRoomTitle |
string |
The room title of the event. |
eventClassRoomType |
enum(Standard, Virtual) |
The room type of the event. |
eventDescription |
longtext |
The description of the event. |
eventDuration |
int |
The duration of the event. |
eventEndDate |
date |
The end date of the event. |
eventStartDate |
date |
The start date of the event. |
eventStatus |
enum(C, P, CA) |
The validation status of the event. Values can be C, P, CA, respectively for Confirmed, Pending, CAncelled. |
eventTeacher |
string |
The teacher of the event. |
eventTitle |
string |
The title of the event. |
eventVirtualRoomLink |
url |
Link to the virtual room of the event. |
trainingDescription |
longtext |
The description of the training course. |
trainingDuration |
string |
The duration of the training course. |
trainingId |
int |
The database ID used to identify the training course. |
trainingLocale |
string(6) |
The main locale of the training course. |
trainingPathCode |
string |
The reference number of the training course. |
trainingStatus |
enum(C, P, A) |
The validation status of the training course. The values displayed in this column are C, P, A which respectively mean Under Construction, Published, Archive. These values can be configured via the `trainingStatusFormat` parameter. |
trainingTitle |
string |
The title of the training course. |
Filters and parameters
Name |
Type |
Description |
catalogVisibility |
yesNoElement |
Only export training courses that have the specified catalog visibility. |
eventClassRoomTypeFilter |
enum(Standard, Virtual) |
Export with filter Virtual or Standard. |
eventDurationAllDayFilter |
yesNoElement |
Export all day between a start day and a end day. |
eventStatusFilter |
enum(C, P, CA) |
Export only events with a chosen status (C - Confirmed, P - Pending, CA - Cancelled) |
maxLength |
int |
If not empty, this option will crop each value to the specified max length (each cell, not each line). |
stripHTML |
string |
If not empty, this option will remove any HTML tag from the exported data. |
templates |
templates |
The definition of a dynamic template, to allow to customize the returned value for a column. It also allows to combine the values of several columns into one. |
trainingIds |
string |
Only export data related to the training courses that have an ID included in the comma-separated list specified in this parameter. |
trainingStatus |
string |
Only export training courses that have the specified statuses. This parameter contains a comma-separated list of training statuses (see the available values in column `trainingStatus`). |
Examples
<providers>
<eventTrainingMetadataProvider>
<columns>
<trainingId/>
<trainingPathCode/>
<trainingTitle/>
<trainingDescription/>
<trainingDuration/>
<trainingLocale/>
<catalogVisibility/>
<trainingStatus/>
<eventTitle/>
<eventDescription/>
<eventStartDate/>
<eventEndDate/>
<eventDuration/>
<eventAllDay/>
<eventVirtualRoomLink/>
<eventTeacher/>
<eventStatus/>
<eventClassRoomTitle/>
<eventClassRoomDescription/>
<eventClassRoomCapacity/>
<eventClassRoomType/>
</columns>
<parameters>
<trainingStatus>P</trainingStatus>
</parameters>
</eventTrainingMetadataProvider>
</providers>