Available columns

Name Description
candidateId The database ID used to identify the learner.
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.
candidateRefNumber The learner’s reference number.
candidateGuid The learner’s GUID.
candidateTimeZone The candidate’s timezone.
candidateGroupAncestors This column is deprecated in the CKLS 14.1 version, please use candidateEntityAncestors instead.
candidateGroupName The learner’s group name.
candidateCustomFieldGuid GUID for one of the learner’s possible custom fields.
candidatePresentation The candidate’s presentation text.
platformaccessdate  
status The progress status (completed, incomplete or not started) of the content referenced by the tracking row.
constantValue Return the constant value specified in this column’s child elements.

Filters and parameters

Name Description
dateFormat Format for dates in the exported data. The default date format is YYYY-MM-DD.
dateTimeFormat Format for dates in the exported data. The default datetime format is YYYY-MM-DD hh:ii:ss.
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.
failedConnections Whether to include failed connections.
connectionStatusFormat The format in which to display the connection status.

Examples

<providers>
    <platformCandidatesAccessProvider>
        <columns>
            <candidateId/>
            <candidateName/>
            <candidateFirstname/>
            <candidateLogin/>
            <candidateEmail/>
            <candidateRefNumber/>
            <candidateGuid/>
            <candidateTimeZone/>
            <candidateGroupAncestors/>
            <candidateGroupName/>
            <candidateCustomFieldGuid/>
            <candidatePresentation/>
            <platformaccessdate/>
            <status/>
            <constantValue/>
        </columns>
        <parameters>
            <groupIds>1,32</groupIds>
            <dateFormat>MM-DD-YYYY</dateFormat>
        </parameters>
    </platformCandidatesAccessProvider>
</providers>