用户管理模块
User Management Module User Guide
THIS WIKI HAS BEEN UPDATED FOR VERSION 13 OF YOUR PBX GUI
Overview
The User Management ("userman") module is replacing several modules that have attempted to create and manage users separately from the Extensions Module. Modules such as iSymphony, XactView, and RestAPI are a few examples. In PBX software version 12 and newer, the new [file:///E:/pages/viewpage.action%3fpageId=28180526 User Control Panel (UCP)] utilizes the User Management module. UCP replaces the old ARI.
In this module, you can create users who have access to extensions or device/user mode users and the settings associated with those devices. For example, a user could be allowed to log into the User Control Panel and access the voicemail of three other accounts or manage your API tokens.
Note
In version 13+ of the PBX GUI software, fax options have moved from the Extensions module to the User Management module.
Logging In
- On the top menu click Admin
- In the drop down click User Management
The Users tab should be active, and a list of current users should be displayed.
Creating / Editing a User
A new user may be auto-generated upon creating an extension in the extension module. To edit an existing user, click the edit button.
You can also create a new user manually. In the Users tab, click the Add button. This should take you to the Login Details tab for the new user.
Login Details
Login Name
This is the login username that the user will use to log into anything external, such as the User Control Panel (UCP) in version 12 and up, [ iSymphony/XactView] version 3 and up, [file:///E:/display/FPG/XMPP+Chat+Management XMPP Chat], and other items that tie to this module.
Description
A friendly name or brief description for this user.
Password
Password for the user. Note: If you proceed to enable XMPP later, the password will be exposed in the database, and you will need to redefine it.
Groups
A list of groups the user belongs to, if any. To select a group, begin typing the group name into the field, and when the system finds it, click on the name. You can add multiple groups.
Primary Linked Extension
This is the extension this user is linked to. A single user can only be linked to one extension, and one extension can only be linked to a single user.
User Details
All of the fields in this tab are optional. This information is stored for use in other apps. Most fields are self-explanatory. The Display Name is a customized username that will be displayed in UCP and Contact Manager. You will need to enter an Email Address for the user if you plan to have the system send the user a welcome e-mail message.
Administration GUI
Here you can give a user administrative access to your PBX. You can control the user's level of privileges.
Allow Administration Login
Use the Yes / No / Inherit buttons to select whether this user can log in to the PBX Administration pages.
Grant Full Administration Rights
Use the Yes / No / Inherit buttons to select whether to grant this user full administration rights regardless of extension range or module access.
Visible Extension Range
(Optional) Enter a starting number and ending number if you want to restrict this user's view to only the extensions, ring groups, and queues within this range. You can only enter one range.
Administration Access
Select the Admin Sections this user should have access to. The default is None selected. If you need to grant access to modules, click the None selected button to bring up a drop-down menu. Then either click the check box next to Select all (for all modules), or click the check box(es) next to the module(s) this user will be allowed to access.
If you grant access to modules, the area next to "Administration Access" will change to show you the modules selected (or a quantity, if several are selected).
Contact Manager
Show in Contact Manager
Use the Yes / No / Inherit buttons to select whether to show this user in Contact Manager。
Fax
In PBX GUI software version 13+, fax options are now found in the User Management module instead of the Extensions module.
The Fax tab is only available if the user has been linked to an extension. If the user hasn't yet been linked to an extension, select the primary linked extension in the Login Details tab, submit settings and apply config, and you should now see the Fax tab.
Enabled
Yes/No/Inherit: Whether to enable fax for the user.
Attachment Format
The format to convert the incoming fax file to before e-mailing it.
Store Locally
Yes/No/Inherit: Whether faxes will be stored by the server and be accessible via the User Control Panel (UCP).
Outgoing Station ID
The outgoing Fax Machine Identifier. This is usually your fax number.
Outgoing Header
The outgoing Fax Machine Header. This usually contains the name of the person or entity sending the fax.
Coversheet name
The name that will appear on the outbound cover sheet.
''''Coversheet Tel
The phone number that will appear on the cover sheet.
Coversheet Email
The email address that will appear on the coversheet.
Email Results
When to email the results of an outgoing fax.
Retries
Number of times to retry sending a failed fax.
Rest API
This section is used in conjunction with the RESTful Phone Apps module, which gives you access to a range of phone-side applications. It requires the commercial [file:///E:/display/FPG/End+Point+Manager End Point Manager (EPM)] to configure your devices, as it needs to receive data from EPM in order for most applications to work correctly.
If RestAPI is enabled here for a user, it will create a token and define the restrictions of what this REST API user has access to.
Enabled
Use the Yes / No / Inherit buttons to select whether RestAPI is enabled for this user. If you enable RestAPI, you will gain access to the rest of the options below.
''''Extensions
Enter the extension(s) this user will be able to control. Click on the Extensions field to display a drop-down menu of available extensions. Click on an extension to select it. To add more extensions, repeat the process.
Modules
Select which modules the user will have access to. The default is "All." Click the All button to display a menu of available modules. Use the checkboxes to select modules.
Rate Limit
Enter the quantity of API requests that this user can make per hour. The default is 1000.
UCP
User Control Panel (UCP) is a user interface for the PBX. This section has several tabs that control a user's privileges in UCP.
General
Allow Login
Use the Yes / No / Inherit buttons to select whether this user is allowed to log into the User Control Panel (UCP).
Active Sessions
If a user is currently logged into UCP, you will see the IP address(es) of the active session(s). To log-out or "boot" a user from a currently active session, you can click the trash can icon 
? next to the session. On the user's end, they will be required to login again to get back in.
Miscellaneous
Allowed Extension Settings
The user will be able to edit settings such as call waiting, call forwarding, find me/follow me, and others for these extensions. Select an extension by clicking in the field. A menu of available extensions will show up. Click on an extension to select it. Repeat the process if you would like to add multiple extensions.
Enable Originating Calls
Use the Yes / No / Inherit buttons to select whether this user is allowed to originate calls from within UCP. This is not the same as WebRTC.
Call History
Allow CDR
Use the Yes / No / Inherit buttons to select whether to allow the user to access Call Detail Records (CDR) for one or more extensions.
CDR Access
Enter the extension(s) whose CDR data this user will be able to view.
Allow CDR Playback
Use the Yes / No / Inherit buttons to select whether to allow this user to play call recordings in UCP.
Allow CDR Downloads
Use the Yes / No / Inherit buttons to select whether to allow users to download call recordings in UCP.
Call Event Logging
Allow CEL
Use the Yes / No / Inherit buttons to select whether to enable Call Event Logging (CEL) for this user in UCP.
Allowed CEL
Enter the extensions whose CEL this user will be able to view.
Conferences
Enable Conference Access
Use the Yes / No / Inherit buttons to select whether to allow this user to access conferences in UCP.
Allowed Conference Bridges
Select which conference bridge(s) the user will be able to access in UCP. Click in the field to display a drop-down list of available conferences. Click on a conference's name to select it. Repeat the process to select multiple conference bridges.
Presence State
Enable Presence
Use the Yes / No / Inherit buttons to select whether to enable presence. Enabling presence allows a user to select their presence state from a drop-down menu in UCP, which changes call behavior according to the selected state. You can customize the available presence states in the [file:///E:/display/FPG/Presence+State+Module Presence States module]. For more information on what this means, see our wiki [file:///E:/pages/viewpage.action%3fpageId=28180596 What is Presence?]
SIPStation SMS
SMS Assigned DIDs
Select the DID(s), if any, that you would like to give this user access to for text messaging (SMS) within UCP. By default, none are selected. To add a DID, click the None selected button and choose one or more DIDs from the drop-down menu.
Voicemail
Enable Voicemail Access
Use the Yes / No / Inherit buttons to select whether this user can view and listen to voicemail within UCP.
Allowed Voicemail
Enter the extension(s) whose voicemail this user will be able to access.
''''WebRTC
WebRTC, or Web Real-Time Communication, is a technology that enables browser-to-browser voice calls and other services such as video chat and P2P file sharing. You can enable WebRTC to allow users to make web-based phone calls in UCP.
You may see an error message "The STUN Server address is blank. In many cases this can cause issues. Please define a valid server in the Asterisk SIP Settings module." If you see this error, you can refer to our wiki [file:///E:/display/FPG/STUN+Servers STUN Servers] for a list of STUN servers, and enter one in the [file:///E:/display/FPG/Asterisk+SIP+Settings Asterisk SIP Settings] module.
Enable WebRTC Phone
Use the Yes / No / Inherit buttons to select whether to enable
WebRTC Certificate
Select a certificate from the drop-down menu. This is the certificate the phone will use for this user.
XMPP
This section controls whether the user has access to XMPP in UCP. XMPP stands for Extensible Messaging and Presence Protocol, which is a communications protocol for message-oriented milddleware XML.
If enabled, the user can login to the XMPP server at localhost using <username>@localhost.
Enabled
Use the Yes / No / Inherit buttons to select whether the user has access to XMPP in UCP. You will need to redefine the user's password after clicking Yes.
