Skip to Content
Last modified by superadmin on 2021/09/09 20:55
From version 2.1
edited by michaely
on 2021/09/09 18:01
Change comment: Import
To version 7.1
edited by superadmin
on 2021/09/09 19:52
Change comment: There is no comment for this version

Summary

Details

Page properties
Parent
... ... @@ -1,0 +1,1 @@
1 +xwiki:ISYMDOCS.Home.iSymphony Administrator's Guide.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.michaely
1 +XWiki.superadmin
Tags
... ... @@ -1,0 +1,1 @@
1 +freepbx|administration|flash|module|elastix|pbx|in|a
Content
... ... @@ -10,6 +10,10 @@
10 10  Any configuration options that the iSymphony FreePBX Module provides should be managed within FreePBX and not the iSymphony Administration Interface. If you make changes on a property that is managed by the (% style="line-height: 1.4285715;" %)iSymphony FreePBX Module in the iSymphony Administration Interface the change will be overwritten with the value stored in the iSymphony FreePBX Module the next time FreePBX is reloaded.
11 11  {{/note}}
12 12  
13 +{{note title="Special note concerning FreePBX batch extension imports"}}
14 +FreePBX does not provide hooks in to the batch import process for extensions. This means that if the iSymphony FreePBX module is installed, while a batch import is run, the module will not be aware of the extensions that were just created. To resolve this you can simply reinstall the iSymphony FreePBX module from **Admin->Module Admin**, in FreePBX. This will re-scan the extensions. **NOTE: Re-installation of the module will revert any settings you have changed in the Admin->iSymphony V3 page, or any of the iSymphony Setting Sections in other FreePBX pages, to default values.**
15 +{{/note}}
16 +
13 13  = Synchronization Modes =
14 14  
15 15  The iSymphony FreePBX module has two modes of synchronization. Users will be managed differently depending on which mode is used. You can change synchronization modes via the **Sync With User Management** option in **Admin->iSymphony V3** in FreePBX.
... ... @@ -18,10 +18,41 @@
18 18  
19 19  When **Sync With User Management** is enabled all iSymphony user settings and extension relationships will be managed from **Admin->User Management** in FreePBX. Only the settings relevant to extensions will appear in the **iSymphony Settings **section on the FreePBX extension page and iSymphony user settings will be hidden.
20 20  
25 +{{note}}
26 +When Sync With User Management is enabled **you must have a user created in User Management, and an extension set in the Additional Extension area, in order for the extension to show up in the Users Widget.**
27 +
28 +For Example:
29 +
30 +If you want extension 100 to show up in the Users Widget, you will need to create extension 100 and a user 100 in FreePBX, and ensure that extension 100 is checked off in user 100's **Additional Extension** area. The username of the user does not have to match the extension number.
31 +{{/note}}
32 +
33 +{{note}}
34 +If a user does not have any selected extensions in their **Additional Extension** area, the user will not show up in the Users Widget
35 +{{/note}}
36 +
37 +{{note}}
38 +The iSymphony FreePBX module does not currently support having the same extension bound to multiple users. If this type of setup is configured in FreePBX, the module will choose a single user to bind the extension to at random. This can cause some users to end up with no bound extensions, preventing the user from showing up in the Users Widget
39 +{{/note}}
40 +
21 21  == Sync With User Management: Off ==
22 22  
23 23  When **Sync With User Management** is disabled all iSymphony user settings and extension relationships will be managed from **Applications->Extensions->[extension** **number]->iSymphony Settings** in FreePBX. Settings in **Admin->User Management** will not be used in iSymphony.
24 24  
45 +== User Authentication ==
46 +
47 +Beginning in iSymphony Module v13.0.5.0 authentication directly against FreePBX is supported. This allows iSymphony to integrate with the FreePBX user manager system while remaining agnostic. iSymphony Server v3.5.1 and later will support the module's FreePBX authentication provider. Starting in FreePBX v14 the sync with User Manager feature will require the authentication provider. This means for **FreePBX v14** and later **iSymphony Module v13.0.5.0 **and **iSymphony Server v3.5.1** or later will be required to use the sync with User Manager feature.
48 +
49 +By default the authentication will take place over HTTP to the asterisk hostname specified in the module. For remote setups using sync with User Manager, using HTTPS is encouraged. HTTPS can be setup as follows:
50 +
51 +1. Install a certificate on the FreePBX server. See the FreePBX HTTPS Setup documentation for more information.
52 +1. On the machine the iSymphony Server is installed on add the protocol and port to the jvm.args file:
53 +11. Open /opt/isymphony3/server/jvm.args
54 +11. Add "-Dcom.xmlnamespace.panel.freepbx.auth.port=443". The default SSL port is 443, modify as needed with the SSL port specified in FreePBX.
55 +11. Add "-Dcom.xmlnamespace.panel.freepbx.auth.protocol=https".
56 +11. Restart the iSymphony Server for the changes to take affect.
57 +
58 +The same technique can be used to modify the default port (80) over HTTP for special setups.
59 +
25 25  = iSymphony Module Configuration Page =
26 26  
27 27  The main iSymphony Module Configuration Page contains information about the module's connection to the iSymphony server along with top level configuration options for the iSymphony Server. You can access this page by navigating to **Admin->iSymphony V3** in FreePBX.
... ... @@ -146,7 +146,7 @@
146 146  |=(((
147 147  **Server Name:**
148 148  )))|(((
149 -This is the unique id of the Core Server the module should manage. See [[doc:Core Servers]] for more information.
184 +This is the unique id of the Core Server the module should manage. See [[doc:ISYMDOCS.Core Servers]] for more information.
150 150  )))
151 151  |=(% colspan="1" %)(% colspan="1" %)
152 152  (((
... ... @@ -160,7 +160,7 @@
160 160  Port:
161 161  )))|(% colspan="1" %)(% colspan="1" %)
162 162  (((
163 -The port value for the iSymphony Server REST service. Default is **58080**. If using SSL the default SSL port will be **55050**. See [[doc:Security]] for more information.
198 +The port value for the iSymphony Server REST service. Default is **58080**. If using SSL the default SSL port will be **55050**. See [[doc:ISYMDOCS.Security]] for more information.
164 164  )))
165 165  |=(% colspan="1" %)(% colspan="1" %)
166 166  (((
... ... @@ -167,7 +167,7 @@
167 167  Username:
168 168  )))|(% colspan="1" %)(% colspan="1" %)
169 169  (((
170 -The login username for the iSymphony Server REST service. Defined in **security.xml**. See [[doc:Security]] for more information.
205 +The login username for the iSymphony Server REST service. Defined in **security.xml**. See [[doc:ISYMDOCS.Security]] for more information.
171 171  )))
172 172  |=(% colspan="1" %)(% colspan="1" %)
173 173  (((
... ... @@ -174,7 +174,7 @@
174 174  (% style="color: rgb(0,0,0);" %)Password:
175 175  )))|(% colspan="1" %)(% colspan="1" %)
176 176  (((
177 -The login password for the iSymphony Server REST service. Defined in **security.xml**. See [[doc:Security]] for more information.
212 +The login password for the iSymphony Server REST service. Defined in **security.xml**. See [[doc:ISYMDOCS.Security]] for more information.
178 178  )))
179 179  |=(% colspan="1" %)(% colspan="1" %)
180 180  (((
... ... @@ -181,7 +181,7 @@
181 181  Use SSL:
182 182  )))|(% colspan="1" %)(% colspan="1" %)
183 183  (((
184 -If checked https will be used to access the REST API. You must have SSL enabled on the server in order for this to function. See [[doc:Security]] for more information.
219 +If checked https will be used to access the REST API. You must have SSL enabled on the server in order for this to function. See [[doc:ISYMDOCS.Security]] for more information.
185 185  )))
186 186  
187 187  == Asterisk Connection Settings ==
... ... @@ -232,7 +232,7 @@
232 232  (% style="color: rgb(0,0,0);" %)Resource Host:
233 233  )))|(% colspan="1" %)(% colspan="1" %)
234 234  (((
235 -The resource host for the Voicemail Agent. See [[doc:Voicemail Agents]] for more information.
270 +The resource host for the Voicemail Agent. See [[doc:ISYMDOCS.Voicemail Agents]] for more information.
236 236  )))
237 237  |=(% colspan="1" %)(% colspan="1" %)
238 238  (((
... ... @@ -239,7 +239,7 @@
239 239  (% style="color: rgb(0,0,0);" %)Resource Extension:
240 240  )))|(% colspan="1" %)(% colspan="1" %)
241 241  (((
242 -The resource extension for the Voicemail Agent. See [[doc:Voicemail Agents]] for more information.
277 +The resource extension for the Voicemail Agent. See [[doc:ISYMDOCS.Voicemail Agents]] for more information.
243 243  )))
244 244  
245 245  == Recording Agent Settings ==
... ... @@ -263,7 +263,7 @@
263 263  Resource Host:
264 264  )))|(% colspan="1" %)(% colspan="1" %)
265 265  (((
266 -The resource host for the Recording Agent. See [[doc:Recording Agents]] for more information.
301 +The resource host for the Recording Agent. See [[doc:ISYMDOCS.Recording Agents]] for more information.
267 267  )))
268 268  |=(% colspan="1" %)(% colspan="1" %)
269 269  (((
... ... @@ -270,7 +270,7 @@
270 270  Resource Extension:
271 271  )))|(% colspan="1" %)(% colspan="1" %)
272 272  (((
273 -The resource extension for the Recording Agent. See [[doc:Recording Agents]] for more information.
308 +The resource extension for the Recording Agent. See [[doc:ISYMDOCS.Recording Agents]] for more information.
274 274  )))
275 275  |=(% colspan="1" %)(% colspan="1" %)
276 276  (((
... ... @@ -277,7 +277,7 @@
277 277  File Mask:
278 278  )))|(% colspan="1" %)(% colspan="1" %)
279 279  (((
280 -The file name mask used to parse information out of the recording file name. See [[doc:Recording Agents]] for more information.
315 +The file name mask used to parse information out of the recording file name. See [[doc:ISYMDOCS.Recording Agents]] for more information.
281 281  )))
282 282  
283 283  == Password Email Settings ==
... ... @@ -332,7 +332,7 @@
332 332  
333 333  = Administrators =
334 334  
335 -The iSymphony FreePBX module will synchronize administrators in **Admin->Administrators** to the iSymphony server, if they have **ALL SECTIONS** or **iSymphonyV3 Panel** selected in their **Admin Access** list. This will allow users to utilize the same login credentials for the FreePBX GUI and the iSymphony Administration interface. See [[doc:Connecting to the Administration Interface]] for more information.
370 +The iSymphony FreePBX module will synchronize administrators in **Admin->Administrators** to the iSymphony server, if they have **ALL SECTIONS** or **iSymphonyV3 Panel** selected in their **Admin Access** list. This will allow users to utilize the same login credentials for the FreePBX GUI and the iSymphony Administration interface. See [[doc:ISYMDOCS.Home.iSymphony Administrator's Guide.Connecting to the Administration Interface.WebHome]] for more information.
336 336  
337 337  = User Management Page =
338 338  
... ... @@ -412,6 +412,10 @@
412 412  
413 413  The iSymphony FreePBX Module will add a section called **iSymphony Settings** to the Extension Configuration Page in FreePBX. This section will allow you to manage iSymphony settings for a specific Extension and User. You can access the FreePBX Extension Configuration Page by navigating to **Applications->Extensions** in FreePBX.
414 414  
450 +{{note}}
451 +An extension can only be assigned to a single user. If an extension is bound to a different user, and then bound to a new user, the previous user will lose the binding to that extension.
452 +{{/note}}
453 +
415 415  |=(((
416 416  Add to iSymphony:
417 417  )))|(((
... ... @@ -440,7 +440,7 @@
440 440  Auto Answer:
441 441  )))|(% colspan="1" %)(% colspan="1" %)
442 442  (((
443 -If set to **Yes** auto answer headers will be used for this Extension in iSymphony. See [[doc:Extensions]] for more information.
482 +If set to **Yes** auto answer headers will be used for this Extension in iSymphony. See [[doc:ISYMDOCS.Extensions]] for more information.
444 444  )))
445 445  |=(% colspan="1" %)(% colspan="1" %)
446 446  (((