Getting started with Product Studio
Product Studio adds a workspace for your product data to the administration under Catalogues > Product Studio. It has seven tabs:
| Tab | Contents | Documentation |
|---|---|---|
| Sheet | All products in a spreadsheet | Sheet |
| Prices | Price changes for many products at once, with a check of every new price, schedules and approval | Pricing |
| Health | The data quality of the catalogue and the rules that fail most often | |
| Languages | Translation coverage per language and field | Translations |
| Rules | Your data quality rules | Data quality rules |
| Import | CSV import with saved profiles | Import and export |
| History | Every change made with Product Studio, with its report and a revert button | Jobs, limits and retention |
The product page also gets a "Product Studio" card with the score, the issues, the translation gaps and the price history of that product.
This documentation describes version 7.0.0, which needs Shopware 6.7.3 or newer. If you need help or have a question that isn't answered here, open a support ticket through your Shopware Account.
Requirements
- Shopware 6.7.3 or newer.
- A message queue worker for large jobs (more than 100 products), imports, exports and the quality check of the
whole catalogue:
bin/console messenger:consume async low_priority, as Shopware recommends for production. Without a worker, these only run while someone has the administration open (admin worker). The job page shows a hint when a job doesn't start.
Installation
- Install and activate the plugin. On activation the quality and translation status of all products is calculated on the queue.
- Give users without the administrator role the permissions they need (see below).
- Change the configuration and create rules if the defaults don't fit (see below).
With a large catalogue, make a database backup before the first large import. Every change can be reverted from the history; the backup covers everything else.
Permissions
Settings > Users & permissions > Roles, under Catalogues:
| Permission | Allows |
|---|---|
| Product Studio: View | Sheet, health, languages, rules and history; saving personal views. Needs "Products: View". |
| Product Studio: Edit | Saving changes from the sheet. Needs "Products: Edit". |
Additional permissions, group "Product Studio":
| Permission | Allows |
|---|---|
| Bulk actions | Bulk actions on a selection or all matching products |
| Import CSV files | Uploading and applying imports |
| Export CSV files | Exporting views |
| Revert changes | Reverting a job from the history |
| Manage data quality rules | Creating, changing and deleting rules |
| Manage import profiles | Saving and deleting import profiles |
| Share views | Saving views that the whole team sees |
| Change prices (Prices tab) | The Prices tab: plan, apply and schedule price jobs, see Pricing |
| Save and share price recipes | Saving, sharing and deleting price recipes |
| Approve price changes | Approving or rejecting price jobs above the approval limits |
Product changes are always saved with the permissions of the user who started them, also when they run in the
background. A user who can open Product Studio but lacks product:update gets a "Missing permission" error per
product, and nothing is changed.
The history shows the jobs of all users, with a filter for your own. Only the user who started a job can apply, cancel or download it; reverting needs the "Revert changes" permission.
Configuration
Settings > Extensions > Product Studio > Configure:
| Setting | Default | Meaning |
|---|---|---|
| Source language | System language | The language translations are made from. Used for "outdated" and as the source column in translation mode. |
| Languages to check | The languages of your sales channels | Languages for which missing and outdated translations are shown. |
| Texts to check | Name, description, meta title, meta description | Texts that are checked for translations. |
| Custom fields to check | None | Text and HTML custom fields of products that are checked for translations like the texts above. |
| Only check languages of the product's sales channels | Off | A language only counts for products that are visible in a sales channel with that language. |
| Warn when a price changes by more than (%) | 50 | The review marks larger changes of the default price. 0 turns the warning off. |
| Warn when the margin falls below (%) | Empty (off) | The review marks prices with a lower margin on the purchase price. A price below the purchase price is always marked. |
| Approval needed from this many price changes / from an average change of (%) | Empty (off) | Price jobs above these limits wait for approval, see Pricing. |
| Keep price history (days) | 400 | For the lowest price of the last 30 days and the price chart. At least 31. |
| Maximum products per bulk action or export | 50,000 | Larger selections are refused. |
| Maximum import file size (MB) | 50 | |
| Maximum rows per import file | 100,000 | |
| Run changes of up to this many products immediately | 100 | Smaller jobs run in the request, larger ones on the queue. |
| Keep job history (days) | 90 | After that the job, its items and its revert data are removed. |
| Keep uploaded and exported files (days) | 7 | The job itself stays. |
Uninstall
Uninstalling with "Keep data" keeps all lae_ps_* tables. Without it, rules, views, profiles, jobs, the
calculated statuses and the uploaded and exported files are removed. Product data is never touched by the uninstall.