Wiki source code of FreePBX Module Administration

Last modified by superadmin on 2021/09/09 20:55
Show last authors
1 **//On this page~://**
2
3
4
5 {{toc maxLevel="1"/}}
6
7 The job of the iSymphony FreePBX Module is to sync the configuration of FreePBX with the configuration of the iSymphony Server. When using the iSymphony FreePBX Module there will be several iSymphony configuration sections added to the FreePBX web interface that will allow you to configure some aspects of the iSymphony Server.
8
9 {{note}}
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 {{/note}}
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
17 = Synchronization Modes =
18
19 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.
20
21 == Sync With User Management: On (default) ==
22
23 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.
24
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
41 == Sync With User Management: Off ==
42
43 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.
44
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
60 = iSymphony Module Configuration Page =
61
62 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.
63
64 == View Debug ==
65
66 If selected debug information for the iSymphony (% style="line-height: 1.4285715;" %)FreePBX Module will be displayed on the page.
67
68 == View Initial User Passwords ==
69
70 **(hidden when Sync With User Management is enabled)**
71
72 Allows the administrator to see the passwords generated for each iSymphony User during installation of the iSymphony FreePBX Module. Administrators can also download a CSV file of the password list from this section.
73
74 == Email Initial Passwords ==
75
76 **(hidden when Sync With User Management is enabled)**
77
78 Allows the administrator to send emails out to each one of the iSymphony Users informing them of their initial (% style="line-height: 1.4285715;" %)iSymphony login username and password.
79
80 {{info}}
81 (% style="white-space: normal;" %)Emails will only be sent out to Users that have an email address set in the **Voicemail** section of their FreePBX Extension configuration page.
82 {{/info}}
83
84 == Server ==
85
86 The Server section displays information about the iSymphony Server connection.
87
88 |=(((
89 **Connected:**
90 )))|(((
91 Shows if the iSymphony FreePBX Module is has a connection to the iSymphony Server or not.
92 )))
93 |=(% colspan="1" %)(% colspan="1" %)
94 (((
95 Version:
96 )))|(% colspan="1" %)(% colspan="1" %)
97 (((
98 Shows the version and revision of the currently connected iSymphony Server.
99 )))
100
101 == License ==
102
103 The License section displays information about the currently active iSymphony license.
104
105 |=(((
106 **Licensed To:**
107 )))|(((
108 The name of the person or organization that the license belongs to.
109 )))
110 |=(% colspan="1" %)(% colspan="1" %)
111 (((
112 Serial Key:
113 )))|(% colspan="1" %)(% colspan="1" %)
114 (((
115 The serial key of license.
116 )))
117 |=(% colspan="1" %)(% colspan="1" %)
118 (((
119 Type:
120 )))|(% colspan="1" %)(% colspan="1" %)
121 (((
122 The type of the license. **PERPETUAL** or **TRIAL**.
123 )))
124 |=(% colspan="1" %)(% colspan="1" %)
125 (((
126 Queues:
127 )))|(% colspan="1" %)(% colspan="1" %)
128 (((
129 The number of Queues allowed on the license.
130 )))
131 |=(% colspan="1" %)(% colspan="1" %)
132 (((
133 PBX Connections:
134 )))|(% colspan="1" %)(% colspan="1" %)
135 (((
136 The number of PBX Connections allowed on the license.
137 )))
138 |=(% colspan="1" %)(% colspan="1" %)
139 (((
140 Licensed Users:
141 )))|(% colspan="1" %)(% colspan="1" %)
142 (((
143 The number of Full Users allowed by the license.
144 )))
145 |=(% colspan="1" %)(% colspan="1" %)
146 (((
147 Expiration Date:
148 )))|(% colspan="1" %)(% colspan="1" %)
149 (((
150 The expiration date of the license if using a **TRIAL** license.
151 )))
152 |=(% colspan="1" %)(% colspan="1" %)
153 (((
154 Activate:
155 )))|(% colspan="1" %)(% colspan="1" %)
156 (((
157 You can enter your serial key here in order to activate your license.
158 )))
159
160 == General ==
161
162 The General section displays general settings for the module.
163
164 |=(((
165 **Sync With User Management:**
166 )))|(((
167 See **Synchronization Modes** above.
168 )))
169 |=(% colspan="1" %)(% colspan="1" %)
170 (((
171 Clean Unknown Items:
172 )))|(% colspan="1" %)(% colspan="1" %)
173 (((
174 If selected, all items on the iSymphony server that are not configured in FreePBX will be removed. If not selected, only items created by this instance of the module will be removed if they are no longer configured in FreePBX. For example, you should disable this option if utilizing a single core server managing multiple PBXs, as this instance of the module should not remove items that were created by other instances of the module on the other PBXs.
175 )))
176
177 == Server API Connection Settings ==
178
179 The Server API Connection Settings specify how the module connects to the iSymphony Server REST API.
180
181 |=(((
182 **Server Name:**
183 )))|(((
184 This is the unique id of the Core Server the module should manage. See [[doc:iSymphony 3\.5 Documentation.iSymphony Administrator's Guide.Configuration.Core Servers.WebHome]] for more information.
185 )))
186 |=(% colspan="1" %)(% colspan="1" %)
187 (((
188 Host:
189 )))|(% colspan="1" %)(% colspan="1" %)
190 (((
191 The hostname or IP of the iSymphony Server REST service.
192 )))
193 |=(% colspan="1" %)(% colspan="1" %)
194 (((
195 Port:
196 )))|(% colspan="1" %)(% colspan="1" %)
197 (((
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:iSymphony 3\.5 Documentation.iSymphony Administrator's Guide.Security.WebHome]] for more information.
199 )))
200 |=(% colspan="1" %)(% colspan="1" %)
201 (((
202 Username:
203 )))|(% colspan="1" %)(% colspan="1" %)
204 (((
205 The login username for the iSymphony Server REST service. Defined in **security.xml**. See [[doc:iSymphony 3\.5 Documentation.iSymphony Administrator's Guide.Security.WebHome]] for more information.
206 )))
207 |=(% colspan="1" %)(% colspan="1" %)
208 (((
209 (% style="color: rgb(0,0,0);" %)Password:
210 )))|(% colspan="1" %)(% colspan="1" %)
211 (((
212 The login password for the iSymphony Server REST service. Defined in **security.xml**. See [[doc:iSymphony 3\.5 Documentation.iSymphony Administrator's Guide.Security.WebHome]] for more information.
213 )))
214 |=(% colspan="1" %)(% colspan="1" %)
215 (((
216 Use SSL:
217 )))|(% colspan="1" %)(% colspan="1" %)
218 (((
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:iSymphony 3\.5 Documentation.iSymphony Administrator's Guide.Security.WebHome]] for more information.
220 )))
221
222 == Asterisk Connection Settings ==
223
224 The Asterisk Connection Settings tell the iSymphony server how to connect to the Asterisk API interface.
225
226 |=(((
227 (% style="color: rgb(0,0,0);" %)Asterisk Server Host:
228 )))|(((
229 The hostname or IP of the Asterisk Server. Used to tell the iSymphony Server how to connect to Asterisk.
230 )))
231
232 == Module Client Link Settings ==
233
234 The Module Client Link Settings dictate what host and port to use to access the client when selecting the client access link in FreePBX.
235
236 |=(((
237 (% style="color: rgb(0,0,0);" %)Client Host:
238 )))|(((
239 The public hostname or IP of the iSymphony Client Interface. Used for links in FreePBX that open the iSymphony Client Interface. Also used in password emails.
240 )))
241 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
242 (((
243 (% style="color: rgb(0,0,0);" %)**Client Port:**
244 )))|(% colspan="1" %)(% colspan="1" %)
245 (((
246 The port of the iSymphony Client Interface. Used for links in FreePBX that open the iSymphony Client Interface. Also used in password emails.
247 )))
248
249 == Voicemail Agent Settings ==
250
251 The Voicemail Agent Settings section allows you to modify the configuration of the Voicemail Agent.
252
253 |=(((
254 (% style="color: rgb(0,0,0);" %)**Identifier**(%%)**:**
255 )))|(((
256 The identifier of the Voicemail Agent to manage.
257 )))
258 |=(% colspan="1" %)(% colspan="1" %)
259 (((
260 (% style="color: rgb(0,0,0);" %)Directory:
261 )))|(% colspan="1" %)(% colspan="1" %)
262 (((
263 The root directory where the voicemail files are stored.
264 )))
265 |=(% colspan="1" %)(% colspan="1" %)
266 (((
267 (% style="color: rgb(0,0,0);" %)Resource Host:
268 )))|(% colspan="1" %)(% colspan="1" %)
269 (((
270 The resource host for the Voicemail Agent. See [[doc:iSymphony 3\.5 Documentation.iSymphony Administrator's Guide.Configuration.Voicemail Agents.WebHome]] for more information.
271 )))
272 |=(% colspan="1" %)(% colspan="1" %)
273 (((
274 (% style="color: rgb(0,0,0);" %)Resource Extension:
275 )))|(% colspan="1" %)(% colspan="1" %)
276 (((
277 The resource extension for the Voicemail Agent. See [[doc:iSymphony 3\.5 Documentation.iSymphony Administrator's Guide.Configuration.Voicemail Agents.WebHome]] for more information.
278 )))
279
280 == Recording Agent Settings ==
281
282 The Recording Agent Settings section allows you to modify the configuration of the Recording Agent.
283
284 |=(((
285 **Identifier:**
286 )))|(((
287 The identifier of the Recording Agent to manage.
288 )))
289 |=(% colspan="1" %)(% colspan="1" %)
290 (((
291 Directory:
292 )))|(% colspan="1" %)(% colspan="1" %)
293 (((
294 The root directory where the recording files are stored.
295 )))
296 |=(% colspan="1" %)(% colspan="1" %)
297 (((
298 Resource Host:
299 )))|(% colspan="1" %)(% colspan="1" %)
300 (((
301 The resource host for the Recording Agent. See [[doc:iSymphony 3\.5 Documentation.iSymphony Administrator's Guide.Configuration.Recording Agents.WebHome]] for more information.
302 )))
303 |=(% colspan="1" %)(% colspan="1" %)
304 (((
305 Resource Extension:
306 )))|(% colspan="1" %)(% colspan="1" %)
307 (((
308 The resource extension for the Recording Agent. See [[doc:iSymphony 3\.5 Documentation.iSymphony Administrator's Guide.Configuration.Recording Agents.WebHome]] for more information.
309 )))
310 |=(% colspan="1" %)(% colspan="1" %)
311 (((
312 File Mask:
313 )))|(% colspan="1" %)(% colspan="1" %)
314 (((
315 The file name mask used to parse information out of the recording file name. See [[doc:iSymphony 3\.5 Documentation.iSymphony Administrator's Guide.Configuration.Recording Agents.WebHome]] for more information.
316 )))
317
318 == Password Email Settings ==
319
320 The Password Email Settings section allows you to modify the properties of the emails that are sent out when using **Email Initial Passwords**.
321
322 |=(% colspan="1" %)(% colspan="1" %)
323 (((
324 Subject:
325 )))|(% colspan="1" %)(% colspan="1" %)
326 (((
327 The subject of the email.
328 )))
329 |=(% colspan="1" %)(% colspan="1" %)
330 (((
331 Body:
332 )))|(% colspan="1" %)(% colspan="1" %)
333 (((
334 The body of the email.
335 )))
336
337 === Email Variables ===
338
339 The email Subject and Body can contain variables that will be replaced with relevant information when the email is sent.
340
341 |=(((
342 %%userId%%
343 )))|(((
344 Will be replaced with the User's iSymphony login username.
345 )))
346 |=(% colspan="1" %)(% colspan="1" %)
347 (((
348 %%password%%
349 )))|(% colspan="1" %)(% colspan="1" %)
350 (((
351 Will be replaced with the User's iSymphony login password.
352 )))
353 |=(% colspan="1" %)(% colspan="1" %)
354 (((
355 %%clientURL%%
356 )))|(% colspan="1" %)(% colspan="1" %)
357 (((
358 Will be replaced with the URL used to access the iSymphony Client Interface. Uses the values specified in the **Client Host** and **Client Port** fields of the **Server Settings** section.
359 )))
360 |=(% colspan="1" %)(% colspan="1" %)
361 (((
362 **%%logo%%**
363 )))|(% colspan="1" %)(% colspan="1" %)
364 (((
365 Will be replaced with the iSymphony logo image. This will only show properly in email clients that support embedded images and html emails.
366 )))
367
368 = Administrators =
369
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:iSymphony 3\.5 Documentation.iSymphony Administrator's Guide.Connecting to the Administration Interface.WebHome]] for more information.
371
372 = User Management Page =
373
374 {{info}}
375 This page is only relevant to iSymphony if **Admin->iSymphony V3->Sync With User Management** is enabled in FreePBX.
376 {{/info}}
377
378 The iSymphony FreePBX Module will add a section called **iSymphony Settings** to the User Management Page in FreePBX. This section will allow you to manage iSymphony settings for the User. You can access the FreePBX User Management Page by navigating to **Admin->User Management** in FreePBX.
379
380 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
381 (((
382 **Add to iSymphony:**
383 )))|(((
384 If set to Yes this user will be added to the iSymphony Server configuration with the specified settings.
385
386 **(hidden when Sync With User Management is disabled)**
387 )))
388
389 The following fields on the User Management Page will also be used in the iSymphony user configuration:
390
391 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
392 (((
393 **Login Name:**
394 )))|(((
395 The username used to login to the iSymphony Client Interface.
396 )))
397 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
398 (((
399 **Password:**
400 )))|(((
401 The password used to login to the iSymphony Client Interface.
402 )))
403 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
404 (((
405 **First Name:**
406 )))|(((
407 First name of this user.
408 )))
409 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
410 (((
411 **Last Name:**
412 )))|(((
413 Last name of this user.
414 )))
415 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
416 (((
417 **Email Address:**
418 )))|(((
419 The user's email address.
420 )))
421 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
422 (((
423 **Cell Phone Number:**
424 )))|(((
425 The cell phone number for this user.
426 )))
427 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
428 (((
429 **Work Phone Number:**
430 )))|(((
431 The work phone number for this user.
432 )))
433 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
434 (((
435 **Home Phone Number:**
436 )))|(((
437 The home phone number for this user.
438 )))
439 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
440 (((
441 **Additional Assigned Extensions:**
442 )))|(((
443 The extensions assigned to this user. This list will determine which extensions are bound to the user in iSymphony.
444 )))
445
446 = Extension Configuration Page =
447
448 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.
449
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
454 |=(((
455 Add to iSymphony:
456 )))|(((
457 If set to **Yes** this extension will be added to the iSymphony Server configuration.
458 )))
459 |=(% colspan="1" %)(% colspan="1" %)
460 (((
461 Full User:
462 )))|(% colspan="1" %)(% colspan="1" %)
463 (((
464 If set to **Yes** this extension will be a full user in iSymphony. Full users have access to all the fuctionality in iSymphony that the current license allows. The amount of full users allowed in iSymphony is restricted via the license. If you mark this user as a full user and there are no more user licenes available the user will remain a lite user.
465
466 **(hidden when Sync With User Management is enabled)**
467 )))
468 |=(% colspan="1" %)(% colspan="1" %)
469 (((
470 Create User:
471 )))|(% colspan="1" %)(% colspan="1" %)
472 (((
473 If set to **Yes** an iSymphony User will be created for this extension.
474
475 **(hidden when Sync With User Management is enabled)**
476 )))
477 |=(% colspan="1" %)(% colspan="1" %)
478 (((
479 Auto Answer:
480 )))|(% colspan="1" %)(% colspan="1" %)
481 (((
482 If set to **Yes** auto answer headers will be used for this Extension in iSymphony. See [[doc:iSymphony 3\.5 Documentation.iSymphony Administrator's Guide.Configuration.Extensions.WebHome]] for more information.
483 )))
484 |=(% colspan="1" %)(% colspan="1" %)
485 (((
486 Email Password:
487 )))|(% colspan="1" %)(% colspan="1" %)
488 (((
489 If set to Yes a password email will be sent to the User when you save the configuration.
490
491 {{info}}
492 An email will not be sent if the there is no email specified in the extension's Voicemail section on the page or if the password is not changing.
493 {{/info}}
494
495 **(hidden when Sync With User Management is enabled)**
496 )))
497 |=(% colspan="1" %)(% colspan="1" %)
498 (((
499 User Password:
500 )))|(% colspan="1" %)(% colspan="1" %)
501 (((
502 The iSymphony User's login password.
503
504 **(hidden when Sync With User Management is enabled)**
505 )))
506 |=(% colspan="1" %)(% colspan="1" %)
507 (((
508 User Extensions:
509 )))|(% colspan="1" %)(% colspan="1" %)
510 (((
511 Specifies which extensions will be bound to the iSymphony User created for this extension. **Self** refers to this extension. You can select multiple entries by using **Ctrl-Click** or **Shift-Click**.
512
513 **(hidden when Sync With User Management is enabled)**
514 )))
515 |=(% colspan="1" %)(% colspan="1" %)
516 (((
517 Alt. Phone Numbers:
518 )))|(% colspan="1" %)(% colspan="1" %)
519 (((
520 Allows you to specify a list of alternative phone numbers for the iSymphony User created for this extension.
521
522 **(hidden when Sync With User Management is enabled)**
523 )))
524
525 = Queue Configuration Page =
526
527 The iSymphony FreePBX Module will add a section called **iSymphony** to the Queue Configuration Page in FreePBX. You can access the FreePBX Queue Configuration Page by navigating to **Applications->Queues** in FreePBX.
528
529 |=(((
530 Add to iSymphony:
531 )))|(((
532 If set to **Yes** this queue will be added to the iSymphony Server configuration.
533 )))
534
535 = Conferences Configuration Page =
536
537 The iSymphony FreePBX Module will add a section called **iSymphony** to the Conferences Configuration Page in FreePBX. You can access the FreePBX Conferences Configuration Page by navigating to **Applications->Conferences** in FreePBX.
538
539 |=(((
540 Add to iSymphony:
541 )))|(((
542 If set to **Yes** this Conference Room will be added to the iSymphony Server configuration.
543 )))

Search

Navigation

iSymphony