NMS - User Interface (UI) Configuration

Contents

  1. 1 Accessing UI Configuration
    1. 1.1 Adding/Modifying UI Configuration
  2. 2 Available Pages
    1. 2.1 Pages Available to Subscriber Login
    2. 2.2 Pages Available to Administrator Login
  3. 3 Global Configuration
    1. 3.1 Language Selections
  4. 4 Page Specific Configuration
    1. 4.1 Backup and Restore
    2. 4.2 Call Request
    3. 4.3 Call Queue
    4. 4.4 CDR
    5. 4.5 Conference
    6. 4.6 Connection
    7. 4.7 Device
    8. 4.8 Dial Plan
    9. 4.9 Dial Permission
    10. 4.10 Domain
    11. 4.11 Event
    12. 4.12 Greetings
    13. 4.13 Hunt Group
    14. 4.14 LIDF
    15. 4.15 MOH
    16. 4.16 Processing Statistics
    17. 4.17 Route
    18. 4.18 Subscriber
    19. 4.19 Subscriber Export
    20. 4.20 Subscriber Import
    21. 4.21 Word File
  5. 5 Application Specific Configuration
    1. 5.1 SBUS
    2. 5.2 HA
    3. 5.3 Queue Statistics
    4. 5.4 Playback
    5. 5.5 Recordings
    6. 5.6 Styles
  6. 6 User Portal (NUPX) - Legacy
    1. 6.1 Agent Settings
      1. 6.1.1 Settings remaining valid in deployment of NupX but existing already:
  7. 7 New Portal Parameters (>1-1220)
  8. 8 Notes

Accessing UI Configuration

From the NMS navigate to System --> Settings --> Advanced --> UI Config



You will see the following screen; from here either edit or add the parameters as defined below. 


Adding/Modifying UI Configuration

Select Add and then choose the appropriate account type; from the drop down menu; that the parameter will apply to and then hit Select Account Type (as below).  This enables you to customize the UI to the exact amount of specificity that you need.



The following dialog box will appear; fill in with information regarding the parameter you are adding (see information below):



You can recreate a parameter by pressing the "Clone" link and then changing the account type or domain as appropriate.  This part of the system can configure the UI for both admin and user portals.

Available Pages

Pages Available to Subscriber Login

Parameters Values Default Descriptions
UI_IS_RESIDENTIAL "yes" or "no" "no" To hide non-Residential Features
UI_SHOW_DOMAIN_DIRECTORY "yes" or "no"
 "no" To Show Domain Directory
UI_SHOW_E911 "yes" or "no" "no" To show E911 Configuration Page
UI_SHOW_CALL_LIST "yes" or "no" "no"    
 To show Personal Call List
UI_SHOW_PHONE_BOOK "yes" or "no" "no"
 To Show Personal Phone Book
UI_SHOW_REMINDER_CALL "yes" or "no" "no"
To Show Reminder Call Page
UI_SHOW_REMOTE_CALLING "yes" or "no" "no" To Show Remote Calling Page
UI_SHOW_SEND_VMAIL "yes" or "no" "no" To Show Send VMail Page
UI_START_PAGE string subscriber_vmail The 1st UI Page after login
UI_START_PAGE_NO_VMAIL string subscriber_cdr_inbound The 1st UI Page after login if VMail not provision...

Pages Available to Administrator Login

Parameters Values Default Descriptions
UI_SHOW_ANI_TABLE "yes" or "no" "no" To show the ANI Substitution
UI_SHOW_AUDIO_MONITOR "yes" or "no" "no" To show the Audio Monitor UI
UI_SHOW_CALL_QUEUE "yes" or "no" "yes" To show Call Queue page
UI_SHOW_CALL_REQUEST "yes" or "no" "yes" To show Call Request page
UI_SHOW_CALL_ROUTING "yes" or "no" "yes" To show Routing page
UI_SHOW_CONFERENCE "yes" or "no" "yes" To show Conference Configuration and Statistics pages
UI_SHOW_CONNECTION_ALL "yes" or "no" "yes" for TAC
 To show the Generic Connections page
UI_SHOW_CONNECTION_STATS "yes" or "no" "yes" for TAC
 To show the Connections Statistics
