This article Applies to:
CVI Fusion -- | Infinity Client -- | Infinity Module -- | Core Services -- | DeMeter -- | CVI Net Web 3.9.0.5 |
Introduction
The following guide is designed to give instructions on how install the CVI Net Web Service as well as defining any requirements that it may need.
Contents3.1 CVI Net (Collector) Service Installation 3.2 CVI Net Web (Viewer) Service Installation |
Requirements
The prerequisites for the CVI Net Web Service are defined below:
- Installation Minimum Requirements - Service requirements needed in order to the service to install and start correctly
- Running Minimum Requirements - Service requirement needed in order to function and be configured correctly after being installed
Installation Requirements
Details | |
| Supported Desktop Operating Systems Supported Server Operating Systems Minimum Processor Speed Minimum Memory (RAM) Minimum Available Disk Space Minimum Installed .NET Framework Version Installed Java Environment | Windows XP Windows 7 Windows 8.1 Windows 10 Windows Server 2003 Windows Server 2008 R2 Windows Server 2012 1.6 GHz 4 GB 500 MB 3.5 Java JRE 7 Java JRE 8 |
Running Requirements
Details | |
| Required Open Network Ports Compatible Database Servers | 4848, 8080, 8081, 8686, 3700, 3820, 3920, 22, 9009, 6666, 7676, 9090, 9200 See compatible Microsoft SQL Server Versions See compatible MySQL Server Versions |
Database Installation
Database Set-up
Before beginning the set-up for CVI Net Web, it is important to know what type of database server will be used by the CVI Net (collector) service to store tightening traceability. Depending on which server type you are using will define which installation to follow and the configuration required for the service.
It also required that the server type you will be using with the CVI Net Web platform is already installed on your server machine and that sufficient rights are being used throughout the set-up process. If you are not operating the server machine locally you will also need to have a suitable network configuration and connection throughout the operations.
Microsoft SQL Server
Microsoft SQL Server is a relational database management system developed by Microsoft that can be used to store and manage tightening traceability recorded by the CVI Net (collector) service. Before beginning the set-up process below it is expected that a compatible version of Microsoft SQL Server and Microsoft SQL Server Management Studio have been installed and configured with adequate permissions available to be used. Please see all compatible Microsoft SQL Server versions below.
Applicable Versions | |
| Compatible Microsoft Server Versions | Microsoft SQL Server 2005 Microsoft SQL Server 2008 Microsoft SQL Server 2012 Microsoft SQL Server 2014 Microsoft SQL Server 2016 Microsoft SQL Server 2017 |
Once a suitable version of a Microsoft SQL Server and management studio have been installed you can follow the instructions below to set-up the correct database and configure the CVI Net Web platform.
SQL Server Services Configuration
- Open SQL Server Configuration Manager
 | If you are struggling to find SQL Server Configuration Manager then you can use the 'Run' Command to open it. Open the Start Menu and type 'Run'. In the Run command window, you can type 'SQLServerManager<version>.msc' and hit Enter. Replace <version> to match your required SQL version seen here:
|
- Click SQL Server Services, ensure that the SQL Server service and SQL Browser service for your used server are Running. If they are not running, right-click and click Start
- Open SQL Server Network Configuration and choose your used server.
- Ensure that TCP/IP is enabled
- Right-click on 'TCP/IP' and choose 'Properties'
- Navigate to 'IP Addresses'
- Scroll to the bottom and take note of the Dynamic Port number
Database Creation
- Launch SQL Server Management Studio
- Define or choose your required server/instance and log in
- In the Object Explorer, right-click on 'Databases' and choose 'New Database...'
- Enter the name of your desired database and click 'OK
- You should see your database now available in the object explorer
Server Connection
- In the Object Explorer, right-click on the server and choose 'Properties'
- Navigate to Security and ensure that 'SQL Server and Windows Authentication Mode' is selected. Click on OK.
Creating a Dedicated SQL Authenticated User
- In the Object Explorer, expand the 'Security' branch, right-click 'Security' and choose 'New Login..'.
- Define a login name and a password
- Disable password policy
- Navigate to 'Security', map user to your database and assign the 'db_owner' role.
- Click 'OK'. You should see your user inside of the logins branch
Creating Database Tables
- Click on the 'Open File' button in the toolbar.
- Select the SQL script 'SQLServer_Ind--.sql' applicable to your version
 | When adding the tables to your database, you must use the correct 'Ind' version to ensure that the schema version of the database is compatible with the verson of CVI Net Web you intend to use. See here for information about database version compatibility in CVI Net Web |
