How to Setup xPortal Communication Gateway (Polling Agent) Software

Summary

• To install the xPortal Communication Gateway software and allow the xPortal Communication Gateway software to communicate through the Windows Firewall.

• To configure the xPortalNet Server to communicate with xPortal Communication Gateway (Polling Agent).

• To configure the Network Setting on Controller in Web Diagnostic.

• To configure Connection setup in xPortalNet Server.

• To configure Controller setup in xPortalNet Server.

• To configure Door setup in xPortalNet Server.

• To monitor all statuses to ensure that xPortalNet software is able to communicate with the controllers via the Polling Agent (PC1).

.

.

Step-by-step Guide:

• To install the xPortal Communication Gateway software and allow the xPortal Communication Gateway software to communicate through the Windows Firewall:

Step 1: Install the xPortal Communication Gateway software by following the instructions provided in the installer file.

.
Step 2: Allow xPortal Communication Gateway to communicate through Windows Firewall:

i. Go to Control Panel > System and Security > Windows Firewall > Allowed apps.
ii. Click Change settings > Allow another app... > Browse for XPCommApp.exe file location. The file path is as follows:

iii. Click Add.

Figure 1: Allowed App Window

.
iv. Click OK to confirm and save changes.

.
Step 3: Please ensure that no other MicroEngine software instances are running in the same PC as the one to run the xPortal Communication Gateway software (PC1).

.
Step 4: Run the xPortal Communication Gateway software.

.
Step 5: Configure the TCP Port number and click OK. Default: TCP Port number 5000. (Users are recommended to leave it as default setting)

Figure 2: Configure TCP Port number at the Server Connection Window

.
Step 6: At the System Tray at the bottom of the window, right-click at xPortal Communication Gateway icon and select Agent.

Figure 3: Right-click xPortal Communication Gateway and Select Agent

.
Step 7: The following window will be shown:

Figure 4: The Polling Agent will Still be Unable to Communicate with xPortalNet software

.

.

.

• To configure the xPortalNet Server to communicate with xPortal Communication Gateway (Polling Agent):

Step 1: Run xPortalNet Service and open xPortalNet Server at xPortalNet server PC.

.

Step 2: Go to Server Admin > Communication Gateway.

.

Step 3: The Add Polling Agent window will be shown. Insert the relevant details into the respective fields according to the table that follows:

Figure 5: Add Polilng Agent Window in xPortalNet Server

.

.
Step 4: Click OK to save the changes.

.

.

• To configure the Network Setting on Controller in Web Diagnostic:

Step 1: Open web diagnostic > Configuration > Network. The following window will be shown:

Figure 6: The Network Tab in the Web Diagnostics

.

.

.
Step 2: Click Save Setting once users have edited the respective fields. The web diagnostic will be accessible only via the new controller IP Address.

.

.

• To configure the Connection Setup in xPortalNet Server:

Step 1: Go to xPortalNet Server > Server Admin > Connection Setup.

Figure 7: Add Connection window in xPortalNet Server

.
 

.

.
Step 2: Click OK to confirm and save changes.

.

.

• To configure Controller Setup in xPortalNet Server:

Step 1: Go to xPortalNet Server > Server Admin > System Device Setup > Controller.
 

Figure 8: Add Controller Window in xPortalNet Server

.
Step 2: Fill up the controller information accordingly.

.

Step 3: Click OK to confirm and save changes.

.

.

• To configure Door Setup in xPortalNet Server:

Step 1: Add new door. Go to xPortalNet Server > Server Admin › System Device Setup › Door.

Figure 9: Add Door Window
.
Step 2: Fill up the information accordingly.

.

Step 3: Click OK to confirm and save changes.

.

.

• To Monitor All Statuses:

Step 1: At xPortalNet Server main page, click on the Remote Communication Gateway tab. The Polling Agent status will be shown as UP.

Figure 10: The Polling Agent Status Shown in Remote Communication Gateway Tab

.
Step 2: At Device List tab, the Controller and Door status will also be shown as UP.

.
Step 3: At the Polling Agent PC, click Latest All Activities List tab. The transaction record will show the Communication Agent Start UP, while in the Device List tab, the Controller status will also be shown as UP. 

.

• Latest All Activities List
  

Figure 11: Latest All Activities List in Polling Agent

.

• Device List
  

Figure 12: Device List in Polling Agent

.
Step 4: Users can flash card at reader and verify that the transaction is shown at both xPortalNet Server and Polling Agent.

• xPortalNet Server
  

Figure 13: Latest Event List in xPortalNet Server

.

• Polling Agent
  
  Figure 14: Latest All Activities List in Polling Agent

.

Step 5: Finished.