This document describes how to install the Connector software onto your Windows Personal Computer(PC), Laptop or server.
Please make sure you have read through the Get Started/Overview before continuing down this document.
Also make sure you understand the concepts of:
- Microsoft Windows http://en.wikipedia.org/wiki/Microsoft_Windows
- A web browser, such as Firefox, Chrome, Internet Explorer, Safari http://en.wikipedia.org/wiki/Web_browser
- Windows Services http://en.wikipedia.org/wiki/Windows_service
- Windows Applications
- Windows users, and logging on as different users
Computer Minimum Requirements
- Computer with one of the operating systems: Windows 7, Windows 8, Windows 10, Windows Server 2008, Windows Small Business Server 2011, Windows Server 2012
- Microsoft Dot Net version 4.6.1 or higher
- 5 Gigabytes of free disk space
- 2 Gigabytes of memory
- 1Ghz CPU processor
- 32bit or 64bit Windows
Overview of Application Install
The Connector is broken up into two pieces of software.
- Connector Windows Service Host
- Connector Application
On a single machine the Connector WIndows Service Host can only be installed once. However the Connector Application can be installed for 0 to infinite Windows users.
The connector's Windows Service Host must be installed first. It gets installed as a windows service, and it handles all the data requests between your Accounting/Enterprise Resource Planning(ERP) system, and any external systems like the Squizz.com platform, or the TOTECS Ecommerce system.
Once the Windows Service Host has been installed, then for any given Windows user on your machine you can install the Connector Application. This application allows users to configure the Windows Service Host, as well as view message logs as the host is processing data. We recommend only installing the Connector Application for Windows users who would be in charge of your system's administration, or have a role requiring access to the connector. This is due to intricate nature of Accounting/ERP systems, processes, and the sensitivity of the data that goes through such systems.
Before you can install the Connector, your machine must have installed Micronet's .Net (pronounced Dot Net) version 4 software. Both the host and the application run on top of .Net and extensively use its available functionality.
Step 1: Check/Install .NET 4
- Go into Control Panel > Program and Features (or Add Remove Programs) and check to see if Microsoft .NET Framework 4.6.1 Extended or higher has been installed.
- Ensure that the Extended .NET application has been installed, not just the .NET Framework 4 Client Profile
- If you have .NET version 4.6.1 or higher installed on your machine then you do not need to worry about installing version 4.6.1.
- Install Microsoft .NET Framework 4.6.2 Extended on your machine if it hasn't been installed by opening a browser and going to https://www.microsoft.com/en-us/download/details.aspx?id=53344
- Download the installation file, and follow the prompts to install the software.
If you have Windows 2012 Server you may need to activate WCF Services to allow the connector's host service to talk to the connector application. To do so follow these steps (For all other Windows ignore these steps):
- Click on Start button, in the start bar enter Server Manager to start the manager.
- Scroll down to the Roles and Features section, click on the drop down icon then select Add Role or Feature option.
- In the Add Role or Feature Wizard, click to add a feature.
- Click on the Features label in the left hand menu.
- Expand the .Net Framework 4,0 Features node.
- Expand the WCF Services node.
- Ensure that the following items are selected:
- HTTP Activation
- Named Pipe Activation.
- Click on the Next Button, confirm the installation, then press the install button.
The connector's service host and the connector applications installed for each Windows user use the Named Pipe protocol in order to talk to each other. This protocol ensures that only users on the same Windows machine can interact with its Windows services.
Step 2: Install Squizz.com Connector Host
- Open a web browser, download the Connector Windows Service Host by entering the link https://www.squizz.com/applications/connector/ConnectorInstaller.msi
- If any errors stop allowing the installation to run then ensure that the correct .NET 4 version has been installed and that the Connector Service has not already been installed.
- Once the Connector Service Host has been installed it should be automatically running as a Windows Service, check this by looking at the Windows Services administration tool available through the Windows Control Panel.
Step 3: Install the Squizz.com Connector Application
- Install the Squizz.com Connector application by logging into Windows as the relevent user.
- Open a web browser, and enter the link https://www.squizz.com/applications/connector/connector-app.html
- Click on the install button. If any warnings appear accept the warnings.
- Follow the installation setup.
- Once the application has been installed run the application by clicking its icon in the start menu folder Squizz.com > "Squizz.com Connector"
- After the connector has loaded you will see a prompt asking you to locate the data directory of the connector, this is in C:\ProgramData\SquizzCom\Connector.
- Note that you may not be able to see these directories if your windows user isn't able to view hidden folders.
- Once the data directory has been found the application has now been installed and is ready to be configured.
The Connector application must be installed on the same Windows instance as the Connector Host. If this does not occur then the application will not be able to talk to the host and perform functions such as allowing users to manually import orders.
Step 4: Create an Adaptor for your Accounting/ERP system/Data Source
To create a new adaptor follow these steps:
- Open the Connector application by clicking on its icon in the desktop or within the Windows start menu.
- Within the application, under the Adaptors and Messages tab in the Adaptors panel, in the drop down select the accounting/ERP system that you wish to connect the adaptor to.
- In the Key field give the adaptor a unique value that no other adaptors have set.
- Click the Add button to create the adaptor. A row will be added to the adaptors the table below the button.
If your Accounting/ERP system is not in the adaptors drop down list then it means that the Connector does not specifically support it. In that case you may need to install the Generic adaptor, and set up connections to your system's underlying data store, or any files where you are storing your data. We would recommend getting in contact with a data specialist if you are unsure on how to configure the Generic adaptor to read or write data from your system/files, or else read the Generic Adaptor documentation linked below.
Below are are list of issues that you may encounter whilst trying to install the Connector Application or the Connector Host in your Windows operating system.
|Issue: After clicking the Install button to install Connector application, when running the setup file the installer immediately hides and the program does not install.|
On Windows Small Business Server 2011 we found that when trying to install the connector application the setup wizard would not run and the nothing would happen after the user tries to run the setup.exe file. For some later versions of Windows this issue may be caused by compatibility issues. To mitigate this you need to set the setup.exe to run in compatibility mode, and optionally run the setup.exe as an administrator user.
The installer will now run and and allow the the user to proceed through installation wizard.
|Issue: After clicking the Install button to install Connector application, when running the setup file the installer fails and an error dialog displays with the message "The installer has encountered an unexpected error installing this package. This may indicate a problem with this package. The error code is 2203.".|
When trying to install the Connector host service, during the setup wizard an error dialog would appear with the message "The installer has encountered an unexpected error installing this package. This may indicate a problem with this package. The error code is 2203.". After accepting the error dialog the install would then abort the installation process and the host application would not be installed. This error dialog can occur when 3rd party anti-virus software or any other software installed on the machine is blocking the installer wizard from completing.
For us this issue occurred when Trend Micro anti-virus software was installed and had its RealTime Scan service running. We stopped the RealTime scan service, which allowed us to install the Connector host service.
We also noticed that if we downloaded an ran the installer directly from Internet Explorer browser, that this error would also not come up.
|Issue: After clicking the Install button to install Connector application, when running the setup file the installer fails and an error dialog displays with the message "Error 1001. InstallUtilLib.dll: Unknown error.".|
When trying to install the Connector host service, during the setup wizard an error dialog would appear with the message "Error 1001 InstallUtilLib.dll.". After accepting the error dialog the install would then abort the installation process and the host application would not be installed.
This issue is most likely caused by the DotNet framework not being installed correctly in your Windows operating system, or otherwise that it hasn't been fully installed and requires a Windows restart to finish of the DotNet installation. If after a restart the error still occurs then the recommendation is to either download the DotNet framework again and install it, or otherwise uninstall the DotNet framework and install it again. If you decide to the use the second option be mindful that you could cause other software using the DotNet framework to no longer work correctly.
This issue was noticed in an Windows 2012 server installation.
|Issue: After clicking the Install button to install Connector application, when running the setup file the installer fails and an error dialog displays with the message "Error 1001. An Exception occurred in the OnAfterInstall event handler of System.ServiceProcess.ServiceInstaller --> Cannot start service SquizzConnectot on Computer".|
When trying to install the Connector host service, during the setup wizard an error dialog would appear with the message "Error 1001. An Exception occurred in the OnAfterInstall event handler of System.ServiceProcess.ServiceInstaller --> Cannot start service SquizzConnectot on Computer". After accepting the error dialog the install would then abort the installation process and the host application would not be installed.
This issue is most likely caused if you had previously uninstalled the Connect Host Service from Windows and immediately tried to install the Connector Host Service again. The error can indicate that Windows was still trying to stop and remove the service in the background, and was unable to complete this task before you tried to install a new version of the service in Windows. To solve this issue wait a minute or two then try to run the installation again.
|Issue:When the Connector Host Service starts a severe error message appears in the Connector logs: "HTTP could not register URL http://+:8050/. Your process does not have access rights to this namespace"|
After the Connecter Host Service is first installed or after the service is restarted, in the Connector's logs if a severe error is raised with the following error "HTTP could not register URL http://+:8050/. Your process does not have access rights to this namespace", this indicates that the Connector Host Service does not have permission by Windows to listen for incomming HTTP connections on port 8050 (or the specific port that you have configured the Connector to run on). This error will be raised by Windows User Access Control feature when the user trying to run the Connector Host Service ("System" user by default) does not have the required permissions to be able to listen on a port for incomming connections.
To solve this issue there are few options. You could run the Connector Host Service as a Windows user who does have elevated permission to listen to ports. Another option is
This command will add a Windows Access Control rule that will allow the Connector Host Service to listen on port 8050 when it is run as a system user.
If you wish to remove the access control rule then type the following command:
Connector Version Upgrade
On a periodic basic SQUIZZ.com will release a newer version of the Connector software. You can find out more information about these new releases by following the SQUIZZ.com Connector feed, as well as viewing the Version History page.
To update the Connector to the next version there are two things you need to do. Open the Connector Application and allow the application to be updated to the latest version. Then once done uninstall the older version of the Connector Windows Service Host, and install the newer version of it.
Below are are list of issues that you may encounter whilst trying to update the Connector Application or the Connector Host in your Windows operating system.
|Issue: After opening the Connector Application in its start window it displays the error: "Error occurred when updating connector database. Technical Error: Attempt to write a read-only database"|
Upon opening the Connector Application and choosing to install the latest version of it. After it has been installed and the start window displays, it remains open and in the message logs the error appears: Error occurred when updating connector database. Technical Error: Attempt to write a read-only database".
This error occurs when the Connector Application attempts to update the Connector's database to the latest version. and either the application does not have permission to write and make changes to the Connector's database, or another program has the Connector's database open and is blocking access to write to the database.
If the Connector Application does not have permission to write to the database it is because the Windows user that the Connector Application is running as does not have write permission set on the Connector's database file. To solve this the Windows user would need to have a permission set on the database file to allow the user to write and make changes to the file. Before doing this read about the Connector Security implications first before allowing these permission changes.
If the Connector Application was being blocked from updating its database due to another program already having the Connector database open, then you will need to find the application in Windows that contains the lock and either close the application. or end its process.