This provider generates a data report containing learning object level tracking data. The following columns for each tracking row can be included in this report.

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.
candidateSmartgroups string The list of the learner's smartgroups names separated by semicolons.
candidateTimeZone string(50) The candidate's timezone.
completionTime datetime The date at which the content referenced by the tracking row has been last accessed
constantValue string Return the constant value specified in this column's child elements.
contentGuid string(40) The GUID of the learning object version.
contentLocale string(6) The locale of the learning object version.
contentRefNumber string The reference number of the learning object version.
contentTitle string The title of the learning object version.
firstCompletionDate datetime The date and time at which the content referenced by the training has been completed for the first time. If this field is not present in the import files, but the data imported is considered completed, the value of this field will be automatically set to today.
firstLaunchDate datetime The date and time at which the content referenced by the tracking row has been launched for the first time.
learningObjectGuid string(40) The GUID of the learning object.
learningObjectPublisher datetime The publisher of the learning object.
learningObjectRealCompletionTime datetime The last launch date of the resource, or NULL if the progression is not 100%.
progression float The progress of the learner on the current content referenced by the tracking row (ie. 80%).
registrationGuid string(40) The GUID of the registration.
reportGuid string(40) The GUID of the tracking row.
reportId int The database ID used to identify the tracking row.
score float The score the learner has achieved on the content.
sessionEndDate date The end date of the session.
sessionGuid string(40) The GUID of the session.
sessionId int The database ID used to identify the session.
sessionStartDate date The start date of the session.
sessionTitle string The title of the session.
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)
templatedValue string A column to be used with the 'templates' option. This column requires an attribute 'templateId' which refers to the definition of one template.
timeGlobal timeGlobalFormat
  • If the current context is a Tracking: the total time the learner spent on the content.
  • If the current context is a Tracking Log: the time the learner spent on the content on the day related to the current log.
  • If the options timeFrames and timeFramesScale are specified in the provider, then the timeGlobal value is filter to only the time spent during the chosen period.
trainingContentFolder string The name of the folder in which the learning object is placed (inside the training course).
trainingContentMandatory enum(Y, N) The flag (Y or N) indicating if the learning object is mandatory in the context of the training course.
trainingGuid string(40) The GUID of the training course.
trainingId int The database ID used to identify the training course.
trainingPathCode string The reference number of the training course.
trainingTitle string The title of the training course.

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.
catalogVisibility yesNoElement Only export training courses that have the specified catalog visibility.
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`.
deltaMode yesNoElement Only export new data (with respect to the last export). In order for this parameter to work, the previous exports must have had a `guid` attribute (``). This feature cannot be used alongside `timeFramesScale`.
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).
modality enum('', learning_channel, kc, blended, campus, distanciel, mentored_action_learning, portal, serious_game, content_test, guided) Only export data related to a training course that belongs to the specified modality.
onlyFromImportedRegistrations yesNoElement Only export tracking data related to registrations that were imported.
onlyFromImportedSessions yesNoElement Only export tracking data related to sessions that were imported.
onlyFromImportedTraining yesNoElement Only export tracking data related to trainings that were imported.
onlyHrisSelectedItems string Only export results defined in the BO of the CKLS for the HRIS connector.
@see on Techwiki
preferredLocales string The comma-separated list of preferred locales.
publishers string Only export tracking data on content issued by the given publishers GUID. Multiple publishers may be specified in a comma-separated list.
reportStatus reportStatus Export tracking data that have the specified report statuses (several values can be given).
sessionGuid string(40) Only export data related to a training session that has the specified GUID.
sessionTitle string Only export data related to a training session that has a title that contains the given string.
statusFormat statusFormat This parameter is used to convert LMS progress status to Scorm-compliant progress status.
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.
timeFrameScaleMode timeFrameScale This parameter is used in addition to `timeFrames` and `timeFramesScale` to determine how the total time spent is estimated. Possible values are `lastActivity` or `timeSpent`
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`.
timeGlobalFormat timeGlobalFormat Time format in which the `timeGlobal` column should be exported
trainingGuid string(40) Only export data related to a training course that has the specified GUID.
trainingModalityFormat string Only export data related to the training courses with the chosen modality, filtered by their database name (ex: blended, guided, learning_channel).
trainingPathCode string Only export data related to a training course that has the specified code.
trainingPublishers string Only export data related to the list of publishers (linked to training courses), filtered by title. Can contain several values separated by commas.
trainingStatus string Only export training courses that have the specified statuses. This parameter contains a comma-separated list of training statuses (see the available values in column `trainingStatus`).
trainingStatusFormat trainingStatusFormat Configure what value to display for each training status value.
withoutLaunchTime yesNoElement Whether or not to export tracking data that has no launch date (the learner has never launched the content). By default, the provider will only export tracking data where the learner has launched the content at least once.
Please note that this option should not be used together with the `timeFrames` options, as the `timeFrames` options are based on the learners activity, so using both options together will prevent from retrieving the data without activity.

Example

<providers>
    <trackingProvider>
		<columns>
			<candidateId/>
			<candidateName/>
			<candidateFirstname/>
			<candidateLogin/>
			<candidateEmail/>
			<candidateRefNumber/>
			<candidateGuid/>
			<candidateEntityName/>
			<candidateCustomFieldGuid label="Department">8345C0A3-B8AB-7F65-0638-39B0E1244AA8</candidateCustomFieldGuid>
			<trainingId/>
			<trainingTitle/>
			<trainingPathCode/>
			<trainingGuid/>
			<sessionId/>
			<sessionTitle/>
			<sessionGuid/>
			<sessionStartDate/>
			<sessionEndDate/>
			<contentGuid/>
			<contentRefNumber/>
			<contentTitle/>
			<contentLocale/>
			<firstLaunchDate/>
			<completionTime/>
			<score/>
			<timeGlobal/>
			<progression/>
			<status/>
            <templatedValue label="URL" templateId="1" />
		</columns>
        <parameters>
            <dateFormat>MM-DD-YYYY</dateFormat>
            <templates>
                <template id="1">https://instanceurl.ck.com/sso/content/{19}/Language/{21}</template>
            </templates>
        </parameters>
    </trackingProvider>
</providers>