Available columns

Name Description
candidateId The database ID used to identify the learner.
candidateGuid The learner’s GUID.
candidateRefNumber The learner’s reference number.
candidateName The learner’s name (family name/surname).
candidateFirstname The learner’s first name.
candidateLogin The learner’s login.
candidateEmail The learner’s e-mail address.
candidateGroupAncestors This column is deprecated in the CKLS 14.1 version, please use candidateEntityAncestors instead.
candidateEntityId The ID used in the database to reference the learner’s entity.
eventTitle The title of the event.
eventDescription The description of the event.
eventStartDate The start date of the event.
eventEndDate The end date of the event.
eventDuration The duration of the event.
eventAllDay Every days for this event.
eventVirtualRoomLink Link to the virtual room of the event.
eventTeacher The teacher of the event.
eventStatus The status of the event.
eventClassRoomTitle The room title of the event.
eventClassRoomDescription The room description of the event.
eventClassRoomCapacity The room capacity of the event.
eventClassRoomEquipments The room equipments of the event.
eventClassRoomType The room type of the event.

Filters and parameters

Name Description
eventClassRoomTypeFilter Export with filter Virtual or Standard.
eventDurationAllDay  
eventStatusFilter Export with a status filter C - Confirmed, P - Pending, CA - Cancelled
entityIds A comma-separated list of the entity ids to filter on. If multiple entity IDs are provided, then the export will return data about learners who belong to at least one of those entities.

Examples

<providers>
    <eventLearnerMetadataProvider>
        <columns>
            <candidateId/>
            <candidateGuid/>
            <candidateRefNumber/>
            <candidateName/>
            <candidateFirstname/>
            <candidateLogin/>
            <candidateEmail/>
            <candidateGroupAncestors/>
            <candidateEntityId/>
            <eventTitle/>
            <eventDescription/>
            <eventStartDate/>
            <eventEndDate/>
            <eventDuration/>
            <eventAllDay/>
            <eventVirtualRoomLink/>
            <eventTeacher/>
            <eventStatus/>
            <eventClassRoomTitle/>
            <eventClassRoomDescription/>
            <eventClassRoomCapacity/>
            <eventClassRoomEquipments/>
            <eventClassRoomType/>
        </columns>
        <parameters>
            <eventDurationAllDay>Y</eventDurationAllDay>
        </parameters>
    </eventLearnerMetadataProvider>
</providers>