Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit dff8aac

Browse files
authored
Merge pull request magento-commerce/devdocs/pull#2517 from magento-devdocs/em_prex-catsynccli
Documenting new feeds
2 parents 4ae1116 + e775776 commit dff8aac

File tree

2 files changed

+31
-13
lines changed

2 files changed

+31
-13
lines changed

src/guides/v2.3/config-guide/cli/config-cli-subcommands-catalog-sync.md

Lines changed: 30 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,43 @@ group: configuration-guide
33
title: Catalog Sync
44
---
55

6-
Magento compiles catalog data into tables using indexers. This process is automatically [triggered by several events](https://docs.magento.com/user-guide/system/index-management-events.html), such as changes to a product's price or inventory levels. To allow some Magento services to use that catalog data, a catalog sync process runs hourly. The catalog sync process exports product data from the Magento server to SaaS services on an ongoing basis. For example, the [Product Recommendations](https://docs.magento.com/user-guide/marketing/product-recommendations.html) feature needs up-to-date catalog information so that it can accurately return recommendations with correct names, pricing, and availability. Use the command-line interface to trigger the catalog sync and reindex product data for consumption by SaaS services.
6+
Adobe Commerce and Magento Open Source compiles catalog data into tables using indexers. This process is automatically [triggered by several events](https://docs.magento.com/user-guide/system/index-management-events.html), such as changes to a product's price or inventory levels. To allow some Commerce services to use that catalog data, a catalog sync process runs hourly. The catalog sync process exports product data from the Commerce server to Commerce services, which are deployed as SaaS, on an ongoing basis. For example, the [Product Recommendations](https://docs.magento.com/user-guide/marketing/product-recommendations.html) feature needs up-to-date catalog information so that it can accurately return recommendations with correct names, pricing, and availability. Use the command-line interface to trigger the catalog sync and reindex product data for consumption by Commerce services.
77

8-
{:.bs-callout-info}
9-
To use the catalog sync commands, you must have an [API key and a SaaS Data Space configured](https://docs.magento.com/user-guide/system/saas.html). If you do not have an API key and have not configured a SaaS Data Space, you can still reindex product data but that data will not be exported to SaaS services.
8+
## Sync catalog data
109

11-
The commands used to sync catalog data are part of the `magento/saas-export` package. See [Install and configure Product Recommendations]({{ site.baseurl }}/recommendations/install-configure.html) for more information.
10+
To synchronize catalog data, you must have an [API key and a SaaS Data Space configured](https://docs.magento.com/user-guide/system/saas.html). If you do not have an API key and have not configured a SaaS Data Space, you can still reindex product data but that data will not be exported to Commerce services.
1211

13-
{:.bs-callout-info}
14-
See the [user guide](https://docs.magento.com/user-guide/system/catalog-sync.html) to learn how to use the Catalog Sync dashboard in the Admin UI to observe and manage the Magento to SaaS syncing process.
12+
The `saascatalog:resync` command is part of the `magento/saas-export` package. See [Install and configure Product Recommendations]({{ site.baseurl }}/recommendations/install-configure.html) for more information.
13+
14+
See the [user guide](https://docs.magento.com/user-guide/system/catalog-sync.html) to learn how to use the Catalog Sync dashboard in the Admin UI to observe and manage the Commerce to SaaS syncing process.
1515

1616
{:.bs-callout-info}
1717
When you trigger a data resync from the command line, it can take up to an hour for the data to update.
1818

19-
The following command reindexes the product data from the Magento catalog and resyncs it to Magento SaaS services:
19+
Command options:
20+
21+
```bash
22+
bin/magento saascatalog:resync --feed <feed name> [no-reindex]
23+
```
24+
25+
The following table explains this command’s parameters and descriptions.
26+
27+
|Parameter|Description|Required?|
28+
|---| ---| ---|
29+
|`feed`| Specifies which entity to resync, such as `products`|Yes|
30+
|`no-reindex`| Resubmits the existing catalog data to Commerce services without reindexing. When this parameter is not specified, the command runs a full reindex before syncing data.|No|
31+
32+
The feed name can be one of the following:
33+
34+
- `products`-- Products in your catalog
35+
- `categories`-- Categories in your catalog
36+
- `variants`-- Product variations of a configurable product, such as color and size
37+
- `productattributes`-- Product attributes such as `activity`, `gender`, `tops`, `bottoms`, and so on
38+
- `productoverrides`-- Customer-specific pricing and catalog visibility rules, such as those based on category permissions
39+
40+
### Examples
41+
42+
The following example reindexes the product data from the Commerce catalog and resyncs it to Commerce services:
2043

2144
```bash
2245
bin/magento saascatalog:resync --feed products
@@ -27,8 +50,3 @@ If you do not want to run a full reindex of the products, you can instead sync t
2750
```bash
2851
bin/magento saascatalog:resync --feed products --no-reindex
2952
```
30-
31-
|Parameter|Description|
32-
|---|---|
33-
|`feed`|(Required) Specifies which entity to resync, such as `products`|
34-
|`no-reindex`|(Optional) Resubmits the existing catalog data to the SaaS service without reindexing. When this parameter is not specified, the command runs a full reindex before syncing data.|

src/shared-services/storefront-events-api-ref-context.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -332,7 +332,7 @@ Syntax:
332332

333333
```javascript
334334
mse.context.setStorefrontInstance(storefrontCtx);
335-
``
335+
```
336336

337337
### mse.context.setContext
338338

0 commit comments

Comments
 (0)