Addon Connector PARtsDB

The SQUIZZ.com PARtsDB Addon Connector is a separate application from the SQUIZZ.com Connector software, that allows Make, Model, Category, and Product data to be obtained from the PARtsDB platform and stored into an intermediate SQLite database file. The SQUIZZ.com PARtsDB Addon Connector runs as a web service on Microsoft Windows operating systems (version 7/2012 and higher), that can be periodically called by the SQUIZZ.com Connector software to export and store data from PARtsDB. The addon-connector can update any existing data found, enter any new data into the SQLite database file, or deactivate any data no longer synchronised.

Within the SQUIZZ.com Connector software a Generic adaptor can be configured using the SQUIZZ.com PARtsDB Addon Connector preset, to read Make, Model and Category data from the addon connector's SQLite database, and then either import the data into the Connector's Data Set for further data management, and/or exported to the SQUIZZ.com and TOTECS platforms.

The SQUIZZ.com PARtsDB Addon Connector provides a web interface that allows its web service to be configured, based on a number of different settings that control how it communicates with PARtsDB's API (Application Programming Interface), and how it reads data from its API. The web interface also allows credentials to be set up to limit how other software can talk to the addon Connector.

SQUIZZ.com PARtsDB Addon Connector Web Service

The SQUIZZ.com PARtsDB Addon Connector gets installed as a Windows service that always runs within the background of Windows, regardless of any users who are currently logged into Windows at the time. This allows the addon connector software to be called by the SQUIZZ.com Connector software at any time to export and cache data from PARtsDB to its SQLite database file. Within the SQUIZZ.com Connector software It's recommended to set up scheduled routines, that call the addon connector to export and cache data at off peak times, to reduce the load on the PARtsDB system, as well as the computer running the addon connector software.

Make/Model Data Caching Routines

The SQUIZZ.com PARtsDB Addon Connector contains pre-built configurations on how it obtains make/model data from the PARtsDB system. It does this by converting each vehicle stored in PARtsDB system into a number of model records, where a model record is created for each year a particular vehicle was manufactured for. For example, if a Toyota Echo vehicle has a manufactured date range from 1998 to 2003, then the addon connector will define model records for the years 1998, 1999, 2000, 2001, 2002 and 2003. For any products assigned to the Toyota Echo vehicle, they will be also assigned to these same 6 models that the addon connector exports and stores/caches within its SQLite database. Each of the defined models will also contain the same attributes of the vehicle. By representing a model for each vehicle year makes it easier for end users to find automotive vehicles, when they know the year that their vehicle was built, or they can select from a list of years to choose from in make/model search forms.

Category Data Caching Routine

The SQUIZZ.com PARtsDB Addon Connector contains pre-built configurations on how it obtains category data that is managed within the PARtsDB system. After organisations have uploaded their product list into the PARtsDB system, they can then set up and manage a category tree within the PARtsDB system. The addon connector has a data export/caching routine that can request to obtain the category data, including the products assigned to each category, and export and cache the category product back within the addon connector's SQLite database file. From there the SQUIZZ.com Connector can be set up with a Generic adaptor to read the category data from the SQLite database, and either import into a Data Set for further management, or else into the SQUIZZ.com and TOTECS platforms. Using the category data can make it easier for end users to find products, by searching through a category tree to find products they are looking for.

To install the SQUIZZ.com PARtsDB Addon Connector software and configure it with the SQUIZZ.com Connector software, check that the computer that the addon connector is being installed on meets the following prerequisites. If it does then follow the steps below:

Prerequisites:

• Microsoft Windows Operating system. Version 7 or higher, or WIndows Server 2012 or higher.
• Windows user with privileges to install Windows services
• Microsoft.NET library version 4.6.1 or higher is installed.
• Computer operating system drive contains at least 2 Gigabytes of available space.
• Computer contains at least 1GB of RAM memory.
• SQUIZZ.com Connector Host Service is installed.
• SQUIZZ.com Connector application is installed.
• Computer has network access to the internet.

SQUIZZ.com PARtsDB Addon Connector Installation and Setup Steps:

1. On a computer running the Microsoft Windows operating system (version 7 or higher , or version 2012 or higher) open a web browser and download the installer file by clicking on this download link.
2. Click on and run the installer file to install it on the computer. The Windows user you are logged in as must have permissions to install programs.
3. Once the installer has successfully completed, open up the web browser from step 1 and enter the URL http://localhost:8091/ui/login to access the addon connector's login page.
4. Type the default user name: user and password: changeit into the login form fields and press the enter key.
5. Within the Settings page modify the values of the settings under the Connector Addon Web Service Settings section, as described within the Application Settings section displayed below. It's highly recommended to change the User Name, Password and Data Requests Require Authentication settings so that no other people can easily login to the addon connector and modify its settings.
6. Click on the Save button to update the changes. If you change the Listen On Port Number or Host URL settings that the addon connector's web service runs on then you will need to change the URL from step 3 with the changed port number and website domain. If you change the User Name and Password settings then you wil need to repeat step 3 to login again with the updated credentials.
7. In the Settings page under the PARts DB Settings section change the BrandID, Brand User and Brand Password settings based on the API credentials PARtsDB has provided to you. If you are unsure on these then contact PARtsDB to determine how to obtain these settings for its system.
8. For the Get Maker Models Request URL setting, in the URL's CountryCodes set a delimited list of country codes of vehicles that you wish to retrieve from the PARtsDB system. Only vehicles within the countries list will be returned. Ask PARtsDB of the possible country values available.
9. Click on the Save button to immediately have the the changes occur when the next time the addon connector's caching routines are run.

