PROCESS PARAMETERS

Process parameters make it possible to provide additional orders and/or relevant information as part of data processing. The various process parameters can be provided as part of the parameters.xml file. This file can be provided together with any type of file format (INSBOU, BMEcat or PAB) as part of the data set (ZIP or 7-ZIP file).

Potential parameters

Element Value assigned Description
PackageDescription Text. Maximum 255 characters The field "PackageDescription" offers the option of providing a specific description for a data provision. This text is shown in the processing report. The following could be a potential value: "Data provision Q3". This parameter has no effect on the data processing.
PublishMethod “ManualAcceptStagingData”; “AutoAcceptStagingData”
Standard: ManualAcceptStagingData

To simplify provision, there is the option of Automatic Publication to the 2BA Master environment. The publication methods currently supported are:

- “manualAcceptStagingData”
This is the standard method that ensures processing, first to the staging environment and subsequently awaits your approval or rejection. This method is particularly recommended the first few times in order to remove all faults from the provision process before the data provided can be published.

- “AutoAcceptStagingData”
The Auto Accept processing method offers the option of automatically uploading the processing to the master environment. The field "ErrorThresholdPercentage" may be used in order to define a number of conditions for approval. If no value is chosen for this field, approval will take place automatically via the "manualAcceptStagingData" method.
SendReportToEmail Text. Maximum 255 characters. According to the format of an e-mail address.

The e-mail address to which the processing report is to be sent. If this field is empty, the e-mail address of the data supplier will be used. Pay attention! If this parameter is specified, the report will not be sent to the email address of the account that delivers the dataset! It is possible to provide several e-mail addresses by separating various e-mail addresses with a semi-colon (;).

Sample value: mijzelf@mijnbedrijf.nl;mijncollega@mijnbedrijf.nl
ReportLanguage

EN; NL

Default value: NL		 It is possible to provide the error messages in the processing report in another language. If there is not translation for a specific error report, the standard message will be used, which will usually be in Dutch. For the moment, only the Dutch and English translations are available.
SkipLoadProducts true; false
Default value: false		 For some formats, including BMEcat 1.2, articles and products are loaded at the same time. Product loading can be excluded by setting this option to "True".
SkipLoadArticlesAndPrices true; false
Default value: false		 As SkipLoadProducts, now only valid for articles and price information.
SkipLoadPrices true; false
Default value: false		 As SkipLoadProducts, now only valid for skipping only the price information.
SkipLoadAttachments true; false If SkipLoadAttachments=true, the attachments/amendments provided will not be read.
GeneratedBy Text, maximum 255 characters This parameter can be used to indicate with which software package the dataset has been provided. This parameter has no effect on the data processing.
OverrulePackageMutationCode true; false
Default value: false		 The PackageMutationCode parameter can be set to True to overwrite the standard method used for a specific format. The BMEcat format has been designed for complete data provision. It may happen, though, that this file needs to be processed as a mutated provision. In this case the file can still be processed as a mutation by using this parameter in combination with the PackageMutationCode parameter.
PackageMutationCode

“ReplaceExistingCatalog”; “UpdateExistingCatalog”

Default value: ReplaceExistingCatalog

The PackageMutationCode can be used to indicate whether the dataset should be processed completely or as a mutation. This parameter only applies if the OverrulPackageMutationCode is set to True.

- "ReplaceExistingCatalog”; the data set will be processed completely
- "UpdateExistingCatalog"; the data set will be processed as a mutation
ReportAllCheckDetailMessages true; false
Default value: false		 The default processing report displays the first 250 messages per review. The "True" value displays all the messages of one review. It must be mentioned in this regard that the list of review details may be extensive. This may mean that it takes longer to go through the error details than expected. 2BA advises only to make occasional use of this option.
AutoConvertToMasterGLN true; false
Default value: false		  

 

Examples
Please note: the file name of the parameter file is parameters.xml (download an example). The elements are case-sensitive.

Example - Automatic uploading
The example below will ensure automatic uploading of the data via the "PublishMethod" parameter. In addition to this parameter, there is also a description and an e-mail address to which the processing report will be sent.

1
2
3
4
5
 
  Test data van MijnBedrijf B.V.
  AutoAcceptStagingData
  mijzelf@mijnbedrijf.nl
 

Example - show all detailed messages
The example below gives a description of the provision and will indicate all detailed messages during reviews. Please note: listing all detailed messages may result in a very long report that is difficult to open.

1
2
3
4
 
  Test data van MijnBedrijf B.V.
  true
 

Example - remove all attachments
The example below will remove all attachments.

1
2
3
4
5
 
  Aanlevering attachments compleet
  true
  ReplaceExistingCatalog
 

 

Cookie statement