MT 5.3 Admin Settings

From Bicom Systems Wiki

5.0-snap.mt.1.png

Site settings set options such as site users, user groups, backup, updates and upgrades option.



API Key
Action Logs




API Key

Here you can generate a random key which is used to interface with PBXware using PBXware API. Additional info on API can be obtained by clicking on the Documentation button.


Action Logs

Action Logs feature will provide information on what changes are made, who made them and when, it can also help you detect unauthorized access by storing information of IP addresses used to log in to your PBXware.


Actions:

  • CSV Upload
Admin can see all CSV upload actions that have been logged.
Action Logs - CSV Upload
  • Download
Different logs are available for CDR Download and Listen actions.
  • Listen
Different logs are available for CDR Download and Listen actions.
Download and Listen



Asterisk CLI

Asterisk CLI


To make it easy for our customers that do not have much experience with working in terminal environment, PBXware 5 now have integrated Asterisk CLI monitor in its interface. Asterisk CLI is accessible to main administrative accounts on PBXware and does not require root password in order to access it.

This might initially sound like a potential security issue but we have prevented this by only allowing execution of monitoring commands when using in-browser Asterisk CLI. Apart from permissions being limited, you will be able to use debugging and other monitoring features same as if you are logged in Asterisk CLI.



Branding

Branding

Even if we have already made the branding much easier to use for customers that do not have experience with CSS editing, new interface pushed this even further, allowing customers to use a color picker to precisely define shade of color they would like to use for each of the PBXware GUI elements.

Two branding types are available:

“simple” and “advanced”. If not set in the database, branding type will automatically be pre-set to “simple”, with PBXware default values.

Advanced branding remains exactly the same as before: in order to make any CSS changes, user must edit CSS files and upload images manually. For this type of branding check our HOWTO Custom Interface Branding.

Simple branding

Before changing any settings, make sure that folder “branding” exists in the path /opt/pbxware/pw/home/sitemanager/, otherwise an error will appear stating you don’t have the right permissions, or the above folder does not exist (please test).

All CSS files, uploaded images and well as the branding configuration file will be stored in the “branding” folder.

Separate CSS files will be created for login page (login_custom.css) and all other pages (main_custom.css).

Under “Login page” section, it is possible to customize login page title and header text. All other settings refer to the site’s visual appearance (CSS).

When uploading background and logo images, pay attention to the following:

  • Supported formats are ‘png’ and ‘svg’
  • Images larger than 50kB are not accepted
  • A dominant color is extracted from every uploaded background image and set as a background color (will appear before loading an image). For transparent or white images, a dominant color will be empty.
  • Images get overwritten upon successful upload, regardless the image type (example login_logo.png will be overwritten with login_logo.jpg) and the latest uploaded image will always be used.

A preview style is available for all elements visible on the branding page. Make sure you test hover and active element states as well.

Saving simple branding settings

When saving simple branding settings, the following files will be created:

  • Re-generated login_custom.css and main_custom.css.
  • All images you have chosen to upload (previously uploaded images will not be deleted if you do not overwrite them).
  • Configuration file simple_branding.json containing all your settings in a JSON format.

In the database, branding type will be set to “3”. (SELECT value FROM config WHERE tag = 'SM' AND name = 'BRANDING_TYPE')

Resetting branding to defaults

When using the “Reset to defaults” button, all simple branding images will be deleted, as well as the simple_branding.json configuration file. CSS files will be empty, but not deleted. Make sure you backup your settings and files before testing.

Applying branding settings to another PBXware

Once you have created your desired style:

  • Copy all files from /opt/pbxware/pw/home/sitemanager/branding to the same path on another PBXware
  • Change permissions for all files (chown 101:1003 *)
  • Navigate to SM Settings -> branding and click “Save”. Your settings should apply immediately (please test).
  • Note: It is important to refresh (or navigate to) the branding page after the files are being copied, otherwise the default values will be saved once you click the “save” button. Please check that your custom settings are loaded to the branding page (check the color pickers) before hitting the “save” button.

Date/Time

Date/Time
  • Date Format:
Set the proper date format shown throughout the systems interface
(ex. 04 Oct 2006)
(Select box)
  • Time Format:
Set the proper time format shown throughout the systems interface
(ex. Select between 12/24 hour format)
(Select box)

Groups

Groups
Add new group


Groups allow for a unified permission system, enabling users access to various applications or part of the applications.

Each site can edit existing or add new groups as per their requirements by clicking on the appropriate action buttons. During add/edit, permissions and group name are available for edit.

  • Reports > Show Call Rating Cost:
