To enable the LS Recommend functionality, you must perform some basic setup in LS Recommend Setup. This includes configuring the authentication and API connections between LS Central and LS Recommend, so that they can integrate and communicate with each other.
To set up the connection between LS Recommend and LS Insight
To set up Recommendation API URL
To assign a Recommendation API URL to the store
There are two types of API connections that need to be configured:
- The Admin. API which is used to connect to the LS Recommend Engine for maintenance processes such as master data synchronization and LS Recommend Batch calculation.
- The Recommendation API which is used by the LS Central POS terminals and LS Commerce to communicate with the LS Recommend Model Reader for recommendation request.
To set up LS Recommend
- Click the
icon, enter LS Recommend Setup, and select the relevant link. - Fill in the relevant fields:
| Field | Description |
|---|---|
| Admin. API URL | This field specifies the URL that is used to connect to the LS Recommend Engine. The engine is used for administrative and maintenance processes such as master data synchronization and LS Recommend Batch calculation. |
| Default Recommendation API URL |
This field specifies the default URL that will be used by the POS terminals and LS Commerce to connect to the LS Recommend Model Reader for recommendation request. This URL is used if no specific Recommendation API URL has been assigned to the stores and LS Commerce Service.
You can set up the Recommendation API URL in the LS Recommend API URL page. For more information see To set up Recommendation API URL below. |
| Days Calculation Logs Exists | This field specifies how far back in days to keep the LS Recommend Calculation Logs. |
| Authentication URL | This field specifies the URL for LS Recommend authentication. |
| Client ID | This field specifies the unique public identifier for your LS Central application, which is used by the LS Recommend authentication server. |
| Client Secret | This field specifies a random encrypted secret known only to your LS Central application and the LS Recommend authentication server. This is used together with the Client ID. |
| Username | This field specifies the user name to be used for LS Recommend authentication. Note: If you change the Username when LS Insight Connection Status is Connected, you will be given the option to disconnect LS Recommend from LS Insight to avoid out-of-sync situations, or to keep the connection. |
| Password | This field specifies the user password to be used for LS Recommend authentication. |
Tip: You can use the Test Connection (Admin. API) action in the Functions menu to test the connection between LS Central and the LS Recommend Engine.
To set up the connection between LS Recommend and LS Insight
LS Insight serves as a data warehouse for LS Recommend and it contains the transactional sales history for the LS Recommend Batch model calculation. For the LS Recommend engine to identify the LS Insight instance and retrieve its data for calculation, you need to set up the connection between LS Recommend and LS Insight.
To set up the connection:
- Click the icon, enter LS Recommend Setup, and select the relevant link.
- Fill in the relevant fields in the LS Insight FastTab:
| Field | Description |
|---|---|
| LS Insight Connection String | This field specifies the connection string between LS Recommend and LS Insight. |
| Display LS Insight Connection String | This field shows the connection string between LS Recommend and LS Insight without the password. |
| LS Insight Connection Status | This field specifies the connection status between LS Recommend and LS Insight. The status will be shown as Connected if a connection has been established. |
In the LS Recommend Setup page, you can use the actions in the LS Insight action menu to maintain the connection:
- Connect LS Insight Database
Establish a connection between LS Recommend and LS Insight according to the LS Insight Connection String field. - Disconnect LS Insight Database
Remove the connection between LS Recommend and LS Insight. - Test LS Insight Connection
Test the connection status between LS Recommend and LS Insight. You can only use this action when the LS Insight Connection Status is Connected.
To set up Recommendation API URL
When an LS Recommend Batch has been calculated, its model will be loaded into an LS Recommend Model Reader which the POS terminals will communicate with for product recommendations. You must set up the Recommendation API URL for the connection between LS Central and the LS Recommend Model Reader.
To set up the Recommendation API URL:
- In the LS Recommend Setup page, click Setup - Recommendation API URL Setup to open the LS Recommend API URL page.
- Click New to create a new Recommendation API URL.
- Fill in the Code and Description fields.
- Fill in the Recommendation API URL field, which will be the URL address used by LS Central to connect to the LS Recommend Model Reader. The authentication details configured in LS Recommend Setup will be used to establish the connection.
When a Recommendation API URL record is deleted or when its URL address is updated, the LS Recommend Batch models that have already been loaded will be unloaded from the associated Model Reader.
The Last Loaded On field shows the time when the model of an LS Recommend Batch was last loaded to or unloaded from the Model Reader.
Tip: You can use the Test Connection action in the Functions menu to test the connection between LS Central and the selected LS Recommend Model Reader.
To assign a Recommendation API URL to the store
You can assign a default Recommendation API URL in LS Recommend Setup, which will be used by LS Central to connect to the LS Recommend Model Reader. You can also assign a Recommendation API URL to the stores. This is especially useful when there are multiple Model Readers and you want to assign a different Model Reader than the default one to the stores.
To assign a Recommendation API URL to the store:
- Click the icon, enter Store List, and select the relevant link.
- Select a store to which you want to assign the Recommendation API URL, and open its Store Card.
- In the LS Recommend FastTab, fill in the Recommendation API URL field.
You can also assign a Recommendation API URL to be used by the LS Commerce Service, if product recommendations are to be displayed on an LS Commerce device. For more information see LS Recommend for LS Commerce.
The tasks listed below describe the setup steps for LS Recommend:
| To | See |
|---|---|
| Set up LS Recommend Batches. | How to: Set Up LS Recommend Batches |
| Set up POS terminals for LS Recommend. | How to: Set Up POS Terminals for LS Recommend |
| Set up items for LS Recommend. | How to: Set Up Items for LS Recommend |
See also