Documentation for ATM Intellect 14.0. Documentation for other versions of ATM Intellect is available too.

Previous page Integration with the Gold crown  Transferring events from ATMs to the Intellect core Next page

When a firewall protection and access control system is in use a VPipe complex is used to organize a through channel between ATM-Intellect Pro and ATM-Intellect Workstation via ATM network resources.

The complex consist of two components:

  1. VPipe server. Installation file is in the ATM-Intellect installation kit at SoftForATM folder and is called VPipeSrv.exe
  2. VPipe client. Installation file is in the ATM-Intellect installation kit at SoftForATM folder and is called VPipeClient.exe

Installation files for VPipe complex are in the archive with intergation modules.

VPipe client is to be installed on the ATM. VPipe client is designed to create a communication channel between ATM-Intellect Pro and ATM-Intellect Workstation.

VPipe client operates as follows:

  1. At start, VPipe client automatically establishes a connection with the specified port of VPipe server and subsequently supports the connection in an operable mode.
  2. Establishes a connection with ATM-Intellect Workstation. Subsequently supports the channel in an operable mode.
  3. VPipe client transmits packages received from ATM-Intellect Pro (through VPipe Server) to ATM-Intellect Workstation, and from ATM-Intellect Workstation to ATM-Intellect Pro without changes.

VPipe Server is to be installed at the ATM-Intellect Pro. VPipe server is designed to receive packages from ATM-Intellect Pro and transmit them to ATM-Intellect Workstation, as well as to receive packages from ATM-Intellect Workstation and transmit them to ATM-Intellect Pro.

VPipe server operates as follows:

  1. At start, VPipe server opens a socket for ATM-Intellect Pro connection
  2. VPipe server opens a socket for VPipe client connection (ATM-Intellect Workstation).
  3. VPipe server transmits, without distortion, packages received from ATM-Intellect Pro into the VPipe client channel (ATM-Intellect Workstation) and back.

A connection is always initiated by VPipe client. At start, VPipe client establishes a connection with ATM-Intellect Workstation as well as with VPipe server (ATM-Intellect Pro). Connection between VPipe server and VPipe client is only possible when ATM-Intellect Pro, at its side, have established a connection to VPipe server.

VPipe complex is configured using Windows registry. The description of registry parameters required for configuring VPipe server and client is given below. It is also possible to set these parameters with the following files that can be found in an archive with integration modules:

  • VPipe_x86.reg for 32-bit OS
  • VPipe_x64.reg for 64-bit OS

VPipe client parameters description (registry section HKEY_LOCAL_MACHINE\SOFTWARE\BITSoft\VPipe\VPipeClient for 32-bit OS, HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\BITSoft\VPipe\VPipeClient for 64-bit) is given in the table.

Name

Type

Default value

Description

PortPDV

DWORD

7777

ATM-Intellect Workstation port to which VPipe client connects

PortLVOS

DWORD

8555

VPipe server port to which VPipe client connects

UsingDNSString0Defines wether the AddressPDV parameter sets an IP address or DNS name of ATM Intellect Workstation

AddressPDV

String


If the UsingDNS = "0",  the IP-address of ATM-Intellect Workstation is specified in the AddressPDV parameter
If the UsingDNS = "1", the DNS-name of ATM-Intellect Workstation is specified in the AddressPDV parameter

AddressLVOS

String


IP-address of VPipe server

TmoConnectPDV

DWORD

5

Interval in seconds between attempts to connect to ATM-Intellect Workstation

TmoConnectLVOS

DWORD

5

Interval in seconds between attempts to connect to ATM-Intellect Pro

FolderLog

String

C:\VPipeClient\

Folder for storing module log files

LogPeriod

DWORD

1

Period of storage of the module log files in months

ExtLog

DWORD

0

If it is necessary to store contents of forwarded packages in the log

TerminalID

String


TerminalID of the ATM where VPipe client is installed

TmoPassiveLVOS

DWORD

120

Allowed time of inactivity on the socket with ATM-IntellectPro (sec.)

TmoPassivePDV

DWORD

120

Allowed time of inactivity on the socket with ATM-Intellect Workstation (sec.)

TmoMonitorTimer

DWORD

120

Interval between attempts to send the monitoring package to ATM-Intellect Workstation (sec.)

VPipe server parameters description (registry section HKEY_LOCAL_MACHINE\SOFTWARE\BITSoft\VPipe\VPipeSrv for 32-bit OS, HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\BITSoft\VPipe\VPipeSrv for 64-bit) is given in the table.

Name

Type

Default value

Description

PortATM

DWORD

8555

ATM-Intellect Pro port to which VPipe client connects

PortLVOS

DWORD

7777

VPipe server port to which ATM-Intellect Pro connects

FolderLog

String

C:\VPipeSrv\

Folder for storing module log files

LogPeriod

DWORD

1

Period of storage of the module log files in months

ExtLog

DWORD

0

If it is necessary to store contents of forwarded packages in the log

RunAsServiceString0

0 – VPipe server does not start as a service.

1 – if the VRecover module has started, it will run the VPipe server.