Differences

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

--- installation_guide:configuration:start [2016/10/24 20:29] – [1) SIP accounts] borja
+++ installation_guide:configuration:start [2016/10/25 21:27] – [Settings] borja
@@ Line 25: / Line 25: @@
+===== System Status =====
+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 :
@@ Line 42: / Line 52: @@
 ----
-==== 1) Telephony access ====
+==== 1) Configure the telephony access ====
-{{:installation_guide:configuration:voximal_trunks.png?nolink&1000|}}
+=== a) Use the test number and the PIN ===
+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.
+=== b) Connect a trunk SIP ===
-You can create a SIP trunk with an operator with the page [[installation_guide:voipproviders:start|Voip Providers]].
+Before you can make external calls or accept incoming calls from outside, you need to setup SIP Trunks. You can choose any VoIP Service providers. You can create a SIP trunk with an operator referenced in the page [[installation_guide:voipproviders:start|Voip Providers]].
 You have to enter informations :
   * A trunk name : a string to identify you accounts
@@ Line 59: / Line 74: @@
 0033123456789:password@myprovider.com/33123456789
 </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|}}
+=== c) Add an extension ===
+After you setup your Voxibot, the first thing you do is to add extensions (connect a Phone). The integrated FreePbx allows you to add a couple of different Device types
+  * Generic SIP Device
+  * Generic IAX2 Device
+  * Generic DAHDi Device
+  * Other Custom Device
+Among these types, SIP device is the most common and popular one.
+You can give your extension any unique number, Display Name, password, whether allow this extension to accept inbound external calls or can make outbound external calls. can have voicemail or not etc.
 ----
@@ Line 67: / Line 95: @@
 ==== 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
+You need to create VoiceXML service, by uploading it or writing it directly with the embedded VoiceXML/PHP editor.
+Select the application menu **Voximal**.
-**''Applications/Voximal''**.
 === Uploading VoiceXML service ===
@@ Line 75: / Line 102: @@
 {{:installation_guide:configuration:voximal_editor_folder.png?nolink&1000|}}
-In page Applications/Voximal click on **''Editor''** tab.
+In page Applications/Voximal click on **Editor** tab.
 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 ===
-{{:installation_guide:configuration:voximal_editor_file.png?nolink&1000|}}
-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.
+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''**).
+To create folders or files, click on right items on top right corner (**Create Directory** or **Create File**).
-Then enter filename, and click **''Create button''**.
+Then enter filename, and click **[Create]**.
-//-- add screenshot --//
+{{: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 :
-  - **''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.
 {{:installation_guide:configuration:voximal_add_application.png?nolink&1000|}}
+----
+==== 4) Number/Routes configuration ====
-----
+You have your DID number and SIP Trunk set up (with the test number, the called number will be 4568 : "VXML" in the dialpad). If you set up the inbound rules, you define when people call your DID number (for example 555-555-555) how your Voxiboy handle such call, normally you set up a Voximal Account (where you define the first VoiceXML document of your voice portal).
-==== 4) Routes configuration ====
-Firstly, you have to define which application you want to use by default for all incoming calls.
+You can 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/Routes''** page.
+It's done by defining the **any DID/any CID** or **All DIDs** settings in **Connectivity/Numbers** 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 (for example Voximal)
-    * 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.
 {{:installation_guide:configuration:voximal_add_number.png?nolink&1000|}}
@@ Line 140: / Line 166: @@
 ----
+===== Call Detail Record =====
+The CDR Reports allows you to view a report showing the telephone calls made from and received to your system.
+You can choose to view a complete history or calls, or to search by date, date range, number called, caller ID, etc.
+{{:installation_guide:configuration:voximal_cdr.png?nolink&1000|}}
+===== Logs =====
+The Asterisk Logfiles Module is an easy way to view portions of the Asterisk Log.  However, this Module is only useful when you want to view a very recent event in the Asterisk Log.
+You have similar Module for the Voximal log :
+{{:installation_guide:configuration:voximal_logs.png?nolink&1000|}}
+===== Settings =====
+=== a) General ===
+{{:installation_guide:configuration:voximal_settings_license.png?nolink&1000|}}
+=== b) TextToSpeech ===
+{{:installation_guide:configuration:voximal_settings_tts.png?nolink&1000|}}
+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
+=== d) License ===
+=== c) Test number ===
+{{:installation_guide:configuration:voximal_settings_test.png?nolink&1000|}}
 ===== Configuration files =====
   * /etc/[[installation_guide:configuration_file_voximald:start|voximald.conf]] (not modify this file)
   * /etc/asterisk/[[installation_guide:configuration_file_voximal:start|voximal.conf]] (not modify directly this file)