Briefing information can be exported to XML-files that contains data from Briefings, Products, Products on Briefing and Prices module. Different Scheduler’s Export Jobs can be used for this purpose depending on specific client’s system.
4.9.1. Custom Export Retail Job
There are 2 Export Retail Jobs, aimed for different ERP-systems.
NavisionExportRetailJob
ElbonetExportRetailJob
These Jobs export briefing & products inside data in .xml named due to Abbreviation in Chains module. Job exports only those briefing that have Field with Export to Financial System field with date that is earlier than current date or equal to it. After briefing has been exported Field with Export to Financial System is set to NULL.
Location: System Configuration > System Status > Scheduler > Scheduler. Properties
Table below describes parameters of Navision Export Retail Job (Elbonet Export Retail Job can be configured in similar way):
Parameter | Description |
|---|---|
joblist=NavisionExportRetailJob | Specify scheduler to run Navision Export Retail Job |
job.NavisionExportRetailJob.type= enCode.app.common.briefing.jobs.ElbonetExportRetailJob | Specify class of the job |
job.NavisionExportRetailJob.startimes=11:32 | Time from 00:00-23:59 when the job starts. Job is performed on daily basis. Comma separated list (spaces not allowed) |
job.NavisionExportRetailJob.param.dropdir= ../Files/customer/inbox | Path to folder with XML and navik files that will be exported |
job.NavisionExportRetailJob.param.SenderEmail= some@email.domain | After exporting XML-file, notification letter will be sent from this address |
job.NavisionExportRetailJob.param.RecipientEmail= somemail@encode.dk | After exporting XML-file, notification letter will be sent to this address |
job.NavisionExportRetailJob.param.EmailSubject=Transfer file from Briefing system to Navision | Subject of the sent E-mail after job has been finished |
job.NavisionExportRetailJob.param.EmailBody=The briefing system has generated a transfer file to Navision. The file name is "n | Body of the sent E-mail after job has been finished |
job.NavisionExportRetailJob.param.SiteID=1 | Id of the site for which NavisionExportRetailJob will be performed |
job.NavisionExportRetailJob.param.StartRetailFieldDefinitionId=10 | Id of the field mapped in the Briefing module as Field with briefing period purchase start |
job.NavisionExportRetailJob.param.StopRetailFieldDefinitionId=11 | Id of the field mapped in the Briefing module as Field with briefing period purchase end |
The following fields must be mapped to execute this job:
Module | Fields |
Briefing |
|
Chains |
|
Prices |
|
Products on Briefing |
|
Suppliers |
|
Products |
|
4.9.2. ERP Export Job
ERP Export Job exports two files: xml and navik that contain necessary information for External Financial System. The job runs once a day and the navik file and one or more xml files are created if one or more campaigns have the current date (or a date in the past) in the Field with Export to Financial System date field.
Location: System Configuration > System Status > Scheduler > Scheduler.Properties
Table below describes parameters of ERP Export Job:
Parameter | Description |
|---|---|
joblist=ERPExportJob | Specify scheduler to run ERP Export Job |
job.ERPExportJob.type= enCode.app.common.briefing.jobs.ERPExportJob | Specify class of the job |
job.ERPExportJob.startimes=5:00 | Time from 00:00-23:59 when the job starts. Job is performed on daily basis Comma separated list (spaces not allowed) |
job.ERPExportJob.param.dropdir= ../Files/customer/inbox | Path to folder with XML and navik files that will be exported |
job.ERPExportJob.param.SenderEmail=some@email.domain | After xml and navik files were exported, letter will be sent from this address |
job.ERPExportJob.param.RecipientEmail= somemail@encode.dk | After xml and navik files were exported, letter will be sent to this address |
job.ERPExportJob.param.EmailSubject=Transfer file from Briefing system to Navision | Subject of the sent E-mail after job has been finished |
job.ERPExportJob.param.EmailBody | Body of the sent E-mail after job has been finished |
job.ERPExportJob.param.SiteID=1 | Id of the site for which ERPExportJob will be performed |
The following fields must be mapped to execute this job:
Module | Fields |
Briefing |
|
Chains |
|
Prices |
|
Products on Briefing |
|
Suppliers |
|
Products |
|
4.9.3. Statistical Data Export Job (DW export)
DW export is a scheduler job that creates fixed format files to be used in client’s Data Warehouse and places them in a local folder.
Only briefings matching the following criteria are exported:
"Ja" value set in the field mapped as DataWarehouse Export Field
Today ("current midnight — 12h") or any future date value is set in the field mapped as Field with briefing period purchase end field
Two different files are created:
dwkamh (data warehouse campaign headers), data from the briefing module
dwkaml (data warehouse campaign lines), data from the promotions
File names are not unique and are therefore overwritten.
Location: System Configuration > System Status > Scheduler > Scheduler.Properties
Table below describes parameters of Statistical Data Export Job:
Parameter | Description |
|---|---|
joblist=StatisticalDataExport | Specify scheduler to run Statistical Data Export Job |
job.StatisticalDataExport.type= enCode.app.common.briefing.jobs.StatisticalDataExportJob | Specify class of the job |
job.StatisticalDataExport.startimes=5:00 | Time from 00:00-23:59 when the job starts. Job is performed on daily basis Comma separated list (spaces not allowed) |
job.StatisticalDataExport.param.dropdir= ../Files/customer/outbox | Path to folder with XML-files that will be exported |
job.StatisticalDataExport.param.SenderEmail= some@email.domain | After XML-files were exported, letter will be sent from this address |
job.StatisticalDataExport.param.RecipientEmail= somemail@encode.dk | After XML-files files were exported, letter will be sent to this address |
job.StatisticalDataExport.param.SiteID=1 | Id of the site for which this job will be performed |
job.StatisticalDataExport.param.includeAll=false | Include inactive briefings, default value is true |
4.9.4. ECommerce Campaign XML Export Job (former Elbonet Export)
Job exports Briefings' data from briefings with 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".
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.ECommerceCampaignXMLExportJob | Specify class of the job |
job.ECommerceCampaignXMLExport.startimes=17:25 | Time from 00:00-23:59 when the job starts. Job is performed on daily basis. If parameter is not specified, the job will immediately run only once and stop |
job.ECommerceCampaignXMLExport.param.dropdir=/data/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. Depending on the singleFile parameter, will be replaced either with a timestamp or field value (see below for more details). |
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 starting from 9.102.0 and later: SFTP-server address to sent generated XML-files |
job.ECommerceCampaignXMLExport.param.hostname=ftp://some.ftp.url.address | Parameter for versions starting from 9.102.0 and later: 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 | ID of the option field in the "Briefing" module. Used for filtering |
job.ECommerceCampaignXMLExport.param.filterByValues=05 Food Prod, 10 Veg Prod | Values of the field specified in filterByField parameter. Only briefings with these values will be exported |
job.ECommerceCampaignXMLExport.param.filterByFieldInProductHeadline=4
| Parameter for versions starting from 9.102.0 and later: ID of the option field in the "Product on Briefing" module. Used for filtering. |
job.ECommerceCampaignXMLExport.param.filterByValuesInProductHeadline= optionId_1, optionId_2 | Parameter for versions starting from 9.102.0 and later: IDs of the options (or linked items in case of module link field) of the field specified in filterByFieldInProductHeadline parameter. Only products with these options set will be exported. |
job.ElbonetExportRetailJob.param.StartEcommerceFieldDefinitionId=1345 job.ElbonetExportRetailJob.param.EndEcommerceFieldDefinitionId=1356 | Fields are used to filter the briefings export according the date range in this fields. If the current date matches the period, the briefing will be exported |
Example
joblist=ECommerceCampaignXMLExport job.ECommerceCampaignXMLExport.type=enCode.app.common.briefing.jobs.ECommerceCampaignXMLExportJob job.ECommerceCampaignXMLExport.startimes=15:20 job.ECommerceCampaignXMLExport.param.dropdir=/data/Files/briefingExport job.ECommerceCampaignXMLExport.param.SiteID=4 job.ECommerceCampaignXMLExport.param.RecipientEmail=abn@encode.dk job.ECommerceCampaignXMLExport.param.SenderEmail=blane@encode.dk job.ECommerceCampaignXMLExport.param.EmailSubject=Overførselsfil fra MS til Elbonet job.ECommerceCampaignXMLExport.param.EmailBodyTemplate=The Briefing system has generated a transfer file %s to the ERP system. job.ECommerceCampaignXMLExport.param.TargetFileName=Elbokam_%s.xml job.ECommerceCampaignXMLExport.param.TargetFileNameParameterField=74 job.ECommerceCampaignXMLExport.param.hostname=sftp://newpanda.encode.dk job.ECommerceCampaignXMLExport.param.remotedir=sftpData/briefingExport job.ECommerceCampaignXMLExport.param.login= job.ECommerceCampaignXMLExport.param.password= job.ECommerceCampaignXMLExport.param.singleFile=false job.ECommerceCampaignXMLExport.param.exportMark=Yes job.ECommerceCampaignXMLExport.param.filterByField=76 job.ECommerceCampaignXMLExport.param.filterByValues=A-Posters, DK Annonce job.ECommerceCampaignXMLExport.param.filterByFieldInProductHeadline=223 job.ECommerceCampaignXMLExport.param.filterByValuesInProductHeadline=140,141 job.ECommerceCampaignXMLExport.param.StartEcommerceFieldDefinitionId=8511 job.ECommerceCampaignXMLExport.param.EndEcommerceFieldDefinitionId=8512
Note!
%sis required property.For versions starting from 9.102 and later:
If singleFile parameter is set to true,
%swill be replaced with a timestamp.If singleFile parameter is set to false, the TargetFileNameParameterField parameter is required and
%swill 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.