ATM Data Capture Plug-In

Owned by Anand Rajaraman
Last updated: Jan 13, 2020
10 min read

Installation and Configuration

Prerequisites

In order to successfully install the ATM Data Capture Plug-in, you will need the following:

  • IP address of each ATM

  • IP address of ATM transaction server (if known, will improve plug-in performance)

  • ATM Data Capture Plug-in Package, sent by 3VR Orders (mail_orders) with the order confirmation email. Includes the following files:

    • ATM Data Capture plug-in file: Plugins.AtmDataCaptureTransaction-Release-1.0.0.xxxxx-7.0.3pg

    • Network troubleshooting file: NetworkCaptureSupport.3pa

  • A network hub, or, if the network switch is capable of port-mirroring, a mirrored port that will be connected to the VIP Appliance’s secondary NIC. See the network diagrams for more information.

  • A VIP Appliance with two network adapters (primary and secondary) is recommended. If you intend to install the plug-in on a VIP Appliance with only one NIC, see Appendix A.

Installation

Checking for Network Capture Support Tool

Prior to adding the plug-in to the appliance, you must install NetworkCaptureSupport.3pa (included in the plug-in download package) on the system if it is not already installed. This file is required for the plug-in to function.

Use the following steps to check whether NetworkCaptureSupport.3pa is currently installed:

  1. Launch 3VR System Manager.

  2. In the Configure tab, select the name of the VIP Appliance to view its settings.

  3. On the right-hand side of System Manager, click Common Operations, then click Installed Support Tools.

  4. In the Installed Support Tools window, check whether Network Traffic Capture Support appears in the list of tools. If it does, proceed to Installing ATM Data Capture Plug-in.

  5. Otherwise, continue to the next step to install it.

Installing Network Capture Support Package (If Necessary)

Use the following steps to install NetworkCaptureSupport.3pa:

  1. Click the Maintenance tab to go to the Maintenance panel.

  2. Click the Update Software tab.

  3. Check the box [√]next to the name of the appliance to select it.

  4. Click Inspect. Check the Status column to verify that the appliance is in a ready state:

    • “OK” is displayed if the system is operating normally and ready to be upgraded.

    • “Unauthorized” will be displayed if the current user is not authorized to install software on the selected server.

    • “Unreachable” will be displayed if the system is not in a state where it can be upgraded.

  5. Click Update.

  6. In the Choose 3VR Update File window, locate the Network Capture Support package file, named NetworkCaptureSupport.3pa:

    • If you are connected to the VIP Appliance with a laptop or over the network, navigate to the drive on your computer where you have saved the file. Click to select it.

    • If you are connected to the VIP Appliance with a monitor, mouse, and keyboard, browse to the USB drive or CD containing the file and click to select it.

  7. Click OK. System Manager will install Network Capture Support on the selected appliance(s). The Status column will show the status of the update as it progresses.

  8. When the update is complete, the Status column for each appliance will show “Done”.

  9. Return to the Installed Support Tools dialog as described in Network Traffic Capture Support topic and verify that Network Traffic Capture Support is now listed.

Installing ATM Data Capture Plug-in

  1. Launch 3VR System Manager.

  2. In the Configure panel, click the plus sign beside the appliance name.

  3. Right-click the Plug-ins folder and select Add Plug-in.

  4. In the resulting Confirm dialog box, click Install to proceed.

  5. Navigate to the folder containing the plug-in file (Plugins.ATMDataCapture-Release-1.0.0.xxxxx-7.0.3pg) and click to highlight the file.

  6. Click OK. The plug-in will now begin installing.

  7. When the plug-in is installed, it will appear below Plug-ins in System Manager.

Setting up the Network

Hub Setup

  1. Connect an Ethernet cable from the VIP Appliance’s primary network card to the network switch.

  2. Connect the ATMs to a hub.

  3. Connect the hub to the network switch.

  4. Connect an Ethernet cable from the VIP Appliance’s secondary network card to the hub.

