Voiceware Quick Config
- Aaron Bailey
The Voiceware Quick Config is a web tool that is designed to allow the bulk upload of rooms, users, and devices and then push that data into a Voiceware system. Our goal is to reduce the time required to setup a Voiceware system by removing repetitive tasks such as adding users or assigning room devices to the lines of a gateway.
Version: 1.3
Quick Start
Add templates for Users, Rooms, and Endpoints.
We recommend using as few templates as possible to keep things simple and easy to manage.
Create one Endpoint template for each type of Phone or Gateway you plan to use.
Create a site and manually add one guest and room
Download the CSV file with data and use as a template to add the remaining users and rooms.
Save this one entry template for later use.
Once all users and rooms have been added use the Transfer Data button to transfer the data to an empty (i.e. factory default) Voiceware system.
Tips:
Each template will be assigned a number along with the chosen name. This number must be included in the template name inside the CSV file.
The CSV file with one user and room can be sent to the hotel if you have a quality contact to be filled out by the hotel.
Templates can be changed for user or rooms in bulk after they have been uploaded by checking the entries and then using the menu drop-down in the top left.
Never attempt to transfer data to a live or configured system. The Quick Config should not allow this but it is your responsibility to check first. Phonesuite will not be held liable for damage done to a live system if the Quick Config is used incorrectly.
The Dashboard currently displays a list of sites that have been built. More information will be added here as needed.
There are three types of templates, Users, Rooms, and Endpoints. These templates contain settings that are later assigned to users or rooms. This helps speed the process of user setup by not requiring that settings like NAT or Phone in Browser Console be set per user / device.
Templates can be used for any site (hotel) and reused any number of times.
Templates will always have a number assigned to them, this number is required in the CSV file when uploading users or templates. See the Sites section for more information.
User Templates
Used to set defaults for users. Its recommended that a standard admin user, and a Front Desk user template be created.
Remember to keep it simple, don’t create 15 user templates, if one user is different than all other admins simply make that change after pushing the data into Voiceware.
Rooms
This template is used for rooms. Again its recommended to only have a few simple templates, one for guest and non-guest rooms.
Endpoints
Endpoint templates will be used to create Endpoints for rooms and users.
Create an Endpoint template for each unique phone and gateway you install.
For Gateways always set the Line Keys to 1.
If no Digit Map is entered the default digit map in the Settings page of Voiceware will be used.
Each new Voiceware installation will have one Site in the Quick Config created for it.
Each site has two tabs, Site Users, and Site Rooms. These tabs allow the addition, edit, or deletion of users or rooms.
For first time setup we recommend manually creating one user and room then download the CSV file with the user and room data. This will give you a good template to use and sample data.
Depending on your customer it might even be possible to send the CSV template to the hotel and have them fill it out. If this is done always check the data before attempting to upload it into the Quick Config.
Site Users
All templates are assigned a number. This number (as pictured above, the 4) must be included in the template name when creating a CSV file.
Templates can be changed in bulk by checking users and then using the “Assign Template” option from the options menu.
Users can manually be added by clicking New User and filling out the information.
Site Rooms
Like users above site rooms can be created manually or created by upload of a simple CSV file.
Having the hotel export a room list and using it as the basis for the CSV upload is likely the quickest and more accurate way to add rooms.
The Port number is the actual port that this room will be assigned to, not the number of line keys. As such the port number should be unique per assigned gateway (i.e. two rooms can’t be assigned to port 7 on the gateway).
Once all data has been entered into the Quick Config its time to push the data into a Voiceware system. To start this process click on the Transfer Data button in the top right.
Next enter the sites IP address in the field and click Check.
If your system has a port forward simply add the port number to the IP (i.e. 1.2.3.4:57090). The Quick Config uses port 443 to do the data transfer.
Never attempt to transfer data to a live or configured system. The Quick Config should not allow this but it is your responsibility to check first. Phonesuite will not be held liable for damage done to a live system if the Quick Config is used incorrectly.
Once the check is complete click on transfer data again and then click Push. After a short time the data will be pushed into the system. Log into the Voiceware system (or refresh the page if already logged in) to spot check the data.
After pushing devices into the system it will take Voiceware 1-2 minutes to load the devices into Asterisk and for them to change their status from N/A to Unregistered.