- After selecting the correct SQL file it should be open in a query like seen here
- Ensure the target is set to your desired database
- Ensure your cursor is before line 1 of the query and click the 'Parse' button on the toolbar or press Ctrl+F5 to validate the query
- The Results pane should show "Command(s) completed successfully."
- Click the 'Execute' button on the toolbar or press F5 to run the query
- The Results pane should show multiple results all stating "1 row(s) affected."
- If you have no errors in this window then your tables should have been created successfully
- If you see any errors in this window -
- then screenshot them and contact support.
- After creating your tables, you can check they have successfully been created by right-clicking on your database inside of the Object Explorer, clicking 'Refresh' and expanding to see your tables.
ODBC Link
Open ODBC data sources, you can do this by typing ODBC into the Start Menu or finding it directly on the C drive. The file location will depend on whether your machine is using and 32 or 64 bit processor.
- 32 bit = C:\Windows\System32\odbcad32.exe
- 64 bit = C:\Windows\SysWOW64\odbcad32.exe
- In the 'System Data Sources' tab, click on Add
- Select the SQL Server Data Source
- Name the Data Source "cvinet_sqlserver"
- Choose the SQL Server/Instance where you have created your database
- Click Next
- Select 'SQL Server Authentication'
- Define the username and password that you set when creating your CVI Net Web database
- Click Next
- If your credential supplied were correct then you will see the below screen, otherwise you will see error messages reading that the login could not be achieved.
| In the event of seeing error message regarding login, please consult the server administrator |
- On the below menu, define the default database for the data source as your CVI Net Web database
- Click Next
- Click Finish
- You will see that a new windows appears asking to test the data source, click ' Test the Data Source...'
If all is configured correctly in your SQL Server instance to allow for remote connection then you should see that the test succeeds like below
| In the event of seeing error message regarding login, please consult the server administrator |
MySQL Server
MySQL is an Open Source database management system that can be used to store and manage tightening traceability recorded by the CVI Net Web service. Before beginning the set-up process below it is expected that a compatible version of MySQL Server and MySQL Workbench have been installed and configured with adequate permission available. Please see all compatible versions below:
Applicable Versions | |
| Compatible MySQL Server Versions Compatible MySQL Workbench Versions | MySQL 5.5 MySQL 5.6 MySQL 6 MySQL Workbench 6.2 CE |
Once a suitable version of a MySQL Server and workbench have been installed you can follow the instructions below to set-up the correct database and configure the CVI Net Web Service.
Server Connection
- Launch MySQL Workbench
- Click on your desired instance and log in
- After successfully logging into the instance, click 'Database' at the top of the window and then select 'Manage Connections'.
- With the 'Manage Server Connections' window open, click on the 'SSL' tab. Ensure that the property 'Use SSL' is set to No.
- Click on 'Test Connection' and verify that you can successfully connect to the server instance and that SSL is not enabled. You should the following dialog message.
Database Creation
- Click on the 'Create Schema' icon in the toolbar
- Define a name for your schema and then click 'Apply'.
- With the 'Apply SQL Script to Database' window open, click 'Apply'
- Click 'Finish'.
| If you look at your Navigator menu, you should see your schema has been created and is now available in your instance. |
Creating a Dedicated MySQL Account
- In the navigator menu, select 'Users and Privileges'
- Select 'Add Account'
- Define your account's login details
- Go to 'Schema Privileges' tab and click 'Add Entry...'
- With the 'New Schema Privilege Definition' window open, click 'Selected Schema', your CVI Net Web database and then click on 'OK'.
- Click 'Select "ALL"' to give all rights to your dedicated user
- Click 'Apply'
Creating Database Tables
- In the navigator menu, double-click your database inside the Schemas sub-menu
- Click 'File' at the top of the window and then choose 'Open SQL Script'
- Select the SQL script 'MySQL_Ind--.sql' applicable to your version
| When adding the tables to your database, you must use the correct 'Ind' version to ensure that the schema version of the database is compatible with the verson of CVI Net Web you intend to use. See here for information about database version compatibility in CVI Net Web |
- After selecting the correct SQL file it should be open in a query like seen here
- Click on the 'Execute Query' icon in the toolbar
- Check the output window to check all tables were created correctly
- If you have no errors in this window then your table should have been created successfully
- If you see any errors in this window-
- then screenshot them and contact support.
- After creating your tables, you can check them by right-clicking on your database inside of the Schemas submenu and expanding the 'Tables' branch
- You're database should now be successfully set-up to be used by the CVI Net Web service.
Software Installation
CVI Net (Collector) Service Installation
- Download the latest version of the CVI Net Service here
- Once downloaded, double-click the installer to run it.
| The naming of the CVI Net Service is "CVINet_3.x.x.x_setup.exe" |
- It should like seen below; click 'Next'
- Click 'No, I don't want to install Oracle Instant Client'. Click 'Next'.
| Oracle is no longer supported. Please contact support if require the use of an Oracle database |
- Define your installation directory for the CVI Net Service. Click 'Next'
- Define whether or not your would like to shortcuts created in your start menu and on your desktop. Click 'Next'
- Click 'Install'
- Click 'Finish'
CVI Net Web (Viewer) Service Installation
- Download the latest version of the Web Service here
- Once downloaded, double-click the installer to run it.
| The naming of the Web Service is "CVINetWeb_3.x.x.x.exe" |
- It should like seen below. Define your installation directory for the Web Service and then click 'Next'.
- Define the type of database you using with your viewer.
| Oracle is no longer supported. Please contact support if require the use of an Oracle database |
- Fill the properties presented in order to access your database and then click 'Next'
| If you are unsure about what these properties refer to then, please consult your server administrator or contact support for more guidance |
- If the properties are correctly entered and the connection is successful you will see the folllowing:
- Click 'Install'
- After the installation has finished click on 'Finish'.
CVI Notifier Installation
- Download the latest version of the Web Service here
- Once downloaded, double-click the installer to run it.
| The naming of the Notifier Service is "CVINet_Notifier_3.x.x.x_setup.exe" |
- It should like seen below. Click 'Next'.
- Define your installation directory and then click 'Next'
- Define whether or not your would like to shortcuts created in your start menu and on your desktop. Click 'Next'
- Click 'Install'
- The Notifier Service is now installed. Click 'Finish'
Software Licensing
CVI Net Web is licensed on a "per connection" basis. This means that you must have licenses with a total number of connections greater than the number of connected controllers.
To find out how to activate and register your license(s), click here.