Export learners

Available columns

Name Type Description
candidateAccountActivated enum(Y, N, U) The status of the learner's account (actived/disabled).
candidateAccountActivatedFrom date If the learner's account is only active during a limited period of time, the first date for which it is active.
candidateAccountActivatedUntil date If the learner's account is only active during a limited period of time, the last date for which it is active.
candidateBadges int Total amont of badges acquired by the learner.
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.
candidateEntityId int The ID used in the database to reference the learner's entity.
candidateEntityName string The learner's entity name.
candidateFirstname string The learner's first name.
candidateFollowLinkedin string(250) The learner's LinkedIn username.
candidateFollowTwitter string(250) The learner's Twitter username.
candidateFollowWeb url(250) The learner's web page.
candidateGuid string(40) The learner's GUID.
candidateId int The database ID used to identify the learner.
candidateLocale string(6) The chosen display locale for the learner, based on the available locales on the instance and their preferences.
candidateLocales string The ordered list of chosen locales for the learner.
candidateLogin string The learner's login.
candidateName string The learner's name (family name/surname).
candidatePoints int Total amont of points acquired by the learner.
candidatePresentation longtext The candidate's presentation text.
candidateRefNumber string The learner's reference number.
candidateSmartgroups string The list of the learner's smartgroups names separated by semicolons.
candidateTimeZone string(50) The candidate's timezone.
constantValue string Return the constant value specified in this column's child elements.
creationDate date The date at which the object (learner, training course or training session) was created.
lastPlatformAccessDate datetime The last date at which the learner has accessed the platform.
managerLogin string The manager's login.

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.
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.
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`.

Examples

<export>
    <providers>
        <platformCandidatesProvider>
            <columns>
                <candidateId/>
                <candidateLogin/>
                <candidateName/>
                <candidateFirstname/>
                <candidateEmail/>
                <candidateRefNumber/>
                <candidateGuid/>
                <managerLogin/>
                <candidateCustomFieldGuid label="Department">8345C0A3-B8AB-7F65-0638-39B0E1244AA8</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>
        </moveToFolder>
    </consolidators>
</export>