Background
Virtual Facility (VF) integrates to both BAS and CMMS applications, using a middleware called the Data Pump. The Data Pump can be installed in cloud or within the client's IT environment. Many times BAS applications are installed locally and the IT organization restricts the network for those solutions to internal traffic. Because of this, the preferred choice for clients is often to have the Data Pump installed within their network so the integration traffic originates from within the network. To simplify installation and maintenance within a client network, Virtual Facility requires clients to install the Data Pump on a dedicated Virtual Machine (VM) that Virtual Facility Technical Team can remotely access.
This article outlines the requirements for Remote Access, Data Pump VM Specifications, and Application Access, so IT teams can prepare in advance for the implementation.
Remote Access
VF Technical Team will utilize a customer provided VPN connection to access the VM, BAS, and CMMS when they are hosted on the client network. Privileges required for each are outlined in the sections below. Virtual Facility will name four employees who will require VPN accounts. The Onboarding Engineer for your implementation will provide the named employee information.
Data Pump VM Specifications
VM Network Access
The following access is required for the Data Pump's Virtual Machine:
- Outbound port 443
- Network configuration/rules to permit traffic between the VM and the front-end servers and database servers for all BAS.
- Network configuration/rules to permit traffic between the VM and the front-end servers and API for all CMMS.
- Remote access for Virtual Facility Technical Staff to install and maintain the Data Pump.
VM Server
A single Data Pump installation can be shared by all integrations. The Data Pump is certified for installation on Windows and Linux. Backup of the Data Pump VM by the customer’s IT department is not a requirement. No alarm data is stored on the VM.
User Privileges
Local admin permissions on the VM for Virtual Facility staff to install and maintain the Data Pump.
Technical Specifications
Windows
Windows OS Versions Supported are:
- Windows 10 and up
- Windows Server 2016 and up
| Specification | Minimum* |
| RAM | ≥ 12Gb |
| CPU | 2 cores @ ≥ 2GHz |
| Disk Space | ≥ 10Gb (plus storage space for OS) |
Linux
Linux OS - no distribution limitations or minimum core version required
| Specification | Minimum* |
| RAM | ≥ 6Gb |
| CPU | 2 cores @ ≥ 2GHz |
| Disk Space | ≥ 5Gb (plus storage space for OS) |
*Actual VM specification will be determined once the final technical scope is agreed upon.
Application Access
BAS and Alarm Sources
The Virtual Facility solution does not make changes to BAS or other alarm sources. Because of this, all BAS and Alarm Source access can be ready only. Two types of access are needed:
- Virtual Facility (VF) Technical Team Access - for inspecting alarms during configuration and set up of the integration
- Integration Access - for reading alarm activity during operation; this may require special access to the API or database depending on the particular system
The VF Technical Team requires one account for each BAS or alarm source that all 4 designated team members can access. If the integration account supports concurrent user sessions, then a single account can be shared between the integration and the VF Technical Team.
The specific method of integration access (API, database, etc.) depends on the alarm source capability. See the article on BAS Integration Sources for more information.
CMMS
The Virtual Facility solution does need to be able to create work orders or service requests in the CMMS. Because of this, all CMMS access must be read/create/edit. Two types of access are needed:
- Virtual Facility (VF) Technical Team Access - for inspecting and creating work in the CMMS during configuration and set up of the integration
- Integration Access - for creating, reading, and updating (syncing) work details during operation
These two types of access will be needed for both test/dev (sandbox) and prod servers. Primary configuration and testing of the integration will be conducted in the test/dev (sandbox) environment, if available. A final round of abbreviated testing will be conducted in prod.
The VF Technical Team requires one account for each CMMS that all 4 designated team members can access.
The specific method of integration access for the CMMS will always be an API. See the article on Supported CMMS for more information.