UI_SHOW_DEVICES "yes" or "no" "yes" To show Device Registrar page
UI_SHOW_DIAL_PLAN "yes" or "no" "yes" To show Dial Plan page
UI_SHOW_DIAL_POLICY "yes" or "no" "yes" To show Dial Policy page
UI_SHOW_DOMAIN "yes" or "no" "yes" To show the Domain page
UI_SHOW_DOMAIN_STATS "yes" or "no" "yes" To show the Domain Statistics
UI_SHOW_GREETING "yes" or "no" "yes" To show Greetings page
UI_SHOW_HUNTGROUP "yes" or "no" "yes" To show Hunt Group page
UI_SHOW_LBRV_FILE "yes" or "no" "no" Show LBRV (i.e. G.723.1 and G.729) files
UI_SHOW_LI "yes" or "no" "no" To show LI (legal intercept) Configuration and Events
UI_SHOW_MOH "yes" or "no" "yes" To show MOH page
UI_SHOW_OPERATOR_ACCOUNT "yes" or "no" "no" To show Operator Account page
UI_SHOW_PREPAID "yes" or "no" "no" To show Rating Configuration and Connection
UI_SHOW_QUEUE_STATS "yes" or "no" "no" To show Queue Statistics
UI_SHOW_RECORDINGS "yes" or "no" "no" To show the Recordings UI
UI_SHOW_SUBSCRIBER "yes" or "no" "yes" To show Subscriber page
UI_SHOW_SYSTEM_ACCOUNT "yes" or "no"
 "yes" To show System Administration Account page
UI_SHOW_SYSTEM_BACKUP "yes" or "no" "yes" To show System Backup and Restore pages
UI_SHOW_SYSTEM_COMMAND "yes" or "no" "no"
 To show System Command
UI_SHOW_SYSTEM_CONFIG "yes" or "no" "yes" To show System Configuration page
UI_SHOW_SYSTEM_STATUS "yes" or "no" "yes" To show System Status and Statistics pages
UI_SHOW_SYSTEM_UPDATE "yes" or "no" "yes" To show System Update pages
UI_SHOW_TERRITORY "yes" or "no" "yes" To show Territory page
UI_SHOW_VMAIL "yes" or "no" "yes" To show VMail page
UI_SHOW_WORDFILE
 "yes" or "no" "no"
 To show the Word File page for Territory or Domain login
(TAC and Admin that has UI_SHOW_SYSTEM_CONFIG already has access to the World File page)
UI_START_PAGE string "system_status"
 The 1st UI Page after login

Global Configuration


Parameters Values Default Descriptions
UI_ADD_PROVISION "yes" or "no" "no"
 To enable the addition/deletion of Users, Devices and Features
(UI_MODIFY_PROVISION and UI_ADD_PROVISION must be "yes" for adds/deletes/imports to be made)
UI_ADMIN_USE_MD5_PASSWORD "yes" or "no"
"yes"
 Use MD5 Password
UI_MODIFY_PROVISION "yes" or "no" "no"
 To modify the parameters of Users, Devices and Features
(If UI_MODIFY_PROVISION is "no", UI_ADD_PROVISION will be disabled and implied as "no")
UI_TABLE_MAX_ROW
 integer
 20
 Maximum # Row per Table

Language Selections

Parameters Values Default Descriptions
UI_SHOW_LANGUAGE_CHOICE "yes" or "no" "no"
To show language choice

Page Specific Configuration

Backup and Restore

Parameters Values Default Descriptions
UI_SHOW_NFR "yes" or "no" "no" To show NFR in Code Upload and Code Select

Call Request

Parameters Values Default Descriptions
UI_SHOW_DEFAULT_CALL_REQUEST "yes" or "no" "yes" To show default for Call Request

Call Queue

Parameters Values Default Descriptions
CALL_QUEUE_MAX_TIME_INC integer 5 (min)
 Increment (min) for Max Queue Time pull down
CALL_QUEUE_MAX_TIME_MAX
 integer 120 (min)
 Maximum Max Queue Time (min)

CDR

Parameters Values Default Descriptions
CDR_EXPORT_NOTE "yes" or "no"
"no"
 To export CDR with Notes
CDR_EXPORT_PAC
 "yes" or "no" "no" To export CDR with PAC
