Import-pipeline table provider for products, inserting, updating, upserting and soft-deleting Product rows as an import pipeline runs. A product can be linked to a single category (see CategoryTableProvider for setting up categories), given parameters and options via ProductOptionsTable, and added to reward stores via ProductInRewardTableProvider. Registered under the provider id "products". Supported fields include name, title, notes, status, baseCost, freightCost, rrp, category, supplier and photoURI, the last of which is downloaded and attached to the product as an image. A product-updated or product-deleted event is fired via ProductsApp after each change.
Implements: DatabaseTableProvider
Properties
| Property | Returns | Description |
|---|---|---|
| providerId | String | Provider id this class is registered under. Used to select it from a DatabaseUpdateStep or DatabaseSourceStep configuration. |
| queryParameters | List<TableParameter> | Query parameters this provider accepts when building its source criteria. |
| tableFields | List<TableParameter> | Describes the row columns this provider accepts for insert, update and updateOrInsert: name, title, notes, status, baseCost, freightCost, rrp, category (the single category to assign the product to), supplier (an organisation, resolved as an org id string, OrgData or Organisation) and photoURI (a URL the product photo is downloaded from). |
Methods
getProviderId()
Returns: String
Provider id this class is registered under. Used to select it from a DatabaseUpdateStep or DatabaseSourceStep configuration.
getQueryParameters()
Returns: List<TableParameter>
Query parameters this provider accepts when building its source criteria.
getTableFields()
Returns: List<TableParameter>
Describes the row columns this provider accepts for insert, update and updateOrInsert: name, title, notes, status, baseCost, freightCost, rrp, category (the single category to assign the product to), supplier (an organisation, resolved as an org id string, OrgData or Organisation) and photoURI (a URL the product photo is downloaded from).