Export the learners connection history

Available columns

Name Type Description
candidateCustomFieldGuid string(250) Data for one of the learner's possible custom fields (GUID of the custom field needs to be specified, please check the examples).
candidateEmail string The learner's e-mail address.
candidateEntityAncestors string The learner's entity ancestors.
candidateEntityName string The learner's entity name.
candidateFirstname string The learner's first name.
candidateGuid string(40) The learner's GUID.
candidateId int The database ID used to identify the learner.
candidateLogin string The learner's login.
candidateName string The learner's name (family name/surname).
candidateRefNumber string The learner's reference number.
candidateTimeZone string(50) The candidate's timezone.
platformAccessDate datetime A date at which the learner has accessed the platform.
status enum For the providers related to tracking: The progress status of the content referenced by the tracking row. The returned values can be overriden thanks to option 'statusFormat'.
Type: enum(completed, incomplete, not started)
For the provider 'Platform Candidates Access': The status of the of connection attempt (0 = failed, 1 = successful).
Type: enum(0, 1)

Filters and parameters

Name Type Description
ancestorsWithCurrent yesNoElement 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.
connectionStatusFormat connectionStatusFormat The format in which to display the connection status.
dateFormat string Format for dates in the exported data. When not specified, the default date format is `YYYY-MM-DD`.
dateTimeFormat string Format for dates in the exported data. When not specified, the default value is `YYYY-MM-DD hh:ii:ss`.
entityIds string 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.
failedConnections yesNoElement Whether to include failed connections.
learnersSmartGroups string A list of IDs of smartgroups separated by commas. Allows to filter the exported results on the specified smartgroups.
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.
timeFrames timeFrameScale Once a learner has completed a learning object or activity, 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 timeFrameScale Once a learner has completed a learning object or activity, 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`.

Example

<providers>
    <platformCandidatesAccessProvider>
        <columns>
            <candidateId/>
            <candidateName/>
            <candidateFirstname/>
            <candidateLogin/>
            <candidateEmail/>
            <candidateRefNumber/>
            <candidateGuid/>
            <candidateTimeZone/>
            <candidateCustomFieldGuid label="Column label">8345C0A3-B8AB-7F65-0638-39B0E1244AA8</candidateCustomFieldGuid>
            <candidatePresentation/>
            <platformaccessdate/>
            <status/>
            <constantValue/>
        </columns>
        <parameters>
            <entityIds>1,32</entityIds>
            <dateFormat>MM-DD-YYYY</dateFormat>
            <connectionStatusFormat>
				<success>S</success>
				<failure>F</failure>
			</connectionStatusFormat>
        </parameters>
    </platformCandidatesAccessProvider>
</providers>