Addon Connector Jiwa
The SQUIZZ.com Jiwa Addon Connector is a piece of software developed by SQUIZZ Pty Ltd that enables data to be exported from the jiwa.com.au system, translated and stored within an SQLite database, that can then be read and transferred by the SQUIZZ.com Connector software to the SQUIZZ.com and TOTECS Ecommerce platforms.
Jiwa products a complete Enterprise Resource Planning system that allows organisations to manage many aspects of their business, including inventory, sales, purchasing, accounting and dispatch. The Jiwa Addon Connector translates and exports Customer Account Product Pricing data from Jiwa's system, that can then be placed into the SQUIZZ.com platform and websites gosted TOTECS platform. This allows all customers to see pricing that is specifically tailored for them, including contract based pricing, specials and locked-in pricing, based on the pricing structures that come out of the box in Jiwa's system. Note that the SQUIZZ.com Jiwa Addon Connector does not support exporting custom pricing logic that has been individually coded in Jiwa system instance.
Topics |
Overview
The SQUIZZ.com Jiwa Addon Connector is a separate application from the SQUIZZ.com Connector software, that allows Customer Account Product Pricing data to be extrapolated and exported from Jiwa's underlying database. The SQUIZZ.com Jiwa 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 data from Jiwa.
Within the SQUIZZ.com Connector software a Generic adaptor can be configured call the Jiwa Addon Connector and then export to the SQUIZZ.com and TOTECS platforms.
The SQUIZZ.com Jiwa 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 Jiwa's underlying database stored in a Microsoft SQL Server instance. The web interface also allows credentials to be set up to limit how other software can talk to the addon Connector.
SQUIZZ.com Jiwa Addon Connector Web Service
The SQUIZZ.com Jiwa 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 from Jiwa. Within the SQUIZZ.com Connector software It's recommended to set up scheduled data exports, that call the addon connector to export data at off peak times, to reduce the load on the Microsoft SQL Server, as well as the computer running the addon connector software.
Product Customer Account Pricing Data Export
The SQUIZZ.com Jiwa Addon Connector contains pre-built configurations on how it obtains customer account product pricing data from the Jiwa system. It will do this by first retrieving all relevant data from ths Microsoft SQL Server database storing the Jiwa data, this includes the product list, customer accounts list (debtors), debtor classification rules, inventory classification rules, and group rules. It will then extrapolate out these rules to produce a final list of product prices specific to each customer account, or based the same group of customer accounts that have the same tailored pricing. Optionally the pricing can be also obtained from a separate second Jiwa installation, then combined together into one final pricing list. This pricing data is then exported in its final form from the addon connector.
Installation And Setup Steps
To install the SQUIZZ.com Jiwa 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 Jiwa Addon Connector Installation and Setup Steps:
- 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.
- 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.
- Once the installer has successfully completed, open up the web browser from step 1 and enter the URL http://localhost:8092/ui/login to access the addon connector's login page.
- Type the default user name: user and password: changeit into the login form fields and press the enter key.
- 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.
- 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.
- In the Settings page under the Jiwa Microsoft SQL Server Database 1 Settings section change each of the settings based on the Microsoft SQL Server that is hosting Jiwa's data. If you are unsure on these then contact Jiwa to determine how to obtain these settings for its system. If your organisation is running to separate instances of Jiwa's software then the Addon Connector can join the data from the separate instances. If this is required then under the Jiwa Database 2 Settings (optional) sections configure the settings for the 2nd Microsoft SQL Server database storing data of the second Jiwa system.
- Click on the Save button to immediately have the the changes occur when the next time the addon connector's data exports are run.
SQUIZZ.com Connector Configuration Steps
- Open up the SQUIZZ.com Connector application.
- WIthin the Adaptors and Messages tab, either create or use an existing Generic adaptor to handle running data exports that allow the SQUIZZ.com Jiwa Addon Connector software to have its data exports run.
- For the Generic adaptor click on the Settings button.
- From the Data Source Type drop down select the Ecommerce Standards Documents web service data source type, type a name such as "Jiwa ERP System", and click on the Create Data Source button.
- Within the Data Source Settings window set the Address/URL setting to localhost:8082/esd/
- Click on the save button
- Click on the Data Exports tab
- In the Data Export drop down select the Customer Account Product Pricing data export
- In the URL set the value data/price_customer_account_pricing
- Click on the save button
- Close the Generic Adaptor Settings window and for the adaptor the routines were created for click on the Exports/Routines button.
- Under the Data Exports tab tab and select the Customer Account Product Pricing data export to call the addon connector to export the product pricing data for customer acocunts.
- Click on the Run Once Off button.
- If the data export is successfully run and are correctly configured within the addon-connector then data should be exported to the selected Ecommerce System. If they don't successfully run then check that the addon-connector is running, has been correctly configured, and that the data source and data export within the Connector application are correctly configured. Common errors include incorrect spelling in URLs, incorrect address to the computer that the addon connector is installed on, order anti-virus or firewall software is blocking the Connector from making requests to the addon connector.
- It's recommended to set up the scheduling of these data exports from step 12 to run on a regular basis, such as daily or weekly. When scheduling data exports ensure that they run in the correct order and have enough time to finish before the next routine starts.
With the SQUIZZ.com Jiwa Addon Connector installed and configured, and a SQUIZZ.com Connector software configured to talk to the Jiwa Addon Connector, the configured Generic adaptor within the SQUIZZ.com Connector software can now run the data exports for the addon connector to communicate with the Jiwa system, to retrieve and export customer account product pricing data. The Connector's Generic adaptor can then be used to forward the exported data to the SQUIZZ.com or TOTECS platforms.
Application Settings
The following settings can be configured for the SQUIZZ.com Jiwa Addon Connector web service, controlling different aspects on how it runs, and how it communicates and retrieves data from the Jiwa API.
Setting | Data Type | Description |
---|---|---|
Connector Addon Web Service Settings | ||
Host URL | URL | Sets the URL that the addon connector runs from and is accessible from. It's reocmmended to leave it as http://localhost unless there is a need to run it from a specific IP address or domain (typically only for remote access). |
Listen On Port Number | NUMBER (0 to 65535) | Set the port number that the addon connector listens to incoming requests on. By default it is set to 8082. It is recommended to only change this number if a another piece of software is already running on the port number, or is a reserved port number, or there is more desirable port number to the software from. Changing this will require changes made to any saved bookmarks or other software that store URLs to the addon connector (such as the SQUIZZ.com Connector software). |
User Name | ANY CHARACTERS | Set the name of the user used to login to the user interface of the addon connector, as well as for software to talk to the addon connector via its web service. |
Password | ANY CHARACTERS | Set the name of the password used to login to the user interface of the addon connector, as well as for software to talk to the addon connector via its web service. |
Data Requests Require Authentication | YES,NO | If set to Yes then both users and software calling the addon connector will need to authenticate first before being able to access and use the addon connector. It's recommended to set this to Yes to restrict access to the addon connector. |
Log Date Format | DATETIME STRING | Set a .NET formatted date time string that specifies how dates shown in logs appear within the addon connector's console. |
Jiwa Microsoft SQL Server Database 1 Settings | ||
MS SQL Server 1 Host/Address | UNC PATH | IP address or UNC path to the computer hosting the Microsoft SQL Server database with the Jiwa system's data. The Host/Address also needs to include the name of the SQL Server instance, such as: 192.168.0.10/SQLEXPRESS ExampleSQLServee/COMPANYSQL |
MS SQL Server 1 Database Name | ANY CHARACTERS | Name of the database within the Microsoft SQL Server instance that is storing the data for the Jiwa system. This may be also be known as the schema name, or catalog name. |
MS SQL Server 1 User Name | ANY CHARACTERS | Name of the user within the Microsoft SQL Server instance that is used to connect to the Jiwa database having its data host. The user needs to have permissions to access Jiwa's database and read from its tables in SQL Server. |
MS SQL Server 1 User Password | ANY CHARACTERS | Password of the user within the Microsoft SQL Server instance that is used to connect to the Jiwa database having its data host. The user needs to have permissions to access Jiwa's database and read from its tables in SQL Server. |
Jiwa Microsoft SQL Server Database 1 Settings | ||
MS SQL Server 2 Host/Address | UNC PATH | IP address or UNC path to the computer hosting the Microsoft SQL Server database with the second separate instance Jiwa system's data. The Host/Address also needs to include the name of the SQL Server instance, such as: 192.168.0.10/SQLEXPRESS ExampleSQLServee/COMPANYSQL Leave this field empty to have the addon connector ignore looking to find data from a second Jiwa instance. |
MS SQL Server 2 Database Name | RELATIVE URL |
Name of the database within the Microsoft SQL Server instance that is storing the data for a second instance of a Jiwa system. This may be also be known as the schema name, or catalog name. This field is only required to be set if the MS SQL Server 2 Host/Address setting contains a value. |
MS SQL Server 2 User Name | ANY CHARACTERS |
Name of the user within the Microsoft SQL Server instance that is used to connect to a second instance of a Jiwa database having its data hosted. The user needs to have permissions to access Jiwa's database and read from its tables in SQL Server. This field is only required to be set if the MS SQL Server 2 Host/Address setting contains a value. |
MS SQL Server 2 User Password | ANY CHARACTERS |
Password of the user within the Microsoft SQL Server instance that is used to connect to a second instance of a Jiwa database having its data hosted. The user needs to have permissions to access Jiwa's database and read from its tables in SQL Server. This field is only required to be set if the MS SQL Server 2 Host/Address setting contains a value. |