Adding content about the catalog sync CLI #8125

erikmarr · 2020-10-26T15:03:56Z

Purpose of this pull request

This pull request (PR) adds information about the CLI commands you can use to sync your catalog.

Affected DevDocs pages

https://devdocs.magento.com/guides/v2.4/config-guide/cli/config-cli-subcommands-catalog-sync.html

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

…g-sync.md Co-authored-by: Misha <[email protected]>

Co-authored-by: Misha <[email protected]>

keharper · 2020-10-26T23:13:33Z

Sorry (not sorry) for jumping in while this PR is still in draft state, but I have to ask these questions:

Is the saascatalog:resync a bin/magento subcommand, or something completely new? If it is a subcommand, then make sure your examples include bin/magento. If it's something new, then we might need to consider placing this info in the P-rex guide.
Does this command live in the main EE repo? If yes, then this bullet point is moot. If you have to install P-rex, then @dshevtsov might have to update his build procedure so that the command appears in the Command Reference.

Removing information about the catalog sync dashboard.

adding bin/magento to commands.

erikmarr · 2020-11-02T21:13:24Z

@keharper these commands are part of bin/magento. I've updated the PR. @dshevtsov these commands are available when you install the composer require magento/saas-export module.

dshevtsov · 2020-11-02T23:32:37Z

@erikmarr, it looks like this is an extension. This functionality is not part of a clean instance and requires extra-installation. The command should not be expected otherwise.

It is not clear how to install it. It fails, when I try to install it on 2.4.1 Commerce with composer require magento/saas-export

$ composer require magento/saas-export
Using version ^42.4 for magento/saas-export
./composer.json has been updated
Loading composer repositories with package information
Updating dependencies (including require-dev)
Killed

misha-kotov · 2020-11-03T00:11:46Z

$ composer require magento/saas-export
Using version ^42.4 for magento/saas-export
./composer.json has been updated
Loading composer repositories with package information
Updating dependencies (including require-dev)
Killed

Could be that composer is running out of memory. Maybe try with
php -d memory_limit=4G `which composer` require magento/saas-export

dshevtsov · 2020-11-03T15:54:39Z

@misha-kotov it didn't help.
@eriksmarr please add a note that the commands are provided by the magento/saas-export package, which is not part of default OpenSource or Commerce installation, with a link to documentation on how to install it and set it up.

fixing MDL trailing space.

erikmarr · 2020-11-03T20:09:42Z

running tests

dshevtsov · 2020-11-03T21:44:49Z

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

+
+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.
+
+The commands used to sync catalog data are part of the `magento/saas-export` module. See [Install and configure Product Recommendations]({{ page.baseurl }}/recommendations/install-configure.html) for more information.


magento/saas-export looks like a package, which is a set of modules.

erikmarr · 2020-11-03T22:14:15Z

running tests

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

…g-sync.md Co-authored-by: Dmitry Shevtsov <[email protected]>

erikmarr · 2020-11-03T22:38:31Z

@dshevtsov thanks for the review. I think I have resolved all your feedback.

erikmarr · 2020-11-03T23:17:55Z

running tests

ghost · 2020-11-03T23:32:55Z

Hi @erikmarr, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

Adding content on catalog sync CLI

78e9d75

erikmarr self-assigned this Oct 26, 2020

erikmarr marked this pull request as draft October 26, 2020 15:04

m2-community-project bot added the Progress: review label Oct 26, 2020

erikmarr requested review from misha-kotov and rossbrandon October 26, 2020 15:04

erikmarr added 2.4.x Magento 2.4.x related changes Internal Dev Differentiates work between community and Magento staff labels Oct 26, 2020

erikmarr changed the title ~~Adding content on catalog sync CLI~~ Adding content about the catalog sync CLI Oct 26, 2020

misha-kotov approved these changes Oct 26, 2020

View reviewed changes

m2-community-project bot assigned misha-kotov Oct 26, 2020

m2-community-project bot added Progress: approved and removed Progress: review labels Oct 26, 2020

rossbrandon approved these changes Oct 26, 2020

View reviewed changes

m2-community-project bot assigned rossbrandon Oct 26, 2020

erikmarr and others added 2 commits October 26, 2020 14:03

Update src/guides/v2.4/config-guide/cli/config-cli-subcommands-catalo…

c117840

…g-sync.md Co-authored-by: Misha <[email protected]>

Apply suggestions from code review

b3809ae

Co-authored-by: Misha <[email protected]>

shrielenee added the hacktoberfest-accepted label Oct 29, 2020

erikmarr added 2 commits November 2, 2020 14:35

Update config-cli-subcommands-catalog-sync.md

3acf89f

Removing information about the catalog sync dashboard.

Merge branch 'master' into em_prex-catsyncapi

8620ab2

erikmarr marked this pull request as ready for review November 2, 2020 20:41

Update config-cli-subcommands-catalog-sync.md

08bd52a

adding bin/magento to commands.

Merge branch 'master' into em_prex-catsyncapi

9890805

erikmarr requested review from keharper, misha-kotov and rossbrandon November 2, 2020 21:13

keharper approved these changes Nov 3, 2020

View reviewed changes

m2-community-project bot assigned keharper Nov 3, 2020

erikmarr added 3 commits November 3, 2020 12:55

Update config-cli-subcommands-catalog-sync.md

7b4956a

Update config-cli-subcommands-catalog-sync.md

bec4ef4

fixing MDL trailing space.

Merge branch 'master' into em_prex-catsyncapi

76ed973

creating symlink

8ae7b4e

dshevtsov reviewed Nov 3, 2020

View reviewed changes

m2-community-project bot assigned dshevtsov Nov 3, 2020

m2-community-project bot added Progress: review and removed Progress: approved labels Nov 3, 2020

creating symlink

5df458b

dshevtsov reviewed Nov 3, 2020

View reviewed changes

src/guides/v2.3/config-guide/cli/config-cli-subcommands-catalog-sync.md Outdated Show resolved Hide resolved

Update src/guides/v2.3/config-guide/cli/config-cli-subcommands-catalo…

941213f

…g-sync.md Co-authored-by: Dmitry Shevtsov <[email protected]>

dshevtsov approved these changes Nov 3, 2020

View reviewed changes

m2-community-project bot added Progress: approved and removed Progress: review labels Nov 3, 2020

erikmarr merged commit ba1c4d5 into master Nov 3, 2020

erikmarr deleted the em_prex-catsyncapi branch November 3, 2020 23:32

m2-community-project bot added Progress: done and removed Progress: approved labels Nov 3, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Adding content about the catalog sync CLI #8125

Adding content about the catalog sync CLI #8125

Uh oh!

erikmarr commented Oct 26, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

keharper commented Oct 26, 2020

Uh oh!

erikmarr commented Nov 2, 2020

Uh oh!

dshevtsov commented Nov 2, 2020 •

edited

Loading

Uh oh!

misha-kotov commented Nov 3, 2020

Uh oh!

dshevtsov commented Nov 3, 2020

Uh oh!

erikmarr commented Nov 3, 2020

Uh oh!

dshevtsov Nov 3, 2020

Uh oh!

erikmarr commented Nov 3, 2020

Uh oh!

Uh oh!

erikmarr commented Nov 3, 2020

Uh oh!

erikmarr commented Nov 3, 2020

Uh oh!

ghost commented Nov 3, 2020

Uh oh!

Uh oh!


		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.

		The commands used to sync catalog data are part of the `magento/saas-export` module. See [Install and configure Product Recommendations]({{ page.baseurl }}/recommendations/install-configure.html) for more information.

Adding content about the catalog sync CLI #8125

Adding content about the catalog sync CLI #8125

Uh oh!

Conversation

erikmarr commented Oct 26, 2020

Purpose of this pull request

Affected DevDocs pages

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

keharper commented Oct 26, 2020

Uh oh!

erikmarr commented Nov 2, 2020

Uh oh!

dshevtsov commented Nov 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

misha-kotov commented Nov 3, 2020

Uh oh!

dshevtsov commented Nov 3, 2020

Uh oh!

erikmarr commented Nov 3, 2020

Uh oh!

dshevtsov Nov 3, 2020

Choose a reason for hiding this comment

Uh oh!

erikmarr commented Nov 3, 2020

Uh oh!

Uh oh!

erikmarr commented Nov 3, 2020

Uh oh!

erikmarr commented Nov 3, 2020

Uh oh!

ghost commented Nov 3, 2020

Uh oh!

Uh oh!

dshevtsov commented Nov 2, 2020 •

edited

Loading