Configuration¶
When a retailer has received credentials from Apptus and successfully installed the Apptus eSales for Shopware plugin it must be configured before use.
Plugin settings¶
The following plugin settings are available.
| Setting | Description | Recommendation |
|---|---|---|
| Apptus enabled | If the Apptus for Shopware plugin should be enabled for the specific shop. | Yes |
| Private key | The eSales private API key for the cluster. The private key is provided by Apptus. | N/A |
| Cluster ID | The eSales WebAPI ID. The cluster ID is provided by Apptus. | N/A |
| API user | The connector user name. The user name is provided by Apptus. | N/A |
| API Password | The connector password. The password is provided by Apptus. | N/A |
| Last incremental export | The time of the last incremental export to Apptus eSales. | N/A |
| Incremental export-interval in seconds | The time between automated incremental exports to eSales. | N/A |
| Full export-interval in seconds | The time between automated full exports to eSales. | N/A |
| Number of products per export file | Products in each export file generated by Shopware. | 1000 |
| Clear categories and products before full import | If categories and products shall be cleared in eSales before import. | Yes |
| Show suppliers within other filters | If the supplier should be a product filter. | No |
| Setup Apptus now | Synchronise panels and attributes to eSales. Overwrites any existing settings. | N/A |
| Export data to Apptus now: Incremental | Run an incremental product export to eSales. | N/A |
| Export data to Apptus now: Full | Run a full product export to eSales. | N/A |
| Load similar products from Apptus | If the similar products shown on a product detail page should be loaded from Apptus. | Yes |
| "Did you mean" on search-result page | If did-you-mean results should be visible on a search result page. | Yes |
| Categories on search-result page | If category suggestions should be visible on a search result page. | Yes |
| Manufacturers on search-result page | If brands should be visible on a search result page. | Yes |
| Load manufacturers in flyout | If brands should be visible in the search flyout. | Yes |
| Load categories in flyout | If categories should be visible in the search flyout. | Yes |
| Correct search-phrase in flyout | If did-you-mean results should be visible in the search flyout. | Yes |
| Max search-term corrections | The maximum number of did-you-mean results in the search flyout. | 3 |
| Suggest search-phrase in flyout | Show search phrase corrections provided by Shopware. Note that this is not provided by eSales. | No |
| Max search-term suggestions | The maximum number of search phrase suggestions provided by Shopware. Note that this is not provided by eSales. | 0 |
| Product-limit in flyout | The maximum number of products in the search flyout. | 5 |
| Category-limit in flyout | The maximum number of categories in the search flyout. | 4 |
| Manufacturer-limit in flyout | The maximum number of brands in the search flyout. | 4 |
| Market | The eSales market as defined in the eSales Admin app. Must match the setting in the eSales Admin app. | N/A |
| Remove the "Best result" sorting when uninstalling/deactivating | If the sort order "Best result" should be kept or not when uninstalling. | No |
| Remove the logs table on plugin uninstall | If logs should be removed when uninstalling. | No |
| Custom Search Attributes | Additional custom search attributes. Attributes are delimited with ,. | N/A |
| Custom Category Search Attributes | Additional custom category search attributes. Attributes are delimited with ,. | N/A |
| Request Logging | Send more detailed logs from Shopware to eSales. | No |
| Recommendations active | Show product recommendations on product display pages. | Yes |
| Show parent categories | Enable the display of parent categories of products when using the Category recommendations. | Yes |
Product usage¶
If a product is used together with the Apptus eSales for Shopware plugin is determined by the configuration for product visibility in Shopware. Products that would be visible according to the standard Shopware logic will be used together with the plugin.
Last update: November 20, 2020