UI_CDR_SEARCH_DAY integer 7
 Number of past day to search CDR
UI_CDR_SHOW_RECORDINGS "yes" or "no" "yes"
 CDR Show Recordings
UI_SHOW_CDR_EXPORT "yes" or "no" "yes" To show CDR Export buttons
 UI_CDR_ALLOW_DOWNLOAD  "yes" or "no" "yes"   To allow the download of CDRs

Conference

Parameters Values Default Descriptions
CONFERENCE_SHOW_AUDIO_DIR
 "yes" or "no" "no" Conference Config - To expose "Audio Dir" configuration for Conference Room
CONFERENCE_SHOW_AUTO_ANS
 "yes" or "no" "no" Participant Config - To expose "Auto Answer" configuration for Conference Room
CONFERENCE_SHOW_RCV_ONLY
 "yes" or "no" "no" Participant Config - To expose "Rcv Only" configuration for Conference Room
 CONFERENCE_SHOW_AUTO_CONDSC  "yes" or "no" "no" Participant Config -  Show Auto Connection and Disconnect
CONFERENCE_SHOW_TRIGGER_BY
 "yes" or "no" "no"
Conference Config -To expose "Trigger By" configuration for Conference Room
UI_DEFAULT_CONFERENCE_DEVICE formatting string "sip:%s.%s@conference-bridge"
 Default Device URI for Conference Room for (<User>,<Domain>)
UI_DEFAULT_CONFERENCE_NAME formatting string "Conference Room for %s.%s"
 Default Name for Conference Room for (<User>,<Domain>)
UI_DEFAULT_CONFERENCE_URI formatting string
 "sip:%s.%s@conference-bridge" Default URI for Conference Room for (<User>,<Domain>)
UI_SELECT_MAX_PARTICIPANTS integer
 40
 Max # Participants per Conference Room

Connection

Parameters Values Default Descriptions
UI_SELECT_GW_CALL_LIMIT_MAX integer 1000
 Maximum value for Connection Session Limit drop-down
UI_SELECT_GW_CPS_LIMIT integer 40
 Maximum value for Connection CPS drop-down
UI_SELECT_GW_MIN_DURATION_LIMIT integer 60 Maximum value for Connection's Minimum Call Duration drop-down
UI_SHOW_GW_CPS "yes" or "no" "no" To show Connection CPS configuration (OR & TR Limit)
UI_SHOW_GW_MIN_DURATION "yes" or "no" "no" To show Connection's Minimum Call Duration
UI_SHOW_GW_RATE_CEILING "yes" or "no" "no" To show Connection Rate Ceiling configuration
UI_SHOW_GW_RATE_MARGIN "yes" or "no" "no" To show Connection Rate Margin configuration
UI_SHOW_GW_TYPE "yes" or "no" "no" To show Connection Type

Device

Parameters Values Default Descriptions
DEVICE_CID_ORIG_MATCH formatting string "*%s@*"
 Formatting string for CID Device Origination Match
DEVICE_CID_TERM_MATCH formatting string "cid:%s@%s"
 Formatting string for CID Device Termination Match

Dial Plan

Parameters Values Default Descriptions
UI_SHOW_DIALPLAN_PARAMETER "yes" or "no" "no"
 To show Dial Plan Parameter
UI_SHOW_DIALPLAN_GRAPH "yes" or "no" "no" To show Flow Graph for Dial Plan

Dial Permission

Parameters Values Default Descriptions
UI_ALLOW_DIALPOLICY_EXPORT "yes" or "no" "yes"
 To Allow Dial Permission Export
UI_ALLOW_DIALPOLICY_IMPORT "yes" or "no" "yes" To Allow Dial Permission Import

Domain

Parameters Values Default Descriptions
UI_SELECT_DOMAIN_CALL_LIMIT_MAX integer 1000
 Maximum value for Domain Session Limit drop-down
UI_SELECT_DOMAIN_SUB_LIMIT_MAX integer 1000
 Maximum value for Domain's Subscriber Limit drop-down
UI_SHOW_DOMAIN_DIAL_MATCH
"yes" or "no" "no" To expose configuration for Domain's "Dial Match"
UI_SHOW_DOMAIN_MAKE_UDIR
"yes" or "no" "no" To expose configuration for Domain's "Make User Dir"
UI_SHOW_DOMAIN_TRANS_URI "yes" or "no" "no" To show Domain URI Translation

