Structure of preset.xml file

Technical Specification
Language used in this document: English (en-US)

The preset.xml file has been developed for the needs of applications handling offers in the IOF for Shops format. It contains multiple supplier settings, that can be read by application with every offer import and synchronization.

This option is particularly helpful, when import configurations plays a very important role and the entity – which wants to use the IOF for Shops – wants to gain a ready-to-use offer from supplier. Provided preset.xml file – with a set of settings uploaded directly to application – allows for service-free offer of import.

Notice:

IAI Downloader fully supports preset.xml file. It can of course generate preset.xml file with import settings and download import settings from provided preset.xml file.

Explanations to specific tags can be found below. They allow to properly configure IOF for Shops files for
applications handling offers, i.e. IAI Downloader:

  • long_name, short_name, showcase_image, description, email, tel, fax, www, address_street, address_zipcode, address_city, address_country, currency, offerCreated, offerExpires – supplier data, which will be displayed in application,
  • url, full, light, categories, sizes, producers, units, parameters, series, traits, warranties, stocks – URLs to specific offer files,
  • categories_auto_mapping, sizes_auto_mapping, series_auto_mapping, units_auto_mapping – can contain True or False values, that are responsible for turning on/off an automatic elements mapping/assignment,
  • selected – can contain True or False values, that are responsible for selecting/deselecting supplier offer to be synchronized on the application list,
  • remote_gateway – contains True or False values that are responsible for the gateway.xml file is/is not present on the computer local hard drive,
  • fully_configured – contains True or False values, that are responsible for full configuration of offer and its readiness to be synchronized,
  • external_program – contains True or False values, that are responsible for the offer source (application plugin),
  • external_program_xml_path – URL to the gateway.xml file, generated by the application plugin,
  • size_code_prefix – prefix added to external system codes,
  • old_size_code_prefix – obsolete and unused element,
  • iai_shop_deliverer_id – supplier ID, to which products from offer should be assigned,
  • plugin_id – plugin ID,
  • size_code_auto – contains True or False values, that are responsible for turning on/off an option of automatic building external system codes from prefix and product/size@id XML node,
  • size_code_code_size - contains True or False values, that are responsible for turning on/off an option of downloading external system codes from product/size@code XML node,
  • update_name, update_short_description, update_long_description, ... - contains 1 or 0 values, that are responsible for turning on/off update of selected attribute during synchronization process,
  • updateExtSysCodePending – outdated and unused element,
  • debug_product_import - contains True or False values, that are responsible for turning on/off option of confirming each import of a new product (debug mode),
  • debug_product_update - contains True or False values, that are responsible for turning on/off option of confirming each update of product in system,
  • debug_product_always_import - contains True or False, that are responsible for importing/not importing each new product from offer to system,
  • debug_product_always_update - contains True or False, that are responsible for updating/not updating each product in the system to find out if they have changed,
  • products_allowed_operations – contains application rights to perform changes in the system:
    • all – application can edit synchronized products and nullify stock quantities in the system,
    • edit – application can edit synchronized products – perform changes in the system,
    • reset – application can nullify stock quantities of synchronized products in the system,
  • version_mode – contains values for grouped products import mode:
    • 1 – import products groups in accordance to supplier offer,
    • 0 – import only first products from groups,
    • 2 – import all products from groups as separate products,
  • gatewayGeneratedOn – date and hour data of gateway.xml file generation,
  • full_lastModified, light_lastModified, categories_lastModified, ... - date and hour of last modification of selected file,
  • providerImageLastModified – date and hour of last modification of (<showcase_image>) supplier picture,
  • imageHash – hash for (<showcase_image>) supplier picture,
  • full_xml_generated, light_xml_generated, categories_xml_generated, ... - date and hour of selected file generation,
  • clonedProductsMode – outdated and unused element,
  • overwrite_products – contains True or False values and determines if all pictures and descriptions should be overwritten during the next synchronization process,
  • SRP_price - contains 1 or 0 values, that are responsible for turning on/off downloading information on SRP from supplier option.
  • STP_price - contains 1 or 0 values, that are responsible for turning on/off downloading information on STP from supplier option.
  • offer_from_bridge – contains 1 or 0 values and determines if an offer is generated by IAI Bridge program.
  • culture_info – contains information about applied format for numbers and dates.