Port Mirroring Setup

  1. Set up a port on the network switch that will mirror traffic from the ATM host.

  2. Connect an Ethernet cable from the VIP Appliance’s secondary network card to the mirrored port.

  3. Connect an Ethernet cable from the VIP Appliance’s primary network card to the network switch.

     

Binding Cameras to Plug-In

  1. Select the ATM Transaction Plugin.

  2. Select the Bound Cameras field and click the ... button.

  3. In the Bind Plug-in to Cameras dialog box, click the check box [√]beside each camera that should be associated with ATM transactions.

  4. Click OK to save your changes and return to the Configure panel.

A pop-up will be displayed notifying you that the 3VR system software must be restarted after making changes. Click OK to close the pop-up message and acknowledge the warning. You will restart software as the last configuration step.

Configuring Per-Camera Settings

  1. After binding cameras to the plug-in (step 3.2), links will appear under Bound Cameras for each camera.

  2. Click a link (for example Edit “1. ATM Camera”) to edit the settings for that camera.

  3. Type the IP address of the ATM in the ATM IP Address box.

  4. Type the ATM ID in the ATM ID box. This will be displayed on transaction events generated by the ATM in 3VR OpCenter.

  5. Click OK to save your changes and return to the Configure panel.

  6. Repeat steps 2 to 5 for any remaining cameras bound to the ATM Data Capture plug-in.

See Appendix B for assistance determining the ATM ID of an ATM.

If multiple ATMs are to be associated with a single camera, the ATM IP Address and ATM ID fields should contain the IP addresses and IDs of all of the ATMs, separated by a comma with no spaces. The values for each ATM should be placed in the same order.

For example, if ATM 1234A (IP address 10.100.2.1) and ATM 5678B (IP address 10.100.2.3) are both to be assigned to camera 1 in the plug-in configuration, the ATM ID for camera 1 should be set to “1234A,5678B” and the ATM IP Address should be set to “10.100.2.1,10.100.2.3”.

Finalize Configuration

Restarting System Software

The 3VR system software must be restarted after initially installing the plug-in or making any changes to its configuration.

  1. In the Configure panel, right-click the appliance name and select Restart 3VR Software.

  2. In the pop-up box that appears, click Restart to proceed. Wait 1-2 minutes for the software to restart.

Verifying Successful Configuration

To verify that the ATM Data Capture plug-in has been correctly configured, check for recent ATM Transaction events in 3VR OpCenter:

  1. In 3VR OpCenter, click the Monitor tab to go to the Monitor panel.

  2. Click camera numbers to select the cameras bound to the ATM Data Capture plug-in.

  3. Click the arrow below the camera selector to open the event type drop-down menu.

  4. Select [√]ATM Transaction and click OK.

  5. If the plug-in has been correctly configured, ATM Transaction events will appear in the Monitor panel as they occur in real-time.

Verify that ATM Transaction events are being generated correctly on all cameras bound to the plug-in during configuration.

Appendix A

Configuring Plug-In on a Single NIC Appliance

The ATM Data Capture Plug-in was designed for use with VIP Appliance models featuring two network adapters. However, a modified configuration may be used to install the plug-in on a system with a single network card.

Physical Setup

The VIP Appliance’s primary NIC is connected to the hub.

Plug-In Configuration

When setting the Selected Network Adapter field, (refer Binding Cameras to Plug-In) select Primary.

Appendix B

How to Identify ATM IDs

ATM IDs can be identified from the following sources:

  • ATM Receipts: The ATM ID is most frequently found immediately after the date and time of the transaction.

  • ATM diagnostic print out: if this feature is available on your ATM, the diagnostic printout may contain the ATM ID.

Appendix C

Trouble Shooting

