Available columns

Name Description
candidateId The database ID used to identify the learner.
candidateLogin The learner’s login.
candidateName The learner’s name (family name/surname).
candidateFirstname The learner’s first name.
candidateEmail The learner’s e-mail address.
candidateRefNumber The learner’s reference number.
candidateGuid The learner’s GUID.
managerLogin The manager’s login.
candidateGroupAncestors This column is deprecated in the CKLS 14.1 version, please use candidateEntityAncestors instead.
candidateGroupId The ID used in the database to reference the learner’s group.
candidateCustomFieldGuid GUID for one of the learner’s possible custom fields.
candidateTimeZone The candidate’s timezone.
candidatePresentation The candidate’s presentation text.
candidateFollowWeb The learner’s web page.
candidateFollowTwitter The learner’s Twitter handle.
candidateFollowLinkedin The learner’s LinkedIn username.
candidateLocale The chosen display locale for the learner, based on the available locales on the instance and their preferences.
candidateLocales The ordered list of chosen locales for the learner.
candidateAccountActivated The status of the learner’s account (actived/disabled).
candidateAccountActivatedFrom If the learner’s account is only active during a limited period of time, the first date for which it is active.
candidateAccountActivatedUntil If the learner’s account is only active during a limited period of time, the last date for which it is active.
lastPlatformAccessDate The last date at which the learner has accessed the platform.
creationDate The date at which the object (learner, training course or training session) was created.
candidatePoints Total amont of points acquired by the learner.
candidateBadges Total amont of badges acquired by the learner.
constantValue Return the constant value specified in this column’s child elements.

Filters and parameters

Name Description
ancestorsWithCurrent For each tracking data row, the learner’s hierarchy can be exported with the other data. This parameter tells the provider whether to include the learner’s group in the hierarchy or not. If set to yes, the learner’s current group will be included. Otherwise, it will be removed from the exported hierarchy.
groupIds This parameter is deprecated in the CKLS 14.1 version, please use entityIds instead. A comma-separated list of the group ids to filter on. If multiple group ids are provided, then the export will return data about learners who belong to at least one of those groups.
timeFrames Once a learner has completed a learning object, a completion date will be saved in the associated tracking row. This parameter is used to the provider to only export tracking data where the completion date is in a certain time span. Must be used with timeFramesScale.
timeFramesScale Once a learner has completed a learning object, a completion date will be saved in the associated tracking row. This parameter is used to the provider to only export tracking data where the completion date is in a certain time span. Must be used with timeFrames.

Examples

<export>
    <providers>
        <platformCandidatesProvider>
            <columns>
                <candidateId/>
                <candidateLogin/>
                <candidateName/>
                <candidateFirstname/>
                <candidateEmail/>
                <candidateRefNumber/>
                <candidateGuid/>
                <managerLogin/>
                <candidateGroupAncestors/>
                <candidateGroupId/>
                <candidateCustomFieldGuid/>
                <candidateTimeZone/>
                <candidatePresentation/>
                <candidateFollowWeb/>
                <candidateFollowTwitter/>
                <candidateFollowLinkedin/>
                <candidateLocale/>
                <candidateLocales/>
                <candidateAccountActivated/>
                <candidateAccountActivatedFrom/>
                <candidateAccountActivatedUntil/>
                <lastPlatformAccessDate/>
                <creationDate/>
                <candidatePoints/>
                <candidateBadges/>
            </columns>
        </platformCandidatesProvider>
    </providers>
    <actions>
        <fileExportAction>
            <format>CSV</format>
            <encoding>UTF-8</encoding>
            <delimiter>semicolon</delimiter>
            <showHeaders>yes</showHeaders>
        </fileExportAction>
    </actions>
    <consolidators>
        <moveToFolder>
            <fileName>Platform_Candidates.csv</fileName>
    </consolidators>
</export>