XML Example plik preset (XML) file

<?xml version="1.0" encoding="utf-8"?>
<preset file_format="IOF" version="3.0" generated="2018-04-12 12:00:00">
    <long_name>example</long_name>
    <short_name>example offer</short_name>
    <showcase_image_url>http://link_to_company_logo.jpg</showcase_image_url>
    <description>example description</description>
    <email>support@superstore.com</email>
    <tel>+48 91 000 000</tel>
    <fax>+48 91 000 001</fax>
    <www>www.iai-shop.com</www>
    <address_street>Madaliń skiego 8</address_street>
    <address_zipcode>76-234</address_zipcode>
    <address_city>Szczecin</address_city>
    <address_country>Poland</address_country>
    <currency>PLN</currency>
    <url>path_or_link_to_gateway.xml_file</url>
    <full>path_or_link_to_full.xml_file</full>
    <light>path_or_link_to_light.xml_file</light>
    <categories>path_or_link_to_categories.xml_file</categories>
    <sizes>path_or_link_to_sizes.xml_file</sizes>
    <categories_auto_mapping>true</categories_auto_mapping>
    <selected>false</selected>
    <remote_gateway></remote_gateway>
    <fully_configured>true</fully_configured>
    <external_program>true</external_program>
    <external_program_xml_path>path_to_external_offer_file</external_program_xml_path>
    <producers>path_to_producers.xml_file</producers>
    <units>path_or_link_to_units.xml_file</units>
    <parameters>path_or_link_to_parameters.xml_file</parameters>
    <stocks>path_or_link_to_stocks.xml_file</stocks>
    <series>path_or_link_to_series.xml_file</series>
    <sizes_auto_mapping>true</sizes_auto_mapping>
    <units_auto_mapping>true</units_auto_mapping>
    <size_code_prefix>example-</size_code_prefix>
    <old_size_code_prefix>previous-</old_size_code_prefix>
    <size_code_auto>true</size_code_auto>
    <size_code_code_size>false</size_code_code_size>
    <update_name>1</update_name>
    <update_short_description>1</update_short_description>
    <update_long_description>1</update_long_description>
    <update_version_name>1</update_version_name>
    <update_series>1</update_series>
    <update_producer>1</update_producer>
    <update_category>1</update_category>
    <update_unit>1</update_unit>
    <update_price>1</update_price>
    <update_icon>1</update_icon>
    <update_images>1</update_images>
    <update_quantities>1</update_quantities>
    <products_allowed_operations>all,edit,reset</products_allowed_operations>
    <update_code_producer>1</update_code_producer>
    <update_deliverer>1</update_deliverer>
    <version_mode>1</version_mode>
    <debug_product_import>true</debug_product_import>
    <debug_product_update>true</debug_product_update>
    <debug_product_always_import>false</debug_product_always_import>
    <debug_product_always_update>false</debug_product_always_update>
    <gatewayGeneratedOn>2018-04-12T12:00:00</gatewayGeneratedOn>
    <full_lastModified></full_lastModified>
    <light_lastModified></light_lastModified>
    <categories_lastModified></categories_lastModified>
    <sizes_lastModified></sizes_lastModified>
    <producers_lastModified></producers_lastModified>
    <units_lastModified></units_lastModified>
    <series_lastModified></series_lastModified>
    <warranties_lastModified></warranties_lastModified>
    <providerImageLastModified></providerImageLastModified>
    <imageHash></imageHash>
    <offerCreated>2018-04-12T12:00:00</offerCreated>
    <offerExpires>2018-04-12T12:00:00</offerExpires>
    <warranties>path_or_link_to_warraties.xml_file</warranties>
    <clonedProductsMode>0</clonedProductsMode>
    <overwrite_products>false</overwrite_products>
    <update_weight>1</update_weight>
    <update_visibility>1</update_visibility>
    <SRP_price>0</SRP_price>
    <STP_price>0</STP_price>
    <offer_from_bridge>0</offer_from_bridge>
    <update_size>1</update_size>
    <culture_info>pl-PL</culture_info>
</preset>

XML Schema Validator: plik preset (XSD) file