Job exports Briefings' data from briefings with the current date between Briefing period purchase start and Briefing period purchase end dates for which field mapped as Intranet Export Field (Field for export) is set to "Yes".
Next Fields are required and need to be mapped in Briefing System Module's Configuration:
The following additional fields must be mapped to execute this job:
Module | Fields |
|---|---|
Briefing |
|
Prices |
|
Products on Briefing |
|
Location: System Configuration > System Status > Scheduler > Scheduler.Properties
Table below describes parameters of ECommerce Campaign XML Export Job:
Parameter | Description |
|---|---|
joblist=ECommerceCampaignXMLExport | Specify scheduler to run ECommerce Campaign XML Export Job |
job.ECommerceCampaignXMLExport.type=enCode.app.common.briefing.jobs.ElbonetExportRetailJob job.ECommerceCampaignXMLExport.type=enCode.app.common.briefing.jobs.ECommerceCampaignXMLExportJob | Specify class of the job |
job.ECommerceCampaignXMLExport.startimes=17:25,19:30 | Time from 00:00-23:59 when the job starts. Job is performed on daily basis. Comma separated list (spaces not allowed) |
job.ECommerceCampaignXMLExport.param.dropdir=../Files/customer/outbox | Path to folder with XML-file that will be exported |
job.ECommerceCampaignXMLExport.param.TargetFileName=Elbokam%s.xml | Name of XML-file. %s is required property |
job.ECommerceCampaignXMLExport.param.TargetFileNameParameterField | Starting from version 9.102.0. Value of the field will be used in file name. This parameter is required and works when singleFile parameter is set to false.
If property is not present or singleFile = true, %s will be replaces with a timestamp. |
job.ECommerceCampaignXMLExport.param.SenderEmail=some@email.domain | After exporting XML-file, notification letter will be sent from this address |
job.ECommerceCampaignXMLExport.param.RecipientEmail=somemail@encode.dk | After exporting XML-file, notification letter will be sent to this address |
job.ECommerceCampaignXMLExport.param.EmailSubject=Transfer file from Briefing system to Navision | Subject of the sent E-mail after job has been finished |
job.ECommerceCampaignXMLExport.param.EmailBody=The Briefing system has generated a transfer file to the ERP system | Body of the sent E-mail after job has been finished |
job.ECommerceCampaignXMLExport.param.SiteID=1 | Id of the site for which ECommerce Campaign XML Export Job will be performed |
job.ECommerceCampaignXMLExport.param.hostname=some.ftp.url.address | Parameter for versions before 9.102.0 FTP-server address to sent generated XML-files |
job.ECommerceCampaignXMLExport.param.hostname= sftp://some.ftp.url.address | Parameter for versions after 9.102.0 SFTP-server address to sent generated XML-files |
job.ECommerceCampaignXMLExport.param.hostname= ftp://some.ftp.url.address | Parameter for versions after 9.102.0 FTP-server address to sent generated XML-files |
job.ECommerceCampaignXMLExport.param.remotedir=XMedia_EL | Remote directory on FTP-server |
job.ECommerceCampaignXMLExport.param.login=FTP_XMedia_EL | User login |
job.ECommerceCampaignXMLExport.param.password=1234 | User password |
job.ECommerceCampaignXMLExport.param.singleFile=true | Defines whether campaigns will be exported in single file or not |
job.ECommerceCampaignXMLExport.param.exportMark=Yes | Briefings can be exported due to such filters: Filter by value from Intranet Export Field |
job.ECommerceCampaignXMLExport.param.filterByField=83 | Filter by Field |
job.ECommerceCampaignXMLExport.param.filterByValues=05 Food Prod, 10 Veg Prod | Filter by Field Values |
job.ECommerceCampaignXMLExport.param.filterByFieldInProductHeadline=4 | Parameter for versions starting from 9.102.0 and later: Filter by Field in Headlines module |
job.ECommerceCampaignXMLExport.param.filterByValuesInProductHeadline= includeValue_1, includeValue_2 | Parameter for versions starting from 9.102.0 and later: Filter by Field Values of the filterByFieldInProductHeadline field in Headlines module. |
Note!
%sis required property in Scheduler.properties. For versions starting from 9.102 and later:
If singleFile parameter is set to true, %s will be replaced with a timestamp.
If singleFile parameter is set to false, the TargetFileNameParameterField parameter is required and %s will be replaced with the value of the field definition id.
For versions before 9.102:
job.ECommerceCampaignXMLExport.param.hostname=some.ftp.url.addressparameter should not contain connection protocol (like//), just IP address
job.ECommerceCampaignXMLExport.param.exportMark=Yesparameter should contain value of Intranet Export Field (Field for export) in Briefing moduleFor versions before 9.102:
Filter by Field and FieldValues is applicable only for Briefing module.
For versions starting from 9.102 and later:
Filter by Field and FieldValues is applicable for Briefing and Product on Briefing modules.
Setting singleFile property to false = will generate new XML for each briefing
Max length of resulted filename is 255 chars (max allowed in linux, MacOS, Windows). Means, f.e. Incito_WHAT_EVER_STRING.xml, cannot be longer then 255. If it is longer, webapp will fail to export this file and will log reason for that.
Limitation
In cases when the naming value has been edited in the Briefing page - after the scheduled job is done the corresponding name of the exported file will not be updated. A new file with the updated name will be exported. And both files will be present in the export folder.