Follow

AnyFeed PRO - Getting Started

Contents:

  1. Fields:
  2. Field Settings:
  3. Shops:
  4. Cache:
  5. Saving: 

Overview:

The Any Feed PRO module allows you to create feeds for your 3rd party requirements. Or if you just need to edit some data and then re-import it.

Getting started with the Any Feed PRO module is very easy.

First install the module using the instructions in the README file. Once completed you can find the module under Extensions -> Products Feeds -> Any Feed PRO .

Once inside the first thing you want to do is create a new feed:

You can then select a name for the feed. There is also a list of "Profiles" which are pre-defined settings which make it easier to get your feeds up and running instantly for some suppliers, such as Google Shopping or Shopzilla.

 

Fields:

Once completed your new feed is added to the page. You can now drag the fields you want included in the feed from the top fields area into your feed. Any field included in the feed, will be exported in the chosen feed.

Make sure to save your feed after making changes!

Once fields have been added they appear in the list.

You can also decide the name of the field, by providing this in the fields list:

The Field Name will be used for the Column header for CSV files, or the XML Tag for XML files.

 

Custom Name Mapping:

This feature allows you to customize how your categories, options or attributes will be exported.

With Categories, Options, and Attributes you are able to select the 'Custom' Option name. When you fill in the 'New Name' field and then click Export. Any Feed PRO will export the custom mapped field with the New Name. 

e.g if your category name is 'Sweaters' you can export this as 'Jumpers'.

 

 Rules:

Rules are used to make changes to the feed dynamically while its being exported. Say for example you wanted to only export your cheap products. You will be able to use our Rules section to acheive this.

e.g. To export only your cheaper products you could use the rules section on the Price field like so:

if Price 'is then than' [ 10 ] 'then Skip this product'. This will skip all products with a price greater than 10.

 

If you add more than one rule to a field, the rules will run in order from top to bottom, with the result of the previous rule being passed to the next one.

e.g If you apply a rule which adds "100" to a field, and another rule that skips products which have a value greater than "100", then all the products would be skipped.

 

Field Settings:

Feed Status:

This setting controls whether your feed is accessible. Feeds can only be downloaded/viewed if the Feed Status is enabled. If you want to temporarily disable a feed then you set the Feed Status to disabled.

If you don't want to Feed to exported again ever then you can permanently disable the feed by deleting it.

Feed Type:

You can export your feed as either a CSV or an XML file.

 

XML Feed Type: Cdata

When CData is turned on all fields will be enclosed in CData tags. This is useful if your product descriptions or names have characters in them which are invalid in XML. When you turn CData on it will allow AnyFeed PRO to be able to process this invalid XML. If you still having trouble figuring out if you need CData switched on have a look at this: (Helpdesk) - Acceptable XML

XML Feed Type: Root Tag

The root tag is used to specify what the root tag of you XML is. The root tag is the first line that is shown in your XML document when you open it. It will show something like this:

<my_product_list>

    <product>

        <name>Test1</name>

    </product>

    <product>

        <name>Test2</name>

    </product>

    ...

</my_product_list>

In this XML example the root tag is "<my_product_list>".

(You do not need to include the "<" or ">" symbols in your root tag, these will be automatically added during the export.)

CSV Feed Type: Delimiter

The CSV delimiter is what 'separates' the columns in your CSV file. 

CSV Feed Type: Filename

The filename you specify here will be the filename Any Feed PRO will export the feed to. 

Currencies:

This is the currency that pricing fields will be exported as. If you choose a currency that is different than your default currency then the pricing will be converted using your OpenCarts currency settings.

To see what currencies are installed on your OpenCart installation you can check System > Localization > Currencies 

Language:

The language setting is used to when exporting multi-language fields, such as your Product Name or Product Description. If you have multiple languages set up in your store then you can use this setting to choose which language will be exported.

To see what languages are installed on your OpenCart installation you can check System > Localization > Languages 

Shops:

The shop setting is used when you want to export this feed for this particular shop. If both are selected Any Feed PRO will try to export this feed for both shops. 

When one shop is selected, only products which belong to that shop will be exported.

Cache

The Cache is useful for stores with a large amount of products. If you have a lot of products then it can increase the time it takes to export your feed. 

How does the cache work?

When the Cache is enabled, any time that someone tries to download your feed, Any Feed PRO will check to see if there is a cached version of the Feed already saved which was created earlier than the Cache timeout value. If it does find a cached feed then it will send this file to the person requesting the feed instead of generating a new one.

Cache - Timeout:

The Cache Timeout determines the maximum age a cached feed can be before a new feed has to be generated.

When deciding your Cache Timeout value you need to find the right balance which works for you.

If you set the timeout too low then new feeds will need to be generated often, which may defeat the purpose of using the Cache.

If you set the timeout too high then the information in your feed could become out of date. If your feeds are only generated once an hour then any changes to products would not be reflected until the next time a feed is created. 

Cache - Cron Command:

Now that you've got a good understanding of how the Cache works, we can combine this feature with Cron Export and have a powerful exporting tool even for very large stores.

When you run the Cron Command from the commandline of your server (SSH) or from a Cron Task, a cached feed will be generated for the profile you specified.

Cron Tasks avoid timeout problems which typically happen when you try to export a large feed from the browser. This is the key for why Cron Exports work so well with the Cache feature.

Example:

Set your Cron Timeout to 16 mins.

Create a Cron Job to export a cached feed every 15 minutes.

Now a fresh cached version of your feed will be generated automatically every 15 minutes which will be cached and served quickly to anyone trying to access your feed.

We set the Cron Timeout to 16 mins instead of 15 which allows the Cron Job some time to actually complete the export. It also means that if there is some problem with the Cron Job, then the customer will be able to generate a new feed anyway if 16 minutes pass without a refresh.

Saving:

Once you are done, don't forget to save as the feed will not be available until it has been saved.

 

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk