Configure the data integration path between Akeneo and SCCOS

Last updated:
Edit on GitHub

After you have configured data mapping between Akeneo and SCCOS, you need to configure the data integration path. To configure the data integration between Akeneo and SCCOS, you need to do the following in the Spryker Middleware Powered by Alumio platform:

  • Create an incoming configuration
  • Create an outgoing configuration
  • Define the route

Create an incoming configuration

The incoming configuration defines what data should be retrieved from Akeneo and how this should be done.

To create the incoming configuration, do the following:

  1. In Spryker Middleware powered by Alumio, go to Connections -> Incoming and click the + sign.
  2. In Name, enter the name of your configuration. As you are entering the name, the identifier will be populated automatically based on the name.
  3. Optional: In Description, add the description of your incoming configuration.
  4. To activate the incoming configuration, set the status to Enabled.
  5. In the Subscriber field, select the HTTP subscriber. You may also select the Akeneo subscriber, however, in this document, we consider the settings for the HTTP subscriber.
  6. In the Request URL, specify the URL to a specific product or the URL to a list of products. The URL should include just the path after akeneo.com, as the base path to the Akeneo environment is already specified in the HTTP client you created. For example, if the actual path to a specific product you want to import from Akeneo is https://test.cloud.akeneo.com/api/rest/v1/producs/1234567890, the path to specify in the Request URL field is /api/rest/v1/producs/1234567890.
Batch products import

If you want to import products in batch, say 100 products from page https://test.cloud.akeneo.com//api/rest/v1/products, the path you should specify is /api/rest/v1/products?limit=100. If you don’t specify the limit value in the URL for batch import, by default, 10 products are imported. If you want to import all the products, do the following:

  1. In the Request URL field, add the link to the page with the product without the limit value. For example: /api/rest/v1/products.
  2. In Follow pagination, select Follow next links.
  3. in Pattern to the link for the next page enter _links.next.
  1. Optional: In Request Parameters, you can specify the request parameters to configure your incoming in a certain way. For example, you can specify the parameters that would enable the import of products that were updated in Akeneo: search={"updated":[{"operator":">","value":"&{timestamp}"}],"completeness":[{"operator":"=","value":100,"scope":"ecommerce"}],"enabled":[{"operator":"=","value":true}]}.

incoming-request-parameters

  1. In HTTP Client, select the Akeneo client that you created at step Connect Akeneo with Spryker Middleware powered by Alumio.
  2. In Entity schema, select Akeneo Product.
  3. Leave other fields empty. In the top right, click Save and continue. You should see the message that the incoming configuration has been created.

incoming-configuration-batch-products

The incoming configuration should now appear at the Configurations -> Incoming page.

Create an outgoing configuration

The outgoing configuration defines how data retrieved from Akeneo should be sent to SCCOS.

To create the outgoing configuration, do the following:

  1. In Spryker Middleware powered by Alumio, go to Connections -> Outgoing and click the + sign.
  2. In Name, enter the name of your configuration. As you are entering the name, the identifier will be populated automatically based on the name.
  3. Optional: In Description, add the description of your incoming configuration.
  4. To activate the incoming configuration, set the status to Enabled.
  5. In Publisher, select No action publisher. You may also select the Akeneo publisher, however, in this document, we consider the settings for the No action publisher.
  6. Click Add entity transformer and add two transformers: the one you created at step Define the Akeneo to Base model transformer step and the one you created at step Define the Base to Spryker model transformer.

outgoing-configuration

Define the route

The route configuration connects the incoming configuration and outgoing configuration to enable the import of data from Akeneo PIM into SCCOS.

To define the route, do the following:

  1. In the Spryker Middleware powered by Alumio platform, go to Connections -> Routes and click the + sign.

  2. In Name, enter the name of your client. As you are entering the name, the identifier will be populated automatically based on the name.

  3. Optional: In Description field, add the description of your route.

  4. To activate the route, set the status to Enabled.

  5. In Incoming configuration fieled, select the configuration you created at step Create an incoming configuration.

  6. In Outgoing configuration, select the outgoing configuration created at step Create and outgoing configuration. create-a-new-route

  7. Click Save & Continue.

The route should now appear on the Configurations -> Routes page.

Next step

Create tasks and import products from Akeneo into SCCOS