Embedded Services

PRESSERO > *Integration information & Supported Services

Embedded Services in Pressero admin is an area that will be hidden unless your account is integrated with one of the external services being supported by this service. As of today, Pressero Embedded Services is compatible with the following (select to go directly to the Embedded Services setup for that provider):

 
  1. Aleyant tFLOW

  2. Caldera StreamLive

  3. HP Site Flow

  4. HP PrintOS Box

  5. Smartsoft Presswise

 

Embedded Services allows synchronization of the following data with Pressero:

 
  1. Orders / Order Status

  2. Products

  3. Categories

  4. Users

 

What each provider can offer will depend on the external provider API capabilities, so please check the KB article for each service to see what they can do or can't-do with Pressero.

 

How to Access

 

Embedded Services is a menu option inside the Preferences panel which will be displayed after your account is set up with integration with a particular solution being supported. After the sales and DevOps teams confirm and setup your account to one of the solutions, you will need to add that solution to this area. Select Embedded Services ≥ Add new account button. A list of all services you are connected with will be shown.

 

Screen Shot 2017-09-29 at 16.28.15.png

 

Clicking on the Add new Account will bring the basic configuration interface, where you can set:

 
  1. Account Name: A name easy enough to allow you to Recognize the Integration;

  2. Provider: You can select the provider you wish to connect to;

  3. Admin User: The admin to be associated with this integration;

 

After you select the Provider, a new option will be shown, called Credentials, there you'll be able to set the specific configuration for each provider, those information will be provided by the external service.

 

Screen Shot 2017-09-29 at 16.30.22.png

 

Once the account configuration is set, the integration must be activated for each site you want to integrate with, similar how shipping and payments work today on Pressero.

 

Activating The Service in a Site

 

To activate the integration for a site, access the site settings page and a new tab will be available, Embedded Service, there you'll be able to select the external service you want to activate. On the first access you'll have two options:

 
  1. Enable: This will enable the integration, allowing you to set special configurations when necessary at Product, Categories and user level;

  2. IsLive: This will activate the service and allow the site to consume and push data to the External service;

 

Screen Shot 2017-09-29 at 16.33.26.png

 

Once the integration is set and saved, you will have the capability to synchronize the site data, consuming the data from the external service or pushing order data.

 

Screen Shot 2017-09-29 at 16.35.04.png

 

Pushing Order

 

One of the most interesting features of the Embedded Service is the capability of Pushing orders to an external partner.

 

For an order to be pushed it must match the following requirements:

 

1. The order is marked as paid;

2. All items are Approved or have at least one approved item and all the remaining items are denied;

3. All files are ready (there's no pending eDoc file)

4. All the order items have a valid status (example: Item with canceled status will not be pushed)

 

Once the order matches all the requirements, Pressero will push the order to the external service. After that a new tab will be displayed on the Order Item details page, where the user will be able to see the integration details, like the date the item was pushed, the current status of the external service and its external ID.

 

Screen Shot 2017-09-29 at 16.38.37.png

 

If the item fails to be pushed a button will be displayed allowing you to try to push the order manually.

 

Updating Order Status

 

Depending on the External Service this operation can be done automatically, when it's a bidirectional integration, or manually.

 

So if the external integration requires the user to update the status manually an option will be available on the Embedded Service configuration tab on the site settings, allowing the user to select the synchronize option and then click on the synchronize button. This process may take a while and the time it takes to finish the process will vary depending on the number of orders to update and the external service server status/performance.

 

Screen Shot 2017-09-29 at 16.42.22.png

 

Product Integration

 

The external Product integration provides two functionalities, that will depend on the External Service:

 
  1. Product Integration: This will allow you to set specific configuration on the product, those configuration will then be consumed by the External Service;

  2. Product Synchronization: This will allow Pressero to download the Product Data from the external service, copying its data to Pressero DB;

 

On both scenarios a new tab will be displayed on the Product, allowing you to see the integrated configuration and data.

 

Screen Shot 2017-09-29 at 16.49.41.png

 

If the item was download from an external provided, the Active checkbox will be checked by default, otherwise the user will have to select this option manually. Each provider can provider or require a set of configuration, for more information and details please check the documentation for each provider.

 

If the external service allow product synchronization, when you click the button Synchronize on the site settings page, Pressero will query the external service, fetch the data will do the following operations:

 
  1. If the product exists, it will update the product information using the data from the External Service

  2. If it's a new Product:

    1. If the external service provides category information:

      1. If the category exists, it will associate it to the Product

      2. If the category does not exists, the process will create a new category on pressero using the data provided by the external service and then associate the Product to the new category

    2. If the service does not offer category information, the synchronization process will set the product category as Root

  3. Will save the integration data on the Product, making the information available on the Embedded Service Tab

 

Screen Shot 2017-09-29 at 16.56.37.png

 

User Integration

 

Pressero does not allow user synchronization, only integration, this means that the synchronization option is not available on the site settings page, but it's possible to set specific information and configuration at user level to allow the external service to consume those data.

 

Screen Shot 2017-09-29 at 17.11.56.png

 

Category Integration

 

This integration allows Pressero to download the categories from the External Service a option will be available on the Site Settings page, so when you click the button Synchronize Pressero will query the external service, fetch the data will do the following operations:

 
  1. If the Category exists, it will update the Category information using the data from the External Service

  2. If it's a new Category, the process will create a new category on pressero using the data provided by the external service

  3. Will save the integration data on the Category, making the information available on the Embedded Service Tab

 

Observations

 
  • One site can be associate to more than one External Service

  • An order can be pushed to more than one external service, if this occur there will be unique identification for each external service the order is connected to

 

Screen Shot 2017-09-29 at 17.21.09.png

 
  • If the item is not ready to be pushed the Embedded Service tab will not be displayed on the Order item details page, but if you click on the the synchronize option on the site settings on the log area a message will be displayed

  • The Synchronization process is asynchronous, so the log information may not be updated immediately, taking a few minutes to update, so you will need to click on the refresh button to see the latest log information

  • The synchronization process may take a few minutes to finish, the time will vary depending on the external service performance and network connectivity

  • Credentials are provided by the external providers, so please contact them before configuring the Embedded Service

  • The Embedded Feature is enabled by Request, so if you have interest on this Feature please contact the support team.