Event

Parameters Values Default Descriptions
UI_SHOW_EVENT_DOWNLOAD_MAX integer 1000
 Event Download Max
UI_SHOW_EVENT_PURGE2 "yes" or "no" "no" To show the Event's Clear button

Greetings

Parameters Values Default Descriptions
UI_ALLOW_GREETING_DELETE
 "yes" or "no" "no" To Allow Greeting Delete
UI_ALLOW_GREETING_UPLOAD "yes" or "no" "no" To Allow Greeting Upload
UI_SELECT_MAX_GREETING_INDEX integer
 9
 Maximum value for Greeting Index drop-down

Hunt Group

Parameters Values Default Descriptions
UI_DISABLE_HUNTGROUP "yes" or "no" "yes" To allow option to disable Hunt Group

LIDF

Parameters Values Default Descriptions
UI_LIDF_BUTTON_EXPORT_IMPORT
 "yes" or "no" "no" To allow Export Import of LIDF
UI_LIDF_BUTTON_LEA_SYNC "yes" or "no" "no" To show button to synchronize LEA

MOH

Parameters Values Default Descriptions
UI_ALLOW_MOH_UPLOAD "yes" or "no" "no" To Allow MOH Upload

Processing Statistics

Parameters Values Default Descriptions
UI_SHOW_STATISTIC_PURGE2 "yes" or "no" "no" To show the Statistic's Clear button

Route

Parameters Values Default Descriptions
UI_ROUTE_CHK_COST "yes" or "no" "yes" To initialize checkbox for Least Cost Route
UI_ROUTE_CHK_FIXED "yes" or "no"
 "yes" To initialize checkbox for Fixed Route
UI_ROUTE_CHK_PERCENTAGE "yes" or "no" "yes" To initialize checkbox for Percentage Route

Subscriber

Parameters Values Default Descriptions
SUBSCRIBER_NULL_PIN1 "yes" or "no" "no" If "yes", allow NULL Subscriber PIN
SUBSCRIBER_PIN_LEN integer
 4
 # character for auto generated Subscriber PIN

Subscriber Export

Parameters Values Default Descriptions
UI_SHOW_EXTENDED_EXPORT "yes" or "no" "yes" To show Extended Export types
 UI_ALLOW_SUBSCRIBER_EXPORT      "yes" or "no"  "yes"  To allow subscriber export 

Subscriber Import

Parameters Values Default Descriptions
UI_IMPORT_CLEAN_DEVICE_AOR "yes" or "no" "no" Default setting for Clean Device AOR when Importing Subscriber
UI_IMPORT_CLEAN_LOGIN "yes" or "no"
 "no" Default setting for Clean Login when Importing Subscriber
UI_IMPORT_SET_DEFAULT_FEATURE string <NULL>
 Default setting for Set Default Feature when Importing Subscriber
 UI_ALLOW_SUBSCRIBER_EXPORT     "yes" or "no"  "yes"  To allow subscriber export by domain level user

Word File

Parameters Values Default Descriptions
UI_ALLOW_WORDFILE_UPLOAD "yes" or "no" "no" To allow Word File upload

Application Specific Configuration

SBUS

Parameters Values Default Descriptions
SBUS_ENABLED "yes" or "no" "no"
 Enables/disables sbus operation, e.g., publish conference events.

HA

Parameters Values Default Descriptions
HA_MOVE_BY_ROLE_SWITCH "yes" or "no" "yes"
 HA Move by Role Switch
UI_SHOW_HA "yes" or "no" "no"
 To show control for HA and disable non-HA Restart

Queue Statistics

Parameters Values Default Descriptions
UI_QUEUE_STAT_MAX_DISPLAY_ROWS      
UI_QUEUE_STAT_MAX_TIME      
UI_STAT_QUEUE_REFRESH4 integer second
 5 Refresh Period for Queue Statistic Page
UI_SHOW_QUEUE_GRAPH  "yes" or "no" "no"  To show graphs for Queue Statistics
 UI_SHOW_QUEUE_SCHEDULE"yes" or "no" "no"To show option of Queue Email Reports
e

Playback

