Skip to Content

Wiki source code of FreePBX Module Administration

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