SQUIZZ.com Connector Configuration Steps

1. Open up the SQUIZZ.com Connector application.
2. WIthin the Adaptors and Messages tab, either create or use an existing Generic adaptor to handle running routines that allow the SQUIZZ.com PARtsDB Addon Connector software to have its caching routines run.
3. For the Generic adaptor click on the Settings button.
4. Click on the Routines tab.
5. Select the Generic HTTP GET Request Routine Type and click the Create Routine button.
   1. In the Routine Code  set the value "Cache PARtsDB Makers" then click on the Save Routine button.
   2. Within the Settings tab enter the following settings
      1. In the Request URL setting set the URL of the addon connector's Makers caching routine with the correct IP address/domain and port number configured from step 5, by default it would be localhost:8081/esd/cache/makers
      2. In the HTTP Request Protocol setting set to http://
      3. In the Timeout setting change the value to 60
      4. In the HTTP Response Validation Regex setting set the value: "resultStatus": 1,
6. Create a routine to allow the addon-connector to cache the Make/Model data from PARtsDB. Select the Generic HTTP GET Request Routine Type and click the Create Routine button.
   1. In the Routine Code  set the value "Cache PARtsDB Maker Models" then click on the Save Routine button.
   2. Within the Settings tab enter the following settings
      1. In the Request URL setting set the URL of the addon connector's Maker Models caching routine with the correct IP address/domain and port number configured from step 5, by default it would be localhost:8091/esd/cache/maker_models
      2. In the HTTP Request Protocol setting set to http://
      3. In the Timeout setting change the value to 1200
      4. In the HTTP Response Validation Regex setting set the value: "resultStatus": 1,
7. Create a routine to allow the addon-connector to cache the Make/Model Product Category Mapping data from PARtsDB. Select the Generic HTTP GET Request Routine Type and click the Create Routine button.
   1. In the Routine Code  set the value "Cache PARtsDB Maker Model Mappings" then click on the Save Routine button.
   2. Within the Settings tab enter the following settings
      1. In the Request URL setting set the URL of the addon connector's Maker Models caching routine with the correct IP address/domain and port number configured from step 5, by default it would be localhost:8091/esd/cache/maker_model_mappings
      2. In the HTTP Request Protocol setting set to http://
      3. In the Timeout setting change the value to 1200
      4. In the HTTP Response Validation Regex setting set the value: "resultStatus": 1,
8. Create a routine to allow the addon-connector to cache the Category data from PARtsDB. Select the Generic HTTP GET Request Routine Type and click the Create Routine button.
   1. In the Routine Code  set the value "Cache PARtsDB Categories" then click on the Save Routine button.
   2. Within the Settings tab enter the following settings
      1. In the Request URL setting set the URL of the addon connector's Category caching routine with the correct IP address/domain and port number configured from step 5, by default it would be localhost:8091/esd/cache/categories
      2. In the HTTP Request Protocol setting set to http://
      3. In the Timeout setting change the value to 1200
      4. In the HTTP Response Validation Regex setting set the value: "resultStatus": 1,
9. Close the Generic Adaptor Settings window and for the adaptor the routines were created for click on the Exports/Routines button.
10. Click on the Routines tab and select each routine to call the addon connector to cache the relevant data.
11. For each routine click on the Run Once Off button. The routines need to be selected run in the following order:
    1. Cache PARtsDB Categories
    2. Cache PARtsDB Makers
    3. Cache PARtsDB Maker Models
    4. Cache PARtsDB Maker Model Mappings
12. If the routines successfully run and are correctly configured within the addon-connector then data should be saved to the addon-connector's SQLite database file. If they don't successfully run then check that the addon-connector is running, has been correctly configured, and that the routines in the Connector application are correctly configured.
13. It's recommended to set up the scheduling of these routines from step 19-20 to run on a regular basis, such as daily or weekly. When scheduling routines ensure that they run in the correct order and have enough time to finish before the next routine starts.
14. Create a new or using an existing Generic adaptor that will be used to retrieve make, model, and category data from the addon connector's SQLite database file.
15. Within the Load Adaptor Preset drop down choose the preset SQUIZZ.com PARtsDB Addon Connector and click on the Load button.
16. Within the preset settings window, for the PARtsDB Addon Connector Database File Path setting enter the path to the addon connector's SQLite database file, by default it will be saved to C:\ProgramData\SquizzCom\PartsDBWebservice\app.db3 if the Windows default drive is C:
17. The preset will configure the Makers, Make Models, Maker Model Attributes, Maker Model Mappings, and Category data exports to retrieve data from the addon-connector's SQLite database file storing the cached PARtsDB data.

With the SQUIZZ.com PARtsDB Addon Connector installed and configured, and a SQUIZZ.com Connector software configured to talk to the PARtsDB Addon Connector, the configured Generic adaptor within the SQUIZZ.com Connector software can now run the routines for the addon connector to communicate with the PARtsDB system's API, to retrieve the different, maker, maker model, maker model mapping, and category data and store them within the SQLite database. The Connector's Generic adaptor can then be used to export the data from the SQLite database out to either a Data Set, SQUIZZ.com or TOTECS platforms.

The following settings can be configured for the SQUIZZ.com PARtsDB Addon Connector web service, controlling different aspects on how it runs, and how it communicates and retrieves data from the PARtsDB API.