Parameters Values Default Descriptions
PLAYBACK_SHOW_GAIN  yes or no  no  Yes will enable the "Gain" value on the playback page
PLAYBACK_GAIN_DEFAULT  -4db to 12db  0  The default gain to be set in the drop-down for playback. 




Recordings

Parameters Values Default Descriptions
RECORDINGS_PLAYBACK_PWD string
 Playback PWD for Recording Playback
RECORDINGS_PLAYBACK_UID string
 Playback UID for Recording Playback
RECORDINGS_PLAYBACK_URL string https://localhost/LiCf/playback.php URL for Recordings Playback
RECORDINGS_PLAYBACK_VIA_URL "yes" or "no" "no" To playback recordings via RECORDINGS_PLAYBACK_URL
UI_CDR_SHOW_RECORDINGS
"yes" or "no" "no"
 To show the associated recording in the CDR table

(constraint the login type and/or account where appropriate)
USE_LIDF_FOR_RECORDINGS3 "yes" or "no" "no" To use LIDF for Recordings
(should set for all login type and account)

Styles

Parameters Values Default Descriptions
UI_COLOR_MENU_MOUSE_OFF_BKG hex integer
 "005388" Menu Background Color when Mouse is OFF
UI_COLOR_MENU_MOUSE_OFF_FONT hex integer "FFFFFF" Menu Font Color when Mouse is OFF
UI_COLOR_MENU_MOUSE_ON_BKGD hex integer "7F2238" Menu Background Color when Mouse is ON
UI_COLOR_MENU_MOUSE_ON_FONT hex integer "FFFFFF" Menu Font Color when Mouse is ON
UI_TITLE_SHOW_IP
"yes" or "no" "yes" To show IP Address at Web Title

User Portal (NUPX) - Legacy

Parameters Values Default Descriptions
NUPX_SHOW_FEATURES_TOD "yes" or "no" "no" show TOD options in NUPX
NUPX_SHOW_PRESENCE_STATUS "yes" or "no" "no"
 show user statuses in NUPX
NUPX_SHOW_DOMAIN_VMAIL "yes" or "no" "no" show options to send domain wide voicemail
NUPX_SHOW_GOOGLE_SIGN_IN "yes" or "no" "no" show google sign-in in Quick Dial
NUPX_HUD_LOGO

url of logo to display on heads up display
NUPX_HUD_LOGO_WIDTH     (optional) sets width of logo on hud display , "215px" is a good value
NUPX_HUD_LOGO_HEIGHT     (optional) sets height of logo on hud display.  "45px" is a good value
NUPX_TRANSFER_TO_VMAIL     the prefix to add when transferring to vmail. If not added it will not show option. example, 3 or *86
 NUPX_HELP_URL     url to iframe on help tab.

Agent Settings

Parameters Values Default Descriptions
NUPX_CALL_HISTORY_DISP "yes" or "no" "yes"
 enables call notes
NUPX_AGENT_ACCESS "yes" or "no" "no"
 allows nupx to be used as an agent (acd group agent)
NUPX_AGENT_ALL_QUEUE_STATUS "yes" or "no" "no" show availability controls for all queues as one
NUPX_SHOW_QUEUES_STATUS "yes" or "no" "no" show queue status
NUPX_CALL_DISP_POPUP_INBOUND "yes" or "no" "no" do you want to auto popup a call disposition box on ended call, inbound
NUPX_CALL_DISP_POPUP_OUTBOUND "yes" or "no" "no" do you want to auto popup a call disposition box on ended call, outbound
NUPX_CALL_DISPOSITION_TIMEOUT      
 

Settings remaining valid in deployment of NupX but existing already:

UI_SHOW_E911 - To show E911 Configuration tab (yes, no)
UI_TITLE_SUB - Title for portal on browser header bar.

New Portal Parameters (>1-1220)

Notes

  1. Added in 1-1207
  2. Added in 1-1208
  3. Changed from USE_LIDF_FOR_RECORIDNG to USE_LIDF_FOR_RECORDINGS in 1-1210
  4. Changed from UI_STAT_QUEUE_REFERESH to UI_STAT_QUEUE_REFRESH in 1-1210
TAGS: server related, ui, configuration, nms, parameters, customize, how to, instructions