If no transactions are being generated after configuring the transaction plug-in and sending test transactions from the ATMs, try these steps to help determine the problem.

  1. Launch System Manager.

  2. Click the plus sign beside the VIP Appliance name to display the list of configuration options.

  3. Select the ATM Transaction Plugin.

  4. Click Edit Settings.

  5. In the Edit Global Settings dialog, change the Network Troubleshooting Mode setting to On.

  6. Click OK to save your changes and return to the Configure panel.

  7. Generate test transactions with each configured ATM.

  8. Return to the global plug-in settings and change the Network Troubleshooting Mode setting to Off.

  9. Launch System Manager and go to the Maintenance panel.

  10. Click the Copy Logs tab.

  11. If you are logged in to a standalone VIP appliance, the Appliance field will show the appliance’s IP address and host name.
    If you are logged in to an Enterprise Appliance, select the system on the Enterprise from the Appliance drop-down menu.

  12. Click (•)By File.

  13. Select the files NWTroubleshooting-NetworkTraffic.txt and NWtroubleshooting-Autodetection.txt.

  14. Fill out the Customer Company Name field and enter any relevant information (technical support case number, contact information, installation date, etc.) in the Details box.

  15. Select (•)Save Logs to. Click the ... button and navigate to the folder where you wish to save the log files.

  16. To copy the log files to the selected folder, click Save Logs.

  17. The saved logs will be in a zip file named with the 3VR serial number. Unzip the folder and open NWTroubleshoting- Autodetection.txt. The text will look something like this:

  18. If ATMs and a transaction host are listed, use the IP addresses listed to reconfigure the bound cameras, restart the VIP Appliance, and generate test transactions again. If no ATMs are detected, proceed to step 19.

  19. Open NWTroubleshoting-networktraffic.txt in a text editor (such as Notepad).This file lists all the recent network traffic seen by the plug-in, and will look something like this:

  20. Use the Search function (Ctrl+F) to locate the transaction ID listed on the receipt from the test transaction.

    If the transaction is found, look at the Destination IP address of the network packet containing the transaction. Use that IP address to configure the bound camera.

Appendix D

Plug-In Customization

Customized transaction integration, such as using specific names, creating searchable fields and removing unwanted or secure information, can be developed by 3VR Professional Services for a one-time charge.

3VR Professional Services requires sample data in order to customize the ATM Data Capture plug-in for the particular needs of your customer. Use the following steps to gather sample data for plug-in customization.

  1. Launch System Manager.

  2. Click the plus sign beside the VIP Appliance name to display the list of configuration options.

  3. Select the ATM Transaction Plugin.

  4. Click Edit Settings.

  5. In the Edit Global Settings dialog, change the Transaction Data Logging setting to On.

  6. Click OK to save your changes and return to the Configuration Panel.

  7. Wait 24 hours before retrieving logs to ensure that sufficient data is recorded.

  8. Launch System Manager and go to the Maintenance panel.

  9. Click the Copy Logs tab.

  10. If you are logged in to a standalone VIP appliance, the Appliance field will show the appliance’s IP address and host name.
    If you are logged in to an Enterprise Appliance, select the system on the Enterprise from the Appliance drop-down menu.

  11. Click (•)By Date. Set the Start and End dates to cover the past 24 hours.

  12. In the Details section of the Copy Logs tab, type the Customer Company Name and type any relevant information (technical support case number, contact information, installation date, etc.) in the Details box.

  13. In the Destination section of the Copy Logs tab, choose a destination for the log files:

    • If you wish to upload the logs directly to 3VR Technical Support select Upload logs to 3VR, then click the Upload Logs button.
      The 3VR appliance must have a working internet connection with valid DNS settings configured in order to upload logs to 3VR.

    • To copy the files to your computer or a portable disk drive, select  Save logs to:

  14. Click the ... button and navigate to the folder where you wish to store the log files. When a location is selected, click the Save Logs button.

  15. The system will display a message confirming that the logs were copied/uploaded.
    Log files saved to a directory or drive will be located in a zip file named using the following format: [Appliance Serial Number]-[Date Logs Were Copied]-[Time Logs Were Copied].zip

  16. If you copied the logs to your computer or a USB drive, send the logs to 3VR using the following steps:

    • Open a web browser.

    • Go to https://uploadlogs.3vr.com/default.aspx

    • Click Choose File and select the exported log zip file

    • Enter the user name techrep, password 3MeDeee

    • Fill out the remaining details of the customer site

    • Click Upload. Make sure that you see the following message: “The file was successfully uploaded.”