Briefing Import Job

  • Updated on Sep 16, 2025
  • Published on Feb 6, 2025
  • 1 minute(s) read
  • DL
  • Migration Team
  • I
 Prev Next

Overview

The Briefing Import Job imports briefing and product data from XML files (e.g., exported from external ERP systems) and creates corresponding briefings, pages, headlines, products, and pricing data in Encodify.

Before scheduling the job, Briefing Import must be configured in the system to ensure proper mapping of XML root elements and fields.

Briefing Import Settings

To configure Briefing Import, follow these steps:

  1. Navigate to Site Configuration → Briefing System Module → Import Configuration

  2. Open the Edit Import Configuration window and upload an XML template for import.

    • Note: The XML used for import can also serve as a template.

  3. Map root elements of the XML.

  4. Map fields to the corresponding module fields.

  5. If pages have no page number tag, use the position() XPath function on the pages’ node to maintain the correct order.

  6. Click OK to save the configuration.

Template download (Release 15.0.0+):

  • XML template files can be downloaded from Briefing System Module → Import Configuration by clicking the file name.

How it works

The Briefing Import Job works as below:

  • The job monitors the configured drop folder for new XML files.

  • Each file is processed to create or update briefings, pages, headlines, products, and pricing data according to the mapping in the Briefing Import settings.

  • Successfully imported files are moved to the backup folder, while failed files are moved to the error folder.

  • System logs are written to the configured log folder.

Parameters

The table below provides an overview of parameters supported for the Briefing Import Job

Parameter

Description

joblist=xmlImport

Name of the scheduler job.

job.xmlImport.type

Class that performs the job: enCode.app.common.briefing.xmlDataImport.XMLDataImportJob.

job.xmlImport.interval

Interval in seconds for periodic execution.

job.xmlImport.param.dropdir

Folder containing XML files to import.

job.xmlImport.param.backupdir

Folder for successfully imported XML files.

job.xmlImport.param.errordir

Folder for failed XML files.

job.xmlImport.param.logdir

Folder for system logs.

job.xmlImport.param.headlineDepartmentId

Department responsible for imported headlines.

job.xmlImport.param.SiteID

Site ID for which the job will be performed.

Note:

  • Ensure all IDs and directories exist and are correctly configured to avoid job failures.

Example Configuration

The below is an example of the Briefing Import Job

joblist=xmlImport
job.xmlImport.type=enCode.app.common.briefing.xmlDataImport.XMLDataImportJob
job.xmlImport.interval=90
job.xmlImport.param.dropdir=../Files/SAP/campaign
job.xmlImport.param.backupdir=../Files/SAP/campaign/backup
job.xmlImport.param.errordir=../Files/SAP/campaign/error
job.xmlImport.param.logdir=../Files/SAP/response
job.xmlImport.param.headlineDepartmentId=4
job.xmlImport.param.SiteID=1

Explanation:

  • Imports XML files from an external ERP system every 90 seconds.

  • Successfully processed files are moved to the backup folder; failed files are moved to the error folder.

  • Headlines are assigned to department with ID=4.

Related articles