General stop sales
General Stop Sales
It is an absolute load, so bear in mind these considerations:
If all the data on the file is correct then the existing definition of “General Stop Sales” is removed and file’s data is inserted into the system to define the new “General Stop Sales”.
If there is any problem with the file or its data then the load is cancelled and the existing definition of “General Stop Sales” is not removed.
Each line represents a unique agency and contains all the information (fields) about it.
The first line is not a header line: it contains data directly.
Inside a line fields are separated using the character
#. This character can’t be used inside data because fields would be gathered in a wrong way.
The data of the fields is not encapsulated by
"or any other character: the information must be included directly.
Any blank line will be skipped.
The file and its data have to be encoded using UTF-8. Otherwise there can be stored strange characters.
If a field is mandatory then it has to be present in each line, even if it has no data: its used position cannot be omitted. If mandatory then we have to see if its data is mandatory or not.
If a field is not mandatory but we want to set it then all previous fields must be present: if any previous field is not mandatory and we don’t want to set a value we will have to include it with no value. We need it this way as it is used the field position to map it to the target data.
If a field’s data is not mandatory and we don’t want to set it then we just keep it empty: i.e. …##…
If a field’s data is mandatory then we have to set something (no value is not admitted).
The fields are separated by
#. If a field is a list of values it also has its values separated by
|Field without data||…##…||We have the separator
|Field directly with data and no lists||…#12#…||It is just the value 12.|
|Field with a list of elements||…#AS;XF;TR#…||Its value is a list and its elements are separated with “;” (“AS”, “XF” and “TR”).|
Control lines allow us to determine how the content of the file has to be interpreted.
This type of lines do not contain data, they contain orders for the process and these orders take effect from the control line forward, so control lines should be placed at the begining of the file (and after any header).
Each control operation has to be given on a separate line (one line one control operation).
|@CTRL:separator=||With the control line @CTRL:separator= followed by a character or string it can be defined the fields separator to be used, overwriting the default one or any previous definition. The specified character or string cannot be used inside data because fields would be gathered in a wrong way. Example of line to set
|@CTRL:separatorlist=||With the control line** @CTRL:separatorlist=** followed by a character or string it can be defined the separator to be used with list items, overwriting the default one or any previous definition. The specified character or string cannot be used inside list data because list items would be gathered in a wrong way. Example of line to set
|Position||Mandatory Field||Mandatory Data||Type||Description|
|0||Yes||Yes||enum||Defines the entity of the stop sale. It may be one of the following types:
|1||Yes||Yes||enum||Defines the type of operation that will be done with the blacklist.
|2||Yes||Yes/-||list of strings||List of codes of entities included into the blacklist.
|3||Yes||Yes||enum||Defines if the blacklist is applied over all the agencies or only for a list of agencies.
|4||Yes||Yes/-||list of string||List of agencies for with the blacklist is applied.
marketare in ISO 3166-1 alpha-2 code format (i.e. “ES”, “PT”, “FR”,…).