Skip to Content

Wiki source code of FreePBX Module Administration

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