Actions

Difference between revisions of "AlphaNetServiceProvider"

From Zenitel Wiki

m (AlphaNetServiceProviderAppl)
m (AlphaNetServiceProviderService)
(2 intermediate revisions by the same user not shown)
Line 37: Line 37:
 
Choose a Server port number, which the clients must use in order to connect to the Service Provider. The clients then must connect to the port and IP-address of the Service Providers.
 
Choose a Server port number, which the clients must use in order to connect to the Service Provider. The clients then must connect to the port and IP-address of the Service Providers.
  
The “RunTime Config” is the maximum time elapsed for the receipt of a “Pong”-response to a “Ping” before the Service Provider detects client connection down.
+
The “Close Client On Ping Time” is the maximum time the Service Provider will wait for a “Pong”-response to a “Ping”. If there is no response the Service Provider will assume that the client connection is down and will close the connection to that client.
  
 
If the configuration is changed, push the “Save To File”-button to save the configuration data.
 
If the configuration is changed, push the “Save To File”-button to save the configuration data.
Line 86: Line 86:
 
The service can be tested using one of the two clients - Example.Stations or Example.Stations_Basic  - as previously described.
 
The service can be tested using one of the two clients - Example.Stations or Example.Stations_Basic  - as previously described.
  
'''Please Note!'''
+
'''Please note that the AlphaNetServiceProviderAppl and AlphaNetServiceProviderService cannot run simultaneously!'''
 
 
# The AlphaNetServiceProviderAppl and AlphaNetServiceProviderService cannot run simultaneously.
 
# The AlphaNetServiceProviderAppl and AlphaNetServiceProviderService use the same configuration. The configuration is handled in the AlphaNet DLL, which stores configuration files in "C:\Users\'''''"actual user"'''''\AppData\Roaming\STENTOFON\SDK". This directory cannot be accessed by the service – it will raise an exception – and therefore the config window in the application will also store a copy in "C:\ProgramData\STENTOFON\SDK Service Provider" to be used by the service. Depending on the permissions which are applicable while running AlphaNetServiceProviderAppl, the location "C:\ProgramData\STENTOFON\SDK Service Provider" may not be created and therefore the configuration file may not be available to AlphaNetServiceProviderService. Please check if the configuration file is available – otherwise make a copy manually.
 
  
 
[[Category:3rd party integration]]  
 
[[Category:3rd party integration]]  
 
[[Category:SDK]]
 
[[Category:SDK]]

Revision as of 13:12, 11 July 2019

AlphaCom icon 300px.png

Introduction

The AlphaNetServiceProvider is a software component, which makes it possible for more clients to connect to one of the two AlphaCom API ports simultaneously. The ports are named “OPC Server 1” and “OPC Server 2” in the AlphaCom. The ports are assigned the port numbers 61112 and 61113 respectively.


PC REMOTE DIRECT TCP.png

The AlphaNetServerProvider is shipped in two versions

  1. AlphaNetServerProviderAppl. The AlphaNetServiceProviderAppl is a Windows GUI application. The application is used for configuration and test of the AlphaNetService provider
  2. AlphaNetServerProviderService. The AlphaNetServerProviderService is a Windows service, which runs in the background without any user interface.

AlphaNetServiceProviderAppl

The AlphaNetServiceProviderAppl is distributed within the Windows installer package named VS-SDK for AlphaCom_Setup_Vx.x.x.x.msi.

The installation can be checked via Start->Control Panel->Programs and Features:


SDK Installation.png

The program package is installed in directory C:\Program Files (x86)\Vingtor Stentofon\VS-SDK for AlphaCom

The AlphaNetServiceProvider Application is mainly a configuration and test tools added to the SDK for easy deployment of the AlphaNetServiceProviderService. The application is started by double click on the AlphaNetServiceProviderAppl.exe

SDK Inst Folder.png

or via Start->All Programs->Vingtor Stentofon->Shortcut to AlphaNetServiceProvider.exe

SDK Start Shortcuts.png

After invocation push the “Config”-button to check or change configuration data:

ServiceApplConfigWindow.png

Enter the AlphaCom IP-address. Select the port number on the AlphaCom to be used. Legal values are 61112 or 61113.

Choose a Server port number, which the clients must use in order to connect to the Service Provider. The clients then must connect to the port and IP-address of the Service Providers.

The “Close Client On Ping Time” is the maximum time the Service Provider will wait for a “Pong”-response to a “Ping”. If there is no response the Service Provider will assume that the client connection is down and will close the connection to that client.

If the configuration is changed, push the “Save To File”-button to save the configuration data.

Press “Connect” to start connecting to the AlphaCom. After about 30 seconds the Service Provider has discovered all nodes and stations in the AlphaNet.

SerProviderApplConnect.png

Start one of the two test clients (Examples.Stations or Examples.Stations_Basic) from the SDK installation directory or shortcut in the Start Menu.

TestClientStart.png

Push the "Config"-button to check and change configuration data. The IP-Address and port number is the IP connection port to the AlphaNetService Provider. Remember to set check mark in "Remote Connection".

TestClientConfigWindow.png

Press the "Connect"-button and after about 30 seconds the discovered nodes and stations are displayed:

TestClientSelectStation.png


The established connection to the AlphaNetServiceProviderAppl is shown in the “Remote Clients” window:

ServiceProviderRemoteClientsWindow.png

AlphaNetServiceProviderService

The AlphaNetServiceProviderService is distributed as a Windows installer package named AlphaNetServiceProviderService_Setup_Vx.x.x.x.msi.

The installation can be verified via Start->Control Panel->Programs and Features:

ServiceInstallation.png

The service can be viewed in the list of installed service, which can be shown by pushing

Start->Control Panel->Administrative Tools->Services:

ServiceList.png

The properties of service can be viewed by right clicking the AlphaNetServiceProviderService and select “Properties”

Right after the installation the service will be in the stopped state, but can be started manually by pushing the “Start the service” option.

Via the “Properties”-window it is possible to select start up type Automatic, which means the service is started automatically at system start up.

ServiceProperties.png

The service can be tested using one of the two clients - Example.Stations or Example.Stations_Basic  - as previously described.

Please note that the AlphaNetServiceProviderAppl and AlphaNetServiceProviderService cannot run simultaneously!

MediaWiki spam blocked by CleanTalk.