Introduction
The software client will require a dedicated machine or virtual machine to run and must meet the minimum specifications listed in the Resource Requirements table below.
All network communication ports are identical to the physical collector and as such the IP address assigned to the client host machine must have these open.
Resource Requirements
Resource requirements for the host machine are listed below:
Item | Specification |
CPU | Min 2 @ 1.2GHZ, Recommended 4 @ 2.6GHZ |
RAM | Min 6GB, Recommended 4GB free memory above base OS requirements |
DISK | Min 128GB |
OS | 64Bit Windows 10 or Windows Server 2012 or later |
Feature | .Net 4.6 |
Installation
There are two software packages to be installed which combined comprise the VSM software client.
These two packages are:
- the Machine Proxy; and
- the Client Gateway.
These packages are available from Virsae or your Business Partner.
The packages can be accessed on the VSM Web Portal by navigating to Service Desk > Files and Folders > Shared with me > Virsae > VSM > VSM Software > Windows Client. Right-click the VSM Software Installer XXXX.zip file and download.
Extract the installation packages to the machine on which they are to be installed. You should see both a ClientGateway and MachineProxy folder.
Client Gateway
Open the Client Gateway folder that you have previously downloaded. Right-click setup and run as administrator.
The installer will open. Click Next to install the Client Gateway:
Check the install directory is satisfactory and then click Next:
Click Next:
Installation will proceed:
If you are presented with a User Account Control dialogue check it is for client Gateway.msi and if so click Yes:
During the installation the Virsae Setup Tool will appear and require some inputs:
Proxy Configuration (Optional)
The VSM Collector software can communicate via a proxy server if required. To setup a Proxy server, check 'Use Proxy', populate Address, Port and Username/Password if required. Then click 'Apply'.
Once complete move to the Customer/Location ID tab.
Customer/Location ID Configuration
There are three options to associate this installation with a customer:
The next sections detail each of these setup types. Select the one that is most appropriate for your implementation (default = One Time Code).
Claim One Time Code
Select the 'Customer/Location ID' tab, select 'Method' > One Time Code.
A One Time Code can be generated in the VSM Web Portal.
If you are a Business Partner right-click the customer and select Service Desk > Equipment Locations.
If you are the customer select Service Desk > Equipment Locations.
Right-click the appropriate location and select 'Generate Onetime Code'.
Copy and paste the code into the Virsae Setup and click 'Claim One Time Code'.
You will receive a message to state the setup has been successful, then click OK:
If this was successful move to - Region Configuration
Login
Select the 'Customer/Location ID' tab, you can then select 'Login with Virsae Credentials' from the 'Method' List, enter your VSM credentials then select 'Login'.
If you are the end customer, the Customer field and your first or only equipment location will already be populated. If you have multiple equipment locations administered, please select the appropriate location for this installation.
If you are the Business Partner select the appropriate customer and equipment location from the drop-down menus.
Once these have been selected, click 'Setup Customer/Location ID':
You will receive a message to state the setup has been successful. Click OK:
If this was successful move to - Region Configuration
Enter Customer/Location Id
Select the 'Enter Customer and Location Id' tab, select 'Method' > Enter Customer and Location ID.
The Customer Id and Location Id can be found on the VSM Web Portal.
If you are a Business Partner right-click the customer and select Service Desk > Equipment Locations.
If you are the customer select Service Desk > Equipment Locations.
Right-click the appropriate equipment location and select 'Export Location ID'.
Copy and paste the Customer ID and Location ID into the Virsae Setup and click 'Update Customer Location'.
You will receive a message to state the setup has been successful, then click OK:
If this was successful move to - Region Configuration
Region Configuration
The Virsae Application can process Customer data within 4 distinct regions - America, Canada, EMEA and APAC.
Select the Region the applies for your installation, the click 'Configure Region'.
Click 'Done'.
Client Gateway setup is complete. Click Close:
See Insufficient Privileges if there is an issue.
Insufficient Privileges
If you receive the following message, it is likely you didn't run the setup as an administrator:
Follow the steps below to complete the setup:
Close the Virsae Setup tool. You will also need to stop any Virsae services that are running.
To do so, right-click on the taskbar and select Task Manager:
The Task Manager will open. Select 'More Details':
Select the 'Services' tab:
Find any Virsae services that are running. Right-click each service and select 'Stop':
Wait until the service is Stopped:
After the Virsae services have been stopped, browse to the installation location of the Client Gateway (Default is C:\Program Files (x86)\Virsae Group\Client Gateway) and right-click on ADSVirsaeTool.exe and select Run as administrator.
If you receive a User Account Control Dialogue, check that it is regarding ADSVirsaeTool.exe and then click Yes:
Repeat the customer and location selection steps. If you still have issues, please contact your Business Partner or Virsae Support.
Machine Proxy Installation
Open the Machine Proxy folder that you have previously downloaded (see Installation) and double click the setup icon.
The software installer will open. Click Next to install the Machine Proxy:
Check the install directory is satisfactory and then click Next:
Click Next:
Installation will proceed:
Machine Proxy setup is complete. Click Close.
Check for Heartbeat
At this point the software client setup is complete. To ensure that the setup is working as expected, you can check the VSM Web portal for a heartbeat.
If you are a Business Partner right-click the customer and select Service Desk > Equipment Locations.
If you are the customer select Service Desk > Equipment Locations.
Click the expansion arrow on the left-hand side of the appropriate equipment location.
There should be a heartbeat showing next to your machine name. Note this may take 5 to 10 minutes after installation.
If there is no heartbeat after this time, then the outbound internet access may not be sufficient. Check your proxy/firewall rules have been implemented correctly otherwise contact Virsae Support.