# Quick Start Getting started with VAULT. ### What is VAULT? Introducing RoamingiQ’s flagship platform, VAULT—a Software as a Service (SaaS) solution thoughtfully designed for seamless user management and Wi-Fi authentication. VAULT is not just a web portal; it’s a fully customizable platform empowering users with effortless network access and management. VAULT simplifies the onboarding process by enrolling users onto the network while configuring essential network policies such as subscriber bandwidth. Moreover, it offers subscriber’s intuitive control over their Wi-Fi accounts and passwords via an incredibly friendly web portal, ensuring convenience at every step. With VAULT’s Patented external pre-shared key (PSK) authenticator, VAULT transcends geographical boundaries, enabling global Wi-Fi roaming. Upon integration, all pre-shared keys are securely stored within the VAULT cloud, granting instant access to VAULT-enabled networks worldwide. ### Getting Started There are two ways to use the VAULT platform: 1. VAULT APIs: VAULT is fully API-driven, allowing development teams to integrate their user interface with VAULT. See [Developers](/developers/api-documentation) for more details. 2. VAULT's User Interface: VAULT provides a white-label user interface for network operators to manage their subscribers, process payments (if desired), and more. The VAULT user interface has three layers of access, providing different views based on the user role. See[ Network Administrator Console](/network-administrator-console/network-administrator-console-introduction), [Venue Administrator Console](/venue-administrator-console/venue-administrator-console-introduction), and [Subscriber Console](/subscriber-console/subscriber-console-introduction) for more details. # Knowledge Base This page describes how to use the Knowledge Base. This Knowledge Base offers comprehensive insights into VAULT's operations, user interaction, and behind-the-scenes processes and business rules. Our Knowledge Base is ever-expanding and evolving. If you cannot locate the information you seek, please [contact RoamingiQ](/getting-started/contact-roamingiq). # Contact RoamingiQ This page describes how to contact RoamingiQ. ### Technical Support For technical support, e-mail . ### Sales For sales inquiries, e-mail . # New Customer Onboarding This page describes the onboarding process for new VAULT customers. Congratulations on choosing VAULT! We're excited to have you join our expanding community of valued customers. To get your environment set up smoothly, we'll need to coordinate some essential details together. Your dedicated VAULT Account Manager will guide you through this process. ### Information We Need From You To create your custom environment, please gather the following required information. #### Required For All Customers 1. Basic Business Information 1. Operator Business Name 2. Address Line 1 3. Address Line 2 4. City 5. State 6. Country 7. Postal Code 8. Primary Contact First Name 9. Primary Contact Last Name 10. Primary Contact Phone Number 11. Primary Contact E-mail Address 12. Support Phone Number 13. Support E-mail Address 2. A List of Initial [Network Administrators](/network-administrator-console/network-operator-settings/network-administrators) #### Required For User Interface Customers 1. Branding Guidelines 1. Brand Standards Documentation 2. Primary Color 3. Transparent PNG Logos for Light Mode 4. Transparent PNG Logos for Dark Mode 5. Favicon 2. [Terms and Conditions](/network-administrator-console/network-operator-settings/terms-and-conditions) - These are the terms and conditions your customers will agree to during sign-up. Once we receive the above information, the VAULT team will create your custom environment. Upon completion, your environment can be deployed; however, we recommend proceeding through the next steps as soon as possible. ### Advanced Configuration 1. Custom URL/DNS setup for wifi.customer.com 1. Once you provide us with your desired URL, we will provide an SSL certificate validation, DKIM validation, and UI entry. You'll need to enter these values into your DNS. 2. Custom e-mail server setup. This is the E-mail address from which users will receive service-based communications. The emails will be built in our [E-mail Templates](/network-administrator-console/network-operator-settings/e-mail-templates) section. 1. Once you provide us with your desired e-mail address we will provide DKIM entries for your DNS. ### Other Information For network operators who intend to take advantage of [SMS Sign Up](/network-administrator-console/sms-sign-up) or the [Shopping Cart](/network-administrator-console/network-operator-settings/shopping-cart), the RoamingiQ team will need to take additional steps to set up SMS features. This process can take up to 30 days due to submissions and approvals required to AWS. Please note, this process cannot start until the Advanced Configuration Steps above are complete. That's it! Now, you can proceed to [Network Operator Settings](/network-administrator-console/network-operator-settings) to complete the setup of your environment.
# System Status and Notifications This page describes where to find system status and receive notifications for VAULT. RoamingiQ maintains a public status page where you can view real-time system health and any ongoing or past incidents. This page contains all data from June 1, 2025 onward. This is the primary place to check during an issue before contacting support. ### How and When To Use the Status Page You can view real-time system status, active incidents, and historical incident reports at The status page should be your first stop when investigating an issue. It provides: * Current system status across core services * Active incidents and ongoing updates * Historical incidents and resolution timelines If there is a broader system issue, it will be reflected on the status page. If you do not see your issue listed, you can continue troubleshooting using other Knowledge Base articles or contact support through the normal channels. ### How To Receive Incident Notifications You can subscribe to receive notifications when incidents are created, updated, or resolved. VAULT Administrators will not be automatically added to this notification list. To unsubscribe, click the unsubscribe link at the bottom of any incident notification e-mail or the confirmation e-mail you received after subscribing. You can also reach out to to unsubscribe any user. #### Important recommendation We do not recommend that individual users subscribe directly to incident notifications. Instead, we strongly recommend that each customer: * Create an internal distribution list (email), and/or * Use an internal channel (such as Microsoft Teams or Slack) Then: * Subscribe that single email address or channel to the status page #### Benefits * Employees can be added or removed internally without needing to manage subscriptions in an external service. * Notifications stay consistent even as teams change. * Avoids duplicate or stale subscriptions over time. * Keeps your organization’s alerting clean and controlled. * RoamingiQ makes no assumptions about who should or should not receive these notifications, putting it in our customer's control. For example: * `support@yourcompany.com` * `noc@yourcompany.com` * A Teams or Slack channel integration Because subscriptions should be tied to a shared distribution or channel, please work with your internal administrators to ask if your company already has a distribution list subscribed, before subscribing to alert notifications. #### I Am Already a Network Admin or SIEM Admin, Will I Receive Notifications? We have learned from customer feedback that assuming your Network Admin list and Notification list are the same, is incorrect. As a result, we are running this notification system separate from our [admin roles](/network-administrator-console/network-operator-settings/network-administrators). Although this requires an additional step to subscribe, it puts total control in your hands for who receives widespread system alerts. If your organization wants SIEM Administrators auto-subscribed, you can simply create an internal distribution list and enroll that e-mail address and a [SIEM Administrator](/network-administrator-console/network-operator-settings/network-administrators#network-administrator-roles) and subscribe it to this status page. # Supported Access Points Here is a list of VAULT's supported access point manufacturers. * Ruckus * Cambium * TP-Link Omada Pro * HPE Aruba * Cisco Meraki * Alta Labs * Juniper Mist (configuration guide underway) * Engenius (configuration guide underway) * TIP Open Wi-Fi (configuration guide underway) If an access point manufacturer you want to see supported is not listed, please contact your VAULT Account Manager to discuss support. # Access Point Configuration Guides The following guides will help you configure access points to work with VAULT. Each access point manufacturer has unique configuration requirements to support VAULT. These guides walk through the configuration to apply on your controller. If you are looking for how to add a controller to VAULT, [click here.](/network-administrator-console/creating-a-new-venue/add-equipment-to-a-venue) # What You'll Need Here is a list of what you will need to complete your access point configuration. The following elements were provided to you by RoamingiQ during your Network Operator onboarding. If you do not have a record of these items, please contact your VAULT Account Manager * IP Address * Port * Shared Secret * Confirm Secret The following element is unique to each Venue and may be found in the [Venue Details](/network-administrator-console/managing-your-venues/view-and-modify-venue-details) page after creating a new Venue in VAULT. * NAS-ID # Ruckus Virtual Smart Zone 5.4 Here is a step-by-step guide on how to configure Ruckus Virtual Smart Zone 5.4 to work with VAULT. ### **Configuration Steps Overview** 1. Configure AAA Authentication Server 2. Configure AAA Accounting Server 3. Configure WLAN 4. Configure NAS-Identifier ### **Configure AAA Authentication Server** 1. Click Services & Profiles 2. Click Authentication 3. Click Proxy (SZ Authenticator) 4. Click +Create ![](/files/lRyETDqqqHrrCVF0XMFO) 1. Enter the following information * Name: VAULT-AUTH * Service Protocol: RADIUS * Primary Server * IP Address: xx.xx.xx.x * Port: xxxx * Shared Secret: XXXXXXX * Confirm Secret: XXXXXXX * Secondary Server * IP Address: xx.xx.xx.x * Port: xxxx * Shared Secret: XXXXXXX * Confirm Secret: XXXXXXX * Response Window: 20 Seconds * Zombie Period: 40 Seconds * Revive Interval: 60 Seconds * No Response Fail: No * Maximum Outstanding Requests (MOR): 0 Requests per Server * All other fields should be default ![](/files/jRWnmnqNJlReLvI29pNR) ### **Configure AAA Accounting Server** 1. Click Services & Profiles 2. Click Accounting 3. Click Proxy 4. Click +Create ![](/files/K1hdF6ua6Pqzey4mGaxo) 1. Enter the following information * Name: VAULT-ACCT * Service Protocol: RADIUS Accounting * Primary Server * IP Address: xx.xx.xx.x * Port: xxxx * Shared Secret: XXXXXXX * Confirm Secret: XXXXXXX * Secondary Server \* * IP Address: xx.xx.xx.x * Port: xxxx * Shared Secret: XXXXXXX * Confirm Secret: XXXXXXX * Response Window: 20 Seconds * Zombie Period: 40 Seconds * Revive Interval: 120 Seconds * Maximum Outstanding Requests (MOR): 0 Requests per server * All other fields should be default ![](/files/T9uFMHcR0T1T0nmDCgq6) ### **Configure WLAN** 1. Click Wireless LANs 2. Select the Zone in which you wish to create the SSID 3. Select the Group in which you want to create the SSID 4. Click Create 5. Enter the following Information * Name: VAULT * SSID: VAULT * Authentication Options * Authentication Type: Standard Usage * Method: Open * Encryption Options * Method WPA2 * Algorithm: AES * 802.11w MFP: Disabled * Dynamic PSK: External * Authentication & Accounting Service * Authentication Service: ON Use the controller as proxy * Select VAULT-AUTH * Accounting Service: ON Use the controller as proxy * Send Interim Update every 30 Minutes * Options * Wireless Client Isolation: Set as needed for venue * RADIUS Options * NAS ID: User-Defined: \ * NAS Request Timeout: 20 Seconds * NAS Max Number Retries: 2 Times * NAS Reconnect Primary: 5 Minutes * Called Station ID: AP MAC * NAS IP: User-Defined: \ * Single Session ID Accounting: Off * Vendor Specific Attribute Profile: Disabled * Advanced Options * Access VLAN * VLAN ID: Set as appropriate for Venue * Enable Dynamic VLAN (AAA Override) - Set as appropriate for Venue * All other fields can be default or set as appropriate for Venue ![](/files/Z1WoLR52uHvXMmXgpMAo) # Ruckus Virtual Smart Zone 6.1 Here is a step-by-step guide on how to configure Ruckus Virtual Smart Zone 6.1 to work with VAULT. ### **Configuration Steps Overview** 1. Configure AAA Authentication Server 2. Configure AAA Accounting Server 3. Configure WLAN ### **Configure AAA Authentication Server** 1. Click Security 2. Click Authentication -> 3. Click Proxy (SZ Authenticator) 4. Click +Create ![](/files/C6eIqcNldGMLpITKDpa3) 5. Enter the following information * Name: VAULT-AUTH * Service Protocol: RADIUS * Primary Server * IP Address: xx.xx.xx.x * Port: xxxx * Shared Secret: XXXXXXX * Confirm Secret: XXXXXXX * Secondary Server * IP Address: xx.xx.xx.x * Port: xxxx * Shared Secret: XXXXXXX * Confirm Secret: XXXXXXX * Response Window: 20 Seconds * Zombie Period: 40 Seconds * Revive Interval: 60 Seconds * No Response Fail: No * Maximum Outstanding Requests (MOR): 0 Requests per Server * All other fields should be default ![](/files/pZ5usZ0Dy222nXxCBtdf) ### **Configure AAA Accounting Server** 1. Click Security 2. Click Accounting 3. Click Proxy ![](/files/N6ipc2A0hpyxiwboE5R5) 1. Click +Create 2. Enter the following information * Name: VAULT-ACCT * Service Protocol: RADIUS Accounting * Primary Server * IP Address: xx.xx.xx.x * Port: xxxx * Shared Secret: XXXXXXX * Confirm Secret: XXXXXXX * Secondary Server * Enable Secondary Server: ON * IP Address: xx.xx.xx.x * Port: xxxx * Shared Secret: XXXXXXX * Confirm Secret: XXXXXXX * Response Window: 20 Seconds * Zombie Period: 40 Seconds * Revive Interval: 120 Seconds * Maximum Outstanding Requests (MOR): 0 Requests per server * All other fields should be default ![](/files/RXjyPhmzssJS9cL6NvWx) ### **Configure WLAN** 1. Click Network 2. Click Wireless LANs 3. Select the Zone in which you wish to create the SSID 4. Select the Group in which you want to create the SSID 5. Click Create 6. Enter the following Information * Name: VAULT * SSID: VAULT * Authentication Options * Authentication Type: Standard Usage * Method: Open * Encryption Options * Method WPA2 * Algorithm: AES * 802.11w MFP: Disabled * Dynamic PSK: External * Authentication & Accounting Service * Authentication Service: ON Use the controller as proxy * Select VAULT-AUTH * Accounting Service: ON Use the controller as proxy * Send Interim Update every 30 Minutes * Options * Wireless Client Isolation: Set as needed for venue * RADIUS Options * NAS ID: User-Defined: \ * NAS Request Timeout: 20 Seconds * NAS Max Number Retries: 2 Times * NAS Reconnect Primary: 5 Minutes * Called Station ID: AP MAC * NAS IP: User-Defined: \ * Single Session ID Accounting: Off * Vendor Specific Attribute Profile: Disabled * Advanced Options * Access VLAN * VLAN ID: Set as appropriate for Venue * Enable Dynamic VLAN (AAA Override) - Set as appropriate for Venue * All other fields can be default or set as appropriate for Venue ![](/files/M4Zr8uvC3IynJF2VFLHd) # Ruckus One Here is a step-by-step guide on how to configure Ruckus One to work with VAULT. ### **Important Note** This guide is for traditional RADIUS based authentication. For DPSK3 support, please refer to the [Ruckus R1 DPSK3](/network-administrator-console/network-operator-settings/ruckus-r1-dpsk3) guide. ### **Configuration Steps Overview** 1. Configure AAA Authentication Server 2. Configure AAA Accounting Server 3. Configure WLAN ### **Configure AAA Authentication Server** 1. Click on Network Control 2. Click on Policies and Profiles 3. Click RADIUS Server 4. Click Add RADIUS Server
5. Enter the following information 1. Profile Name: VAULT-AUTH 2. Type: Authentication RADIUS Server 3. Primary Server 1. IP Address: xx.xx.xx.x 2. Port: xxx 3. Shared Secret: XXXXXXX 4. Secondary Server 1. IP Address: xx.xx.xx.x 2. Port: xxx 3. Shared Secret: XXXXXXX 6. Click Add
### **Configure AAA Accounting Server** 1. Click on Network Control 2. Click on Policies and Profiles 3. Click RADIUS Server 4. Click Add RADIUS Server
5. Enter the following information: 1. Profile Name: VAULT-ACCT 2. Type: Accounting RADIUS Server 3. Primary Server: 1. IP Address: xx.xx.xx.x 2. Port: xxxx 3. Shared Secret: XXXXXXX 4. Confirm Secret: XXXXXXX 4. Secondary Server: 1. IP Address: xx.xx.xx.x 2. Port: xxxx 3. Shared Secret: XXXXXXX 4. Confirm Secret: XXXXXXX 6. Click Add
### **Configure WLAN** 1. Click Wi-Fi 2. Click Wi-Fi Network List 3. Click Add Wi-Fi Network
4. Enter the following Information: 1. Network Name: VAULT 2. Network Type: Dynamic Pre-Shared Key (DPSK) 3. Click Next
5. Continue Entering The Following Information: 1. Security Protocol: WPA2 (Recommended) 2. Use RADIUS Server 3. Authentication Server: VAULT-AUTH 4. Proxy Service: Enabled 5. Accounting Service: Enabled 6. Accounting Server: VAULT-ACCT
6. Click Show more settings 7. Select Networking Tab 8. Entering the Following Information: 1. Client Inactivity Timeout: 86400 2. RADIUS OPTIONS 1. NAS ID: User-Defined 2. Custom NAS ID: \ 3. Single Session ID Accounting: Enabled
8. Click Next 9. Select the Venue to apply the SSID 10. Enable Activated on the Venue 11. Click Next
12. At the summary screen Click Add # Ruckus Unleashed Here is a step-by-step guide on how to configure Ruckus Unleased to work with VAULT. ### **Configuration Steps Overview** 1. Configure AAA Authentication Server 2. Configure AAA Accounting Server 3. Configure WLAN 4. Configure NAS-Identifier ### **Configure AAA Authentication Server** 1. Select Admin & Services 2. Select Services 3. Select AAA Services 4. Click +Create ![](/files/GfwjyCnUTDARb2mvJrbL) 1. Enter the following information * Name: VAULT-AUTH * Type: RADIUS * Auth Method: PAP * Enable Backup RADIUS support * First Server * IP Address: xx.xx.xx.x * Port: xxxx * Shared Secret: XXXXXXX * Confirm Secret: XXXXXXX * Second Server * IP Address: xx.xx.xx.x * Port: xxxx * Shared Secret: XXXXXXX * Confirm Secret: XXXXXXX * Retry Policy * Request Timeout: 3 Seconds * Max Number of Retries: 2 * Max Number of Consecutive Drop Packets: 1 * Reconnect Primary: 5 Minutes * Click OK ![](/files/YkQ2sFPEOZNlK2GCnzqs) ### **Configure AAA Accounting Server** 1. Select Admin & Services 2. Select Services 3. Select AAA Services 4. Click +Create ![](/files/cSOeachdGGsnZ2HTxpSP) 1. Enter the following information * Name: VAULT-ACCT * Type: RADIUS Accounting * Enable Backup RADIUS Accounting support * First Server * IP Address: xx.xx.xx.x * Port: xxxx * Shared Secret: XXXXXXX * Confirm Secret: XXXXXXX * Second Server * IP Address: xx.xx.xx.x * Port: xxxx * Shared Secret: XXXXXXX * Confirm Secret: XXXXXXX * Retry Policy * Request Timeout: 3 Seconds * Max Number of Retries: 2 * Max Number of Consecutive Drop Packets: 1 * Reconnect Primary: 5 Minutes * Click OK ![](/files/rZK1rVMtx1f9aApnsr7K) ### **Configure WLAN** 1. Select Wi-Fi Networks 2. ![](/files/5k6kOVC68wruyhPYyfyl) 3. Click Create 4. Enter the following information * Name: VAULT * Usage Type: Standard * Authentication Method: Open * Encryption Method: WPA2 * Password: Leave as BLANK * Accounting Server: VAULT-ACCT * Send Interim-Update every 30 Minutes ![](/files/kLDA5J9ZUzEuGCN7QPBX) 1. Select Show Advanced Options 2. Select Zero-IT & DPSK Tab 3. Change Dynamic PSK to External 4. Select Authentication Server: VAULT-AUTH 5. Optional for Multiple VLAN (PAN) Deployments * Select WLAN Priority Tab * Select Enable Dynamic VLAN * Click OK ![](/files/g5TMGCHsigNj7vI3JfV8) ### **Set NAS Identifier** 1. Open Putty and SSH into Access Point 2. Type: enable to enter enable context options 3. Type: config to enter configuration context options 4. Type: wlan VAULT to enter SSID specific context options 5. Type: nasid-type user-define \ 6. Type: end 7. Type: end 8. Type: exit ![](/files/isFMBtfCYKgXTSgd8IsM) # Cambium cnMaestro X Here is a step-by-step guide on how to configure Cambium cnMaestro X to work with VAULT. ### **Configuration Steps Overview** 1. Verify Prerequisites 2. Configure WLAN 3. Configure AP Group ### **Verify Prerequisites** 1. Verify an Access Point Group has been created (outside the scope of this document) 2. Verify an Access Point is associated to the Access Point Group (outside the scope of this document) 3. Set appropriate view to follow this guide * Click on Administration * Click Settings * In General Tab change account view to Access and Backhaul * You can change this view back after following this configuration guide. ![](/files/3jlYL3R9ZlfYYktm8s3N) 1. Check software version on access points. * EPSK is supported on version 4.2.2-a6 and above * Click Shared Settings * Click WLANs and AP Groups * Select the AP Groups Tab * Click on the AP Group being used for VAULT * Select an AP within the AP Group * Select Software Update Tab * Verify Active Version is 4.2.2-a6 or higher ![](/files/NLMRDchtaQ60Pfmr5SsT) ### **Configure WLAN** 1. Click on Shared Settings 2. Click on WLANS and AP Groups 3. Select (or create) WLAN Associated with AP Group 4. Under Configuration * Select WLAN and set the following information * Type: Enterprise Wi-Fi * Name: VAULT * Scope: Base Infrastructure * Description: VAULT * Basic Settings * SSID: Enable * SSID: VAULT * Security: WPA2 Pre-Shared Keys * Passphrase: \ * All other settings should be set to Best Practices ![](/files/dEwbTBlliNptCpbKO9WB) * Select AAA Servers Under Configuration * If Using cnMaestro On Premise or AMI Version * Select “Proxy RADIUS through cnMaestro” * Under Authentication Server enter the following information * 1\. Host: xx.xx.xx.x * Secret: XXXXXXX * Port: xxxx * 2\. Host: xx.xx.xx.x * Secret: XXXXXXX * Port: xxxx * Timeout: 3 * Attempts: 1 * Under Accounting Server Enter the following information * 1\. Host: xx.xx.xx.x * Secret: XXXXXXX * Port: xxxx * 2\. Host: xx.xx.xx.x * Secret: XXXXXXX * Port: xxxx * Timeout: 20 * Attempts: 3 * Accounting Mode: Start-Interim-Stop * Interim Update Interval: 1800 ![](/files/1t4iuh7XLk1ubmHxIxow) * Under Advanced Settings Enter the following information * NAS-Identifier: Custom * Custom NAS-ID: RoamingIQ Will Provide the Nas-Identifier to use * Dynamic VLAN: Enabled * Called Station ID: AP-MAC * Click Save * All other settings should remain DEFAULT or set to Best Practices ![](/files/hdS9rpbFznh4YScc7yVc) ### **Configure AP Group** 1. Select Shared Settings 2. Click WLANs and AP Groups 3. Click AP Groups Tab 4. Click AP Group Associated to WLAN and AP 5. Select Network Under Configuration Tab 6. Select the Interface connected to Network Infrastructure * Enter the following information * Ethernet Port Type: Trunk Multiple VLANS * Native VLAN: 1 (or set to your specific infrastructure) * Allowed VLANS: 2-4094 (or set to your specific infrastructure) * All other fields may remain DEFAULT or set to Best Practices ![](/files/0hKaPf32zTxwAt74gKnC) 1. Select User-Defined Overrides under Configuration * Enter the following information ! wireless wlan 1 epsk RADIUS ! * * Where wireless wlan 1 is the wlan number on the physical Access Point * You may need to ssh in to the AP and show the configuration to find the actual wlan # * Click Save * All other fields may remain DEFAULT or set to Best Practices ![](/files/vW9J11B4bc2JdOTePIMZ) # TP Link Omada Pro Here is a step-by-step guide on how to configure TP-Link Omada Pro to work with VAULT. ### **Configuration Steps Overview** 1. Verify Prerequisites 2. Configure RADIUS Profile 3. Configure WLAN ### **Verify Prerequisites** 1. Verify an Access Point Group has been created (outside the scope of this document) 2. Verify an Access Point is associated to the Access Point Group (outside the scope of this document) 3. Verify Access Point firmware of EAP653v1 or later 4. Verify Omada Pro Firmware 5.9.50 or later ### **Configure RADIUS Profile** 1. From the Omada Controller Dashboard Click on Settings 2. Click Expand Authentication Option 3. Click on RADIUS Profile 4. Click +Create New RADIUS Profile ![](/files/q73VbxpRg3F2S6TQltql) 1. Under Create New RADIUS Profile set the following information * Name: VAULT * Select Enable VLAN Assignment for Wireless Network to enable it * Under Authentication Server 1 * Authentication Server IP/URL: xx.xx.xx.x * Authentication Port: xxxx * Authentication Password: XXXXXXX * Select RADIUS Accounting: To enable Accounting Server * Select Interim Update: To enable Interim Updates * Interim Update Interval: 1800 Seconds * Under Accounting Server 1 * Accounting Server IP/URL: xx.xx.xx.x * Accounting Port: xxxx * Accounting Password: XXXXXXX 2. Click Save ![](/files/1uWnNQmUQU2CxFFSDQIo) ### **Configure WLAN** 1. From the Omada Controller Dashboard Click on Settings 2. Click Expand Wireless Networks Option 3. Click on WLAN 4. Click +Create New Wireless Network ![](/files/WGDyeV30XQeo04KLlTDO) 1. Under Create New Wireless Network set the following information \* * Network Name (SSID): VAULT * Band: * Select 2.4 GHz to enable 2.4 GHz * Select 5 GHz to enable 5 GHz * De-Select 6 GHz to DISABLE 6 GHz * Guest Network: De-Select to DISABLE * Security: Select PPSK with RADIUS * RADIUS Profile: Select VAULT (created in previous steps) * Authentication Type: Select Generic Radius with unbound MAC * NAS ID: RoamingIQ Will Provide the NAS-Identifier to use * Expand Advanced Settings * VLAN: Click to Enable * Enter a standard VLAN ID for your organization 2. Set all other values to best practices 3. Click Apply ![](/files/nGud9QdIhrdWXhsixRuu) # Aruba Central Here is a step-by-step guide on how to configure Aruba Central to work with VAULT. ### **Configuration Steps Overview** 1. Setup a Group 2. Configure WLAN 3. Add Parameter ### **Assumptions** * AP licensed in Aruba Central * AP with Firmware AOS 10.5.1 or above ### **In Aruba Central – Setup a Group for APs** 1. Setup a Group for your AP’s connecting to the VAULT MPSK Environment * Add a Group Name * Select Access Points * Click Next ![](/files/HaGZfaWOjqPK6aE9QGfD) 2. Continue Group Setup * Select ArubaOS 10 * Select Campus/Branch * Click Add ![](/files/EQAXjzHGzHLp3DvV0akc) 3. Select the Config Wheel and Set a Device Password ![](/files/Be4y1sSj56FIrTDgTBNB) ![](/files/8F8aLTSugMWShZtRCo3Q) 4. Under the Security Tab add the Radius Authentication Server ![](/files/vAUtB17PlQ9G4KgY4TDF) 5. The Configuration Parameters will be Provided by VAULT and are unique to your account * Enter the Following Information and Click Save * Name: VAULT * IP Address: xx.xx.xx.x * Shared Key: XXXXXXX * Retype Key: XXXXXX * Timeout: 5 * Leave Radsec UNCHECKED * Auth Port: xxxx * NAS IP Address: Leave Blank * NAS Identifier: VAULT will provide the NAS-ID for each Venue * Retry Count: 3 * Click Save ![](/files/JKVFkGTTZZB5pPxxph5t) ### **Configure WLAN** \ There are many parameters that can be customized. For now, we will create a simple WLAN network. 1. Select the WLAN Tab * Click the + Add Sign in the bottom right corner ![](/files/ghHH7nzodyYKLJuA1hpq)
2. General Tab * Type in the SSID: VAULT * Click Next ![](/files/hl2IAcImD7hkAfFnaUjI) 3. VLAN Tab * Select Dynamic * Click Next ![](/files/CwRzELhxKDB6CKc8kz1E) 4. Security Tab * Set the Key Management Dropdown to MPSK-AES * Set the Primary Server Dropdown to the Radius Server you Configured Above * If you Setup a Secondary Server, you can Setup Here ![](/files/KHwLW5lrSt1VZNy40yOJ) * Expand the Advanced Settings and Disable 802.11r ![](/files/xb7zSWQXEY7L9LzLdCFm) * Click Next Two More Times and Your WLAN SSID with MPSK AES Should be Complete ![](/files/XrjHR0KTCjuHYZKO4uzo) ### **Add Parameter** There is one more section that you must complete to finalize the configuration. We will be adding a parameter in the configuration via the Aruba Central Swagger API Interface. 1. At the Global Level Select Organization * Select Platform Integration * Select Rest API ![](/files/yHEnR3Q0RoGcgDjH44e1) 2. Select the My Apps and Tokens Tab * Create a Token and Download the Token * Copy the Access Token to a Text Editor (It is valid for 2 hours) ![](/files/nsevOr05z8SWXebWv16L) 3. Select the APIs Tab * Click on the Aruba Swagger Link and a New Tab will Open ![](/files/TuW4YXn0sqq0GIinb24o) 4. Copy your Token from your Text Editor and Paste in the Access Token Area * Click the Right Arrow !\[A screenshot of a computer Description automatically generated with low confidence]\(/files/GVAgsQGTZOsyXxit0IGp) 5. Under Category, Select Configuration * Select AP Configuration * Select Get AP Configuration ![](/files/AF4oJHePVo6T8ZINgk00) 6. Find and Select the Name of your Group * Click Get AP Configuration !\[A screenshot of a computer Description automatically generated with medium confidence]\(/files/GD6dErqtUZ2Ogun5HAN0) 7. Click Try * If everything is correct, you will get a copy of the Group AP Configuration * Copy the Entire Text Box from the Swagger Interface and Paste to a Text Editor ![](/files/ZUh1c1WF4NjrZAXqsT1H) 8. Within the Text Editor * Find the Section with the SSID Profile Name of what you Previously Created * At the Bottom, Before Auth-Server Section, Type in the Following: " mpsk-cloud-auth", !\[A picture containing text, screenshot, font, algebra Description automatically generated]\(/files/LSzwSllICMUUOMZtmIj1) 9. Copy Everything from the Text Editor Including the New Section * In the Swagger Interface, Select Replace AP Configuration * Where it says CLIs, Paste the Data from the Text Editor Including the " mpsk-cloud-auth" * Once you Replace the AP Configuration and Receive a “200” Response Code from the Swagger API, the Configuration will be Complete !\[A screenshot of a computer Description automatically generated with medium confidence]\(/files/46FBDfqjYJt1m1zp1ooZ) # Cisco Meraki Here is a step-by-step guide on how to configure Cisco Meraki to work with VAULT. Please refer to [Cisco Meraki's documentation](https://documentation.meraki.com/MR/Encryption_and_Authentication/IPSK_with_RADIUS_Authentication) for additional information on how to configure VAULT with Cisco Meraki. ### **Configuration Steps Overview** 1. Configure SSID. 2. Configure Access Control. 3. Configure RADIUS. 4. Configure Client IP and VLAN. ### **Configure SSID** 1. Click on “Wireless.” 2. Click on “Configure -> SSID.”
3. Under the SSID Slot select “Enabled.” 4. Click “Rename” to Enter SSID Name – VAULT.
5. Click "Save Changes." ### **Configure Access Control** 1. Click “edit settings" next to Access Control.
2. Under Security select “Identity PSK with RADIUS.” 3. Select “Easy PSK” from the drop-down list.
4. Wi-Fi Personal Network (WPN) – “Disabled.” 5. WPA encryption – “WPA2 only.” 6. 802.11r – “Disabled.” 7. 802.11w – “Disabled.” 8. Mandatory DHCP – “Disabled.”
9. Splash page – “Non (direct Access).”
### **Configure RADIUS** 1. Under RADIUS servers click “Add Server” and enter the following information. 1. Host IP or FQDN – xx.xx.xx.x 2. Auth port – xxxx 3. Secret – XXXXXXX 2. Click “Done.” 3. Click “Add Server” to add a Secondary RADIUS server and enter the following information. 1. Host IP or FQDN – xx.xx.xx.x 2. Auth port – xxxx 3. Secret – XXXXXXX 4. Click “Done.” 5. Under RADIUS accounting servers Click “Add Server” and enter the following information. 1. Host IP or FQDN – xx.xx.xx.x 2. Acct port – xxxx 3. Secret –XXXXXXX 6. Click “Done.” 7. Click “Add Server” to add a Secondary RADIUS server and enter the following information. 1. Host IP or FQDN – xx.xx.xx.x 2. Acct port – xxxx 3. Secret – XXXXXXX 8. Click “Done.” 9. Set Accounting interim interval to “30 Minutes.” 10. RADIUS testing – “Disabled.” 11. RADIUS CoA support – “Disabled.” 12. RADIUS CoA support – “Disabled.” 13. Dashboard RADIUS proxy – “Enabled.” 14. Click on “Advanced RADIUS Settings.” 15. Set NAS ID to “Custom.” 16. Enter “Custom” String for NAS ID. 17. All other settings may be left as default or set to Best Practices. ### **Configure** Client IP and VLAN 1. Under Client IP and VLAN select “External DHCP server assigned.” 2. Select “Bridged.” 3. Select “Override VLAN tag” next to RADIUS override. 4. Select “VLAN ID” as VLAN tagging option. 5. Set a DEFAULT VLAN ID (per best Practices).
6. Click “Save” to complete all changes. # Alta Labs Here is a step-by-step guide on how to configure Alta Labs to work with VAULT. ### **Configuration Steps Overview** 1. Configure SSID. 2. Configure Advanced Features 3. Configure Power-User Settings ### **Configure SSID** 1. From Dashboard Click on Settings 2. Click + Add new
3. Enter WiFi Network Name (e.g. VAULT) 4. Select WiFi Security as – Enterprise 5. Enter Primary Radius Information 1. IP Address – xx.xx.xx.xx (Production Servers Provided by RoamingIQ) 2. Secret – xxxxxx 3. Auth port – xxxx 4. Acct. Port - xxxx
### **Configure Advanced Features** 1. Click Advanced Settings to display advanced options. 2. Select Default Network Type (for Enterprise/Open) as “Large”
3. Turn Fast Roaming off. 4. Click NAS ID to Enter a Custom NAS ID 5. Custom NAS ID: \ 6. Enable PSK Offload. 7. All other fields should be set to best practices.
### **Configure Power User Settings** 1. Click to enable Power-User settings 2. Enter the following information in the text box. Please Note RoamingIQ will provide the secondary Server address for production. { "hostapd": " auth\_server\_addr=xx.xx.xx.xx radius\_acct\_interim\_interval=1800 " }
3. Click Save at the bottom of the page. # Supported Routers Here is a list of VAULT's supported Router/Gateway manufacturers. * Mikrotik * Nomadix (configuration guide underway) * Fortinet (configuration guide underway) If a router/gateway you want to see supported is not listed, please contact your VAULT Account Manager to discuss support. # Router Configuration Guides The following guides will help you configure routers to work with VAULT. These guides walk through the configuration to apply on your router. If you are looking for how to add a Router to VAULT, [click here.](/network-administrator-console/creating-a-new-venue/add-equipment-to-a-venue) # Mikrotik Here is a step-by-step guide on how to configure Mikrotik to work with VAULT. ### C**onfiguration Steps Overview** 1. Enable APIs 2. Create VLAN Interface 3. Create IP Address 4. Create DHCP Pool 5. Create DHCP Server 6. Create DHCP Network 7. Create Hotspot 8. Create Simple Queue ### **Important Note** All configuration steps detailed assume the Mikrotik Router has an accessible IP address and configuration steps are accomplished via WebFig user interface. ### **Enable APIs** 1. Click IP 2. Click Services 3. Click api-ssl 4. Click Enabled to enable the service 5. Port: 8729 6. Available From: Click down arrow to add an IP address
7. Set IP Addresses to: 1. 3.217.123.156/32 2. 34.204.9.182/32 3. 100.20.214.243/32 4. 52.23.18.184/32 8. Click OK
9. Click api 10. Click Enabled to enable the service 11. Port: 8728 12. Available From: Click down arrow to add an IP address
9. Set IP Addresses to: 1. 3.217.123.156/32 2. 34.204.9.182/32 3. 100.20.214.243/32 4. 52.23.18.184/32 10. Click OK ![](/files/qqXLhOMIBxCPrh0kTSLL) ### **Create VLAN Interface** !\[Table Description automatically generated]\(/files/elNtxnPiZkhsuAAOoRaP) 1. Click Interfaces 2. Click Add New 3. Click VLAN 4. Select Enabled to Enable the new VLAN 5. Enter the following information: 1. Name: vlan+VLANID (example: vlan1050) 2. VLAN ID: VLANID (example: 1050) 3. Interface: Select the Physical Interface to send VLAN traffic (example: sfp-sfpplus2) 4. All other fields can remain default 6. Click OK ### **Create IP Address** !\[Graphical user interface Description automatically generated]\(/files/NEOqiPhaAFcfxpNoUmn3) 1. Click IP 2. Click Addresses 3. Click Add New 4. Click Enable to enable the IP 5. Enter the IP address and MASK as CIDR to assign as the default gateway IP of the VLAN\ (ex. 172.20.50.1/24) 6. Network: Enter the Network Address of the Subnet (ex. 172.20.50.0) 7. Interface: Select the newly created VLAN 8. Click OK ### **Create DHCP Pool** ![](/files/rmTJ3ngntkpz31RaA6n7) 1. Click IP 2. Click Pool 3. Click Add New 4. Enter Name as vlan+VLANID+pool (ex. vlan1050pool) 5. Click down arrow to add addresses 6. Enter the starting address – ending address for pool (ex. 172.20.50.3-172.20.50.254) 7. Leave Next Pool as none 8. Click OK ### **Create DHCP Server** ![](/files/uXOGMDsJrRxkNmnKp2mI) 1. Click IP 2. Click DHCP Server 3. Click Add New 4. Click Enabled to enable the DHCP Server 5. Enter the following information: 1. Name: dhcp+VLANID (ex. dhcp1050) 2. Interface: Newly Created VLAN Interface (ex. vlan1050) 3. Lease Time: Enter valid lease time\ (ex. 3d 00:00:00) 4. Address Pool: Select Address Pool Created above (ex. vlan1050pool) 5. All other values may remain default or set to best practices 6. Click OK ### **Create DHCP Network** !\[Graphical user interface, table Description automatically generated]\(/files/bXNLXxppnOhtR3okNRs2) 1. Click IP 2. Click DHCP Server 3. Select Networks Tab 4. Click Add New 5. Enter the following Information: 1. Address: The Subnet Address in CIDR format (ex. 172.20.50.0/24) 2. Gateway: The IP address assigned to the New VLAN (ex. 172.20.50.1) 3. All other options can be default or set to best practices 6. Click OK ### **Create Hotspot** !\[Graphical user interface, application Description automatically generated]\(/files/QPareM9g1d4r5ueRXZuF) 1. Click IP 2. Click Hotspot 3. Select Server Profiles Tab 4. Click Add New 5. Enter the following information: 1. Name: vlan+VLANID+hsprof (ex. vlan1050hsprof) 2. Hotspot Address: The IP address assigned to the New VLAN (ex. 172.20.50.1) 3. All other fields may remain default or set to best practices 6. Click OK 7. Select Servers Tab 8. Click Add New 9. Enter the following information: 1. If Hotspot should be enabled:\ Select Enabled 2. Name: vlan+VLANID+hotspot\ (ex. vlan1050hotspot) 3. Interface: Select the Newly Created VLAN Interface (ex. vlan1050) 4. Address Pool: Select the Newly Created Address Pool (ex. vlan1050pool) 5. Profile: Select the Newly Created Hotspot Profile (ex. vlan1050hsprof) 6. All other fields may remain default or set to best practices 10. Click OK ![](/files/WYn5IGdBJvYbDRjIB2zq) ### **Create Simple Queue** !\[Graphical user interface Description automatically generated]\(/files/ygmDx1Ey2zyaHu1S7F5j) 1. Click Queues 2. Click Add New 3. Click Enable to enable the queue 4. Enter the following information: 1. Name: vlan+VLANID+queue\ (ex. vlan1050queue) 2. Target: Select the Newly Created VLAN (ex. vlan1050) 3. Target Upload: 1. Set MAX Limit to Upload Limit\ (ex. 1G) 4. Target Download: 1. Set MAX Limit to Download Limit\ (ex. 1G) 5. All other fields may remain default or set to best practices 5. Click OK # Network Administrator Console Introduction This page introduces the Network Administrator Console. The Network Administrator Console is the central hub for Network Administrators to manage their network operator environment, venues, and subscribers. VAULT empowers Network Operators with comprehensive control over their environment, granting them authority to dictate how VAULT integrates with their networks. Network Operators can [create Venues](/network-administrator-console/creating-a-new-venue), [manage subscribers](/network-administrator-console/managing-your-subscribers), customize the [look and feel ](/network-administrator-console/network-operator-settings/e-mail-templates)of customer communications, define VAULT's [user policies](/network-administrator-console/network-operator-settings/service-plans), and much more. # Network Operator Settings Here is a step-by-step guide on how to configure your Network Operator Console Settings. Network Operators have various settings to provide total control of your environment, venues, and subscribers. There are some initial settings to configure as part of your onboarding process, that can be modified at a later date. This section of the knowledge base will walk you through those. # E-mail Templates Here is a step-by-step guide on how to configure your e-mail templates. ### Introduction VAULT grants Network Operators total control over the design and language of e-mails that are sent to your subscribers. ### How To Edit E-mail Templates #### Navigate to the E-mail Template Settings inside your Network Operator Settings {% embed url="" %} #### Basic Settings At the top of the main settings page, you'll see two fields for "Email Logo" and "Brand Color." These two settings will apply to all of your e-mail templates. Next, on the main settings page, you'll see various drop-downs to select the template you want to edit. First, select the Language of the template. Next, choose the Email Type. * "Welcome Email" - contains all of the welcome e-mails sent to new subscribers and administrators. * Next, choose a "User Type" to see the template you are editing. * "Subscriber Events" - contains all of the event-based e-mails that are sent upon a certain condition or trigger. * Next, choose an "Action Type" to see the template you are editing. #### Preview The "Preview" tab shows the appearance of the e-mail template you have selected. This Preview updates in real-time as you make changes to the other two tabs. #### Branding Template The "Branding Template" tab contains all of the HTML that generates how an e-mail looks. If you have an e-mail designer on staff, they can edit this HTML to fully customize the look of the e-mail template. #### Components The "Components" tab contains all of the fields and text contained in your e-mail template. You may edit any of this content, including adding additional variables from the Dynamic Variables list at the top of the page. Note, not all e-mail templates support all Dynamic Variables. #### Save Changes When you are done editing your template, click "Save Changes" to save the changes. # Terms and Conditions Here is a step-by-step guide on how to configure your Terms and Conditions. ### Introduction VAULT empowers Network Operators with complete control over the terms and conditions users consent to upon [account activation.](/subscriber-console/subscriber-account-activation) ### How To Edit Terms and Conditions #### Navigate to the Terms and Conditions Settings inside your Network Operator Settings {% embed url="" %} Select the Language you want to edit. You may copy+paste your terms and conditions text into the UI, or use the built in editor. When you are done, click "Save Changes," to save your changes. # Display Options Here is a step-by-step guide on how to configure your Display Options. ### Introduction VAULT gives Network Operators total control over the branding of their user interface, and provides the ability for branding to be customized on a per Venue basis with branding profiles. An Important Note: Customized venue branding only affects the user interface after a Subscriber or Venue Administrator logs in. At present, VAULT is unable to identify what Venue a Subscriber or Administrator belong to before they login, and will therefore display the Default Network Operator branding on login and sign up pages. ### How To Edit Display Options From your Network Operator Console->Support->Display Options. Choose the Display Option you want to edit. All Network Operators have a pre-built "default" display option that is assigned to new Venues. Across the top, you will see four tabs; #### Theme Here is where you will choose your color pallet and provide URLs for your logo files. As you make changes to the theme, you will see those changes reflected in the preview in real time. #### Meta Data Here is where you will enter the meta data that a web browser will use in its display of your portal pages. #### Behavior Here is where you can customize elements of VAULT's behavior. Presently the options to customize are; Cancellation Options Method: When subscribers cancel their service and are required to select a reason, choose whether to support single select via radio buttons or multi select via checkboxes. Google Analytics ID: Here you can link your VAULT environment to your own Google Analytics ID. #### Support Here is where you can customize how VAULT displays support information to subscribers. You can customize your support e-mail address and phone number that will display to Venues using this display option profile. This allows you to segment support e-mail addresses and phone numbers by venue, if desired. In addition, VAULT allows you to choose whether to display support links to subscribers. For example, you can choose to enable support links, and then provide an, "Eternally Managed Support URL." When used in combination, if a subscriber clicks to "Add a Support Ticket," they will be taken to your "Externally Managed Support URL." ### How To Assign A Display Option to a Venue Please refer to the [Venue Settings](/network-administrator-console/creating-a-new-venue/venue-details-configuration-options#other-venue-settings) to assign Display Option profiles to Venues. # Network Administrators Here is a step-by-step guide on how to add Network Administrators to VAULT. ### What Are Network Administrators Network Administrators have access to the Network Operator Console for your VAULT environment. ### Network Administrator Roles There are four different Network Administrator Roles. 1. Domain Administrator: These are Super Admins for VAULT with full access to [Network Operator Settings](/network-administrator-console/network-operator-settings). 2. SIEM Administrator: These users receive event management notifications. Urgent Note: This role is not liked to VAULT's automated incident management system, described in [this page.](/getting-started/system-status-and-notifications) These two services must be maintained completely separate, in order to ensure communications are processed properly. A SIEM Administrator will receive internal system notifications, such as gateway configuration failures. 3. Account Manager: These users receive [Venue Administrator](/venue-administrator-console/venue-administrator-console-introduction) access to all Venues in your environment. 4. Customer Support: These users have access to [Manage Subscribers](/network-administrator-console/managing-your-subscribers) in the Network Operator Console. They are not be able to modify [Network Operator Settings](/network-administrator-console/network-operator-settings) or [Venue Settings](/network-administrator-console/managing-your-venues), but can see see the information. ### How to Add Network Administrators {% embed url="" %} The Network Administrator will receive an e-mail now inviting them to create their account. ### How to Remove a Network Administrator Navigate to your list of administrators through step 4 in the walkthrough above. From here, scroll through your list of administrators, and click "Delete" in the corresponding row. A confirmation window will appear. Click "Confirm" to remove the administrator. # Service Plans Here is a step-by-step guide on how to create service plans in VAULT. ### How Service Plans Work As a Network Operator, VAULT allows you to create service plans and then [Add or Remove Service Plans to Venues.](/network-administrator-console/creating-a-new-venue/add-and-remove-service-plans-to-venue) This eliminates the need for Network Operators to recreate the same service plan multiple times. If your service plans have a price, you can apply discounts for Service Plans at a Venue through the [Venue Shopping cart](/network-administrator-console/creating-a-new-venue/configure-venue-shopping-cart) or for a unit via the [Unit Shopping Cart](/network-administrator-console/creating-a-new-venue/add-venue-units). When a subscriber is added to VAULT, the policies associated with the service plan are automatically configured to your [network router](/network-equipment/supported-routers) that was [added to the venue](/network-administrator-console/creating-a-new-venue/add-equipment-to-a-venue). ### How to Add Service Plans {% embed url="" %} ### What Do Each of the Fields Mean? * Service Plan Name - this is the name subscribers will see for the service plan. * Service Plan Description - this is the description subscribers will see for the service plan. * Service Plan Image - this is the image or icon users will see when signing up via the [shopping cart](/network-administrator-console/network-operator-settings/shopping-cart). * External Service Plan ID - this can be your company's ID for a service plan. It will not display for customers, but will be available in [webhooks ](/network-administrator-console/network-operator-settings/webhooks)and for use with [API integrations](/developers/api-documentation). * Upload Kbps - the upload speed the subscriber will receive. * Download Kbps - the download speed the subscriber will receive. * Concurrent Devices - the number of concurrent devices a subscriber may have connected at one time. For the purpose of device concurrency, a device is considered connected until a stop packet is received or 30 minutes have lapsed since receiving an accounting packet. * Session Timeout - the number of seconds a device is allowed to remain connected before being forced to reauthenticate. We recommend setting this to, "3600." * Billing Cycle Hours - the billing cycle frequency for the service plan. * Billing Cycle Price - the price the subscriber will be charged for each Billing Cycle Hours. Edits to the price will affect all existing subscriptions in addition to new subscriptions. * Maximum Billing Cycles - the number of billing cycles a given e-mail address may be billed for. * Maximum Free Cycles - not currently active * Trial Cycles - the number of billing cycle hours that will be provided at no charge. * SMS Code - the SMS code for the service plan to be used during a [SMS based sign up.](/network-administrator-console/sms-sign-up) * Require Service Plan? - check this box if you want this service plan to automatically be added and required at all venues. * Default Service Plan for Residential Units - check this box if you want this service plan to be the default service plan for residents at a venue, if no service plan has been [added to that venue](/network-administrator-console/creating-a-new-venue/add-and-remove-service-plans-to-venue). * Default Service Plan for Guest Subscriptions - check this box if you want this service plan to be the default service plan for guests at a venue, if no service plan has been [added to that venue](/network-administrator-console/creating-a-new-venue/add-and-remove-service-plans-to-venue). ### **How Do I Provide Service Plan Information for FCC Broadband Labels?** To provide information for an FCC Broadband Label, select the "Broadband Label" tab from the top of the Service Plan Settings popup. For more information, visit the[ FCC Broadband Labels](/network-administrator-console/network-operator-settings/fcc-broadband-labels) page. # FCC Broadband Labels Here is a step-by-step guide on how to configure FCC Broadband Labels in VAULT. ### What Are FCC Broadband Labels? In 2024, an FCC regulation went into effect requiring the display of a "Broadband Consumer Label," at the point of sale for internet products. The purpose of these labels, as stated on the [FCC's dedicated Broadband Label webpage](https://www.fcc.gov/broadbandlabels) is, "...to provide clear, easy-to-understand, and accurate information about the cost and performance of high-speed internet services." ### Where Can I Find More Information About the Labels? More information can be found on the [FCC's dedicated Broadband Label webpage](https://www.fcc.gov/broadbandlabels). Please note, RoamingiQ is not a legal firm and will not provide legal advice, interpretations, or recommendations on information to enter for display on the Broadband label. ### How Do I Configure a Broadband Label? Setting up VAULT to display Broadband Labels in accordance with the FCC requirements is a simple two-step process. 1. Service Plan Settings - Within Your [Service Plan Settings](/network-administrator-console/network-operator-settings/service-plans), click the tab called "Broadband Label." Enter the required information, and select "Save Changes"
2. Venue Settings - Within the [Venue's Settings](/network-administrator-console/creating-a-new-venue/venue-details-configuration-options#other-venue-settings), enter the "Expected Latency" you want to see displayed on the label, and check the box that says "Enable Broadband Label?"
### Why Are the Settings in Different Locations? VAULT's goal is always to make it intuitive, quick, and seamless to configure your venues. The FCC regulation requires the display of some information that is service plan dependent, such as expected speeds and data policy links, along with other information that is venue dependent, such as expected latency. ### Where Do Subscribers See the Label? If enabled, the label will appear during the service plan selection in the [Shopping Cart](/network-administrator-console/network-operator-settings/shopping-cart) during [Self-Sign Up](/subscriber-console/subscriber-self-sign-up) and within the Subscriber's Account Settings. ### What Do the Labels Look Like? The [FCC's dedicated Broadband Label webpage](https://www.fcc.gov/broadbandlabels) provides samples of how the Broadband labels are required to look. For more information on the display in VAULT, refer to the[ Subscriber Self-Sign Up](/subscriber-console/subscriber-self-sign-up) of the Knowledge Base. # Keypools Here is a step-by-step guide on how to add Keypools to VAULT. ### What are Keypools? A keypool is essentially a reservoir of keys, or Wi-Fi passwords, along with the corresponding SSID for authentication purposes. VAULT has three types of keypools. 1. Global: A global keypool is available at all venues. Any subscriber's Wi-Fi password, or PSK, in that keypool will work at all venues. We recommend always using a global keypool and broadcasting the same SSID at all venues, for example, "RoamingiQ Wi-Fi." 2. Local/Venue: A local keypool is exclusive to one specific venue. Any subscriber's Wi-Fi password, or PSK, in that keypool will only work at that venue with that local keypool. 1. However, if you also have a global keypool, any Wi-Fi passwords associated with the local keypool will also "roll up" to work with the global keypool. 3. Unit: A unit keypool is exclusive to one specific unit at at venue. 1. Any subscriber's Wi-Fi password, or PSK, in a unit keypool will also roll up to work with any Venue or Global keypool. ### How to Create Keypools {% embed url="" %} You may also create a new keypool while creating or modifying a venue within the [venue settings](/network-administrator-console/creating-a-new-venue/add-a-keypool-to-a-venue-or-unit). #### Keypool Scope and Display Order After you have created a keypool, you will see two additional values. 1. Scope: Indicates if a keypool is global, local, unit, or attached a [Ruckus R1 for DPSK3.](/network-administrator-console/network-operator-settings/ruckus-r1-dpsk3) 1. Global: Indicates a keypool is global. 2. 8 Character String: Indicates a keypool is local. 3. 32 Charater String: Indicates a keypool belongs to Ruckus R1. 2. Display Order: If multiple keypools are available at a venue, the keypool with the lowest display order will appear by default when the subscriber logs into their VAULT account. As a best practice, ensure a local keypool or Unit keypool at a Venue has a lower display order value than a global keypool at a Venue. # Shopping Cart Here is a step-by-step guide on how to configure the Shopping Cart in VAULT. ### What is the Shopping Cart? The shopping cart allows subscribers to sign up for service and modify their service via a self-service sign up flow. **The shopping cart supports both paid and free service plans**. [Click here](/subscriber-console/subscriber-self-sign-up) for information on how subscribers use the shopping cart to sign up for service. ### Do I Have to Have a Stripe Account? A Stripe account is required if you want the shopping cart to allow users to sign up for paid service plans. If you only want to allow subscribers to sign up for free service plans, a Stripe account is not required. ### How Do I Enable the Shopping Cart? Before enabling the shopping cart, please contact your VAULT Account Manager to ask which individuals should receive [Developer Access](https://docs.stripe.com/payments/account/teams/roles) to your Stripe environment. This step is important for the VAULT team to assist with setting up your Stripe account and providing technical support. {% embed url="" %} ### What Do Each of the Fields Mean? * Enabled/Disabled: A checkbox here enables the shopping cart for your environment. You may decide which venues appear in your shopping cart in the [venue settings.](/network-administrator-console/creating-a-new-venue/configure-venue-shopping-cart) * Issue Refund by Default: A checkbox here automatically provides subscribers with a pro-rata refund if they cancel their service or if a venue administrator cancels the subscriber's service. Network Administrators can [choose if a refund](/network-administrator-console/managing-your-subscribers/issuing-a-refund-or-credit) should be issued at all times. * Stripe Publishable Key, Stripe Secret Key, and Stripe Webhook Signing Secret: These are values provided by Stripe that are unique to your Stripe environment. * Shopping Cart Short URL: This is an optional field if you would like to create a shorter link for your Shopping Cart, using a service like TinyURL. In some instances, such as [SMS Based Sign Up](/network-administrator-console/sms-sign-up), this URL will be used to keep SMS messages shorter. ### Where Do I Find the Stripe Values? Stripe provides documentation on obtaining these values at . Your VAULT Account Manager can assist with retrieving these keys. ### Next Steps Next, please reach out to your VAULT Account Manager. There will be two additional steps to complete. 1. Developer Access - You'll need to add a couple of individuals from RoamingiQ as Developers in your Stripe account. Your VAULT Account Manager can provide you with those details. 2. Once in, the VAULT team will need to add VAULT as a webhook endpoint in your Stripe environment. # Shopping Cart Payment Rules Here are details on how VAULT handles successful and failed payments ### How Does Vault Determine a Billing Cycle? When a subscriber's service is activated an invoice date is generated that matches the date the subscription begins. This date will remain their invoice date, with some exceptions we'll touch on later in this page. The length of the billing cycle is determined by the [Service Plan settings](/network-administrator-console/network-operator-settings/service-plans#what-do-each-of-the-fields-mean). ### What Happens if the Invoice Date Is on a Day Not All Months Have? If a subscription's invoice date is on a date that not all months have, VAULT will hold billing the subscription until the would-be invoice date has passed. Let's explain with an example. A subscription is created with an invoice date of October 31st. On October 31st, the user is billed. Their next invoice date would be the non-existent, November 31st. VAULT will instead bill on the next actual date, which in this case in December 1st. Going forward, the 1st of the month will be this subscription's new invoice date. This method creates a natural attrition like process where invoices become billed on a consistent and always existent day of the month for subscribers. ### What Happens When a Payment is Successful? If a payment is successful, the subscriber is notified via e-mail and their service continues as normal. ### What Happens When a Payment Fails? If a payment fails to process, a series of events occur; 1. The subscription is downgraded to the best available free service plan for that individual subscription. This is determined based on all available price adjustments for the subscription, including the[ service plan's original price](/network-administrator-console/network-operator-settings/service-plans#what-do-each-of-the-fields-mean), [venue discounts](/network-administrator-console/creating-a-new-venue/configure-venue-shopping-cart), [unit discounts](/network-administrator-console/creating-a-new-venue/add-venue-units#what-does-each-of-the-values-mean), and[ subscriber discounts](/network-administrator-console/managing-your-subscribers/view-and-modify-subscriber-details#how-to-modify-a-subscribers-price). 2. The subscriber is notified via e-mail of the failed payment, and provided the reason code if that code was provided by Stripe. The subscriber is asked to login to the subscriber UI to update their payment information, and try to process the payment again. 1. The subscriber UI modals will be blurred and blocked via a pop-up, only allowing the subscriber to either update their payment information or logout. 2. If the subscriber enters new payment information and attempts to process the payment again, the subscriber is immediately reactivated to their paid plan. The subscription will not be downgraded again for two days, even if the payment fails. This is due to Stripe webhook delays, and to not overwhelm onsite equipment with configuration changes. If the subscriber never updates their payment information, their subscription will remain in a payment failed status until the subscription is removed. If multiple invoice dates pass, and then the subscriber attempts to process a payment, they are only charged for the most recent invoice. ### How Does Vault Pro-Rate Upgrades and Downgrades for Shopping Cart Customers? When a subscription is upgraded or downgraded for a retail, or billed, customer, the service plan changes go into effect immediately, and the pro-rata balance is applied to the next invoice. This allows for a consistent and known billing date for the customer, but lets them enjoy their new service plan speeds and policies immediately. # Property Management System Here is a step-by-step guide on how to configure Property Management Systems in VAULT. PMS integration is available in beta for RealPage managed Venues. Please note, additional fees may apply for RealPage integration. Please reach out to your VAULT Account Manager with any questions. ### What Does Property Management Integration Do? When a Venue is linked to a Property Management System in VAULT, VAULT will automatically add units and subscribers to the Venue. This removes the need for administrators to add subscribers to VAULT. ### How Do I Enable PMS Integration There are a few steps to take to add PMS integration 1. Reach out to your VAULT Account Manager to ensure your environment is enabled for PMS integration. Your Account Manager will discuss additional steps that the property will have to take to enable PMS synchronization. Before creating or modifying a Venue, the Venue's Management will need to [approve the integration.](/network-administrator-console/creating-a-new-venue/connect-a-venue-to-realpage#property-management-approval) 2. Next, your VAULT Account Manager will work with you to obtain the correct credentials to create a PMS Profile in your Operator Settings. 3. When steps 1 and 2 are complete, your environment is now setup for PMS Integration. 4. When creating or modifying a Venue, you'll need to [connect that Venue to the PMS Profile.](/network-administrator-console/creating-a-new-venue/connect-a-venue-to-realpage) ### How Often Does Vault Sync With PMS? Hourly ### What Are Limitations With PMS Integration? * VAULT does not presently support PMS integration for properties using the VAULT[ Shopping Cart](/network-administrator-console/network-operator-settings/shopping-cart). * In order for VAULT to automatically add subscribers, VAULT must also automatically add units. This is to ensure that VAULT will always have the unit available for a subscriber. * VAULT will only add a subscriber using the "Head of Household" according to the PMS. * Venue Administrators and Network Administrators are not able to delete subscriptions that have synced with PMS. * [Overlapping Subscriptions](/network-administrator-console/creating-a-new-venue/overlapping-subscriptions) are not supported for PMS connected properties. ### Can I Override the PMS Sync? Somewhat. You are able to do the following functions with a Venue that syncs units and subscribers. 1. Add a Unit - You may add a unit outside of the PMS sync. That unit will require any subscribers to be manually added as the unit you create cannot sync with PMS. 2. Add a subscriber - You may add a subscriber to a PMS synced unit or a manually added unit. Other functions may work, such as deleting a unit and moving a subscriber from one unit to the other, but those changes may be undone upon the next PMS sync. # Webhooks Here is a step-by-step guide on how to configure a webhook server in VAULT. ### What Are Webhooks? A webhook is an automated message or payload that is sent based on a unique trigger. You can think of it as a reverse API. Instead of a user or developer requesting information from an API in a pull fashion, a webhook sends information in a push fashion. ### Why Would I Want to Use Webhooks? Webhooks are a great way for Network Operators to capture data when an event occurs. For example, when an administrator [issues a refund](/network-administrator-console/managing-your-subscribers/issuing-a-refund-or-credit), a webhook is sent to your webhook server with relevant information, including the administrator who issued it, the amount, and the subscriber it was issued to. This data can then be transformed and cataloged into your CRM or other database for record keeping. ### How to Add a Webhook URL {% embed url="" %} ### What Webhooks Are Available ? Below is a list of available webhooks. You can view sample payloads for each webhook [here](/developers/sample-webhook-payloads). #### Webhooks for Venues (VU1) VenueUnitAdded (VU2) VenueUnitUpdated (V7) KeyStart (V8) KeyEnd #### Webhooks for subscribers (S1) LoginPasswordCreated #### Webhooks for subscriptions (SU1) SubscriptionSetupSuccess (SU2) SubscriptionPlanUpdated (SU3) SubscriptionVenueUnitUpdated (SU4) SubscriptionPriceUpdated (SU5) SubscriptionNextInvoiceAdjustment (SU6) SubscriptionStartDateAdjustment (SU7) SubscriptionEndDateAdjustment #### Webhooks for Stripe-enabled subscriptions (SUS2) StripePaymentSuccess (SUS3) StripePaymentFailed (SUS4) StripePaymentMethodUpdated (SUS5) StripeChargeRefunded # Ruckus R1 DPSK3 Here is a step-by-step guide on how to configure Ruckus R1 in VAULT for DPSK3. ### Important Information Presently, the Ruckus R1 integration with VAULT is exclusively for support of Ruckus WPA3/DPSK3 system. For traditional VAULT deployments, please refer to our [R1 Configuration guide.](/network-equipment/access-point-configuration-guides/ruckus-one) ### How Do I Add My R1 Controller to VAULT? 1. From the Operator Information page, select the "Ruckus R1" tab. 2. Click, "Add Ruckus R1 Controller" 3. Enter the required Information. If you do not have this information available, please reach out to your Network Engineering team or your VAULT Account Manager for assistance.
4. If you want to immediately begin Syncing PSKs for the connected sites, select Sync PSKs. You can also enable this later. As noted, keypools will begin syncing immediately when you select "Add Ruckus R1 Controller" 5. To confirm your Keypools/SSIDs began to sync, navigate to the [Keypools ](/network-administrator-console/network-operator-settings/keypools)page within your operator settings. There, you should see Keypools from R1 listed with an "Auth Mechanism" of WPA3. 6. Now that your controller is setup, you'll need to link it to the specific Venues that will be using the R1 DPSK3 integration. You may do this from the Venue Details->[Keypools Settings ](/network-administrator-console/creating-a-new-venue/add-a-keypool-to-a-venue-or-unit)by adding your new R1 Keypool to the Venue. # Network Operator Logs Here is a step-by-step guide on how to view Network Operator Logs in VAULT. ### What Are Network Operator Logs The logs for a Network Operator encompass all event logs available across your entire environment. More granular logs are available for [individual units](/network-administrator-console/managing-your-venues/view-and-modify-venue-units#unit-logs) or [individual subscriptions](/network-administrator-console/managing-your-subscribers/view-subscriber-logs). ### How to View Network Operator Logs Navigate to Your Network Operator Environment->Settings->Operator Information->Logs # Gateway Errors and Pending Changes Here is a step-by-step guide on how to view Gateway Errors and Pending VLAN Changes. ### Equipment Error Logs You can view individual equipment logs by navigating to that specific [equipment's logs](/network-administrator-console/creating-a-new-venue/add-equipment-to-a-venue#how-to-view-equipment-logs) within the Venue Details page. Alternatively, you can view a single log of all errors across all equipment at all Venues from your Network Operator Console->Support->Equipment Error Logs. ### Pending VLAN Changes You can view a list of all VLAN changes across all of your sites from your Network Operator Console->Support->Pending Gateway VLAN Disable or Enable. # Creating a New Venue Here is a step-by-step guide on how to create a new Venue in VAULT. VAULT allows Network Operators to create and manage their own venues. Creating a new venue in VAULT only takes a couple of minutes. ### What is a Venue? A Venue is a physical location where you will provide internet services using the VAULT platform, either via [API ](/developers/api-documentation)or through your custom-branded VAULT user interface. ### How Do I Create a Venue? Login to VAULT as a [Network Administrator](/network-administrator-console/network-operator-settings/network-administrators) and select the button that says "Add New Venue." This will open the Venue creation wizard, beginning with the [General Information](/network-administrator-console/creating-a-new-venue/venue-details-general-information) page. # Venue Details/General Information Here is a step-by-step guide on how to enter the General Information for a Venue. When creating a new Venue, VAULT requests basic information about the Venue, including its location and contact information, as well as more advanced configuration options. ### General Information Venue Name: This is the name of the Venue that subscribers and administrators will see. Venue Type: This is the type of service you are offering at the venue. * Wi-Fi and Wired Access: Select this if subscribers will have Wi-Fi and Wired access provided by the Network Operator. * Wired Access Only: Select this if subscribers will only have wired access, such as in a Bring Your Own Device deployment. [Property Management Group](/property-management-group): Select the Property Management Group for this Venue. Address Information: Provide the physical address for the Venue. If the venue has multiple addresses, that's okay. We will take care of that when we [add units.](/network-administrator-console/creating-a-new-venue/add-venue-units) This address should be the primary address of the venue. # Venue Details/Configuration Options Here is a step-by-step guide on how to enter the Configuration Options for a Venue. ### Venue E-mail Settings There are three e-mail configuration settings for each venue. #### Welcome E-mail Send Advance Enter the number of hours prior to a subscription start date in which you want subscribers to receive their [welcome e-mail.](/network-administrator-console/network-operator-settings/e-mail-templates) A setting of "0" will send welcome e-mails immediately when a subscriber is added. This is the recommended setting. #### Send email for added subscriptions? Check this box if you want welcome e-mails to be sent from VAULT for new subscriptions when they are added. #### Send email for ended subscriptions? Check this box if you want subscription-ended e-mails to be sent from VAULT for subscriptions when they reach their [service end.](/network-administrator-console/managing-your-subscribers/ending-a-subscription) ### Venue VLAN Ranges There are three VLAN setting ranges to configure in VAULT. #### Resident Devices VLAN Range This is the VLAN range available for resident subscriptions. This range should include all VLANs that you [assign to units](/network-administrator-console/creating-a-new-venue/add-venue-units) as well as additional VLANs if you intend to support [Overlapping Subscriptions](/network-administrator-console/creating-a-new-venue/overlapping-subscriptions). This range will be used to initially assign VLANs to units for [RealPage ](/network-administrator-console/network-operator-settings/property-management-system)enabled venues. #### Guest Devices VLAN Range This range is not yet in use, but we recommend setting it for a future update. In the future, this range will be used to dynamically assign a VLAN to [Guest Subscriptions](/venue-administrator-console/venue-administrator-dashboard/add-guests). Today, Guest VLANs are attached to a dummy unit as part of [adding units ](/network-administrator-console/creating-a-new-venue/add-venue-units)to a venue. #### Roaming Devices VLAN Range This range is not yet in use, but we recommend setting it for a future update. In the future, this range will be used to dynamically assign a VLAN to a roaming subscription. Today, roaming devices are attached to a dummy unit as part of [adding units](/network-administrator-console/creating-a-new-venue/add-venue-units) to a venue. ### Other Venue Settings #### Allow Overlapping Subscriptions For information on Overlapping Subscriptions, please visit the dedicated [Overlapping Subscriptions page.](/network-administrator-console/creating-a-new-venue/overlapping-subscriptions) **Enable Broadband Label** This will enable [FCC Broadband Labels](/network-administrator-console/network-operator-settings/fcc-broadband-labels) for the Venue. **Typical Latency** This field is used to display the typical latency value within an [FCC broadband label](/network-administrator-console/network-operator-settings/fcc-broadband-labels). Display Option ID This field is used to determine the [Display Option](/network-administrator-console/network-operator-settings/display-options) that is used for branding purposes for Subscribers and Venue Administrators # Overlapping Subscriptions This page explains how Overlapping Subscriptions work. ### What is an Overlapping Subscription? An overlapping subscription exists when two subscriptions are concurrently active in the same unit. The first subscription is attached to what we call the "primary unit." The second subscription is "overlapping." ### How Do I Enable Overlapping Subscriptions? You may enable overlapping subscriptions for an entire [Network Operator](#how-to-enable-overlapping-subscriptions-for-a-network-operator), an entire [Venue](#how-to-enable-overlapping-subscriptions-for-a-venue), or just a single [unit](#how-to-enable-overlapping-subscriptions-for-a-unit). When you enable overlapping subscriptions as a network operator, all venues in your environment will have overlapping subscriptions enabled. When you enable overlapping subscriptions for a venue, all units in that venue will have overlapping subscriptions enabled. When you enable overlapping subscriptions for a specific unit, only that unit will have overlapping subscriptions enabled. #### How to Enable Overlapping Subscriptions for a Network Operator {% embed url="" %} #### How to Enable Overlapping Subscriptions For a Venue {% embed url="" %} #### How to Enable Overlapping Subscriptions For a Unit {% embed url="" %} ### What Happens When Overlapping Subscriptions are Disabled? When overlapping subscriptions are disabled, a subscription cannot be added to a unit that already has an existing subscription. If a user is attempting to sign up via the [Shopping Cart](/network-administrator-console/network-operator-settings/shopping-cart), that unit will not appear in the list of available units. ### What Happens When Overlapping Subscriptions are Enabled? When overlapping subscriptions are enabled and a subscription is added to a unit with an existing subscription, VAULT will create a temporary unit and assign a VLAN from the Resident Devices [VLAN Ranges](/network-administrator-console/creating-a-new-venue/venue-details-configuration-options#resident-devices-vlan-range), if a VLAN in that range is available. If a VLAN in that range is not available, the subscription will not be added. This might occur if every VLAN in that range is statically assigned to a unit, for example. The user being added as the overlapping subscription will remain in the temporary unit with the temporary VLAN until the subscription in the primary unit has been removed. At that time, the overlapping subscription will be moved to the primary unit and assigned to the primary unit's VLAN. The temporary unit will then be removed, and the VLAN will return to the pool of available VLANs. ### Why Would I Want to Enable Overlapping Subscriptions? Enabling overlapping subscriptions is beneficial when you don't want any barriers to a user being added to VAULT. For example, if you are offering your products on a retail basis where subscribers sign themselves up for service using the [Shopping Cart](/network-administrator-console/network-operator-settings/shopping-cart), you want to ensure that any unit a user attempts to sign up for is available. A potential challenge that may occur in this scenario is rare, but you should be aware. If a user is 1) in an overlapping subscription, 2) physically inside the unit, 3) connects a wired device to a wired port, and 4) attempts to communicate between that wired device and a wireless device, then they will be unable to do so. This is because the wired unit is likely configured to the static unit's VLAN, while the wireless device is placed on the temporary VLAN. This is a rare situation with a lot of "ands," that need to occur. If this happens, the subscription in the primary unit should be removed so the overlapping subscription will migrate to the primary unit. ### Why Would I Want to Disable Overlapping Subscriptions? Keeping overlapping subscriptions disabled is beneficial if you want to ensure data accuracy in VAULT. For example, if you are offering your products on a bulk basis where subscribers are primarily added by a Venue Administrator, you may want to ensure that the old subscriber is always removed from the unit before a new subscriber is added. Overlapping Subscriptions may not be used with a[ RealPage](/network-administrator-console/network-operator-settings/property-management-system) connected property. ### How Long Does it Take to Shift a Subscriber From a Temporary VLAN to the Primary Unit's VLAN? VAULT will make the shift immediately. However, due to caching of network equipment, it's possible that the network will still assign the user to the temporary unit's VLAN. A best practice in this case is to ensure that the subscriber disconnects all devices from the network for 30 minutes, so their PSK has no activity during that time, allowing the network to reset it's cache. # Add Venue Units Here is a step-by-step guide on how to add units to a Venue. During the Venue Creation Wizard, you will be asked to upload your units to VAULT using a CSV file. Alternatively, you can navigate to the upload units page separately by accessing your Network Operator Console->Venues->upload units. You can also [add a single unit](#how-to-add-a-single-unit-to-a-venue) to VAULT or [modify venue units ](/network-administrator-console/managing-your-venues/view-and-modify-venue-units)that have already been uploaded. Please skip this step if you will be setting up a Venue as a [RealPage](/network-administrator-console/network-operator-settings/property-management-system) synced Venue. ### How to Download the Unit Upload Template From the unit upload screen, click on "download template" to download a CSV template for unit uploads. Alternatively, you may [export units](/network-administrator-console/managing-your-venues/export-units) if the Venue already has units and use that as the template.
### How to Use the Unit Upload Template Each column represents a value that VAULT needs in order to add a unit. The columns marked with a "\*" are required fields. **It's critical that you do not change any of the headers in the first row of the template**, or your unit upload may fail. That includes not removing the "\*". ### What Does Each of the Values Mean? * Unit ID: This is the ID for the unit. * Building: This is the building ID for the unit. * Floor: This is the floor ID for the unit. * Purpose: This is what the unit will be used for; * "wiredunit": Use this value for a traditional residential unit where there is wired and wireless service available. This will be the value for most of your units. * "localwirelessonly": Use this value for non-physical units, such a guest subscription. VAULT requires a unit-to-VLAN association for all subscriptions, including guest subscriptions. These users will only have wireless access to the venue. As a best practice, your networking team should enable "client isolation" on this VLAN on the network. These units will appear in the available list to [Add a Guest.](/venue-administrator-console/venue-administrator-dashboard/add-guests) * "globalroaming": Use this value for a non-physical unit for roaming users to be assigned to when they roam to this venue. The VLAN associated with this unit is the VLAN roaming devices will be placed on. As a best practice, your networking team should enable "client isolation" on this VLAN on the network. * Address 1, Address 2, City, State, Postal Code, Country: This is the address information for the unit, which can be different, or the same as, the [address information for the venue](/network-administrator-console/creating-a-new-venue/venue-details-general-information). * VLAN: This is the VLAN for the unit. All subscriptions added to this unit will be placed on this VLAN. If you do not enter a VLAN in this column, VAULT will pull an available VLAN from the Venue's [VLAN Ranges.](/network-administrator-console/creating-a-new-venue/venue-details-configuration-options#resident-devices-vlan-range) * Unit Internal ID: If you are making an [update to a unit](/network-administrator-console/managing-your-venues/view-and-modify-venue-units), you may enter the Unit Internal ID to ensure VAULT recognizes the existing unit. * Unit External ID: Use this value for a unit ID that is external to VAULT, such as your own company's unit ID. * Shopping Cart Price Adjustment: If you are offering retail services using the [Shopping Cart](/network-administrator-console/network-operator-settings/shopping-cart), you may provide a unit level discount to subscribers who sign up for service in this unit. Any discount you apply here will be applied to all subscribers who sign up for service in this unit until you remove the discount. ### How to Upload The Unit Upload Template Once you've completed your template, save the file as a CSV. VAULT will not recognize other formats. Click the "Upload Units" button and select your file using your operating systems file explore. The upload will begin immediately. ### How to Resolve Unit Upload Errors If you receive an error during the unit upload, VAULT will stop processing the unit upload. VAULT iterates through your upload file one row at a time, beginning from the top. You will need to correct the error VAULT provided and remove the rows from your CSV file that were processed successfully. Once complete, save the file and try the upload again. ### How to Add a Single Unit to a Venue From your Network Operator Console->Venues->Add Unit. Select the Venue, and then enter the same information for each unit as you would during a unit upload. # Add and Remove Service Plans to Venue Here is a step-by-step guide on how to add service plans to a venue. Once you have [created your service plans](/network-administrator-console/network-operator-settings/service-plans), it's time to add them to a Venue. Remember, any service plan that was set as a required service plan will automatically be added to the Venue. ### How to Add Service Plans to a Venue During the Venue Creation Wizard, you will be asked to add service plans to the Venue. You can separately navigate to the service plan page by navigating to your Network Operator Console->Venues->View/Modify Venue->select the Venue->Service Plans. Once there, click on "Add Service Plan" to see a list of your available service plans to add to the venue. Select the plan from the list, and click "Add Service Plan." ### How to Remove Service Plans from a Venue Navigate to the service plan page by navigating to your Network Operator Console->Venues->View/Modify Venue->select the Venue->Service Plans. Find the service plan you wish to remove, and click the "Disable" button in the row of that service plan. There are a few important notes to be aware of when removing a service plan. 1. You cannot remove a service plan from a Venue if there are subscribers currently associated with that service plan. 2. If you remove a service plan from a Venue that is [set to be required](/network-administrator-console/network-operator-settings/service-plans#what-do-each-of-the-fields-mean), the service plan may show as removed, but VAULT will automatically re-add the plan to the Venue within a couple of minutes. # Add a Keypool to a Venue or Unit Here is a step-by-step guide on how to add Keypools to a venue. If you are not familiar with Keypools, please read the [Keypools ](/network-administrator-console/network-operator-settings/keypools)page of the Knowledge Base. ### How to Add a Keypool to a Venue Navigate to the Keypools page by navigating to your Network Operator Console->Venues->View/Modify Venue->select the Venue->Keypools. Here, you have multiple options to choose from when adding a Keypool. You may either create new global, venue, or unit keypools, or you can Assign an Existing Keypool which may enable property to property roaming.
Any Keypool set as a Global Keypool will automatically be added to the Venue. If you wish to add a Local Keypool to the venue, you may do so during the Venue Creation Wizard or Navigate to the Venue's Keypool's page by navigating to your Network Operator Console->Venues->View/Modify Venue->select the Venue->Keypools. Enter the SSID for the Keypool, and select if the Keypool is [Global or Local](/network-administrator-console/network-operator-settings/keypools), then select "Add Keypool." ### How to Add a Keypool to a Unit In addition to adding a Keypool to a Unit from the Venue Details page, you may also add a Keypool to a unit from the Unit Details page by navigating to your Network Operator Console->Venues->View/Modify Venue->Units->select the Unit->Keypools.
# Add Venue Administrators to a Venue Here is a step-by-step guide on how to add Venue Administrators to a Venue. ### How to Add Venue Administrators to a Venue During the Venue Creation Wizard, you will be asked to add Venue Administrators to the Venue. You can separately navigate to the Venue Administrators page by navigating to your Network Operator Console->Venues->View/Modify Venue->select the Venue->Administrators. Once there, click on "Add Administrator." Enter the information for the Administrator, and click on "Add Staff." The Administrator will then receive an [e-mail](/network-administrator-console/network-operator-settings/e-mail-templates) inviting them to complete the account creation process and login to their Venue Administrator portal. # Add Equipment to a Venue Here is a step-by-step guide on how to add equipment to a Venue. ### How to Add Equipment to a Venue During the Venue Creation Wizard, you will be asked to add equipment to the Venue. You can separately navigate to the Venue Administrators page by navigating to your Network Operator Console->Venues->View/Modify Venue->select the Venue->Equipment. Once there, click on "Add Equipment." Enter the information for the Equipment, and click on "Add Equipment." ### What Do Each of the Fields Mean? * Equipment Type * Router/Gateway: A Router/Gateway is linked to VAULT so VAULT can perform necessary functions including; * Disable Captive Portal on a VLAN when a valid subscriber exists in a unit assigned to that VLAN. * Set bandwidth controls (Max BW UP/Max BW Down) on a VLAN when a valid subscription exists in a unit assigned to that VLAN. * WiFi Controller: A WiFI Controller is linked to VAULT to allow VAULT to capture a finger print of a connected MAC address. VAULT will display this information to[ network administrators](/network-administrator-console/managing-your-subscribers/view-subscriber-devices) as well as subscribers. * Information may include Device name, Operating System, and Device Type. * Equipment Name: This field is used to Identify the equipment and is user-defined. * Manufacturer: This field is a required field and must be one of VAULT's [supported Wi-Fi Controllers](/network-equipment/supported-access-points) or [supported routers](/network-equipment/supported-routers). * Model: This field is used to identify the model of the equipment and is user defined. * Wireless Zone: This field is currently not required or critical to VAULT's operation, but may be in a future update. It may be used for filtering data in a multi-tenant wireless controller. For instance identifying rogue access points within a venue. * Connection Protocol: The protocol to use when connecting to this piece of equipment. Traditionally HTTP or HTTPS, but may include SSH, FTP, etc. * IP Address: The IP Address of the equipment that VAULT will communicate with to perform its functions. * Port: The UDP/TCP Port that VAULT will communicate through to perform its functions. * User Name: The username used to connect to the equipment being added. It is recommended to create a VAULT specific username for security purposes. * Password: The password used to connect to the equipment being added. It is recommended to create a VAULT specific username for security purposes. * Status: The current status of the equipment from VAULT's perspective: * UP: VAULT can reach the equipment and should continue operations as normal. * DOWN: VAULT is having trouble connecting with the equipment. VAULT will not continue attempting to communicate with the equipment. ### Adding Multiple Gateways to a Venue VAULT supports up to three Gateways per venue. When a Venue has multiple gatways, all configurations will be attempted on all gateways with a status set to "Up." If a new gateway is added to an existing venue, VAULT will attempt to configure all existing subscriptions to that gateway. ### How to View Equipment Logs Once equipment has been added to a Venue, you may begin to see it's logs by navigating back to the Equipment tab of the Venue Details page->Select the Equipment->Click the Logs tab. SIEMs may also view all recent configuration failures by navigating to their Network Operator Console->Settings->Equipment Error Log. For an individual gateway, they can navigate to the [equipment log](/network-administrator-console/creating-a-new-venue/add-equipment-to-a-venue#how-to-view-equipment-logs). ### What Happens if My Router or Gateway Fails to Configure? VAULT uses a tiered backoff with circuit breaker escalation. The gateway configuration scheduler automatically retries after failed configuration attempts. If failures continue, the system gradually slows down the retry rate, alerts operations staff, and eventually stops attempting configuration. Any **successful configuration attempt fully resets the error counters**, and the gateway returns to normal operation. Below are the various circuit breakers. These circuit breakers are subject to change as RoamingiQ continuously monitors their efficacy and routinely optimizes system performance. * 3 failures in 1 minute: Wait 1 minute before trying again. * 20 failures in 1 hour: Wait 1 hour before trying again, alert [SIEM Administrators.](/network-administrator-console/network-operator-settings/network-administrators#network-administrator-roles) * 39 failures in 1 day: Wait 1 day before trying again, alert [SIEM Administrators.](/network-administrator-console/network-operator-settings/network-administrators#network-administrator-roles) * 272 failures in 1 week: Mark gateway DOWN and stop all attempts, alert [SIEM Administrators.](/network-administrator-console/network-operator-settings/network-administrators#network-administrator-roles) If the final circuit breaker is tripped and the gateway is set to down, Network Operators may reset the gateway counters by navigating to the equipment details page and setting the status of the equipment back to up. Each circuit breaker counter is specific to an individual gateway, for Venues with multiple gateways. # Configure Venue Shopping Cart Here is a step-by-step guide on how to configure the shopping cart for a Venue. If you have enabled the [Shopping Cart](/network-administrator-console/network-operator-settings/shopping-cart) as a Network Administrator, you may choose to override some of those settings for a specific Venue. During the Venue Creation Wizard, you will be asked to make those modifications. You can separately navigate to the Venue Shopping Cart page by navigating to your Network Operator Console->Venues->View/Modify Venue->select the Venue->Shopping Cart. ### What Values Can I Override? VAULT follows a decision-making logic when processing retail transactions for a Venue. First, it looks to the Venue settings for any overrides. If an override value is present, VAULT will use that Value instead of the [Network Operator's Shopping Cart](/network-administrator-console/network-operator-settings/shopping-cart) setting. * Enable Shopping Cart: You can choose to enable or disable the shopping cart for a specific Venue. For example, if the [Shopping Cart](/network-administrator-console/network-operator-settings/shopping-cart) is enabled for the Network Operator, but disabled for the Venue, then this particular Venue will not be available for Shopping Cart based functions. All other Venues will remain available. * Shopping Cart Price Discount: You can provide a universal discount across all of your [Service Plans](/network-administrator-console/network-operator-settings/service-plans) for this Venue. * **Important Note:** When you edit the venue discount, if there are existing subscriptions at the venue, the discount is only applied to new subscriptions. * Trial Cycle Adjustments: You can adjust the number of [trial cycles](/network-administrator-console/network-operator-settings/service-plans#what-do-each-of-the-fields-mean) a user will receive for all [Service Plans](/network-administrator-console/network-operator-settings/service-plans) for this Venue. * Stripe Configuration Override: You can use a separate Stripe account for each Venue by entering that Stripe information here. * **Important Note: Do not modify these values if there are subscribers assigned to the Venue.** Once a subscriber has been added to a Venue, that subscriber's record is associated with the Stripe account that was associated with that Venue at the time the subscriber was created. If you modify the Stripe information for the Venue at that time, transactions for those subscribers will fail to process. # Connect a Venue to RealPage Here is a step-by-step guide on how to configure RealPage for a Venue. ### Venue Management Approval Before configuring a RealPage Venue in VAULT, you will need to reach out to your contact at the venue and ask them to approve VAULT for integration. These steps are per RealPage. 1. Login in to the RealPage Integration Marketplace. 2. Select Manage Integrations 3. Find RoamingiQ, or VAULT in the Integration list. 4. Find the property for syncing, and toggle the box. 5. Note, this will trigger an e-mail from RealPage to the VAULT team, that they will also have to approve. Once they have done so, they will confirm with you that are you are good to proceed. **Please do not proceed to the next steps until this is complete.**
### Configuring a RealPage Venue in VAULT 1. During the Venue Creation Wizard, you will be asked if you want to connect a [PMS Profile](/network-administrator-console/network-operator-settings/property-management-system) to the Venue. You can separately navigate to the PMS settings page by navigating to your Network Operator Console->Venues->View/Modify Venue->select the Venue->PMS. 2. Select the appropriate [PMS Profile](/network-administrator-console/network-operator-settings/property-management-system). 3. Enter the RealPage Site ID. The Venue Manager should have this information. 4. Determine if you want VAULT to sync units, or subscribers and units. In order to sync subscribers, unit sync must be enabled. 5. Click "Save Changes" to begin the sync process.
### How Do I Configure Unit VLANs When VAULT is Adding Units From RealPage? VAULT will automatically assign a VLAN to a unit from the available [Resident Devices VLAN range](/network-administrator-console/creating-a-new-venue/venue-details-configuration-options#resident-devices-vlan-range) according to the Venue profile. It is required to allow VAULT to generate the unit list from RealPage in order to ensure data accuracy. Once the unit list is generated, Network Administrators may [export their unit list](/network-administrator-console/managing-your-venues/export-units), make modifications to the VLANs, and then[ re-upload the unit list](/network-administrator-console/managing-your-venues/view-and-modify-venue-units#how-to-modify-multiple-units). Because the Unit IDs will be unchanged, VAULT will update the VLAN assignments as requested. Please refer to the [PMS Integration ](/network-administrator-console/network-operator-settings/property-management-system)article in the Knowledge Base for information about PMS integration. # Migrating a Venue to VAULT From Another Provider Here is a step-by-step guide on how to migrate a Venue from another User Interface or Authentication Provider to VAULT VAULT makes migrating subscribers and Venues from alternative platforms quick and easy. To start, the first thing you'll want to do is [create the Venue in VAULT.](/network-administrator-console/creating-a-new-venue) ### How Do I Import my Subscribers? When it is time to import your subscribers, the VAULT team will assist. We will ask you to provide a [subscriber upload CSV](/network-administrator-console/managing-your-subscribers/add-subscribers-to-a-venue#how-to-use-the-subscriber-upload-template) with one additional column, which is the subscriber's current Wi-Fi password. The VAULT team will then work their magic to allow your migrated subscribers to be imported, maintaining their existing Wi-Fi password. ### Will My Subscribers Be Impacted? That's the beauty of migration. No. With our migration process, your subscribers will retain access to the Wi-Fi. The only impact on the subscribers will be access to VAULT's subscriber portal. ### What Is the Process For a Migration? Here is the recommended process and timelines for migrating subscribers into the VAULT platform. These are flexible and can be adjusted with your VAULT Account Manager and your internal Customer Support team. 1. [Create the venue in VAULT.](/network-administrator-console/creating-a-new-venue) 2. 7 days prior to going live: We recommend you notify all of your subscribers of the upcoming change. Inform them that they are going to be invited to sign up and login to a new Wi-Fi portal, but that their service will not be disrupted. 3. 72 hours prior to going live: Remind your subscribers of the upcoming change. Inform them that they are going to be invited to sign up and login to a new Wi-Fi portal, but that their service will not be disrupted. 4. 48 hours prior to going live: Provide your VAULT Account Manager with a [subscriber upload CSV](/network-administrator-console/managing-your-subscribers/add-subscribers-to-a-venue#how-to-use-the-subscriber-upload-template), with one additional column, which is the subscriber's current Wi-Fi password. The VAULT team will then upload the subscribers to the Venue for you. **Note: The VAULT team must perform this step in order to keep the subscriber's existing Wi-Fi passwords active**. 5. At this time, e-mails will be sent to subscribers inviting them to log in and create their new VAULT account. 6. Going Live: Your networking team [modifies the configuration](/network-equipment/access-point-configuration-guides) on your controller to point the network at VAULT's servers. Subscribers are now authenticating against the VAULT system without ever losing connectivity. # Managing Your Subscribers Here is a step-by-step guide on how to mange your subscribers in VAULT. VAULT allows Network Operators total control over their subscribers, including [adding ](/network-administrator-console/managing-your-subscribers/add-subscribers-to-a-venue)and [removing ](/network-administrator-console/managing-your-subscribers/ending-a-subscription)subscribers, issuing [refunds](/network-administrator-console/managing-your-subscribers/issuing-a-refund-or-credit), and more. ### What Is a Subscriber? A Subscriber is an end-user that you want to grant Wi-Fi access to a network. # Add Subscribers to a Venue Here is a step-by-step guide on how to add subscribers to a Venue as a Network Administrator As a Network Administrator, you may [upload subscribers](#how-to-upload-the-subscriber-upload-template) or [add individual subscribers](#how-to-add-an-individual-subscriber). For Venue Administrators, click [here](/venue-administrator-console/venue-administrator-dashboard/add-subscribers). ### How to Download the Subscriber Upload Template You may upload subscribers using a CSV file. Navigate to your Network Operator Console->Subscribers->Upload Subscribers. From here, click on "Download Template", to receive a generic CSV template for the upload. If you first select a Venue, and then click, "Download Template," you will receive a custom and pre-populated template for that Venue.
Alternatively, you may [Export Units](/network-administrator-console/managing-your-venues/export-units) to receive a unit list already filled out and ready for upload. Just make sure to modify the missing headers of the Unit Export to match the headers of the subscriber upload template. ### How to Use the Subscriber Upload Template Each column represents a value that VAULT needs in order to add a Subscriber. The columns marked with a "\*" are required fields. **It's critical that you do not change any of the headers in the first row of the template**, or your subscriber upload may fail. That includes not removing the "\*" Here is what each of the values in the template mean; * Unit ID: This is the ID for the unit you will be adding the subscriber to. * Building: This is the building ID for the unit you will be adding the subscriber to. * Floor: This is the floor ID for the unit you will be adding the subscriber to. * Given Name: The Subscriber's first name. * Family Name: The Subscriber's last name. * E-mail: The Subscriber's e-mail address. * Locale: The language preference for the subscriber. * "en-us" for English. * "es-xl" for Spanish. * Address 1, Address 2, City, State, Postal Code: This is the address information for the unit, which can be different, or the same as, the address information for the venue. * Contact by Email: A true value means the subscriber has given their permission to be contacted via e-mail for **non-business critical communications**. A false value means they have not given their permission for the same. Note: Subscribers are unable to opt out of business critical communications. * Start Date: The start date for the subscription. * End Date: The end date for the subscription. If you do not enter an end date, the subscription will be active in perpetuity until it is [ended](/network-administrator-console/managing-your-subscribers/ending-a-subscription). * Subscriber Token: If the subscriber already exists, this is their unique identifier. * External Subscriber ID: Use this value for a subscriber ID that is external to VAULT, such as your own company's customer ID. * External Subscription ID: Use this value for a subscription ID that is external to VAULT, such as your own company's subscription ID. ### How to Upload The Subscriber Upload Template Once you've completed your template, save the file as a CSV. VAULT will not recognize other formats. Click the "Upload Subscribers" button and select your file using your operating systems file explore. The upload will begin immediately.
### How to Add an Individual Subscriber You may also add a Subscriber individually. From your Network Operator Console, click the hot button on the dashboard that says, "Add New Subscriber." Enter the same values from the upload CSV and select "Add Resident." ### Adding a Subscriber to a Retail Service Plan If the service plan you selected has a price, you will be asked to enter the subscriber's credit card information. You may choose to do so at this time, or you can close the prompt and the subscriber will be asked to enter their information when they log in to the [Subscriber Console](/subscriber-console/subscriber-console-introduction). The subscriber will not be able to view their Wi-Fi password until they enter their credit card information. ### Can a Subscriber Have Multiple Subscriptions? Yes. If a subscriber has multiple subscriptions at the same venue, they will have a different Wi-Fi password for each subscription. This way each subscription and Wi-Fi password will be associated to a unique VLAN. If a subscriber has multiple subscriptions at different venues, their Wi-Fi password will remain the same and be active at each venue. # View and Modify Subscriber Details Here is a step-by-step guide on how to view and modify subscriber details in VAULT . ### How to Find a Subscriber and Subscription in VAULT There are a couple of ways to find a subscriber in VAULT. * If you know the Subscriber's e-mail address, from your Network Operator Console->Subscribers->Subscriber Search. Enter the e-mail address of the Subscriber, and click "Search." * The search will return all subscriptions, past and present, for that e-mail address. * If the e-mail address is not an exact match, no results will be returned in the search. * You can also use the Subscriber Search feature to search by phone number, or view all historical subscriptions for a specific unit. * To view a list of all subscribers at a Venue, from the Network Operator Console->Subscribers->View/Modify Subscriber->select the Venue. You may then filter the list by searching for the subscriber's name, phone number, or part of their e-mail address. * To view an active subscriber in a unit, from the Network Operator Console->Venues->View/Modify Venue->select the Venue->Units. From here, you can search for a specific unit. Click on the unit in the table, then click the Subscriptions tab. If the unit has an active subscription, you may select that subscription. ### How to Modify a Subscriber or Subscription Once you've found the subscriber and opened the subscriber details page, you may edit any value that is not greyed out. To save your edits, click the button that says, "Save Changes" For an explanation of each value, refer to the [Add Subscribers ](/network-administrator-console/managing-your-subscribers/add-subscribers-to-a-venue#how-to-use-the-subscriber-upload-template)page of the Knowledge Base. ### How to Modify Multiple Subscriptions From the Network Operator Console, slick on Subscribers->View/Modify Subscriber->select the Venue. You can make limited edits en masse to multiple subscribers; 1. Modify Service Plan: Select the service plan you want to change subscribers to. Check the box next to each subscriber you want to move to the new service plan, and click, "Modify Service Plan." 2. Modify End Date: Select the new end date for the subscriptions. Check the box next to each subscriber you want to modify, and click, "Modify Selected Subscriptions." 3. Delete Subscriptions: Select the subscriptions you want to end immediately, and click "Remove Selected Subscriptions." ### How to Modify a Subscriber's Price The net billing price for a subscriber is the combination of multiple values added together. 1. The price of the [service plan.](/network-administrator-console/network-operator-settings/service-plans) 2. Any applicable [Venue discounts](/network-administrator-console/creating-a-new-venue/configure-venue-shopping-cart). 3. Any applicable [Unit discounts](/network-administrator-console/creating-a-new-venue/add-venue-units#how-to-use-the-unit-upload-template). When a subscription is created, the [Unit discount](/network-administrator-console/creating-a-new-venue/add-venue-units#how-to-use-the-unit-upload-template) that was associated with the unit at the time the subscription was created is copied to the subscription as a "Subscription Discount." This lets you modify [unit discounts ](/network-administrator-console/managing-your-venues/view-and-modify-venue-units)for future subscribers or subscription discounts for an active subscription without one impacting the other. As you enter a new "Subscription Discount," you will see the Net Billing Price update in real-time. Please note this is a preview, and you must select "Save Changes" in order to save the change. This price will be updated for the subscription's next billing cycle. It will not automatically [issue a refund or a credit](/network-administrator-console/managing-your-subscribers/issuing-a-refund-or-credit) for the subscription. ### What If I Created a Subscription At the Wrong Price? When a subscription is created, an invoice is generated that must have a payment applied to it. Any [modifications to a subscriber's price](#how-to-modify-a-subscribers-price) are only forward-looking. In the event this occurs, the best resolution is to [delete the subscription](/network-administrator-console/managing-your-subscribers/ending-a-subscription), ensure the [unit discount](/network-administrator-console/managing-your-venues/view-and-modify-venue-units) is set correctly, and then [re-add the subscriber](/network-administrator-console/managing-your-subscribers/add-subscribers-to-a-venue). Remember that because a Wi-Fi password is associated to a user, the user's existing Wi-Fi password will simply re-activate and all of their devices will automatically rejoin the network. ### Where Can I Find More Information on How VAULT Handles Payments? More Information can be found on the [Shopping Cart Payment Rules](/network-administrator-console/network-operator-settings/shopping-cart/shopping-cart-payment-rules) page of the Knowledge Base. ### Where Can I Resend the Subscriber's Activation E-mail or SMS? From the subscriber details, click the button that says, "Actions" and select "Resend Activation". From there, select if you want to resend the activation link via E-mail or SMS. If selecting SMS, please take note of the confirmation dialogue asking if you have the subscriber's consent to send the text message. RoamingiQ is not liable or responsible for any SMS messages that are sent to subscriber's without their explicit consent. Once you confirm that you have that consent by checking the two checkboxes, click "Resend Activation" from the confirmation screen to send the activation. ### How Do I Move a Subscription To a Different Venue? From the subscriber details, click the button that says, "Actions" and select "Move to Another Venue". From there, select the new Venue and Unit you want to move the subscription to. Important Note: This will end the current subscription and create a new subscription at the destination venue/unit. The subscriber’s service plan and personal profile will be preserved. If the subscriber has a payment method on file, they will need to re-enter their payment information upon login. The destination venue must have the same service plan available. # Ending a Subscription Here is a step-by-step guide on how to end a subscription in VAULT. Subscriptions will automatically end at midnight, local venue time, on the service end date. ### How to End a Subscription Immediately Navigate to the [Subscriber Details](/network-administrator-console/managing-your-subscribers/view-and-modify-subscriber-details#how-to-find-a-subscriber-and-subscription-in-vault) page. From there, click "Delete Subscription." If a payment has been processed, you will be asked if you want to [provide a refund](/network-administrator-console/managing-your-subscribers/issuing-a-refund-or-credit) to the subscriber. Select a reason for deleting the subscription, and click confirm. ### How to End a Subscription In the Future Because subscriptions will automatically end at midnight, local venue time, you may also modify the Service End date from the [Subscriber Details](/network-administrator-console/managing-your-subscribers/view-and-modify-subscriber-details#how-to-find-a-subscriber-and-subscription-in-vault) page. Click the Service End date field and select a new end date from the calendar. Then select "Save Changes" to submit the change. ### How to End Multiple Subscriptions You can also end multiple subscriptions at a given Venue at once. From your Network Operator Console, click "Subscribers", "then select "View/Modify Subscriber", and select your Venue from the Venue drop down. Select the tab labeled, "Delete Subscriptions." You may then select which Subscriptions you want to end and click, "Remove Selected Subscriptions" to end all of the selected subscriptions immediately. # Issuing a Refund or Credit Here is a step-by-step guide on how to issue a refund or credit in VAULT. Refunds and credits do not apply for free, or bulk, service plans. ### How to Issue a Refund to a Subscriber #### How to Issue a Refund to a Subscriber as Part of Ending a Subscription When [Ending a Subscription](/network-administrator-console/managing-your-subscribers/ending-a-subscription), Network Administrators have the option to issue a refund to a subscriber if they are on a paid service plan. Venue Administrators will automatically issue a refund or not, depending on your [default settings](/network-administrator-console/network-operator-settings/shopping-cart#what-do-each-of-the-fields-mean). [Navigate the Subscriber Details](/network-administrator-console/managing-your-subscribers/view-and-modify-subscriber-details#how-to-find-a-subscriber-and-subscription-in-vault) and [End the Subscription Immediately.](/network-administrator-console/managing-your-subscribers/ending-a-subscription#how-to-end-a-subscription-immediately) You then have two options to calculate the refund for the subscriber. You may select a "refund date," which will calculate the refund for you on a pro-rata basis based on the last invoice date and the refund date. Alternatively, you may enter a "Refund Amount" manually. Double check the Refund Amount is accurate, and click "Confirm."
#### How to Issue a Refund to a Subscriber For a Previous Charge Navigate to a [Subscriber's Transaction History](/network-administrator-console/managing-your-subscribers/view-subscriber-transaction-history). From here, you will see a list of all successful payments from a subscriber. Click the "Refund" button in the row of the transaction you want to refund, and then click the Refund tab. You then have two options to calculate the refund for the subscriber. You may select a "refund date," which will calculate the refund for you on a pro-rata basis based on the last invoice date and the refund date. Alternatively, you may enter a "Refund Amount" manually. Double check the Refund Amount is accurate, and click "Submit." ### How to Issue a Credit to a Subscriber You may also issue a credit against a subscriber's next invoice. Navigate to a [Subscriber's Transaction History](/network-administrator-console/managing-your-subscribers/view-subscriber-transaction-history). From here, you will see a list of all successful payments from a subscriber. Click the "Refund" button in the row of the transaction you want to refund, and then click the Credit tab. You then have two options to calculate the credit for the subscriber. You may select a date range, which will calculate the credit for you on a pro-rata basis based on the selected range. Alternatively, you may enter a "Credit Amount" manually. Double check the Credit fund Amount is accurate, and click "Submit." # Messaging Subscribers Here is a step-by-step guide on how to message Subscribers in VAULT. ### How VAULT Messaging Works VAULT has an internal messaging system that allows Network Administrators and Venue Administrators to message subscribers. This guide is for Network Administrators. Click [here ](/venue-administrator-console/venue-administrator-dashboard/message-subscribers)for Venue Administrators. When a message is sent to a subscriber, the subscriber will receive the relevant e-mail based on your [e-mail templates](/network-administrator-console/network-operator-settings/e-mail-templates), informing them they have a message. The subscriber is asked to log in to view the message. Upon login, the message will popup and the subscriber will be required to acknowledge the message to continue to the [subscriber console](/subscriber-console/subscriber-console-introduction). ### Why Do Subscribers Have to Log In to View a Message? VAULT captures the acceptance and acknowledgment of messages sent to subscribers. You can view this status and acceptance date from the Messages tab of the [Subscriber Details](/network-administrator-console/managing-your-subscribers/view-and-modify-subscriber-details#how-to-find-a-subscriber-and-subscription-in-vault) page. By requiring subscribers to log in, we are able to record that acceptance. ### How to Message a Single Subscriber Navigate to the [Subscriber Details](/network-administrator-console/managing-your-subscribers/view-and-modify-subscriber-details#how-to-find-a-subscriber-and-subscription-in-vault) page. From there, click the "Messages" tab. Click "Send Message," and enter your message subject and content. Click "Send" to send the message. ### How to Message Multiple Subscribers In order to message multiple subscribers, Network Administrators will need to [step down](/network-administrator-console/how-to-change-roles) to the Venue Administrator role and [Message Subscribers](/venue-administrator-console/venue-administrator-dashboard/message-subscribers). ### How to View When a Message is Read Navigate to the [Subscriber Details](/network-administrator-console/managing-your-subscribers/view-and-modify-subscriber-details#how-to-find-a-subscriber-and-subscription-in-vault) page. From there, click the "Messages" tab. Here you will see a list of messages and, if the message has been read, the time at which the subscriber read the message. # View Subscriber Bandwidth Here is a step-by-step guide on how to view a Subscriber's bandwidth in VAULT. If you have properly [configured the accounting server](/network-equipment/access-point-configuration-guides) on your wireless controller, VAULT will receive and capture bandwidth data for your Subscribers. ### How to View Subscriber Bandwidth Navigate to the [Subscriber Details](/network-administrator-console/managing-your-subscribers/view-and-modify-subscriber-details#how-to-find-a-subscriber-and-subscription-in-vault) page. From there, click the "Bandwidth" tab. Select either "7 days" or "6 months" to change the view and see the Subscriber's bandwidth data for the selected period of time. # View, Modify, and Test Subscriber Wi-Fi Passwords Here is a step-by-step guide on how to view Subscriber Wi-Fi Passwords in VAULT. ### A Note About Wi-Fi Passwords RoamingiQ believes a Wi-Fi password is a critical piece of personal information that belongs to Subscribers and Subscribers only. With VAULT's roaming capability, Wi-Fi passwords have more value and use than a traditional Wi-Fi password used to access a network. We fundamentally believe Wi-Fi passwords are not held up to acceptable security standards by our industry and counterparts. That said, we also recognize the need for support staff to be able to assist subscribers when they have Wi-Fi password issues. To that end, we allow Network Administrators, and only Network Administrators, the ability to view a subscriber's Wi-Fi password. Network Administrators should perform a thorough check to ensure the subscriber they are providing a Wi-Fi password to is indeed the actual subscriber. ### How to View a Subscriber's Wi-Fi Password Navigate to the [Subscriber Details](/network-administrator-console/managing-your-subscribers/view-and-modify-subscriber-details#how-to-find-a-subscriber-and-subscription-in-vault) page. From there, click the "Keys" tab. Find the SSID the Subscriber is trying to connect to, and click "Show Wi-Fi Password." You will be prompted to confirm you want to view the password, and can click "Show Password," to view the Wi-Fi password. ### How to Modify a Subscriber's Wi-Fi Password Navigate to the [Subscriber Details](/network-administrator-console/managing-your-subscribers/view-and-modify-subscriber-details#how-to-find-a-subscriber-and-subscription-in-vault) page. From there, click the "Keys" tab. Find the SSID the Subscriber is trying to connect to, and click "Change Wi-Fi Password." Enter the new Wi-Fi password for the subscriber, and click submit. Please note, although most Wi-Fi password changes take effect immediately, it may take up to five minutes to process the change. ### How to Test a Subscriber's Wi-Fi Password When Viewing a Subscriber's Wi-Fi Password, you also have the option to perform a test authentication by clicking the "Test PSK" button. You will be prompted to confirm all of the information in the test query is correct, and then click "Confirm" to perform the test. This test will send a test authentication to all of VAULT's authenticators, and respond with detailed results. Please note, performing a test authentication may cause a MAC address to show under the subscriber’s device list for up to 30 days as result of the test authentication. ### How To Generate Wi-Fi Password Handouts VAULT allows Network Administrators to generate paper Wi-Fi handouts to provide subscribers that contain their Wi-Fi Password. It is important to note that VAULT will allow you to generate a handout for residents who have not completed the registration process, which means they have not accepted the Terms and Conditions of using your service. It is the Network Operator's responsibility to only provide these handouts to user's who have accepted the terms and conditions. To generate the handouts, navigate to Support->Generate Wi-Fi Handouts. Choose the Venue, and select the unit(s) you want to generate the handout for, up to and including all units. Then select "Generate Individual Handouts." From there, you may either print them or save them as a PDF and provide them to the property. # View Subscriber Transaction History Here is a step-by-step guide on how to view Subscriber Transaction History in VAULT. ### How to View a Subscriber's Transaction History Navigate to the [Subscriber Details](/network-administrator-console/managing-your-subscribers/view-and-modify-subscriber-details#how-to-find-a-subscriber-and-subscription-in-vault) page. From there, click the "Transactions" tab. Here you will see a list of all transactions for a subscriber. This will include an "invoice" for zero dollar, or bulk transactions, as well as retail transactions. From this page, you may [process refunds or credits](/network-administrator-console/managing-your-subscribers/issuing-a-refund-or-credit) for Subscribers. # View Subscriber Logs Here is a step-by-step guide on how to view Subscriber Logs in VAULT. ### How to View a Subscriber's Log Navigate to the [Subscriber Details](/network-administrator-console/managing-your-subscribers/view-and-modify-subscriber-details#how-to-find-a-subscriber-and-subscription-in-vault) page. From there, click the "Logs" tab. You may use the log to help troubleshoot, or find more details about, a subscriber and subscription. ### What is in a Subscriber Log? The Subscriber Log shows various system events for subscribers. These events include but are not limited to; * Subscription creation * Subscription ending * Payment Success * Payment Failed * Payment Method entered * E-mail Sent * E-mail Read # View Subscriber Devices Here is a step-by-step guide on how to view Subscriber Devices in VAULT. If you have properly [configured the accounting server](/network-equipment/access-point-configuration-guides) on your wireless controller, VAULT will receive and capture device data for your Subscribers. ### How to View a Subscriber's Connected Devices Navigate to the [Subscriber Details](/network-administrator-console/managing-your-subscribers/view-and-modify-subscriber-details#how-to-find-a-subscriber-and-subscription-in-vault) page. From there, click the "Devices" tab. Here you will see a list of devices that are currently, or have recently, been connected. ### What Does Each Value Mean? * Status: A green dot indicates the device is currently connected. A red dot indicates the device is currently disconnected. * Type: The type of device, according to the [Wireless Controller](/network-equipment/access-point-configuration-guides). * Name: The name given to the device by the Subscriber, if any. * Host Name: The MAC address of the device. * IP Address: The IP Address of the device on the network. * Last Connected: The last time the device was seen by the [Wireless Controller](/network-equipment/access-point-configuration-guides). # View System Data Here is a step-by-step guide on how to view Subscriber System Data in VAULT. ### What is a Subscriber's System Data Subscriber System Data contains various internal and external values for a subscriber. These values are only relevant for advanced troubleshooting. ### How to View a Subscriber's System Data Navigate to the [Subscriber Details](/network-administrator-console/managing-your-subscribers/view-and-modify-subscriber-details#how-to-find-a-subscriber-and-subscription-in-vault) page. From there, click the "System Data" tab. Here you will see a list of devices that are currently, or have recently been, connected. ### What Does Each Value Mean? * Cognito Status * Confirmed: The subscriber's phone number or e-mail address has been verified. * Reset Required: The subscriber's password needs to be reset. * Compromised: The subscriber's account has been compromised and is disabled. * Unknown: The subscriber's status is unknown. * Status * AUP Not Accepted: The subscriber has been added to VAULT but has not completed their account setup by accepting the terms and conditions. * In Service: The subscriber is active and in service. * Error: The subscriber's status is unknown. * Email Verified: If the user has clicked a sign up link and completed their setup process, this will be "true." If not, it will be "false." * Subscriber Token: This is VAULT's unique identifier for the Subscriber. * Phone Number Verified: If the user has performed an SMS verification, this will be "true." If not, it will be "false." * External Subscriber ID: If an External ID was added to the subscriber by a Network Administrator, it will display here. * Stripe Customer ID: This is Stripe's unique identifier. * Subscriber Managed by SSO: If the Subscriber was added by a Single Sign On platform, this will be "true." If not, it will be "false." * Contact Pref SMS: If the subscriber has opted into SMS communications, this will be "true." If not, it will be "false." * Contact Pref Email: If the subscriber has not opted out of e-mail communications, this will be "true." If not, it will be "false." * Date Added: This is the date the subscriber was created. # Permanently Delete a Subscriber Record Here is a step-by-step guide on how to view permanently delete a Subscriber record in VAULT. ### An Important Warning! This process is not reversable. Performing this action will permanently remove all existence, including logs, of a subscriber. The subscriber's information will not be able to be recovered. This should only be used in the event of unrecoverable system errors or in response to data privacy requests. ### How to Delete a Subscriber Record As a Network Administrator, click on Support->Delete Subscriber. Enter the e-mail address of the subscriber you want to delete, and follow the on screen prompts. This deletion may take several minutes to process throughout the large VAULT database. # Managing Your Venues Here is a step-by-step guide on how to mange your Venues in VAULT. Once you have [created a new venue](/network-administrator-console/creating-a-new-venue), you can view and modify your Venues using the Network Operator Console. # View and Modify Venue Details Here is a step-by-step guide on how to View and Modify Venue Details in VAULT. ### How to Open Venue Details The quickest way to open the Venue Details page is to find the Venue using the quick access table when you log in to the Network Operator Console. You can search for the Venue name in the "Filter" box, or click "Show More +," and scroll until you find your Venue. Once you've found it, click on the Venue to open the Venue Details Page. Alternatively, from the Network Operator Console, you can click on "Venues," then click "View/Modify Venue," and select the Venue from the dropdown. ### How To Modify Venue Details From here, you can modify most of the information you entered when you [created the venue](/network-administrator-console/creating-a-new-venue). This includes [Venue Details](/network-administrator-console/creating-a-new-venue/venue-details-general-information), [Venue E-mail Settings](/network-administrator-console/creating-a-new-venue/venue-details-configuration-options#venue-e-mail-settings), [VLAN Ranges](/network-administrator-console/creating-a-new-venue/venue-details-configuration-options#venue-vlan-ranges), and [Overlapping Subscription Settings](/network-administrator-console/creating-a-new-venue/overlapping-subscriptions). You may also view the [NAS-ID](/network-equipment/access-point-configuration-guides/what-youll-need) required by your Wi-Fi Controller, VAULT's Venue ID, and your External Venue ID, if applicable. To submit your changes, click "Save Changes" at the bottom of the page. ### How to Modify Venue Settings Using the tabs across the top of the Venue Details page, you may also modify a venue's available [service plans](/network-administrator-console/creating-a-new-venue/add-and-remove-service-plans-to-venue), [modify keypools](/network-administrator-console/creating-a-new-venue/add-a-keypool-to-a-venue-or-unit), [add Venue Administrators](/network-administrator-console/creating-a-new-venue/add-venue-administrators-to-a-venue), [update or modify venue equipment](/network-administrator-console/creating-a-new-venue/add-equipment-to-a-venue), and modify [venue shopping cart](/network-administrator-console/creating-a-new-venue/configure-venue-shopping-cart) settings. # View and Modify Venue Units Here is a step-by-step guide on how to view and modify units for a Venue. There are two ways to update information for a unit. ### How to View Venue Units From your Network Operator Console, click "Venues", click "View/Modify Venue", select the Venue, click "Units." From here, you can search for the specific unit you want to update and click that unit in the table. #### Unit Subscriptions Along the top of the page, you may click the "Subscriptions" tab to view any Subscriptions in the unit. If there is an active subscription, clicking on it will take you to the [Subscriber Details](/network-administrator-console/managing-your-subscribers/view-and-modify-subscriber-details) page. #### Unit Logs Along the top of the page, you may can click the "Logs" tab to view any all of the Logs related to the unit. In these logs, you'll see events such as the unit being created or modified and a subscription being added or removed from the unit. #### Unit Shopping Cart Along the top of the page, you may can click the "Shopping Cart" tab to view unit level Shopping Cart settings. If you are offering retail services using the [Shopping Cart](/network-administrator-console/network-operator-settings/shopping-cart), you may provide a unit-level discount to subscribers who sign up for service in this unit. Any discount you apply here will be applied to all Subscribers who sign up for service in this unit until you remove the discount. The discount will not apply to any existing subscriptions in that unit. #### Unit Bandwidth Along the top of the page, you may click the "Bandwidth" tab to view the previous 6 months of Bandwidth data for the unit. You may also venue [subscriber bandwidth](/network-administrator-console/managing-your-subscribers/view-subscriber-bandwidth) and [venue bandwidth](/network-administrator-console/managing-your-venues/view-venue-bandwidth) in different locations. #### Unit Transactions Along the top of the page, you may click the "Transactions" tab to search the transaction history for the unit. You may also venue [subscriber transactions](/network-administrator-console/managing-your-subscribers/view-subscriber-transaction-history) in a different location. ### How to Modify a Single Unit From the Unit Details screen, you may modify the available values and click "Save Changes" once complete to save your changes. Refer to [this page](/network-administrator-console/creating-a-new-venue/add-venue-units) for a list of the values. ### How to Modify Multiple Units The easiest way to update multiple units is to process another [unit upload](/network-administrator-console/creating-a-new-venue/add-venue-units) using a CSV. VAULT will assume a unit is being updated, instead of being created, if one of the following two conditions are met; 1. The Unit ID, Building, and Floor already exist for that Venue. 2. The Unit\_ID Internal already exists for that Venue. It may be easiest to [export your units](/network-administrator-console/managing-your-venues/export-units) and use that CSV as the template to make changes. Note that VLANs for units with subscriptions attached cannot be updated. ### How to Delete Units From the Units tab of the Venue Details page, you check the box to the left of an individual unit or the box in the header to select all units. Then click "Delete Selected Units." VAULT will not allow a Network Administrator to delete a unit with an active subscription in the unit. ### Additional Unit Settings From the Unit Details page, there are two additional settings that can be modified that were not available during unit creation. When a unit is created, these two settings are copied from the Venue settings to the unit setting. * Allow Overlapping Subscriptions - This allows you to override the [Overlapping Subscriptions](/network-administrator-console/creating-a-new-venue/overlapping-subscriptions) setting for the Venue for this individual unit. * Enable Shopping Cart? - This allows you to override the [Shopping Cart](/network-administrator-console/creating-a-new-venue/configure-venue-shopping-cart) setting for a Venue for this individual unit. # Export Units Here is a step-by-step guide on how to export units for a Venue. You may export all of the units in a Venue to a CSV. This may be helpful if you need to [update the configuration](/network-administrator-console/managing-your-venues/view-and-modify-venue-units#how-to-modify-multiple-units) for multiple units. ### How to Export Units From your Network Operator Console->Venues->Export Units->select the Venue you wish to export->Export Units. This will download a CSV to your device.
# View Venue Bandwidth Here is a step-by-step guide on how view Venue bandwidth in VAULT. If you have properly [configured the accounting server](/network-equipment/access-point-configuration-guides) on your wireless controller, VAULT will receive and capture bandwidth data for your Venues. ### How to View Venue Bandwidth Data From the [Venue Details](/network-administrator-console/managing-your-venues/view-and-modify-venue-details#how-to-open-venue-details) page, select the "Bandwidth" tab. Enter the date of bandwidth data you wish to see, and select a Usage Unit for the output. Then select "Get Bandwidth Usage." You may also click "Export" to export the data to a CSV. Venue-level bandwidth data is received from your [wireless controller](/network-equipment/access-point-configuration-guides). VAULT is only able to display bandwidth data for one day at a time. Advanced Network Monitoring Software, such as PRTG, SolarWinds, and Zabbix, are available for more advanced reporting. # View Venue Logs Here is a step-by-step guide on how to view Venue Logs in VAULT. ### How to View a Venue's Log From the [Venue Details](/network-administrator-console/managing-your-venues/view-and-modify-venue-details#how-to-open-venue-details) page, select the "Logs" tab. Here you will see all of the log events related to a venue. This log page may have too much data if there is a specific event you are looking for. For more granular log data, it is better to [View Subscriber Logs](/network-administrator-console/managing-your-subscribers/view-subscriber-logs) or [View Unit Logs](/network-administrator-console/managing-your-venues/view-and-modify-venue-units#unit-logs). # View Venue Transaction History Here is a step-by-step guide on how to view Venue Transaction History in VAULT. ### How to View Venue Transaction History From the [Venue Details](/network-administrator-console/managing-your-venues/view-and-modify-venue-details#how-to-open-venue-details) page, select the "Transactions" tab. Enter the date range you wish to see, and click "Find Transactions." You may also click "Export" to export the data to a CSV. If you are looking for transactions for a particular subscriber, we recommend [Viewing Subscription Transaction History](/network-administrator-console/managing-your-subscribers/view-subscriber-transaction-history). # View Venue Devices Here is a step-by-step guide on how to view a Venue's connected devices in VAULT. ### How to View a Venue's Devices From the [Venue Details](/network-administrator-console/managing-your-venues/view-and-modify-venue-details#how-to-open-venue-details) page, select the "Devices" tab. This will display a list of recently connected devices at the Venue. You may click on a device to pull up the Subscription Details for the associated resident account. ### Understanding Flagged Devices VAULT may temporarily throttle a device that sends an unusually high volume of failed Wi-Fi authentication requests. This typically happens when a device is misconfigured or repeatedly retries an incorrect saved password. VAULT will not apply long-term throttling to devices for simple password mistakes. The majority of throttled attempts come from a small population of devices. At the time this article was published, approximately 61% of failed authentication requests during a recent monitoring period came from only 5% of devices that generated at least one failed request. Throttling: * Applies only to the individual device * Is temporary. Devices that are throttled are automatically reset after a maximum period of time. * Does not disable the subscriber or venue * Does not block every connection attempt If the device later submits valid credentials, it can connect normally. **Under no circumstances does VAULT have a blacklist that blocks all connection attempts from a device.** ### How to View Flagged Devices Within the Devices menu, select the "Flagged Devices" tab. This contains devices that have been flagged for potential abuse due to high volumes of bad authentication requests. The list contains four pieces of information 1. MAC Address: The physical MAC address of the device 2. Status: There are three status values; 1. Grace: The device has generated an elevated number of failed requests and is being lightly throttled. If a valid PSK is submitted during a processed request, the device can connect. 2. Concern: The device has generated an excessive number of failed requests and is being throttled more heavily. A valid PSK can still be processed, but the device may require multiple connection attempts. 3. Flagged: The device has generated an abusive volume of requests during the monitored period and is being aggressively throttled. The device can still connect if a valid PSK is processed, an administrator resets its status, or the remaining time expires and its status is automatically reset. 3. Attempts: The number of failed attempts received by VAULT during the monitored period. The monitored period begins when the first invalid request is received following an administrative reset or the automatic expiration of the previous monitoring period. 4. Time Remaining: The amount of time remaining in the monitored period, at which point a device's status is reset. ### How to Reset Flagged Devices From the Flagged Devices list, you may select some or all devices within a venue, and reset their flagged status back to zero. Select the device(s) you wish to reset, and select, "Reset Selected Devices." # Delete a Venue Here is a step-by-step guide on how to Delete a Venue in VAULT. ### How to Delete a Venue From your Network Operator Console, click "Venues" and click "View All Venues". Find the Venue you want to delete, and check the box to the left of the Venue. You may select multiple Venues for deletion. Once you have selected your Venue(s), click "Delete Selected Venues". You will receive a confirmation and warning dialogue. Follow the instructions in the prompt, and click Confirm. Please note, the deletion process may take an extended period of time to complete. VAULT will not fully delete a Venue if there are any active subscriptions in the Venue. Please remove the subscriptions individually before processing the Venue's deletion. # How to Change Roles Here is a step-by-step guide on how to change roles in VAULT. The VAULT user interface has three layers of access providing different views to user's based on their role. See [Network Administrator Console](/network-administrator-console/network-administrator-console-introduction), [Venue Administrator Console](/venue-administrator-console/venue-administrator-console-introduction), and [Subscriber Console](/subscriber-console/subscriber-console-introduction) for more details. Each user role is able to "step down" to the lower level of access. That means [Network Administrators](/network-administrator-console/network-operator-settings/network-administrators) are able to step down to the [Venue Administrator Console](/venue-administrator-console/venue-administrator-console-introduction), and [Network Administrators](/network-administrator-console/network-operator-settings/network-administrators) and [Venue Administrators](/venue-administrator-console/venue-administrator-console-introduction) can step down to the [Subscriber Console](/subscriber-console/subscriber-console-introduction). Please note, the [Subscriber Console](/subscriber-console/subscriber-console-introduction) may not display all elements properly if you do not have an active subscription at a Venue. ### How To Change Roles From the [Network Administrator Console](/network-administrator-console/network-administrator-console-introduction) or [Venue Administrator Console](/venue-administrator-console/venue-administrator-console-introduction), select the person icon on the top right of the screen, and select the Account for the role you wish to "step down" to. From the[ Subscriber Console](/subscriber-console/subscriber-console-introduction), select the hamburger menu on the top right, then click "My Account," and select the Account for the role you wish to "step up" to. Note that Subscribers will not have the option to "step up" from the Subscriber Console. # SMS Sign Up This page introduces SMS sign up for subscribers. ### What is SMS Sign Up? VAULT offers the convenience of delivering Wi-Fi passwords to subscribers via SMS. To utilize this feature, please contact your VAULT Account Manager. The VAULT team must complete an SMS number registration, which can take up to thirty days to receive. ### How To Configure SMS Sign Up To enable SMS sign up for subscribers, you must first configure a unit and service plan tailored for SMS-based registrations. Subscribers wishing to sign up will simply need to send a two-word text message to your designated phone number. The first word of the message will determine the service plan, and the second message will determine the unit or VLAN. #### Configuring the Service Plan When [configuring a service plan](/network-administrator-console/network-operator-settings/service-plans#what-do-each-of-the-fields-mean), enter the word you want to be associated with this service plan in the SMS Code field. For example, "free." #### Configuring the Unit SMS-based sign ups are considered [Guest Subscriptions](/venue-administrator-console/venue-administrator-dashboard/add-guests). VAULT needs a VLAN assigned to a unit in order to properly place a device, using a Wi-Fi password generated from an SMS-based sign up, on the correct VLAN. While there are a few configuration methods available, the recommended setup is as follows. 1. [Add a unit](/network-administrator-console/creating-a-new-venue/add-venue-units) to your "Global" venue. This is a venue that the VAULT team will have created in your environment. 2. For this purpose, be sure to select Guest Subscription. If doing a CSV upload select ["localwirelessonly."](/network-administrator-console/creating-a-new-venue/add-venue-units#what-does-each-of-the-values-mean) 3. For the SMS Code, enter the second half of the two-word message you want subscribers to send. For example, "WiFi." 4. Ensure that the VLAN associated with the unit is configured at all of your Venues with client isolation enabled. ### How to Use SMS Sign Up In this example, VAULT is configured to receive the SMS message "Free WiFi" at the phone number your VAULT Account Manager provided. When the message is sent to your phone number, the first word indicates the subscriber's chosen service plan, while the second word specifies the VLAN, via the unit, where the subscriber's devices will be placed. # Venue Administrator Console Introduction This page introduces the Venue Administrator Console. The Venue Administrator Console is the central hub for Venue Administrators to manage their venues and subscribers. A Venue Administrator may be a Venue Administrator at a single venue or multiple venues. ### How Do I Select Which Venue I Want to View? At the top left of the Venue Administrator dashboard, click the name of the venue. If you are a Venue Administrator at more than one venue, you may select which venue you are viewing. # Venue Administrator Dashboard This page introduces the Venue Administrator Dashboard. The Venue Administrator Dashboard is presented upon logging in and provides quick access to [add subscribers](/venue-administrator-console/venue-administrator-dashboard/add-subscribers), [add guests](/venue-administrator-console/venue-administrator-dashboard/add-guests), [add additional venue administrators](/venue-administrator-console/venue-administrator-dashboard/add-venue-administrators), and [send messages](/venue-administrator-console/venue-administrator-dashboard/message-subscribers).
# Add Subscribers Here is a step-by-step guide on how to add subscribers to a Venue as a Venue Administrator. As a Venue Administrator, you may [upload subscribers](#how-to-upload-the-subscriber-upload-template) or [add individual subscribers](#how-to-add-an-individual-subscriber). For Network Administrators, click [here](/network-administrator-console/managing-your-subscribers/add-subscribers-to-a-venue). ### What is a Subscriber? A subscriber is an end-user of the internet service at a Venue. For a multi-family community, consider this a resident of the property. A subscriber differs from a [guest](/venue-administrator-console/venue-administrator-dashboard/add-guests) who is at the venue on a short-term basis and needs temporary access. ### How to Upload Subscribers Using the Provided Template You may upload subscribers using a CSV file. Navigate to your Venue Administrator Console->Residents->Export Residents. This will download a file of your existing residents (if any). You can use this same template to upload new subscribers. ### How to Use the Subscriber Upload Template Each column represents a value that VAULT needs to add a subscriber. The columns marked with a "\*" are required. **It's critical that you do not change the headers in the first row of the template**, or your subscriber upload may fail. That includes not removing the "\*" Here is what each of the values in the template mean; * Unit ID: The ID for the unit you will add the subscriber to. * Building: The building ID for the unit you will add the subscriber to. * Floor: The floor ID for the unit you will add the subscriber to. * Given Name: The subscriber's first name. * Family Name: The subscriber's last name. * E-mail: The subscriber's e-mail address. * Locale: The language preference for the subscriber. * "en-us" for English. * "es-xl" for Spanish. * Phone: The subscriber's phone number. The format must include a country code. * For the United States, the format is +1xxxyyyzzzz * Address 1, Address 2, City, State, Postal Code: The address information for the unit. This can be the same as the venue address or different. * Contact by Email: A true value means the subscriber has given permission to be contacted via e-mail for **non-business critical communications**. A false value means they have not given permission. Note: Subscribers cannot opt out of business critical communications. * Contact by Text: A true value means the subscriber has given permission to be contacted via text. A false value means they have not given permission. * Start Date: The start date for the subscription. * End Date: The end date for the subscription. If you do not enter an end date, the subscription will be active in perpetuity until it is [ended](/network-administrator-console/managing-your-subscribers/ending-a-subscription). * Subscriber Token: If the subscriber already exists, this is their unique identifier. * External Subscriber ID: Use this value for a subscriber ID that is external to VAULT, such as your own company's customer ID. * External Subscription ID: Use this value for a subscription ID that is external to VAULT, such as your own company's subscription ID. ### How to Upload The Subscriber Upload Template Once you've completed your template, save the file as a CSV. VAULT will not recognize other formats. Navigate to your Venue Administrator Console->Residents->Bulk Upload Residents->select your file using your operating system's file explorer. The upload will begin immediately. ### How to Add an Individual Subscriber You may also add a subscriber individually. From your Venue Administrator Console, click the dashboard button, "Add New Resident." Enter the same values from the upload CSV and select "Add Resident." ### Adding a Subscriber to a Retail Service Plan If your selected service plan has a price, you will be prompted to enter the subscriber's credit card information. You may enter now, or you can close the prompt, and the subscriber will be asked to enter their information upon logging into the [Subscriber Console](/subscriber-console/subscriber-console-introduction). The subscriber will not be able to view their Wi-Fi password until they enter their credit card information. # Add Guests Here is a step-by-step guide on how Venue Administrators add guests to a Venue. ### What is a Guest? A guest is someone who needs free internet service at a Venue for a short period. For a multifamily community, this may be a prospective tenant or a handyperson working onsite for the week. A guest differs from a more permanent [subscriber](/venue-administrator-console/venue-administrator-dashboard/add-subscribers) who typically pays for internet service or receives internet service on an ongoing basis. ### How to Add a Guest From your Venue Administrator Console, click the dashboard button, "Add New Guest." Enter the required fields and select "Add Guest." Your guest will then receive an e-mail with instructions on how to connect to the network. ### # Add Venue Administrators Here is a step-by-step guide on how to add additional Venue Administrators. ### How to Add a Venue Administrator From your Venue Administrator Console, click the dashboard button, "Add/Modify Staff." Click the "+ Add Staff" button at the top of the popup. Enter the required fields, and select "Add Staff." Your Venue Administrator will receive an e-mail with instructions on how to set up their Venue Administrator Account. ### How to Remove a Venue Administrator From your Venue Administrator Console, click the dashboard button, "Add/Modify Staff." Find the Venue Administrator you wish to remove, and click "Delete" in the corresponding row. A confirmation window will appear. Click "Confirm" to remove the administrator. # Message Subscribers Here is a step-by-step guide on how to message Subscribers in VAULT. ### How VAULT Messaging Works VAULT has an internal messaging system that allows Network Administrators and Venue Administrators to message subscribers. This guide is for Venue Administrators. Click [here ](/network-administrator-console/managing-your-subscribers/messaging-subscribers)for Network Administrators. When a message with VAULT is sent to a subscriber, the subscriber receives an e-mail informing them of the new message. The subscriber is notified to log in to view the message. Upon login, the message pops up, and the subscriber is required to acknowledge the message to continue to the subscriber console. ### Why Do Subscribers Have to Log In to View a Message? VAULT captures the acceptance and acknowledgment of messages sent to subscribers. You can view the status and acceptance date from the Messages tab of the [Subscriber Details](/venue-administrator-console/managing-your-subscribers/view-and-modify-subscriber-details) page. By requiring subscribers to log in, we can record that acceptance. ### How to Message Multiple Subscribers From your Venue Administrator Console, click the dashboard button, "Send Message." Select if you want to message all buildings at the venue or only specific buildings. Enter your message subject and message content, then press send. ### How to Message a Single Subscriber Alternatively, you may navigate to the [Subscriber Details](/venue-administrator-console/managing-your-subscribers/view-and-modify-subscriber-details) page. From there, click the "Messages" tab. Click "Send Message" to enter your message subject and content. Click "Send" to dispatch the message. ### How to View When a Message is Read Navigate to the [Subscriber Details](/venue-administrator-console/managing-your-subscribers/view-and-modify-subscriber-details) page. From there, click the "Messages" tab. Here you will see a list of messages and, if the message has been read, the time at which the subscriber read the message. ### # Activity Summary Here is a step-by-step guide on the Activity Summary section of the Venue Administrator Dashboard. ### What is the Activity Summary? The Activity Summary is a quick view of recent service activations and upcoming expirations.
#### New Residents Today This provides a count of your total subscribers with a service start date of today's date. You can click on the count to view a list of these subscribers. Further, you may click on a subscriber to [view and modify subscriber details.](/venue-administrator-console/managing-your-subscribers/view-and-modify-subscriber-details) #### New Residents Next 7 Days This provides a count of your total subscribers with a service start date within the next 7 days. You can click on the count to view a list of these subscribers. Further, you may click on a subscriber to [view and modify subscriber details.](/venue-administrator-console/managing-your-subscribers/view-and-modify-subscriber-details) #### Expiring Within 14 Days This provides a count of your total subscribers with a service end date within the next 14 days. You can click on the count to view a list of these subscribers. Further, you may click on a subscriber to [view and modify subscriber details](/venue-administrator-console/managing-your-subscribers/view-and-modify-subscriber-details), including extending their service end date if needed. # Service Status Here is a step-by-step guide on the Service Status section of the Venue Administrator Dashboard. ### What is the Service Status The Service Status is a quick view of the status of units across your property.
#### Assigned Units This provides a count of your total units with a subscriber assigned to them. You can click on the count and view a list of these units and their assigned subscriber. Further, you may click on a subscriber to [view and modify subscriber details.](/venue-administrator-console/managing-your-subscribers/view-and-modify-subscriber-details) #### Unassigned Units This provides a count of your total units without a subscriber assigned to them. You can click on the count and view a list of these units. #### Pending AUP Acceptance This feature provides a count of your total units with assigned subscribers who have not completed their account activation and accepted the terms and conditions. By clicking on the count, you can access a list of these units along with their assigned subscribers. Further, you have the option to click "Resend Activation to All" to reissue the activation e-mail to all subscribers on this list. # Support Summary Here is a step-by-step guide on the Support Summary section of the Venue Administrator Dashboard. ### What is the Support Summary The Support Summary is a snapshot of support tickets and equipment status at your property. Note: the support summary may not display all values if VAULT does not support the ticketing system or Network Monitoring System your Network Operator is using. Today, VAULT supports Connectwise for ticketing and PRTG for Network Monitoring.
#### Open Tickets This provides a count of your total open tickets with your network operator. Click on the count to view a list of these tickets, as well as summary information. Due to user privacy, we are unable to display any further information on tickets to Venue Administrators. #### Core Equipment Status This feature offers an overview of your core equipment, such as routers, firewalls, and wireless controllers. If any core device is reported offline by the Network Monitoring, a red circle will appear. System. Click on the label to access the comprehensive list of equipment, along with the status reported by the Network Monitoring System. Additionally, hover over the "?" icon to view summary counts of the equipment status. #### Customer Premise Equip This area offers insight into the customer premise equipment, including access points. Status colors are determined by the criteria outlined in the table below. Green status indicates that both criteria columns are met, while yellow or red indicates that only one of the criteria columns is met. Click on the label to access a detailed list of equipment with status as reported by the Network Monitoring System. Additionally, hover over the "?" icon to view summary counts of the equipment status. | Circle Color | Total | Percentage | | ------------ | ----- | ------------ | | Green | <=30 | <=5% | | Yellow | 31-48 | >5% and <10% | | Red | >=49 | >=10.01% | # Quick Search Here is a step-by-step guide on how to Quick Search for Subscribers. ### What is the Quick Search Quick Search is the fastest way to [View and Modify Subscriber details.](/venue-administrator-console/managing-your-subscribers/view-and-modify-subscriber-details) You can search for a subscriber via e-mail address, unit number, building, floor, or name. # Recent Service Activations Here is a step-by-step guide on the Recent Service Activations table of the Venue Administrator Dashboard. ### What is the Recent Service Activations table? The Recent Service Activations table lists all recent service activations. It displays all historical activations, with the most recent at the top. Click "Show More +" to expand the list to more rows. You may click any subscription to [View and Modify Subscriber Details.](/venue-administrator-console/managing-your-subscribers/view-and-modify-subscriber-details)
#### # Renew or Confirm Upcoming Expirations Here is a step-by-step guide on the Renew or Confirm Upcoming Expiration table of the Venue Administrator Dashboard. ### What is the Renew or Confirm Upcoming Expirations Table? This table provides a list of subscriptions that are about to expire or reach their service end date. You can click "renew" to open the [Subscriber Details](/venue-administrator-console/managing-your-subscribers/view-and-modify-subscriber-details) page or "confirm" to clear the notification. Click "Show More +" to expand the list to more rows.
#### # Managing Your Subscribers Here is a step-by-step guide on how to mange your subscribers in VAULT. This section of the guide describes how to manage existing subscribers in VAULT. In order to first add a subscriber, click [here](/venue-administrator-console/venue-administrator-dashboard/add-subscribers). # View and Modify Subscriber Details Here is a step-by-step guide on how to view and modify subscriber details in VAULT. Once a subscriber has been added to VAULT, you may view their subscriber details in order to retrieve information or make changes to their subscription. ### How to Find a Subscriber and Subscription in VAULT There are a number of ways to view a subscriber's details. The quickest option is to use the [Quick Search](/venue-administrator-console/venue-administrator-dashboard/quick-search) feature near the top of the dashboard to search for the subscriber. Once you have found them, click on the subscriber to view their details. ### How to Modify a Subscriber Once you've found the subscriber and opened the subscriber details page, you may edit any value that is not greyed out. To save your edits, click the button that says, "Modify Resident." For an explanation of each value, refer to the [Add Subscribers ](/network-administrator-console/managing-your-subscribers/add-subscribers-to-a-venue#how-to-use-the-subscriber-upload-template)page of the Knowledge Base. # Ending a Subscription Here is a step-by-step guide on how to end a subscription in VAULT. Subscriptions will automatically end at midnight, local venue time, on the service end date. ### How to End a Subscription Immediately Navigate to the [Subscriber Details](/venue-administrator-console/managing-your-subscribers/view-and-modify-subscriber-details) page. From there, click "Delete Subscription." Select a reason for deleting the subscription, and click confirm. ### How to End a Subscription In the Future Because subscriptions are set to automatically end at midnight, local venue time, you may also modify the Service End date from the [Subscriber Details](/venue-administrator-console/managing-your-subscribers/view-and-modify-subscriber-details) page. Click the Service End date field and select a new end date from the calendar. Then select "Modify Resident" to submit the change. # View Subscriber Bandwidth Here is a step-by-step guide on how to view a Subscriber's bandwidth in VAULT. ### How to View Subscriber Bandwidth Navigate to the [Subscriber Details](/venue-administrator-console/managing-your-subscribers/view-and-modify-subscriber-details) page. From there, click the "Bandwidth" tab. Select either "7 days" or "6 months" to change the view and see the subscriber's bandwidth data for the selected period of time. # View Subscriber Transactions Here is a step-by-step guide on how to view Subscriber Transaction History in VAULT. ### How to View a Subscriber's Transaction History Navigate to the [Subscriber Details](/venue-administrator-console/managing-your-subscribers/view-and-modify-subscriber-details) page. From there, click the "Transactions" tab to see a list of all transactions for a subscriber. This will include an "invoice" for zero-dollar or bulk transactions, as well as retail transactions. # Resend Activation E-mail or SMS Here is a step-by-step guide on how to resend a subscriber's activation e-mail in VAULT. ### How to Resend All Subscriber's Activation E-mails To resend all subscriber's activation e-mails, refer to the [Service Status](/venue-administrator-console/venue-administrator-dashboard/service-status) page. ### How to Resend An Individual Subscriber's Activation E-mail Navigate to the [Subscriber Details](/venue-administrator-console/managing-your-subscribers/view-and-modify-subscriber-details) page. From there, confirm the "Status" field says "AUP not accepted." If the field says, "In Service" that means the subscriber has already retrieved their activation e-mail and completed their account set up process. From the subscriber details, click the button that says, "Resend Activation". From there, select if you want to resend the activation link via E-mail or SMS. If selecting SMS, please take note of the confirmation dialogue asking if you have the subscriber's consent to send the text message. RoamingiQ is not liable or responsible for any SMS messages that are sent to subscriber's without their explicit consent. Once you confirm that you have that consent by checking the two checkboxes, click "Resend Activation" from the confirmation screen to send the activation. # Export Subscribers Here is a step-by-step guide on how to export your subscribers in VAULT. To export your subscribers to a CSV, navigate to your Venue Administrator Console->Residents->Export Residents. # Support Here is a step-by-step guide on how to use Support options in VAULT. Some or all of the support features may not be enabled depending on your Network Operator's configuration. To view your support options from your Venue Administrator Dashboard, click "Support." #### New Support Ticket Click here to submit a support ticket to your network operator #### View Equip Up/Down This displays the status of core equipment at your venue. The status can also be viewed in the [Support Summary](/venue-administrator-console/venue-administrator-dashboard/support-summary) section of the dashboard. #### Signal Levels This displays the Wi-Fi signal strength, or RSSI, as reported by your Wi-Fi controller. #### Bandwidth Usage This displays the bandwidth usage for each unit at your venue on the selected date. You may click "Export" to export this data to a CSV file. #### FAQs This displays an FAQ for connecting devices to the network. # Subscriber Console Introduction This page introduces the Subscriber Console. The Subscriber Console is the central hub for subscribers, or end-users of your internet service, to manage their accounts. The subscriber console allows subscribers to view and edit their Wi-Fi passwords, view messages sent by [network administrators](/network-administrator-console/managing-your-subscribers/messaging-subscribers) and [venue administrators](/venue-administrator-console/venue-administrator-dashboard/message-subscribers), view their devices, and modify their payment information.
# Subscriber Account Activation This page introduces how subscriber's activate their account. VAULT has multiple ways to add subscribers. [Network Administrators](/network-administrator-console/managing-your-subscribers/add-subscribers-to-a-venue) or [Venue Administrators](/venue-administrator-console/venue-administrator-dashboard/add-subscribers) can add subscribers, or subscribers can sign up via the [shopping cart](/network-administrator-console/network-operator-settings/shopping-cart). No matter how a subscriber is added to VAULT, the quick and easy onboarding process remains the same. ### What Happens When a Subscriber is Added to VAULT? Once a subscriber has been added, using any method, there are a few quick steps for the subscriber to complete their account setup. 1. The subscriber will receive a welcome e-mail crafted from the [e-mail templates](/network-administrator-console/network-operator-settings/e-mail-templates) provided by the network operator. The e-mail includes an invitation prompting the subscriber to click a link, enabling them to set up their subscriber account.
2. Upon clicking the link in the email, the subscriber will be directed to a terms and conditions page where they can review and agree to the network operator's [terms and conditions](/network-administrator-console/network-operator-settings/terms-and-conditions). The subscriber will also be asked to create a password for the subscriber console.
3. The subscriber is now set up and can log in to access their Wi-Fi password and manage their account. # Subscriber Self-Sign Up This page introduces how subscriber's self-sign up for service using the VAULT shopping cart. To view how to setup the VAULT shopping cart, click [here](/network-administrator-console/network-operator-settings/shopping-cart). ### What is the Shopping Cart? The shopping cart allows subscribers to sign up for and modify their service via a self-service sign up flow. **The shopping cart supports both paid and free service plans**. Subscribers navigate to the shopping cart via your unique network operator URL/finddeals. For example, [www.roamingiq.com/finddeals](http://www.roamingiq.com/finddeals). From there, subscribers complete a basic shopping cart sign up flow; 1. The subscriber selects their venue
2. The subscriber provides basic user information including; 1. E-mail Address 2. First and Last Name 3. Phone Number 4. Unit 5. Service Start Date 3. Next, VAULT will display the available [service plans](/network-administrator-console/creating-a-new-venue/add-and-remove-service-plans-to-venue), and pricing if applicable.
4. If you have enabled [FCC Broadband Labels](/network-administrator-console/network-operator-settings/fcc-broadband-labels), the next page will display the label. If you do not have FCC Broadband Labels enabled for the venue, the user will be taken directly to step 5.
5. Next, VAULT will ask the user to confirm their information. 6. The next step depends on if the user is signing up for a paid plan or a free service plan. Paid Plan: If the user is signing up for a paid plan, they will be asked to enter their credit card information. This information is sent directly to Stripe. VAULT does not store or process the subscriber's credit card information.
Free Plan: If the user is signing up for a free plan, they will be asked to perform an SMS verification.
7. The user will receive their confirmation and welcome e-mail, and be invited to [complete their account setup](/subscriber-console/subscriber-account-activation). # API Documentation This page explains where to find VAULT API Documentation Current API Documentation is available at: {% embed url="" %} Deprecated API Documentation: {% embed url="" %} DISCLAIMER: This is the OpenAPI 3.0 documentation for the RoamingiQ's VAULT Network Operator Console APIs. This documentation was generated by Artificial Intelligence, and therefore may be subject to error. Please notify of any errors or issues. # Sample Webhook Payloads Here are sample payloads for the Available Webhooks. ### (VU1) VenueUnitAdded "Payload": { "Type": "VenueUnitAdded", "dateAddedUTC.ISO8601": "2023-03-23T04:09:08.125Z", "SourceIP": "68.116.101.82", "Administrator": "", "AdministratorOS": "Mac OS 10.15.7", "AdministratorBrowser": "Safari 16.3", "SourceLocale": "en-us", "UnitID\_internal": "USA.MA.02081.ROAMINIQDEMOMANAGEDPROPERTIES.WALPOLE.\_V3VENUE.USA.MA.02081.AAROAM666.WALPOLE.101.1.1", "PrimaryUnitID\_internal": "USA.MA.02081.ROAMINIQDEMOMANAGEDPROPERTIES.WALPOLE.\_V3VENUE.USA.MA.02081.AAROAM666.WALPOLE.101.1.1", "externalVenueUnitID": "", "VenueID": "USA.MA.02081.ROAMINIQDEMOMANAGEDPROPERTIES.WALPOLE.\_V3VENUE.USA.MA.02081.AAROAM666.WALPOLE", "externalVenueID": "", "UnitID": "Unit 10-TEMP-1953", "UnitFloor": "DEFAULT", "UnitBuilding": "DEFAULT", "AddressLine1": "763 Lucille Ct", "AddressLine2": "GJ - Retail Test 1", "City": "Moorpark", "State": "CA", "Country.ISO3166A3": "USA", "PostalCode": "93021", "vlan": 1953, "purpose": "wiredunit", "ServicePlanID\_globalroaming": "", "RealPageUnitID": "", "SMSCode": "", "VenueUnitPriceAdjustment": 0, "singleuseVenueUnitPriceAdjustment": "Inherit", "event": "Unit USA.MA.02081.ROAMINIQDEMOMANAGEDPROPERTIES.WALPOLE.\_V3VENUE.USA.MA.02081.AAROAM666.WALPOLE.101.1.1 added. " } ### (VU2) VenueUnitUpdated "Payload": { "Type": "VenueUnitUpdated", "dateAddedUTC.ISO8601": "2023-02-22T23:57:45.923Z", "SourceIP": "23.240.155.176", "Administrator": "TestToken", "AdministratorOS": "Mac OS 10.15.7", "AdministratorBrowser": "Safari 16.3", "SourceLocale": "en-us", "UnitID\_internal": "USA.VA.22102.ROAMINGIQD.WALPOLE.\_V3VENUE.USA.CA.93021.GJTESTVE.MOORPARK.UNITT1.1.1", "externalVenueUnitID": "", "VenueID": "USA.VA.22102.ROAMINGIQD.WALPOLE.\_V3VENUE.USA.CA.93021.GJTESTVE.MOORPARK", "UnitID": "Unit T1", "UnitFloor": "1", "UnitBuilding": "1", "AddressLine1": "763 Lucille Ct", "AddressLine2": "GJ Test Venue 1", "City": "Moorpark", "State": "CA", "Country.ISO3166A3": "USA", "PostalCode": "93021", "vlan": 1007, "purpose": "wiredunit", "ServicePlanID\_globalroaming": "", "RealPageUnitID": "", "SMSCode": "", "VenueUnitPriceAdjustment": -1500, "singleuseVenueUnitPriceAdjustment": "Inherit" } ### (V7) KeyStart { "dateAddedUTC.ISO8601": "2024-03-14T15:21:03.078Z", "Type": "KeyStart", "WebhookURL": "", "Payload": { "Type": "KeyStart", "dateAddedUTC.ISO8601": "2024-03-14T15:21:03.078Z", "VenueID": "USA.MA.02081.ROAMINIQDEMOMANAGEDPROPERTIES.WALPOLE.\_V3VENUE.USA.MA.02081.AAROAM666.WALPOLE", "purpose": "wiredunit", "VenueName": "AA RoamingiQ Demo Property10", "AddressLine1": "27 Renmar Ave", "AddressLine2": "Suite 10", "City": "Walpole", "State": "MA", "Country.ISO3166A3": "USA", "PostalCode": "02081", "UnitID\_internal": "USA.MA.02081.ROAMINIQDEMOMANAGEDPROPERTIES.WALPOLE.\_V3VENUE.USA.MA.02081.AAROAM666.WALPOLE.101.1.1", "UnitID": "6-203", "UnitBuilding": "6", "UnitFloor": "2", "vlan": 1282, "externalVenueUnitID": "", "RealPageUnitID": "", "SubscriberToken": "TestToken", "externalSubscriberID": "", "externalSubscriptionID": "", "ServicePlanID": "USA.VA.22102.ROAMINGIQ.WALPOLE.\_V3SERVICEPLAN\_.500MBX500MB", "psk": "kdnyyryy.TestToken", "ssid": "VAULT" }, "webhookresponse": \[ "Accepted" ] }, ### (V8) KeyEnd { "dateAddedUTC.ISO8601": "2024-03-14T14:56:42.354Z", "Type": "KeyEnd", "WebhookURL": "[https://mywebhook.com"](https://hook.us1.make.celonis.com/h115fv28652ngeowd1xhagh6e1216it5%22), "Payload": { "Type": "KeyEnd", "dateAddedUTC.ISO8601": "2024-03-14T14:56:42.354Z", "VenueID": "USA.MA.02081.ROAMINIQDEMOMANAGEDPROPERTIES.WALPOLE.\_V3VENUE.USA.MA.02081.AAROAM666.WALPOLE", "purpose": "wiredunit", "NAS-Identifier": "USA.MA.02081.AAROAM666.WALPOLE", "externalVenueID": "", "VenueName": "AA RoamingiQ Demo Property10", "AddressLine1": "27 Renmar Ave", "AddressLine2": "Suite 10", "City": "Walpole", "State": "MA", "Country.ISO3166A3": "USA", "PostalCode": "02081", "UnitID\_internal": "USA.MA.02081.ROAMINIQDEMOMANAGEDPROPERTIES.WALPOLE.\_V3VENUE.USA.MA.02081.AAROAM666.WALPOLE.101.1.1", "UnitID": "109", "UnitBuilding": "650", "UnitFloor": "1", "vlan": 1101, "externalVenueUnitID": "", "RealPageUnitID": "", "SubscriberToken": "TestToken", "externalSubscriberID": "", "externalSubscriptionID": "", "ServicePlanID": "USA.VA.22102.ROAMINGIQ.WALPOLE.\_V3SERVICEPLAN\_.1GIGX1GIG", "psk": "hccpcqfv.TestToken", "ssid": "VAULT" }, "webhookresponse": \[ "Accepted" ] }, ### (S1) LoginPasswordCreated "Payload": { "Type": "LoginPasswordCreated", "dateAddedUTC.ISO8601": "2023-03-15T03:12:49.743Z", "SourceIP": "23.240.155.176", "Administrator": "TestToken", "AdministratorOS": "", "AdministratorBrowser": "PostmanRuntime/7.31.1", "SourceLocale": "en-us", "EmailAddress": "", "SubscriberToken": "TestToken", "externalSubscriberID": "", "GivenName": "Gaurav", "FamilyName": "Jain", "locale": "en-us", "contactpref\_sms": false, "contactpref\_email": false, "event": "Subscriber accepted TandC. ", "PhoneNumber.E164": "+11234567890" } ### (SU1) SubscriptionSetupSuccess "Payload": { "Type": "SubscriptionSetupSuccess", "dateAddedUTC.ISO8601": "2023-03-22T21:40:02.060Z", "EmailAddress": "", "PhoneNumber.E164": "+11234567890", "SubscriberToken": "TestToken, "externalSubscriberID": "", "externalSubscriptionID": "", "GivenName": "Gaurav", "FamilyName": "Jain", "locale": "en-us", "contactpref\_sms": false, "contactpref\_email": false, "UnitID\_internal": "USA.CO.80112.ROAMINGIQMANAGEDPROPERTIES.WALPOLE.\_V3VENUE.USA.CA.93021.GJ-RETAI.MOORPARK.UNIT11.1.1", "externalVenueUnitID": "", "UnitID": "Unit 11", "UnitBuilding": "1", "UnitFloor": "1", "AddressLine1": "763 Lucille Ct", "AddressLine2": "GJ - Retail Test 1", "City": "Moorpark", "State": "CA", "PostalCode": "93021", "Country.ISO3166A3": "USA", "VenueID": "USA.CO.80112.ROAMINGIQMANAGEDPROPERTIES.WALPOLE.\_V3VENUE.USA.CA.93021.GJ-RETAI.MOORPARK", "externalVenueID": "3768-ext-Update1", "VenueName": "GJ - Retail Test 1", "VenueAddressLine1": "763 Lucille Ct", "VenueAddressLine2": "GJ - Retail Test 1", "VenueCity": "Moorpark", "VenueState": "CA", "VenueCountry.ISO3166A3": "USA", "VenuePostalCode": "93021", "Currency": "USD", "CurrencySymbol": "$", "ServicePlan": { "ServicePlanID": "USA.CO.80112.ROAMINGIQ.WALPOLE.\_V3SERVICEPLAN\_.500MBPS", "externalServicePlanID": "External SERVICEPLAN\_.500MBPS", "ServicePlanName": "500 Mbps", "ServicePlanDescription": "500 Mbps (with in-unit wired ports, billed monthly)", "BillingCycleHours": 730.5, "BillingCycleRecurrence": 0, "TrialCycles": 0, "VenuePriceAdjustment": -2000, "VenueUnitPriceAdjustment": -200, "DownloadKbps": 500000, "UploadKbps": 500000, "ConcurrentDevices": 100, "BillingCyclePrice.USD": 11099, "ListBillingCyclePrice.USD": 11099, "NetBillingCyclePrice.USD": 8899 }, "StripeCustomerID": "cus\_rAnDoMsTrInG", "SourceIP": "68.116.101.82", "AdministratorOS": "Mac OS 10.15.7", "AdministratorBrowser": "Safari 16.3", "SourceLocale": "en-us", "StartDateTimeUTC.ISO8601": "2023-03-26T07:00:00.000Z", "EndDateTimeUTC.ISO8601": "", "AccountAddedByAdministrator": "", "Status": "AUP not accepted", "SetupSuccessDateTimeUTC.ISO8601": "2023-03-22T21:40:18.134Z", "StripeSetupIntentId": "seti\_1MoZO4JdtrandomstringAkPzN", "StripePaymentMethod": "pm\_1MoZOGrandomstringhBTm90x", "Events": \[] } ### (SU2) SubscriptionPlanUpdated "Payload": { "Type": "SubscriptionPlanUpdated", "dateAddedUTC.ISO8601": "2023-03-22T21:40:02.060Z", "EmailAddress": "", "PhoneNumber.E164": "+11234567890", "SubscriberToken": "TestToken", "externalSubscriberID": "", "externalSubscriptionID": "", "GivenName": "Gaurav", "FamilyName": "Jain", "locale": "en-us", "contactpref\_sms": false, "contactpref\_email": false, "UnitID\_internal": "USA.CO.80112.ROAMINGIQMANAGEDPROPERTIES.WALPOLE.\_V3VENUE.USA.CA.93021.GJ-RETAI.MOORPARK.UNIT11.1.1", "externalVenueUnitID": "", "UnitID": "Unit 11", "UnitBuilding": "1", "UnitFloor": "1", "AddressLine1": "763 Lucille Ct", "AddressLine2": "GJ - Retail Test 1", "City": "Moorpark", "State": "CA", "PostalCode": "93021", "Country.ISO3166A3": "USA", "VenueID": "USA.CO.80112.ROAMINGIQMANAGEDPROPERTIES.WALPOLE.\_V3VENUE.USA.CA.93021.GJ-RETAI.MOORPARK", "externalVenueID": "3768-ext-Update1", "VenueName": "GJ - Retail Test 1", "VenueAddressLine1": "763 Lucille Ct", "VenueAddressLine2": "GJ - Retail Test 1", "VenueCity": "Moorpark", "VenueState": "CA", "VenueCountry.ISO3166A3": "USA", "VenuePostalCode": "93021", "Currency": "USD", "CurrencySymbol": "$", "ServicePlan": { "ServicePlanID": "USA.CO.80112.ROAMINGIQ.WALPOLE.\_V3SERVICEPLAN\_.750MBPS", "externalServicePlanID": "SP700MBPS", "ServicePlanName": "750 Mbps", "ServicePlanDescription": "750 Mbps (with in-unit wired ports, billed monthly)", "BillingCycleHours": 730.5, "BillingCycleRecurrence": 0, "TrialCycles": 0, "VenuePriceAdjustment": -2000, "VenueUnitPriceAdjustment": -200, "DownloadKbps": 750000, "UploadKbps": 750000, "ConcurrentDevices": 100, "BillingCyclePrice.USD": 8970, "ListBillingCyclePrice.USD": 8970, "NetBillingCyclePrice.USD": 6770 }, "StripeCustomerID": "cus\_NZiprandomt0wQR", "SourceIP": "68.116.101.82", "AdministratorOS": "Mac OS 10.15.7", "AdministratorBrowser": "Safari 16.3", "SourceLocale": "en-us", "StartDateTimeUTC.ISO8601": "2023-03-26T07:00:00.000Z", "EndDateTimeUTC.ISO8601": "", "StripeSetupIntentId": "seti\_1MoZO4randome6nAkPzN", "StripePaymentMethod": "pm\_1MoZOrandomntTAhBTm90x", "BillingCyclePriceAdjustment": 0, "Events": \[ { "timestamp": "2023-03-22T21:54:47.971Z", "event": "Subscription plan updated to 750 Mbps", "reason": "", "SourceIP": "68.116.101.82", "FirewallSourceIP": "68.116.101.82", "AdministratorOS": "Mac OS 10.15.7", "AdministratorBrowser": "Safari 16.3", "SourceLocale": "en-us", "Administrator": "TestToken, "ServicePlanID": "USA.CO.80112.ROAMINGIQ.WALPOLE.\_V3SERVICEPLAN\_.750MBPS" } ] } ### (SU3) SubscriptionVenueUnitUpdated "Payload": { "Type": "SubscriptionVenueUnitUpdated", "dateAddedUTC.ISO8601": "2023-03-22T16:51:47.466Z", "EmailAddress": "", "PhoneNumber.E164": "+11234567890", "SubscriberToken": "TestToken", "externalSubscriberID": "", "externalSubscriptionID": "", "GivenName": "Gaurav", "FamilyName": "Jain", "locale": "en-us", "contactpref\_sms": false, "contactpref\_email": false, "UnitID\_internal": "USA.CO.80112.ROAMINGIQMANAGEDPROPERTIES.WALPOLE.\_V3VENUE.USA.CA.93021.GJ-RETAI.MOORPARK.UNIT14.1.1", "externalVenueUnitID": "", "UnitID": "Unit 14", "UnitBuilding": "1", "UnitFloor": "1", "AddressLine1": "763 Lucille Ct", "AddressLine2": "GJ - Retail Test 1", "City": "Moorpark", "State": "CA", "PostalCode": "93021", "Country.ISO3166A3": "USA", "VenueID": "USA.CO.80112.ROAMINGIQMANAGEDPROPERTIES.WALPOLE.\_V3VENUE.USA.CA.93021.GJ-RETAI.MOORPARK", "externalVenueID": "3768-ext-Update1", "VenueName": "GJ - Retail Test 1", "VenueAddressLine1": "763 Lucille Ct", "VenueAddressLine2": "GJ - Retail Test 1", "VenueCity": "Moorpark", "VenueState": "CA", "VenueCountry.ISO3166A3": "USA", "VenuePostalCode": "93021", "Currency": "USD", "CurrencySymbol": "$", "ServicePlan": { "ServicePlanID": "USA.CO.80112.ROAMINGIQ.WALPOLE.\_V3SERVICEPLAN\_.1GBPS", "externalServicePlanID": "EXT1000E31", "ServicePlanName": "1 Gbps", "ServicePlanDescription": "1 Gbps (with in-unit wired ports, billed monthly)", "BillingCycleHours": 730.5, "BillingCycleRecurrence": 0, "TrialCycles": 0, "VenuePriceAdjustment": -2000, "VenueUnitPriceAdjustment": -1200, "DownloadKbps": 1000000, "UploadKbps": 1000000, "ConcurrentDevices": 100, "BillingCyclePrice.USD": 17999, "ListBillingCyclePrice.USD": 17999, "NetBillingCyclePrice.USD": 14799 }, "StripeCustomerID": "cus\_NZerandomCkYk", "SourceIP": "68.116.101.82", "AdministratorOS": "Mac OS 10.15.7", "AdministratorBrowser": "Safari 16.3", "SourceLocale": "en-us", "StartDateTimeUTC.ISO8601": "2023-03-22T17:22:38.522Z", "EndDateTimeUTC.ISO8601": "2023-04-01T06:59:59.999Z", "StripeSetupIntentId": "seti\_1MoUt6JrandomtT8G4llbwg", "StripePaymentMethod": "pm\_1MoUtrandomTqoXk1GMS", "Events": \[ { "timestamp": "2023-03-22T21:35:50.361Z", "event": "Subscription unit updated from Unit 11-1-1 to Unit 14-1-1", "reason": "", "SourceIP": "68.116.101.82", "FirewallSourceIP": "68.116.101.82", "AdministratorOS": "", "AdministratorBrowser": "PostmanRuntime/7.31.3", "SourceLocale": "en-us", "Administrator": "TestToken" } ] } ### (SU4) SubscriptionPriceUpdated "Payload": { "Type": "SubscriptionPriceUpdated", "dateAddedUTC.ISO8601": "2023-03-22T21:40:02.060Z", "EmailAddress": "", "PhoneNumber.E164": "+11234567890", "SubscriberToken": "TestToken", "externalSubscriberID": "", "externalSubscriptionID": "", "GivenName": "Gaurav", "FamilyName": "Jain", "locale": "en-us", "contactpref\_sms": false, "contactpref\_email": false, "UnitID\_internal": "USA.CO.80112.ROAMINGIQMANAGEDPROPERTIES.WALPOLE.\_V3VENUE.USA.CA.93021.GJ-RETAI.MOORPARK.UNIT11.1.1", "externalVenueUnitID": "", "UnitID": "Unit 11", "UnitBuilding": "1", "UnitFloor": "1", "AddressLine1": "763 Lucille Ct", "AddressLine2": "GJ - Retail Test 1", "City": "Moorpark", "State": "CA", "PostalCode": "93021", "Country.ISO3166A3": "USA", "VenueID": "USA.CO.80112.ROAMINGIQMANAGEDPROPERTIES.WALPOLE.\_V3VENUE.USA.CA.93021.GJ-RETAI.MOORPARK", "externalVenueID": "3768-ext-Update1", "VenueName": "GJ - Retail Test 1", "VenueAddressLine1": "763 Lucille Ct", "VenueAddressLine2": "GJ - Retail Test 1", "VenueCity": "Moorpark", "VenueState": "CA", "VenueCountry.ISO3166A3": "USA", "VenuePostalCode": "93021", "Currency": "USD", "CurrencySymbol": "$", "ServicePlan": { "ServicePlanID": "USA.CO.80112.ROAMINGIQ.WALPOLE.\_V3SERVICEPLAN\_.750MBPS", "externalServicePlanID": "SP700MBPS", "ServicePlanName": "750 Mbps", "ServicePlanDescription": "750 Mbps (with in-unit wired ports, billed monthly)", "BillingCycleHours": 730.5, "BillingCycleRecurrence": 0, "TrialCycles": 0, "VenuePriceAdjustment": -2000, "VenueUnitPriceAdjustment": -500, "DownloadKbps": 750000, "UploadKbps": 750000, "ConcurrentDevices": 100, "BillingCyclePrice.USD": 8970, "ListBillingCyclePrice.USD": 8970, "NetBillingCyclePrice.USD": 6470 }, "StripeCustomerID": "cus\_NZiprandom0wQR", "SourceIP": "68.116.101.82", "AdministratorOS": "Mac OS 10.15.7", "AdministratorBrowser": "Safari 16.3", "SourceLocale": "en-us", "StartDateTimeUTC.ISO8601": "2023-03-26T07:00:00.000Z", "EndDateTimeUTC.ISO8601": "", "StripeSetupIntentId": "seti\_1MoZOrandome6nAkPzN", "StripePaymentMethod": "pm\_1MoZOrandomntTAhBTm90x", "BillingCyclePriceAdjustment": 0, "Events": \[ { "timestamp": "2023-03-22T21:59:26.453Z", "event": "Updated unit-level price adjustment to -500", "reason": "Text", "SourceIP": "68.116.101.82", "FirewallSourceIP": "68.116.101.82", "AdministratorOS": "", "AdministratorBrowser": "PostmanRuntime/7.31.3", "SourceLocale": "en-us", "Administrator": "TestToken" } ] } ### (SU5) SubscriptionNextInvoiceAdjustment "Payload": { "Type": "SubscriptionNextInvoiceAdjustment", "dateAddedUTC.ISO8601": "2023-03-22T21:40:02.060Z", "EmailAddress": "", "PhoneNumber.E164": "+11234567890, "SubscriberToken": "TestToken", "externalSubscriberID": "", "externalSubscriptionID": "", "GivenName": "Gaurav", "FamilyName": "Jain", "locale": "en-us", "contactpref\_sms": false, "contactpref\_email": false, "UnitID\_internal": "USA.CO.80112.ROAMINGIQMANAGEDPROPERTIES.WALPOLE.\_V3VENUE.USA.CA.93021.GJ-RETAI.MOORPARK.UNIT11.1.1", "externalVenueUnitID": "", "UnitID": "Unit 11", "UnitBuilding": "1", "UnitFloor": "1", "AddressLine1": "763 Lucille Ct", "AddressLine2": "GJ - Retail Test 1", "City": "Moorpark", "State": "CA", "PostalCode": "93021", "Country.ISO3166A3": "USA", "VenueID": "USA.CO.80112.ROAMINGIQMANAGEDPROPERTIES.WALPOLE.\_V3VENUE.USA.CA.93021.GJ-RETAI.MOORPARK", "externalVenueID": "3768-ext-Update1", "VenueName": "GJ - Retail Test 1", "VenueAddressLine1": "763 Lucille Ct", "VenueAddressLine2": "GJ - Retail Test 1", "VenueCity": "Moorpark", "VenueState": "CA", "VenueCountry.ISO3166A3": "USA", "VenuePostalCode": "93021", "Currency": "USD", "CurrencySymbol": "$", "ServicePlan": { "ServicePlanID": "USA.CO.80112.ROAMINGIQ.WALPOLE.\_V3SERVICEPLAN\_.750MBPS", "externalServicePlanID": "SP700MBPS", "ServicePlanName": "750 Mbps", "ServicePlanDescription": "750 Mbps (with in-unit wired ports, billed monthly)", "BillingCycleHours": 730.5, "BillingCycleRecurrence": 0, "TrialCycles": 0, "VenuePriceAdjustment": -2000, "VenueUnitPriceAdjustment": -500, "DownloadKbps": 750000, "UploadKbps": 750000, "ConcurrentDevices": 100, "BillingCyclePrice.USD": 8970, "ListBillingCyclePrice.USD": 8970, "NetBillingCyclePrice.USD": 6470 }, "StripeCustomerID": "cus\_NZirandomt0wQR", "SourceIP": "68.116.101.82", "AdministratorOS": "Mac OS 10.15.7", "AdministratorBrowser": "Safari 16.3", "SourceLocale": "en-us", "StartDateTimeUTC.ISO8601": "2023-03-26T07:00:00.000Z", "EndDateTimeUTC.ISO8601": "", "StripeSetupIntentId": "seti\_1MoZO4Jdrandom6nAkPzN", "StripePaymentMethod": "pm\_1MoZOGrandomAhBTm90x", "BillingCyclePriceAdjustment": -500, "Events": \[ { "timestamp": "2023-03-22T22:02:35.464Z", "event": "Updating one-time adjustment for next billing cycle -500", "reason": "Text", "SourceIP": "68.116.101.82", "FirewallSourceIP": "68.116.101.82", "AdministratorOS": "", "AdministratorBrowser": "PostmanRuntime/7.31.3", "SourceLocale": "en-us", "Administrator": "TestToken" } ] } ### (SU6) SubscriptionStartDateAdjustment "Payload": { "Type": "SubscriptionStartDateAdjustment", "dateAddedUTC.ISO8601": "2023-03-21T19:55:43.231Z", "EmailAddress": "", "PhoneNumber.E164": "+11234567890", "SubscriberToken": "TestToken", "externalSubscriberID": "", "externalSubscriptionID": "", "GivenName": "Gaurav", "FamilyName": "Jain", "locale": "en-us", "contactpref\_sms": false, "contactpref\_email": false, "UnitID\_internal": "USA.CO.80112.ROAMINGIQMANAGEDPROPERTIES.WALPOLE.\_V3VENUE.USA.CA.93021.GJ-RETAI.MOORPARK.UNIT11.1.1", "externalVenueUnitID": "", "UnitID": "Unit 11", "UnitBuilding": "1", "UnitFloor": "1", "AddressLine1": "763 Lucille Ct", "AddressLine2": "GJ - Retail Test 1", "City": "Moorpark", "State": "CA", "PostalCode": "93021", "Country.ISO3166A3": "USA", "VenueID": "USA.CO.80112.ROAMINGIQMANAGEDPROPERTIES.WALPOLE.\_V3VENUE.USA.CA.93021.GJ-RETAI.MOORPARK", "externalVenueID": "3768-ext-Update1", "VenueName": "GJ - Retail Test 1", "VenueAddressLine1": "763 Lucille Ct", "VenueAddressLine2": "GJ - Retail Test 1", "VenueCity": "Moorpark", "VenueState": "CA", "VenueCountry.ISO3166A3": "USA", "VenuePostalCode": "93021", "Currency": "USD", "CurrencySymbol": "$", "ServicePlan": { "ServicePlanID": "USA.CO.80112.ROAMINGIQ.WALPOLE.\_V3SERVICEPLAN\_.500MBPS", "externalServicePlanID": "External SERVICEPLAN\_.500MBPS", "ServicePlanName": "500 Mbps", "ServicePlanDescription": "500 Mbps (with in-unit wired ports, billed monthly)", "BillingCycleHours": 730.5, "BillingCycleRecurrence": 0, "TrialCycles": 0, "VenuePriceAdjustment": -2000, "VenueUnitPriceAdjustment": -200, "DownloadKbps": 500000, "UploadKbps": 500000, "ConcurrentDevices": 100, "BillingCyclePrice.USD": 11099, "ListBillingCyclePrice.USD": 11099, "NetBillingCyclePrice.USD": 8899 }, "StripeCustomerID": "cus\_NZRandomH3e", "SourceIP": "68.116.101.82", "AdministratorOS": "Mac OS 10.15.7", "AdministratorBrowser": "Safari 16.3", "SourceLocale": "en-us", "StartDateTimeUTC.ISO8601": "2023-04-02T07:00:00.000Z", "EndDateTimeUTC.ISO8601": "", "StripeSetupIntentId": "seti\_1MoBHRandomYWDEsu8x", "StripePaymentMethod": "pm\_1MoBHRandomKntTOhkXqr6d", "Events": \[ { "timestamp": "2023-03-22T01:08:17.414Z", "event": "Subscription start date updated to 2023-04-02T07:00:00.000Z", "reason": "", "SourceIP": "68.116.101.82", "FirewallSourceIP": "68.116.101.82", "AdministratorOS": "Mac OS 10.15.7", "AdministratorBrowser": "Safari 16.3", "SourceLocale": "en-us", "Administrator": "TestToken" } ] } ### (SU7) SubscriptionEndDateAdjustment "Payload": { "Type": "SubscriptionEndDateAdjustment", "dateAddedUTC.ISO8601": "2023-03-22T01:50:42.702Z", "EmailAddress": "", "PhoneNumber.E164": "+11234567890, "SubscriberToken": "TestToken, "externalSubscriberID": "", "externalSubscriptionID": "", "GivenName": "Gaurav", "FamilyName": "Jain", "locale": "en-us", "contactpref\_sms": false, "contactpref\_email": false, "UnitID\_internal": "USA.CO.80112.ROAMINGIQMANAGEDPROPERTIES.WALPOLE.\_V3VENUE.USA.CA.93021.GJ-RETAI.MOORPARK.UNIT11.1.1", "externalVenueUnitID": "", "UnitID": "Unit 11", "UnitBuilding": "1", "UnitFloor": "1", "AddressLine1": "763 Lucille Ct", "AddressLine2": "GJ - Retail Test 1", "City": "Moorpark", "State": "CA", "PostalCode": "93021", "Country.ISO3166A3": "USA", "VenueID": "USA.CO.80112.ROAMINGIQMANAGEDPROPERTIES.WALPOLE.\_V3VENUE.USA.CA.93021.GJ-RETAI.MOORPARK", "externalVenueID": "3768-ext-Update1", "VenueName": "GJ - Retail Test 1", "VenueAddressLine1": "763 Lucille Ct", "VenueAddressLine2": "GJ - Retail Test 1", "VenueCity": "Moorpark", "VenueState": "CA", "VenueCountry.ISO3166A3": "USA", "VenuePostalCode": "93021", "Currency": "USD", "CurrencySymbol": "$", "ServicePlan": { "ServicePlanID": "USA.CO.80112.ROAMINGIQ.WALPOLE.\_V3SERVICEPLAN\_.500MBPS", "externalServicePlanID": "External SERVICEPLAN\_.500MBPS", "ServicePlanName": "500 Mbps", "ServicePlanDescription": "500 Mbps (with in-unit wired ports, billed monthly)", "BillingCycleHours": 730.5, "BillingCycleRecurrence": 0, "TrialCycles": 0, "VenuePriceAdjustment": -2000, "VenueUnitPriceAdjustment": -200, "DownloadKbps": 500000, "UploadKbps": 500000, "ConcurrentDevices": 100 }, "StripeCustomerID": "cus\_NrandomWbDnzi", "Events": \[ { "timestamp": "2023-03-22T02:11:25.674Z", "event": "Subscription end date updated to 2023-03-31T06:59:59.999Z", "reason": \[], "SourceIP": "68.116.101.82", "FirewallSourceIP": "68.116.101.82", "AdministratorOS": "Mac OS 10.15.7", "AdministratorBrowser": "Safari 16.3", "SourceLocale": "en-us", "Administrator": "TestToken" } ] } ### (SUS2) StripePaymentSuccess "Payload": { "Type": "StripePaymentSuccess", "dateAddedUTC.ISO8601": "2023-03-15T03:10:21.062Z", "EmailAddress": "", "PhoneNumber.E164": "+11234567890", "SubscriberToken": "TestToken", "externalSubscriberID": "", "externalSubscriptionID": "", "GivenName": "Gaurav", "FamilyName": "Jain", "locale": "en-us", "contactpref\_sms": false, "contactpref\_email": false, "UnitID\_internal": "USA.CO.80112.ROAMINGIQDEMO.WALPOLE.\_V3VENUE.USA.CA.93021.GJ-RETAI.MOORPARK.UNIT11.1.1", "externalVenueUnitID": "", "UnitID": "Unit 11", "UnitBuilding": "1", "UnitFloor": "1", "AddressLine1": "763 Lucille Ct", "AddressLine2": "GJ - Retail Test 1", "City": "Moorpark", "State": "CA", "PostalCode": "93021", "Country.ISO3166A3": "USA", "VenueID": "USA.CO.80112.ROAMINGIQDEMO.WALPOLE.\_V3VENUE.USA.CA.93021.GJ-RETAI.MOORPARK", "externalVenueID": "3768-ext-Update1", "VenueName": "GJ - Retail Test 1", "VenueAddressLine1": "763 Lucille Ct", "VenueAddressLine2": "GJ - Retail Test 1", "VenueCity": "Moorpark", "VenueState": "CA", "VenueCountry.ISO3166A3": "USA", "VenuePostalCode": "93021", "Currency": "USD", "CurrencySymbol": "$", "ServicePlan": { "ServicePlanID": "USA.CO.80112.ROAMINGIQ.WALPOLE.\_V3SERVICEPLAN\_.1GBPS", "externalServicePlanID": "EXT1000E31", "ServicePlanName": "1 Gbps", "ServicePlanDescription": "1 Gbps (with in-unit wired ports, billed monthly)", "BillingCycleHours": 730.5, "BillingCycleRecurrence": 0, "TrialCycles": 0, "VenuePriceAdjustment": -2000, "VenueUnitPriceAdjustment": -1000, "DownloadKbps": 1000000, "UploadKbps": 1000000, "ConcurrentDevices": 100, "BillingCyclePrice.USD": 14999, "NetBillingCyclePrice.USD": 14999, "ListBillingCyclePrice.USD": 17999 }, "StripeCustomerID": "cus\_NWorandomzA3V", "StripeSetupIntentId": "seti\_1MlkieJdrandomsDCunDB", "PaymentSuccessDateTimeUTC.ISO8601": "2023-03-15T03:10:21.062Z", "StripePaymentIntentId": "pi\_3MlkjHrandomtT119lsdJl", "StripePaymentChargeId": "ch\_3MlkjrandomT1earAubB", "AmountProcessed": 14999, "AmountReceived": 14999, "StripePaymentMethod": "pm\_1MlkiqJrandomonKn4jSR" } ### (SUS3) StripePaymentFailed "Payload": { "Type": "StripePaymentFailed", "dateAddedUTC.ISO8601": "2023-03-16T23:51:03.902Z", "EmailAddress": "", "PhoneNumber.E164": "+11234567890", "SubscriberToken": "TestToken, "externalSubscriberID": "", "externalSubscriptionID": "", "GivenName": "Gaurav", "FamilyName": "Jain", "locale": "en-us", "contactpref\_sms": false, "contactpref\_email": false, "UnitID\_internal": "USA.CO.80112.ROAMINGIQDEMO.WALPOLE.\_V3VENUE.USA.CA.93021.GJ-RETAI.MOORPARK.UNIT11.1.1", "externalVenueUnitID": "", "UnitID": "Unit 11", "UnitBuilding": "1", "UnitFloor": "1", "AddressLine1": "763 Lucille Ct", "AddressLine2": "GJ - Retail Test 1", "City": "Moorpark", "State": "CA", "PostalCode": "93021", "Country.ISO3166A3": "USA", "VenueID": "USA.CO.80112.ROAMINGIQDEMO.WALPOLE.\_V3VENUE.USA.CA.93021.GJ-RETAI.MOORPARK", "externalVenueID": "3768-ext-Update1", "VenueName": "GJ - Retail Test 1", "VenueAddressLine1": "763 Lucille Ct", "VenueAddressLine2": "GJ - Retail Test 1", "VenueCity": "Moorpark", "VenueState": "CA", "VenueCountry.ISO3166A3": "USA", "VenuePostalCode": "93021", "Currency": "USD", "CurrencySymbol": "$", "ServicePlan": { "ServicePlanID": "USA.CO.80112.ROAMINGIQ.WALPOLE.\_V3SERVICEPLAN\_.1GBPS", "externalServicePlanID": "EXT1000E31", "ServicePlanName": "1 Gbps", "ServicePlanDescription": "1 Gbps (with in-unit wired ports, billed monthly)", "BillingCycleHours": 730.5, "BillingCycleRecurrence": 0, "TrialCycles": 0, "VenuePriceAdjustment": -2000, "VenueUnitPriceAdjustment": -1000, "DownloadKbps": 1000000, "UploadKbps": 1000000, "ConcurrentDevices": 100, "BillingCyclePrice.USD": 17999, "ListBillingCyclePrice.USD": 17999, "NetBillingCyclePrice.USD": 14999 }, "StripeCustomerID": "cus\_NX9randomly2A", "StripeSetupIntentId": "seti\_1MmQj7randomtTJEgLPyFr", "StripePaymentMethod": "pm\_1MmQrandomi2aCqAbA", "PaymentFailureReason": " Card was declined for an unknown reason. ", "Events": \[ { "timestamp": "2023-03-17T00:01:20.311Z", "event": "Payment failed - Card was declined for an unknown reason. (generic\_decline). " } ] } ### (SUS4) StripePaymentMethodUpdated "Payload": { "Type": "StripePaymentMethodUpdated", "dateAddedUTC.ISO8601": "2023-03-15T23:55:56.301Z", "EmailAddress": "", "PhoneNumber.E164": "+11234567890, "SubscriberToken": "TestToken", "externalSubscriberID": "", "externalSubscriptionID": "", "GivenName": "Gaurav", "FamilyName": "Jain", "locale": "en-us", "contactpref\_sms": false, "contactpref\_email": false, "UnitID\_internal": "USA.CO.80112.ROAMINGIQDEMO.WALPOLE.\_V3VENUE.USA.CA.93021.GJ-RETAI.MOORPARK.UNIT11.1.1", "externalVenueUnitID": "", "UnitID": "Unit 11", "UnitBuilding": "1", "UnitFloor": "1", "AddressLine1": "763 Lucille Ct", "AddressLine2": "GJ - Retail Test 1", "City": "Moorpark", "State": "CA", "PostalCode": "93021", "Country.ISO3166A3": "USA", "VenueID": "USA.CO.80112.ROAMINGIQDEMO.WALPOLE.\_V3VENUE.USA.CA.93021.GJ-RETAI.MOORPARK", "externalVenueID": "3768-ext-Update1", "VenueName": "GJ - Retail Test 1", "VenueAddressLine1": "763 Lucille Ct", "VenueAddressLine2": "GJ - Retail Test 1", "VenueCity": "Moorpark", "VenueState": "CA", "VenueCountry.ISO3166A3": "USA", "VenuePostalCode": "93021", "Currency": "USD", "CurrencySymbol": "$", "ServicePlan": { "ServicePlanID": "USA.CO.80112.ROAMINGIQD.WALPOLE.\_V3SERVICEPLAN\_.1GBPS", "externalServicePlanID": "EXT1000E31", "ServicePlanName": "1 Gbps", "ServicePlanDescription": "1 Gbps (with in-unit wired ports, billed monthly)", "BillingCycleHours": 730.5, "BillingCycleRecurrence": 0, "TrialCycles": 0, "VenuePriceAdjustment": -2000, "VenueUnitPriceAdjustment": -1000, "DownloadKbps": 1000000, "UploadKbps": 1000000, "ConcurrentDevices": 100, "BillingCyclePrice.USD": 17999, "ListBillingCyclePrice.USD": 17999, "NetBillingCyclePrice.USD": 14999 }, "StripeCustomerID": "cus\_NX5randomOW0b", "SourceIP": "23.240.155.176", "AdministratorOS": "Mac OS 10.15.7", "AdministratorBrowser": "Safari 16.3", "SourceLocale": "en-us", "StartDateTimeUTC.ISO8601": "2023-03-16T00:03:35.964Z", "EndDateTimeUTC.ISO8601": "", "SetupSuccessDateTimeUTC.ISO8601": "2023-03-16T01:06:17.532Z", "StripeSetupIntentId": "seti\_1Mm5FjJrandomtTpoLjU4aY", "StripePaymentMethod": "pm\_1MmrandomntTfbyrSBHr", "Events": \[ { "timestamp": "2023-03-16T01:05:11.488Z", "event": "Payment method update requested (23.240.155.176 , Mac OS 10.15.7 , Safari 16.3 , en-us )" }, { "timestamp": "2023-03-16T01:05:28.624Z", "event": "Payment method updated. " }, { "timestamp": "2023-03-16T01:06:06.139Z", "event": "Payment method update requested (23.240.155.176 , Mac OS 10.15.7 , Safari 16.3 , en-us )" } ] } ### (SUS5) StripeChargeRefunded "Payload": { "Type": "StripeChargeRefunded", "dateAddedUTC.ISO8601": "2023-03-15T15:24:20.557Z", "EmailAddress": "", "PhoneNumber.E164": "+11234567890", "SubscriberToken": "TestToken", "externalSubscriberID": "", "externalSubscriptionID": "", "GivenName": "Gaurav", "FamilyName": "Jain", "locale": "en-us", "contactpref\_sms": false, "contactpref\_email": false, "UnitID\_internal": "USA.CO.80112.ROAMINGIQDEMO.WALPOLE.\_V3VENUE.USA.CA.93021.GJ-RETAI.MOORPARK.UNIT11.1.1", "externalVenueUnitID": "", "UnitID": "Unit 11", "UnitBuilding": "1", "UnitFloor": "1", "AddressLine1": "763 Lucille Ct", "AddressLine2": "GJ - Retail Test 1", "City": "Moorpark", "State": "CA", "PostalCode": "93021", "Country.ISO3166A3": "USA", "VenueID": "USA.CO.80112.ROAMINGIQDEMO.WALPOLE.\_V3VENUE.USA.CA.93021.GJ-RETAI.MOORPARK", "externalVenueID": "3768-ext-Update1", "VenueName": "GJ - Retail Test 1", "VenueAddressLine1": "763 Lucille Ct", "VenueAddressLine2": "GJ - Retail Test 1", "VenueCity": "Moorpark", "VenueState": "CA", "VenueCountry.ISO3166A3": "USA", "VenuePostalCode": "93021", "Currency": "USD", "CurrencySymbol": "$", "ServicePlan": { "ServicePlanID": "USA.CO.80112.ROAMINGIQ.WALPOLE.\_V3SERVICEPLAN\_.1GBPS", "externalServicePlanID": "EXT1000E31", "ServicePlanName": "1 Gbps", "ServicePlanDescription": "1 Gbps (with in-unit wired ports, billed monthly)", "BillingCycleHours": 730.5, "BillingCycleRecurrence": 0, "TrialCycles": 0, "VenuePriceAdjustment": -2000, "VenueUnitPriceAdjustment": -1000, "DownloadKbps": 1000000, "UploadKbps": 1000000, "ConcurrentDevices": 100, "BillingCyclePrice.USD": 14999, "NetBillingCyclePrice.USD": 14999, "ListBillingCyclePrice.USD": 17999 }, "StripeCustomerID": "cus\_NX0BrandomWYw", "AmountRefunded": 14978, "StripeSetupIntentId": "seti\_1MlwArandom9YQPdUWT", "StripePaymentIntentId": "pi\_3MlwBrandomtT0c0n2tzy", "RefundDateTimeUTC.ISO8601": "2023-03-15T15:25:00.422Z", "StripeRefundReceiptURL": "", "AmountProcessed": 14999 } # Property Management Group This page describes Property Management Groups Property Management Groups are currently under development for future use cases. This page will be updated accordingly.