Updated as of Version 26.02.
Ready to upgrade? Contact PeopleFluent Support.

Data Import/Export in the Background Task Console

You can manage recurring data imports and exports in the Background Task Console.

To create scheduled import an export tasks, your role must have access to the System Administration feature.

Create a Scheduled Import or Export Task

  1. Go to Manage Center > System > System Utilities > Background Task Console. The Background Task Console page opens and lists any existing scheduled tasks.
  2. Click + Add Tasks..
  3. Configure the task.  Use the table below for guidance:
Field Description
Task Select Import or Export
Frequency

Select a frequency for the task. Task schedules are saved as Outline Processor Markup Language (OPML) files that contain the task definitions. Please see OPML Background Task Definition Example below for an example.

  • Hourly - hourly import tasks are saved in imports-hourly.opml. Hourly export tasks are saved in exports-hourly.opml.
  • Daily - daily tasks are saved in the imports-daily.opml and exports-daily.opml. You can configure the hour of the day at which daily tasks are run by setting the value of the system.handlerstarttime property in WEB-INF/conf/ekp.properties. The value can be an integer between 0 and 23 inclusive. By default, daily tasks run at 3 a.m. To schedule daily tasks to run at 11 p.m., for example, set the value to 23 (system.handlerstarttime=23).
  • Weekly - weekly tasks are saved in the imports-weekly.opml and exports-weekly.opml. You can configure the day of the week on which weekly tasks are run by setting the value of the system.handlerStartDayOfWeek property in WEB-INF/conf/ekp.properties. The value can be an integer between 1 and 7 inclusive, with 1 denoting Sunday and 7 denoting Saturday. By default, weekly tasks run on Sunday. Weekly tasks run at the same hour of the day as daily tasks. To schedule weekly tasks to run on a Saturday, for example, set the value to 7 (system.handlerstarttime=7).
  • Monthly - monthly tasks are saved in the imports-monthly.opml and exports-monthly.opml. Monthly tasks always run on the first day of the month, at the same hour of the day as daily tasks.
Title Enter a title for the task.
Type Enter the task type. Please see Task Types below for information about the task types supported by the console.
URL

Enter the URL for the source (for import) or destination (for export). The console supports the following URL schemes:

  • File (exported data is written to a file on the local file system)
  • FTP (exported data is uploaded to a file on an FTP server)
  • HTTPS (exported data is submitted using HTTPS POST)

If the URL points to a directory when the file scheme is used, the importer scans the directory for all files that do not have the .imported file name extension. Every matching file will be processed and then the .imported file extension added to the file name. 
Email Enter an email address to which task start and end notifications will be sent.
Encrypt Select the checkbox to encrypt the import or export.
  1. Click Save.

Task Types

The Background Task Console supports the following task types:

  • aiccPackage
  • autoEnrollment
  • certificationCsv
  • completedTrainingRecordsXml
  • courseCsv
  • courses
  • ekpXml
  • examSectionImports
  • examSectionQuestionImports
  • externalTrainingCsv
  • getUsersCsv
  • imsEnterprise
  • jobProfilesCsv
  • mainExamImports
  • modules
  • organizationsCsv
  • programCsv
  • ServiceNowExamDataFeed
  • externalTrainingCsv
  • sfiaImport
  • tncUsersCsv
  • trainingHistory
  • trainingHistoryCsv
  • trainingHistoryXml
  • turboTrainingHistory
  • userMergeXml
  • users200510Xml
  • usersCsv

OPML Background Task Definition Example

<?xml version="1.0" encoding="UTF-8"?>
<opml version="1.0">
  <head/>
  <body>
    <outline type="trainingHistoryCsv" xmlUrl="file:/c:/data/group-enrollment.csv"/>
    <outline type="users200510Xml" xmlUrl="file:/C:/temp/out/users.xml"/>
    <outline type="trainingHistoryXml" xmlUrl="ftp://uname:pwd@ftp.abc.com/data/trainingHistory.xml"/>
    <outline type="csUsersCsv" xmlUrl="https://competencysuite.abc.com/cgi/userimporter.asp"/>
  </body>
</opml>

Are you a PeopleFluent administrator?
Check out our Help Center or Contact Support.

Was this article helpful?

0 out of 0 found this helpful