XML Source Provider

The XML Source feeds data from any XML URL or local file, reading its structure and building a dedicated query and source types to the best of its abilities.

Settings

Setting	Description	Default
Name	The name that will identify this source instance.
Default Cache Time	The default duration in seconds before the cache is renewed, set to 0 to disable caching. This setting can be overriden in each query configuration.	3600

If the source is a remote file, the URL and an optional API key-based authentication are required:

Setting	Description
URL	The feed URL from which to generate the source content.
Requires Authentication	If the URL is protected by authorization.
Authentication	The authentication details to use.

When authentication is present, you can specify its details. Currently, only the API key method is supported, either via a header or a query parameter.

Setting	Description
API Key	The API key to use.
API Key Mode	Where the key is set, in a header or in a query parameter.
Parameter Name	The name of the header or of the query parameter where the API key is set.

If the source is a local file, the file path is required.

Setting	Description
File	The relative or absolute local path to the file to use as source.

Optionally, an XPath filter can be set, which will allow narrowing down your XML file if needed. It's also possible to map some of the result item properties to dedicated types, to make better use of YOOtheme Pro filters, such as dates or numbers.

Setting	Description
XPath Filter	Optional XPath filter, like /jobs/job.
Data Types	Data type mapping for each field.

XML Query

Fetches records from the XML file and resolves to a list of dynamically generated record types based on the feed schema.

Setting	Description	Default	Dynamic
Start	The offset applied to the query.	1	✓
Quantity	The limit applied to the query.	20	✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600