installation_guide:configuration:start

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		 Previous revision
Next revisionBoth sides next revision
installation_guide:configuration:start [2016/09/09 13:48] – [Web Configuration of Voximal] borjainstallation_guide:configuration:start [2016/10/25 20:49] – [Login] borja
Line 1: Line 1:
-====== Voximal  Web Configuration with FreePBX ======+====== Voximal Web Configuration ======
  
 ===== Access ===== ===== Access =====
  
 All the configuration is managed throw a web interface based on the FreePBX project. All the configuration is managed throw a web interface based on the FreePBX project.
-To access to the web interface, open the link **''http://your_server_address/admin''**.  +To access to the web interface, open the link 
-It's protected by a login.+
  
 +**''http://your_server_address/admin''**. 
 +
 +It's protected by a login (the first login after the installation will request you a password).
 +
 +
 +{{:installation_guide:configuration:voximal_first.png?nolink&1000|//-- add screenshot --//}}
  
 ===== Login ===== ===== Login =====
  
-After installation there are 3 default login, with differents access permissions  +After installation there are 3 default login accounts, with differents access permissions  
-  * **''user''** : access to Voximal configuration and reports. +  * **user** : access to Voximal configuration and reports. 
-  * **''admin''** : user access and network configuration +  * **admin** : user access and network configuration 
-  * **''root''** : full access (full freePBX features).+  * **root** : full access (full freePBX features). 
 + 
 +Each login have a default password (requested after the package installation, or the image activation), you can be change them with the root account. 
 + 
 +{{:installation_guide:configuration:voximal_login.png?nolink&1000|}} 
  
-Each login has a default password, you can be change it with the root account.+===== System Status =====
  
-//-- add screenshot --//+The home page after login show you the system status.
  
 +  * Host name of the server
 +  * Summary : Main modules status
 +  * Interpreter statistics
 +  * Telephony statistics
 +  * Uptime / Load average
  
 +{{:installation_guide:configuration:voximal_system_status.png?nolink&1000|}}
 ---- ----
  
-===== Configuration steps =====+===== Main configuration steps =====
  
 To configure the Voximal IVR you have 4 steps to do : To configure the Voximal IVR you have 4 steps to do :
Line 30: Line 46:
   - Configure the relation between the DID and the VoiceXML service you want to use ([[#Routes configuration|Routes configuration]])   - Configure the relation between the DID and the VoiceXML service you want to use ([[#Routes configuration|Routes configuration]])
  
-Some default values can be updated with the page **''Settings/Voximal settings''**.+---- 
 +**Note**: On each configuration page, don't forget to click on **[Submit]** button at the bottom page before changing page. If you don't click on **[Submit]** you'll lose all your changes.
  
-The license informations are accessible in page **''Settings/Voximal settings''**, in tab ''License''.+**Note**: All changes are not directly configure on the server. After one change, you'll see a button **[Apply Config]** in menu. To activate the changes on server __you have to click on__ **[Apply Config]**. 
 +----
  
-//**__WARNING__**: On each configuration page, don't forget to click on ''Submit'' button at the bottom page before changing page. If you don't click on ''Submit'' you'll lose all your changes.//+==== 1) Configure the telephony access ====
  
-//**__WARNING__**: All changes are not directly configure on the server. After one change, you'll see a button **''"Apply Config"''** in menu. To put change on server __you have to click on__ **''"Apply Config"''**.//+If your server is connected to the internet you can use the free test access to place calls to your server. 
 +There is nothing to do. You should only check that the port 4569 is open from/to internet in UDP.
  
----- 
  
-==== 1) SIP accounts ==== 
  
 You can create a SIP trunk with an operator with the page [[installation_guide:voipproviders:start|Voip Providers]]. You can create a SIP trunk with an operator with the page [[installation_guide:voipproviders:start|Voip Providers]].
Line 55: Line 72:
 0033123456789:password@myprovider.com/33123456789 0033123456789:password@myprovider.com/33123456789
 </code> </code>
-  * **Click on submit** button+  * Click on **[submit]** button (don't remember to apply your modifications)
  
-//-- add screenshot --//+{{:installation_guide:configuration:voximal_trunks.png?nolink&1000|}}
  
 ---- ----
Line 63: Line 80:
 ==== 2) Create a VoiceXML service ==== ==== 2) Create a VoiceXML service ====
  
-You need to create VoiceXML service, by uploading it or writing it directly with embedded VoiceXML/PHP editor,  with the page **''Applications/Voximal''**.+You need to create VoiceXML service, by uploading it or writing it directly with the embedded VoiceXML/PHP editor.  
 +Select the application menu **Voximal**.
  
 === Uploading VoiceXML service === === Uploading VoiceXML service ===
  
-In page Applications/Voximal click on **''Editor''** tab.+{{:installation_guide:configuration:voximal_editor_folder.png?nolink&1000|}} 
 + 
 +In page Applications/Voximal click on **Editor** tab.
 At the end of the page, you have the way to upload files : At the end of the page, you have the way to upload files :
-    * Click on **''Browse''** and select your files (''.vxml'', ''.php'', ...). +    * Click on **Browse** and select your files (.vxml, .php, ...). 
-    * Then click on **''Upload''**. Your files will appear in list.+    * Then click on **[Upload]**. Your files will appear in list.
  
 === Create VoiceXML service with editor === === Create VoiceXML service with editor ===
  
-You can update VoiceXML file (extension ''.vxml''), by clicking on the filename. The file content will appear, and you'll be able to update it, and check the syntax. 
  
-The editor page allow to create folders and files, and edit them. 
  
-To create folders or files, click on right items on top right corner (**''Create Directory''** or **''Create File''**).+You can update VoiceXML file (extension .vxml), by clicking on the filename. The file content will appear, and you'll be able to update it, and check the syntax. 
 + 
 +The editor page allow to create folders and files, and edit them.
  
-Then enter filename, and click **''Create button''**.+To create folders or files, click on right items on top right corner (**Create Directory** or **Create File**).
  
-//-- add screenshot --//+Then enter filename, and click **[Create]**.
  
 +{{:installation_guide:configuration:voximal_editor_file.png?nolink&1000|}}
  
 ---- ----
  
-==== 3) Voximal accounts ====+==== 3) Create a Voximal account ====
  
-When your VoiceXML services are ready, you have to define it in the IVR. +When your VoiceXML services is ready, you have to configure it in the server. 
-To do it, add Voximal applications. Click on **''Applications/Voximal''** menu item.+To do it, add Voximal account. Select the **Voximal** menu item.
  
-To create a Voximal Application, you have to define in minimum 2 required informations : +To create a Voximal Account, you have to define in minimum 2 required informations : 
-  - An application name, in field **''Name''** +  - An application name, in field **Name** 
-  - The VoiceXML url of the service, in field **''URL''**. You can select a local one, in the list or writing a local or HTTP one.+  - The VoiceXML url of the service, in field **URL**. You can select a local one, in the list or writing a local or HTTP one.
 There are several options : There are several options :
-  - **''Max sessions''** : you can define a specific limit, if you want lower maximum session than the license. +  - **Max sessions** : you can define a specific limit, if you want lower maximum session than the license. 
-  - **''Dial format''** : you can define a specific dialout format for outgoing calls. +  - **Dial format** : you can define a specific dialout format for outgoing calls. 
-  - **''Mark''** : you can define a specific mark, that will appear in traces. +  - **Mark** : you can define a specific mark, that will appear in traces. 
-  - **''Speech''** : you can specify the use of the ASR. In case of using ASR server, the better way is to set ''Automatic'' choice. +  - **Speech** : you can specify the use of the ASR. In case of using ASR server, the better way is to set **Automatic** choice. 
-  - **''Max time''** : you can set a maximum duration of call. If not setted or equals to 0, the duration is unlimited. +  - **Max time** : you can set a maximum duration of call. If not setted or equals to 0, the duration is unlimited. 
-  - **''Vxml parameter''** : you can set a string to pass it to vxml script. +  - **Vxml parameter** : you can set a string to pass it to vxml script. 
-  - **''Star delay''** : you can set a time delay to start the service.+  - **Start delay** : you can set a time delay to start the service.
  
-//-- add screenshot --//+{{:installation_guide:configuration:voximal_add_application.png?nolink&1000|}}
  
 +----
  
 +==== 4) Number/Routes configuration ====
  
----- +You have to define which application you want to use by default for all incoming calls.
- +
-==== 4) Routes configuration ====+
  
-Firstly, you have to define which application you want to use by default for all incoming calls. +It's done by defining the **any DID/any CID** or **All DIDs** settings in **Connectivity/Numbers** page.
-It's done by defining the **''any DID/any CID''** or **''All DIDs''** settings in **''Connectivity/Routes''** page.+
  
-  - Select **''All DIDs''** item (on top right corner) +  - Select **All DIDs** item (on top right corner) 
-  - __Leave empty Field__ **''DID Number''**  +  - __Leave empty Field__ **DID Number**  
-  - Select the application to use : **''Voximal Application''** +  - Select the application to use : **Voximal Application** 
     * You can select an existing application     * You can select an existing application
-    * Or create a new one by clicking "Add new **''Voximal application''**" +    * Or create a new one by clicking "Add new **Voximal application**" 
-  - **Click on submit** button+  - Click on **[submit]** button.
  
-//-- add screenshot --//+{{:installation_guide:configuration:voximal_add_number.png?nolink&1000|}}
  
  
  • installation_guide/configuration/start.txt
  • Last modified: 2020/10/12 15:31
  • by badereddine