TranslationI will note that many applications are built to perform the same logic using application database queries and so there is a configuration variable (Catalog_ItemCatalogSource) which can be set to "Solr"/"Application Db".
- ItemCatalogSource Configuration Variable.PNG (10.02 KiB) Viewed 1732 times
- ItemCatalogSource Configuration Variable.PNG (10.02 KiB) Viewed 1732 times
Below is an explanation of how this system works using Solr to perform quick searches and support complex custom catalogs or a basic design, but be built for growth.
This includes the setup of:
- Item Import
- Reindex
- Catalog
- Catalog Search Method
- Catalog Left Panel/Category Facet Filters
- Site Header Category Menu/Category Facet Menu
- Solr Configuration File
- ItemImport Batch Job Screenshot.PNG (6.16 KiB) Viewed 1732 times
- ItemImport Batch Job Screenshot.PNG (6.16 KiB) Viewed 1732 times
typically we populate tables meant to simulate the table structure in JDE, but could have as many as below:
- EC_Item_Master
- EC_Item_Branch
- EC_Item_Account
- EC_Item_Media
- EC_Item_Catalog
Reindex
- Reindex Method Screenshot.PNG (9.06 KiB) Viewed 1732 times
- Reindex Method Screenshot.PNG (9.06 KiB) Viewed 1732 times
Typically at the end of the item import, a "Reindex" service will run.
That service accepts a query. This is the query that joins the application database tables to create the data set that is given to Solr.
Typically there will be a method called something like "ItemCatalogQuery" which outputs the query used to create the catalog selection. The data set will exactly match what the users see on the catalog page and how searches are performed against this, so its important to get this part right or it may require changes later on.
This is built in a method because all the services that work with Solr need this query.
Catalog
Some examples of controls that can be added to the catalog page that call the controller:
- Results per page: 10, 30, 60, etc
- "Filter Results By" search. Where keywords can be typed in which filter the current selection
- Sorting by fields ASC/DESC
- Paging. Viewing page 1, 2, 3, ... 50. Which uses some math from the "results per page" to find out what the start and end number of the catalog should be. The paging buttons and that math can get a little confusing, so there is an export of that logic we have to start with
- Category Filters. "Show only the products in this product family. This is called the catalog left menu and will be explained later.
Catalog Search Method
The catalog search method receives input of what type of search is being performed. The added controls to the catalog page end up adding more filters (like showing 30 vs 60 results per page, sorting, showing results on page 50, etc). So at the very beginning of this method, it stores all the types of filters it could receive and what values it is given to know what search it will perform.
The catalog search method also calls a Solr service so it too needs to call the "ItemCatalogQuery" method to have this value to pass into the service.
From the inputs to the Catalog Search Method, a search query is created. But the query is in Solr syntax since it will be passed into a Solr service called "Search".
Here is a typical Solr Search Service query:
In Solr, the "*" is a wildcard character.
Once results return from the Solr search service, the rest of the Catalog search method's job is to get the extra bit of info that Solr was not in charge of holding, but that should be displayed on the catalog. This can include, price, availability, product image.
We put the Catalog Search method in charge of this because then this method can be used from anywhere on the application to search for items. We would want to do this because recreating it elsewhere would risk not using the same search criteria and could accidentally show restricted items to the end user.
Then if everywhere that performs search is using the same method, we want the same stuff to display everywhere we show the item. so it makes sense to also need the image, price, etc in these secondary locations. So instead of duplicating the effort to get that extra info, we put it in the catalog search method to be done once.
Catalog Left Panel/Category Facet Filters
The left panel of the catalog displays the categories that exist for the items on the page.
- Catalog Left Menu Screenshot.PNG (2.73 KiB) Viewed 1732 times
- Catalog Left Menu Screenshot.PNG (2.73 KiB) Viewed 1732 times
Here is an example of the output it returns in the Solr "Search" service if using the FacetColumns:
The "Catalog Search" method just outputs this XML to be used by method: "ItemCatalogFacetsMenu". This takes the XML of the various Facets for the returned items and builds the html to create the hyperlinks that show in the left panel.
Here is the XML export that creates this Once this method creates the HTML, it is put on the page in an HTMLGenericControl
Site Header Category Menu/Category Facet Menu
- EC Category Menu Example Screenshot.PNG (10.89 KiB) Viewed 1732 times
- EC Category Menu Example Screenshot.PNG (10.89 KiB) Viewed 1732 times
This would allow the user to browse the categories and filter down until they see a subset of the items that they wish to browse.
This is done using another Solr service "GetFacetedValues". This is another Solr service, so again it needs the full query that gets passed into all Solr services. So we need to call "ItemCatalogQuery" method again and pass that as input.
It also needs to know which facets we are interested in. Maybe when the items show on the catalog page, we show all possible facets: catcod1, catcode2, catcode3, catcode4. But when shown in the menu, we only want to show 2 levels deep. So we would enter those 2 values: Catcode2, catcode2.
And finally the Solr service again needs the Solr query search value. This should be identical to the search performed in the CatalogSearch Method. If it is not, you risk showing items the user is not allowed to see.
Once the service runs, it produces an output like this:
Of those, 343 of them (all) belong to the categorycode2 value of "WI" which has the description "Waist".
Now, not all of this info came from the Solr service. Some of it was found afterwards and merged back to the service's xml so it can be used to create the html of the menu that shows on the site.
Solr Configuration File
The part I wont explain how to set up is the solr configuration file. It sits on the server and is named managed-schema.
This cant be setup by the EASYProcess developer because this wont be accessible from EASYProcess due to security permissions.
The file stores the definitions of its datatypes and each column and what datatype it is set up as.
The query that populates Solr with data needs every field in its select clause to already exist in the Solr schema.
- Solr Schema File CopyField Screenshot.PNG (9.03 KiB) Viewed 1732 times
- Solr Schema File CopyField Screenshot.PNG (9.03 KiB) Viewed 1732 times