Groups offer several kinds of reports such as CDR, etc., and the 'Show Call Rating Cost' has been introduced as well.

When this option is used in a group it will affect all users that are in that group. If this option is set to "No" or is not checked, then when looking at CDRs the Rating Cost column will not be shown. This affects CSV download and E-mail too. Default behavior is "Yes", meaning that if nothing is changed, then the Rating Cost column will be shown.

  • Reports > Allow CDR extensions:

If the input field is not empty (populated with comma separated extension numbers) then the drop-down options will work as follows:

1. Including - > All CDRs that include the selected extensions as can be shown.
2. Between - > Only calls BETWEEN the selected extensions can be shown.
3. From - > Only calls made FROM the selected extensions can be shown.
4. To - > Only calls made TO the selected extensions can be shown.
Allow CDR ext

IP Address Restrictions

IP Address Restrictions

The IP restrictions menu is used to set whether some IP ranges have access or are banned, which depends on selection of the Blacklist/Whitelist in the Settings menu.


Add new IP policy

Policies

Policies
Policies

Add/Edit IP restrictions policies which dictate which IP ranges can/cannot access GUI of PBXware.

When adding/editing, you will provide name and IP range for the current policy.

  • Policy Name:
Name that describes this policy
(ex. admin)
([a-z][0-9])
  • Policy Range:
IP range on which admin will or will not have access to GUI
(ex. 10.1.0.0/24)
([0-9])

Settings

LDAP Settings
5.0-site.lang.png
Licensing

Select whether set policies will be whitelisted or blacklisted which means they will be either allowed to access GUI or they will not.

LDAP

PBXware LDAP integration, allows users with Active Directory or openLDAP account to authenticate to PBXware using their LDAP credentials.

Language

Here you can choose which language you want your Site Manager to display.



Licensing

Read Getting Started->Setup Wizard->Licensing chapter.



SMTP Configuration

SMTP Configuration

The system sends email notifications and alerts to various users and administrator during operation. For normal operation, email sending requires user to have a remote SMTP server through which to send emails.


  • E-mail Account:
Address to which the email will go if a recipient is not specifically defined
(ex. john@domain.com)
([0-9][a-z] @)
  • Server Address:
The host to send mail to, in the form "host | IP_addr"
(ex. mail.domain.com)
([0-9][a-z])
  • Server port:
Port used to send emails to the host
(ex. Default port is 25)
([0-9])
  • Username:
Username used for SMTP AUTH
(ex. username)
([a-z][0-9])
  • Password:
Password used for SMTP AUTH
(ex. password)
([a-z][0-9])
Encryption
  • SSL/TLS:
Specifies whether ssmtp uses SSL/TLS to talk to the SMTP server
(ex. The default is NO)
(Option buttons)
  • StartTLS:
Specifies whether ssmtp does a EHLO/STARTTLS before starting SSL negotiation
(ex. See RFC 2487)
(Option buttons)
  • Options
Custom From Header

Sessions

After a user logs into the system, all data sent between the user and the system will be encrypted by industry standard SSL (secure layer socket) to improve security.

5.0-snap0086.png
  • Session Type:
Session type describes which type of connection will be used for connection to the PBXware GUI.
Available options:
  • HTTPS only - Complete data flow between the system and the GUI user is secured using SSL
  • Number of login attempts to be allowed


  • Login retry time period (minutes)

Site Administrators

Site Administrators

In this menu you can add a new GUI administrator or edit existing one.

  • Name:
Name of the new admin user
(ex. John)
([a-z])
  • Email:
Email address used for admin login
(ex. john@domain.com)
([a-z] [0-9] [@_.-])
  • Password:
Password used for logging in
(ex. fjhoe5!4fh8o%e54fg_vh8)
([0-9][a-z])
  • Verify Password:
Verify given password
(ex. fjhoe5!4fh8o%e54fg_vh8)
([0-9][a-z])


Site Users

5.0-snap3453.png

Site users are allowed to login to the system interface in order to perform a specific function according to granted permissions. Each user belongs to a user group. Each group's permissions are pre-set in order to allow unified access and permission control.

The user can have access to any application or part of that application depending on permissions granted. It highly recommended to add/edit groups before adding new users.

Add/Edit Users

User fields are standard fields required to be entered in order for the system to allow users access to various applications. In addition users' status can be changed to "suspended" by ticking the check box and pressing "save"





Updates

5.0-site-settings-updates.png

This section allows a shortcut to the licensing screen. It is useful if a license upgrade needs to be performed.



Next -> 23. End Points