You are on page 1of 86

MA4000 Management System

Installation Guide
15.0

NEC Corporation
March 2018
Revision 28
i

Liability Disclaimer
NEC Corporation reserves the right to change the specifications, functions, or features, at any time,
without notice.
NEC Corporation has prepared this document for the exclusive use of its employees and customers. The
information contained herein is the property of NEC Corporation and shall not be reproduced without prior
written approval from NEC Corporation.

© 2018 NEC Corporation

Microsoft®, Windows® and SQL Server® are registered trademarks of Microsoft Corporation. GOOGLE®
is a trademark of Google Inc.

All other brand or product names are or may be trademarks or registered trademarks of, and are used to
identify products or services of, their respective owners.

MA4000 Management System Installation Guide Revision 28


ii

Table of Contents
Liability Disclaimer ....................................................................................................................i

Table of Contents .....................................................................................................................ii

Figures .....................................................................................................................................iii

Tables ........................................................................................................................................v

Introduction .......................................................................................................................... 1-1


How This Guide Is Organized ......................................................................................................................... 1-2

Getting Started ..................................................................................................................... 2-1


Web Server Requirements ............................................................................................................................. 2-1
Database Server Requirements ...................................................................................................................... 2-6
Web Client Requirements ............................................................................................................................. 2-13

Installation ............................................................................................................................ 3-1


Simple Mode Installation................................................................................................................................. 3-1
Advanced Mode Installation ............................................................................................................................ 3-8
Installing MA4000 IP-PBX and Dterm Manuals ............................................................................................. 3-21

Upgrade ................................................................................................................................. 4-1


Upgrading MA4000 ......................................................................................................................................... 4-1

Migrate ................................................................................................................................... 5-1


File Locations ................................................................................................................................................. 5-1
Server Hostnames .......................................................................................................................................... 5-1
Migrate Prerequisite Applications First if Applicable ........................................................................................ 5-2
Back Up MA4000 Scheduled Tasks (Background Tasks) ................................................................................. 5-2
Install MA4000 on Destination Server ............................................................................................................. 5-2
Migrate the MA4000 Database ....................................................................................................................... 5-4
Restore Windows Scheduler Info for MA4000 Tasks Scheduled To Run (Background Tasks) ....................... 5-5
Migrate MA4000 Call Audit Feature................................................................................................................. 5-5
Update Integrated Applications with new MA4000 Database Connection Information ...................................... 5-6
Edit MA4000 Alarm URL in NEC CAS Private.config ....................................................................................... 5-6
Release MA4000 Licenses in LMC ................................................................................................................. 5-6
Migrate IP-PBX Backups ................................................................................................................................. 5-6
Migrate DAPS CSV Files if Stored on MA4000 Server ..................................................................................... 5-6
MA4000 Management System Installation Guide Revision 28
iii
Migrate Advanced Import/Export Scenario Files ............................................................................................. 5-7
Migrate SIP Terminal Profile/Directory Files ..................................................................................................... 5-7
Migrate Log Files (Optional) ........................................................................................................................... 5-7
Migrate Custom Config File Settings ............................................................................................................... 5-8
Restart New MA4000 Server ........................................................................................................................... 5-9

Miscellaneous Procedures .................................................................................................. 6-1


Licensing MA4000 .......................................................................................................................................... 6-1
MA4000 Event Log Configuration .................................................................................................................... 6-2
Adding URLs to Trusted Site Zone .................................................................................................................. 6-8
HTTPS Access Configuration ......................................................................................................................... 6-8
Replacing the MA4000.com Encryption Certificate ....................................................................................... 6-17
Modify Server Host Name ............................................................................................................................. 6-19

Troubleshooting ................................................................................................................... 7-1


Background Tasks fail with Access Denied Error ............................................................................................ 7-1
Background Tasks Fail with HRESULT: 0x80070520 Error ............................................................................ 7-1
Background Tasks fail due to Windows Account Credentials Error ................................................................. 7-2
Background task starts, but has no updates and runs indefinitely ................................................................... 7-3

Figures
Figure 2-1 MA4000 - No IIS Installed .............................................................................................................. 2-3
Figure 2-2 SQL Server 2017 Setup - Feature Selection .................................................................................. 2-8
Figure 2-3 SQL Server 2017 Setup - Database Engine Configuration ............................................................ 2-8
Figure 2-4 SQL Server 2014 Setup - Feature Selection .................................................................................. 2-9
Figure 2-5 SQL Server 2014 Setup - Database Engine Configuration ............................................................ 2-9
Figure 2-6 SQL Server 2012 Setup - Feature Selection ................................................................................ 2-10
Figure 2-7 SQL Server 2012 Setup - Database Engine Configuration .......................................................... 2-10
Figure 2-8 SQL Server 2008 Setup - Feature Selection ................................................................................ 2-11
Figure 2-9 SQL Server 2008 Setup - Database Engine Configuration .......................................................... 2-11
Figure 2-10 SQL Server 2017 Properties - Mixed Mode Configuration ......................................................... 2-12
Figure 3-1 Simple Mode - Choose Language Setup ....................................................................................... 3-2
Figure 3-2 Simple Mode - Installation Welcome .............................................................................................. 3-2
Figure 3-3 Simple Mode - Choose Region ...................................................................................................... 3-3
Figure 3-4 Simple Mode - Release Notes ....................................................................................................... 3-3
Figure 3-5 Simple Mode - License Agreement ................................................................................................ 3-4

MA4000 Management System Installation Guide Revision 28


iv
Figure 3-6 Simple Mode - WMI Services Warning .......................................................................................... 3-4
Figure 3-7 Simple Mode - Installation Mode.................................................................................................... 3-5
Figure 3-8 Simple Mode - Choose a base URL .............................................................................................. 3-5
Figure 3-9 Simple Mode - Authentication Service ........................................................................................... 3-6
Figure 3-10 Simple Mode - Destination Drive ................................................................................................. 3-6
Figure 3-11 Simple Mode - Copy Files ............................................................................................................ 3-7
Figure 3-12 Simple Mode - License Settings .................................................................................................. 3-7
Figure 3-13 Simple Mode - Display Passwords .............................................................................................. 3-8
Figure 3-14 Simple Mode - Installation Complete ........................................................................................... 3-8
Figure 3-15 Advanced Mode - Choose Language........................................................................................... 3-9
Figure 3-16 Advanced Mode - Welcome ......................................................................................................... 3-9
Figure 3-17 Advanced Mode - Choose Region ............................................................................................. 3-10
Figure 3-18 Advanced Mode - Release Notes .............................................................................................. 3-10
Figure 3-19 Advanced Mode - License Agreement ....................................................................................... 3-11
Figure 3-20 Advanced Mode - WMI Services Warning.................................................................................. 3-11
Figure 3-21 Advanced Mode - Installation Mode ........................................................................................... 3-12
Figure 3-22 Advanced Mode - Use previous HTTPS/HTTP Settings ............................................................ 3-12
Figure 3-23 Advanced Mode - Choose a certificate ...................................................................................... 3-13
Figure 3-24 Advanced Mode - Choose a base URL...................................................................................... 3-13
Figure 3-25 Advanced Mode - Authentication ............................................................................................... 3-14
Figure 3-26 Advanced Mode - Destination Drive........................................................................................... 3-14
Figure 3-27 Advanced Mode - Database Installation .................................................................................... 3-15
Figure 3-28 Advanced Mode - Database Password ...................................................................................... 3-16
Figure 3-29 Advanced Mode - Windows Authentication ................................................................................ 3-16
Figure 3-30 Advanced Mode - Account Creation .......................................................................................... 3-17
Figure 3-31 Advanced Mode - Data and Log Path ........................................................................................ 3-17
Figure 3-32 Advanced Mode - Assign-Create User....................................................................................... 3-18
Figure 3-33 Advanced Mode - MA4000 Destination Location ....................................................................... 3-19
Figure 3-34 Advanced Mode - Copying Files ................................................................................................ 3-19
Figure 3-35 Advanced Mode - Configure License Settings ........................................................................... 3-20
Figure 3-36 Advanced Mode - Display Passwords........................................................................................ 3-20
Figure 3-37 Advanced Mode - Installation Complete .................................................................................... 3-21
Figure 4-1 MA40000 Upgrade Welcome ......................................................................................................... 4-1
Figure 4-2 MA40000 Upgrade Release Notes ................................................................................................ 4-2
Figure 4-3 MA40000 Upgrade License Agreement ......................................................................................... 4-2
Figure 4-4 Incompatible Device ...................................................................................................................... 4-3
Figure 4-5 Remove Alarm Client Notifications ................................................................................................ 4-3
Figure 4-6 Manual Migrate.............................................................................................................................. 4-4

MA4000 Management System Installation Guide Revision 28


v
Figure 4-7 Registered Applications ................................................................................................................. 4-4
Figure 4-8 Upgrade Complete ........................................................................................................................ 4-5
Figure 5-1 Installation Mode ........................................................................................................................... 5-3
Figure 5-2 Web Site........................................................................................................................................ 5-3
Figure 5-3 Continue Repair ............................................................................................................................ 5-5
Figure 6-1 MA4000 Properties - Event Log Configuration ............................................................................... 6-3
Figure 6-2 Running Evntwin.exe ..................................................................................................................... 6-3
Figure 6-3 Event to Trap Translator - Custom Settings ................................................................................... 6-4
Figure 6-4 Event to Trap Translator - Custom Settings Editing ....................................................................... 6-4
Figure 6-5 Event to Trap Translator - Custom Settings - NEC MA4000 Event Source .................................... 6-5
Figure 6-6 Event to Trap Translator - Custom Settings - All Required Event IDs Selected.............................. 6-5
Figure 6-7 Properties - Event Source NEC MA4000 Event ID Configuration................................................... 6-6
Figure 6-8 Event to Trap Translator - Custom Settings - All Required Event IDs ............................................ 6-6
Figure 6-9 Services ........................................................................................................................................ 6-7
Figure 6-10 SNMP Service Properties - Traps Configuration Tab ................................................................... 6-7
Figure 6-11 SNMP Service Configuration - Destination Host Specification ..................................................... 6-8
Figure 6-12 SNMP Service Properties - Traps Tab with Added Destination .................................................... 6-8
Figure 6-13 Change existing HTTPS settings ................................................................................................. 6-9
Figure 6-14 Choose a certificate ..................................................................................................................... 6-9
Figure 6-15 Certificate Signing Request ....................................................................................................... 6-10
Figure 6-16 Certificate change warning ........................................................................................................ 6-10
Figure 6-17 Choose a URL ........................................................................................................................... 6-11
Figure 6-18 Configure applications ............................................................................................................... 6-11
Figure 6-19 Changes applied ....................................................................................................................... 6-12

Tables
Table 2-1 Minimum Web Server Requirements .............................................................................................. 2-1
Table 2-2 Small/Medium Business Server Recommendations - Up to 5000 Extensions ................................. 2-2
Table 2-3 Enterprise Server Recommendations - 5000 to 10000 Extensions ................................................. 2-2
Table 2-4 Enterprise Server Recommendations - Above 10000 Extensions ................................................... 2-2
Table 2-5 Storage Requirements .................................................................................................................... 2-7
Table 2-6 Minimum Web Client Requirements .............................................................................................. 2-13
Table 5-1 Default Location for Main Directories .............................................................................................. 5-1
Table 6-1 Status Messages ............................................................................................................................ 6-1

MA4000 Management System Installation Guide Revision 28


Introduction 1-1

1
Introduction
In this document, unless otherwise stated, “MA4000” refers to the
MA4000 Management System.

MA4000 is a web-based product designed to configure and manage communications systems using a
unified methodology.
It uses additional supporting applications to provide additional features allowing an IT Administrator to
integrate the NEC Enterprise Communications system into the corporate business environment.
MA4000 has the following features, and more, which define a platform for management of UNIVERGE
devices:
 Alarm Notification System
 Application Program Interface (API/SDK)
 Audit Trail Logging
 Authorization Code Management
 Custom Reports
 Flexible Access Levels
 Directory Integration (CSV or LDAP directory source)
 OW5000 Integration
 Range Programming
 Searchable Help System
 System Health Monitoring
 Task Scheduling
 Voice Mail System Management
 IP-PBX Management
 Voice Traffic Analysis
 VoIP Statistics
 Call Auditing

MA4000 Management System Installation Guide Revision 28


Introduction 1-2
How This Guide Is Organized

Chapter 1 This chapter outlines how to use the guide, including the actual manual organization
Introduction and chapter layout.

Chapter 2 This chapter lists the hardware and software requirements for MA4000 and its
Getting Started supporting applications.

Chapter 3 This chapter guides you through each step of the installation wizard for MA4000 and
Installation its supporting applications.

Chapter 4 This chapter provides a walk-through of the process of upgrading MA4000 and its
Upgrade supporting applications.

Chapter 5 This chapter provides the steps needed to migrate MA4000 and its supporting
Migrate applications.

Chapter 8 This chapter contains the information on how to perform custom installations, and
Miscellaneous how to make changes to the configuration of MA4000 and its supporting applications
Procedures after an installation has been completed.

MA4000 Management System Installation Guide Revision 28


Getting Started 2-1

2
Getting Started
Your operating environment must meet or exceed the requirements listed in this chapter to ensure that
MA4000 will function properly.

Web Server Requirements


Table 2-1 lists the minimum web server requirements for a small site. NEC recommends using the highest
performing server available, tailored to your specific requirements.
MA4000 is supported in both physical and virtual machine environments as long as the machine meets or
exceeds the requirements specified in the Minimum Web Server Requirements.
Please refer to the Web Server Recommendations section for suggestions on server hardware/software for
larger systems. Refer to the Database Storage Requirements section for suggestions on disk space
requirements for the MA4000 database.

Table 2-1 Minimum Web Server Requirements

Item Minimum Requirements

Processor 2.0 GHz (64-bit) Dual Core

Memory 4 GB RAM

Hard Drive Space 40 GB for installation and application files

Network 100 Mbps or faster

Operating System Windows Server 2016


Evaluation, Standard, Datacenter
Windows Server 2012 R2
Evaluation, Foundation, Standard, Datacenter
Windows Server 2012
Foundation, Standard, Datacenter
Windows Server 2008 R2 SP1
Foundation, Standard, Enterprise, Datacenter
Windows 10 64-bit
Pro, Enterprise

Applications Microsoft .NET Framework 4.6.1

MA4000 Management System Installation Guide Revision 28


Getting Started 2-2
The installation of MA4000 is not supported on “Server Core” systems
or Windows servers configured to be domain controllers.
In order to protect passwords and similar sensitive data, MA4000
requires the Windows OS Cryptography services to provide the
following algorithms: MD5 and RC2. These algorithms must not be
disabled in the OS. For example, the Windows OS must not be set to
use only FIPS compliant algorithms.

Web Server Recommendations

Table 2-2 Small/Medium Business Server Recommendations - Up to 5000 Extensions

Item Recommendations

Processor 2.0 GHz to 3.0 GHz Dual Core

Memory 4 GB RAM or more

Operating System Windows Server 2016 Standard

Database Server Microsoft SQL Server 2017 Express

Table 2-3 Enterprise Server Recommendations - 5000 to 10000 Extensions

Item Recommendations

Processor 2.0 GHz to 3.0 GHz Quad Core

Memory 8 GB RAM or more

Storage RAID 0/1

Network 100 Mbps / 1000 Mbps

Operating System Windows Server 2016 Standard

Database Server Microsoft SQL Server 2017 Standard

Table 2-4 Enterprise Server Recommendations - Above 10000 Extensions

Item Recommendations

Processor 2.0 GHz to 3.0 GHz Quad Core

Memory 16 GB RAM or more

MA4000 Management System Installation Guide Revision 28


Getting Started 2-3
Item Recommendations

Storage RAID 5

Network 100 Mbps / 1000 Mbps

Operating System Windows Server 2016 Standard or Enterprise

Database Server Microsoft SQL Server 2017 Standard

Internet Information Services Requirements


Internet Information Services (IIS) must be installed on the web server in order to install the MA4000
application.

Installing IIS
The MA4000 installation checks to see if the IIS components that it requires are installed. If any
components are missing, Figure 2-1 displays allowing you to install and configure them automatically.

Figure 2-1 MA4000 - No IIS Installed

The following Windows features and role services are verified by the installer and must be turned on to
confirm that IIS is installed. Clicking the Yes button in the installer dialog will turn on all of these Windows
features.
Windows Server 2016
Web Server (IIS) Role services:
Web Server
Common HTTP Features
Default Document
Static Content
Security
Request Filtering
Windows Authentication
Application Development
.NET Extensibility 4.6
ASP.NET 4.6
ISAPI Extensions
ISAPI Filters
Management Tools
MA4000 Management System Installation Guide Revision 28
Getting Started 2-4
IIS Management Console
IIS 6 Management Compatibility
IIS 6 Metabase Compatibility
Features:
.NET Framework 4.6 Features
.NET Framework 4.6
ASP.NET 4.6
WCF Services
HTTP Activation
XPS Viewer

Windows Server 2012 (includes R2)


Web Server (IIS) Role services:
Web Server
Common HTTP Features
Static Content
Default Document
Application Development
ASP.NET 4.5
.NET Extensibility 4.5
ISAPI Extensions
ISAPI Filters
Security
Windows Authentication
Request Filtering
Management Tools
IIS 6 Management Compatibility
IIS 6 Metabase Compatibility
Features:
.NET Framework 4.5 Features
.NET Framework 4.5
ASP.NET 4.5
WCF Services
HTTP Activation
XPS Viewer

Windows Server 2008 R2


Web Server (IIS) Role services:
Web Server
Common HTTP Features

MA4000 Management System Installation Guide Revision 28


Getting Started 2-5
Static Content
Default Document
Application Development
ASP.NET
.NET Extensibility
ISAPI Extensions
ISAPI Filters
Security
Windows Authentication
Request Filtering
Management Tools
IIS Management Console
IIS 6 Management Compatibility
IIS 6 Metabase Compatibility
Features:
Windows Process Activation Service
Process Model
.NET Environment
Configuration APIs
XPS Viewer

Windows 10
Features:
.NET Framework 4.6 Advanced Services
ASP.NET 4.6
WCF Services
HTTP Activation
Internet Information Services
Web Management Tools
IIS 6 Management Compatibility
IIS Metabase and IIS 6 configuration compatibility
IIS Management Console
World Wide Web Services
Application Development Features
.Net Extensibility 4.6
ASP.NET 4.6
ISAPI Extensions
ISAPI Filters
Common HTTP Features

MA4000 Management System Installation Guide Revision 28


Getting Started 2-6
Default Document
Static Content
Security
Request Filtering
Windows Authentication
Windows Process Activation Service
.NET Environment
Configuration APIs
Process Model
XPS Viewer

WMI and SNMP Requirements


The following Windows components must be installed in order for MA4000 to be able to collect SNMP traps
from an IP-PBX. The real-time IP-PBX fault and VoIP statistics collections in MA4000 will not function
without these Windows components. If these components are not installed before you begin installing
MA4000, a warning dialog box will display during the MA4000 installation process. Installing these
components may require access to the installation disc for the server’s operating system.

Installing WMI and SNMP


From the Microsoft Windows Desktop, select Start, and then Control Panel.
Select Programs and Features.
Select Turn Windows features on or off.
Select Add Features in Server Manager Features Summary.
Select the SNMP Services check box, then click Next.
Click Install to install SNMP Services, then click Close.

Database Server Requirements


MA4000 requires one of the following Microsoft database server products:
• SQL Server 2017
• SQL Server 2017 Express
• SQL Server 2016
• SQL Server 2016 Express
• SQL Server 2014
• SQL Server 2014 Express
• SQL Server 2012
• SQL Server 2012 Express
• SQL Server 2008 R2
• SQL Server 2008 R2 Express Edition
• SQL Server 2008
• SQL Server 2008 Express Edition

MA4000 Management System Installation Guide Revision 28


Getting Started 2-7

Due to the performance restrictions of SQL Server Express Edition,


NEC recommends only using these products for demonstration units
and small sites.

MA4000 is distributed with SQL Server 2017 Express Edition, which it can install automatically, or you
may choose to use an existing database server if a compatible one is available.
If you choose to use an existing database server or install an instance of SQL Server manually, you will
need the following information to complete the MA4000 installation.
 The database server and instance name
 The sa password or equivalent access to the database instance
 The location where the database data and log files should be stored relative to the server hosting
the database.

If you intend to use the Call Audit feature of MA4000, please refer to
the "Database Server Requirements" chapter of the "Call Audit
Installation Guide" because it requires its own separate database.

Database Storage Requirements

Table 2-5 Storage Requirements

MA4000 Feature Storage Per Unit

Base Features 1000.0 MB —

Extension Management 4.5 MB per 1000 SV9500-family extensions

26.5 MB per 1000 SV9300-family extensions

VoIP Statistics 0.3 MB per 1000 call events

Traffic Management 0.2 MB CPU Occupancy per IP-PBX


(per month, collected hourly)
1.9 MB Route Peg Count per route
(per month, collected hourly)
1.3 MB Route Traffic per route
(per month, collected hourly)
20 MB Terminal Traffic per LEN
(per day, hourly collection)

User Management 1.4 MB per 1000 users

Voice Mail Management 6.8 MB per 1000 mailboxes

Authorization Code 0.2 MB per 1000 authorization codes


Management

MA4000 Management System Installation Guide Revision 28


Getting Started 2-8
MA4000 Feature Storage Per Unit

Alarm History 1.2 MB per 1000 alarms

SQL Server 2017/2016 Installation Requirements


If you are manually installing an instance of SQL Server 2017/2016 for use with MA4000, the following
items should be configured during the SQL Server installation process.
For any issues or questions regarding the manual installation of SQL Server, or its system requirements,
please refer to Microsoft's documentation and support resources.

On the Feature Selection screen, the required feature is Database Engine Services as shown in
Figure 2-2. The Management Tools - Basic feature is highly recommended, but it is not required.

Figure 2-2 SQL Server 2017 Setup - Feature Selection

On the Server Configuration tab of the Database Engine Configuration screen, select Mixed Mode,
specify a strong password for the built-in SQL Server system administrator account, and add the local
Administrator windows account to the SQL Server administrators as shown in Figure 2-3.

Figure 2-3 SQL Server 2017 Setup - Database Engine Configuration

MA4000 Management System Installation Guide Revision 28


Getting Started 2-9
Complete the installation and select the new database instance while installing MA4000 using
Advanced Mode.

SQL Server 2014 Installation Requirements


If you are manually installing an instance of SQL Server 2014 for use with MA4000, the following items
should be configured during the SQL Server installation process.
For any issues or questions regarding the manual installation of SQL Server, or its system requirements,
please refer to Microsoft's documentation and support resources.

On the Feature Selection screen, the required feature is Database Engine Services as shown in
Figure 2-4 . The Management Tools - Basic feature is highly recommended, but it is not required.

Figure 2-4 SQL Server 2014 Setup - Feature Selection

On the Server Configuration tab of the Database Engine Configuration screen, select Mixed Mode,
specify a strong password for the built-in SQL Server system administrator account, and add the local
Administrator windows account to the SQL Server administrators as shown in Figure 2-5.

Figure 2-5 SQL Server 2014 Setup - Database Engine Configuration

Complete the installation and select the new database instance while installing MA4000 using
Advanced Mode.
MA4000 Management System Installation Guide Revision 28
Getting Started 2-10
SQL Server 2012 Installation Requirements
If you are manually installing an instance of SQL Server 2012 for use with MA4000, the following items
should be configured during the SQL Server installation process.
For any issues or questions regarding the manual installation of SQL Server, or its system requirements,
please refer to Microsoft's documentation and support resources.
On the Feature Selection screen, the required feature is Database Engine Services as shown in
Figure 2-6. The Management Tools - Basic feature is highly recommended, but it is not required.

Figure 2-6 SQL Server 2012 Setup - Feature Selection

On the Server Configuration tab of the Database Engine Configuration screen, select Mixed Mode,
specify a strong password for the built-in SQL Server system administrator account, and add the local
Administrator windows account to the SQL Server administrators as shown in Figure 2-7.

Figure 2-7 SQL Server 2012 Setup - Database Engine Configuration

Complete the installation and select the new database instance while installing MA4000 using
Advanced Mode.

SQL Server 2008 R2 / SQL Server 2008 Installation Requirements


If you are manually installing an instance of SQL Server 2008 R2 or SQL Server 2008 for use with
MA4000, the following items should be configured during the SQL Server installation process.
MA4000 Management System Installation Guide Revision 28
Getting Started 2-11
For any issues or questions regarding the manual installation of SQL Server, or its system requirements,
please refer to Microsoft's documentation and support resources.
On the Feature Selection screen, the required feature is Database Engine Services as shown in
Figure 2-8. The Management Tools - Basic feature is highly recommended, but it is not required.

Figure 2-8 SQL Server 2008 Setup - Feature Selection

On the Account Provisioning tab of the Database Engine Configuration screen, select Mixed Mode,
specify a strong password for the built-in SQL Server system administrator account, and add the local
Administrator windows account to the SQL Server administrators as shown in Figure 2-9.

Figure 2-9 SQL Server 2008 Setup - Database Engine Configuration

Complete the installation and select the new database instance while installing MA4000 using
Advanced Mode.

Authentication Mode Configuration


MA4000 authenticates with the database server using the SQL Server authentication mode. If an existing
database instance is being used, it may be necessary to enable this authentication mode.
The following procedure explains how to verify/enable SQL Server authentication using Microsoft SQL
Server Management Studio. If this application is not installed on the database server, a free version may
be downloaded from Microsoft's website.

MA4000 Management System Installation Guide Revision 28


Getting Started 2-12
Complete the following steps to enable SQL Server authentication for an instance of SQL Server:
From the Microsoft Windows Desktop, select Start > All Programs > Microsoft SQL Server > SQL
Server Management Studio.
Right-click the database instance and select Properties. Figure 2-10 displays.

Figure 2-10 SQL Server 2017 Properties - Mixed Mode Configuration

Select the Security tab.


Select the SQL Server and Windows Authentication mode option located in the Server authentication
section.
Click OK.
Restart the SQL Server (InstanceName) Windows service.

Remote Database Connections


The following procedures may need to be performed if remote access is needed to the MA4000 database.
This is necessary when MA4000 and its database reside on separate servers, and/or when another
application needs direct access to the MA4000 database.
Please refer to Microsoft support for additional information regarding remote database connectivity with
SQL Server.

If a firewall is being used, exceptions must be created to allow inbound


and outbound traffic for the SQL Server database services.

Enable Remote Connections


From the Microsoft Windows Desktop, select Start > All Programs > Microsoft SQL Server > SQL
Server Management Studio.
Right-click the database instance and select Properties.
MA4000 Management System Installation Guide Revision 28
Getting Started 2-13
From the Server Properties window, select the Connections tab.
Enable the Allow remote connections to this server check box and click OK.

For SQL Server 2012, 2014, 2016 and 2017, select Start, type mmc and then press Enter to open
the Microsoft Management Console. Go to File > Add Snap-in and add the SQL Server
Configuration Manager snap-in and then click OK. Expand the SQL Server Configuration Manager
tree in the left-hand pane and then proceed to Step 5.

For SQL Server 2008 (including R2), select Start > All Programs > Microsoft SQL Server >
Configuration Tools > SQL Server Configuration Manager.
Select SQL Server Network Configuration > Protocols for InstanceName for the database instance
used by MA4000.
Right-click on the TCP/IP protocol and click Enable.
Select SQL Server Services.
On the right-side, right-click on the SQL Server (InstanceName) service and click Restart.
Right-click on the SQL Server Browser service and click Properties.
On the Service tab change the Start Mode to Automatic and click Apply.
On the Log On tab click Start to start the SQL Server Browser service and click OK.

Web Client Requirements


Table 2-6 Minimum Web Client Requirements

Item Descriptive Text

Video 1024 x 768 Pixel Display

Input Devices Mouse and Keyboard

Applications Microsoft Internet Explorer 10+


*Support for IE 10 will be removed in MA4000 15

Microsoft Edge
Google Chrome

Network 100 Mbps Ethernet Adapter

JavaScript must be enabled within client web browsers using MA4000.


For Internet Explorer users, NEC recommends adding the MA4000 URL
to the Internet Explorer Trusted Sites zone of all client PCs to avoid
issues with Internet Explorer security settings.
MA4000 uses the X-UA-compatible HTTP header to display using a
legacy Document mode. If this Compatibility Mode is disabled via
browser settings or domain policy it will cause some pages to behave
incorrectly.

MA4000 Management System Installation Guide Revision 28


Installation 3-1

3
Installation

Ensure the IT Professional installing MA4000 has Local Administrator


Privileges.

It is recommended that you install the NEC Centralized Authentication


Service on a web server prior to installing MA4000.
Be sure to read the "Call Audit Installation Guide" document if the Call
Audit feature of MA4000 will be used

Simple Mode Installation


This mode will install MA4000 Management System using default settings and randomly generated strong
passwords which can be viewed at the end of the installation process.
The installer will attempt to detect an existing MA4000 named instance, or a default instance, of a
compatible database server application on the local server.
If a database instance which meets these criteria is not found, a new MA4000 named instance of SQL
Server 2017 Express Edition will be installed.
To install the MA4000 Management System using Simple Mode, complete the following steps.

Insert the disc into the appropriate drive and launch the MA4000 Management System installation.

MA4000 Management System Installation Guide Revision 28


Installation 3-2
Figure 3-1 Simple Mode - Choose Language Setup

If prompted, choose the language that will be used by the installer, then click Next >.

Figure 3-2 Simple Mode - Installation Welcome

Click Next > to continue.

MA4000 Management System Installation Guide Revision 28


Installation 3-3
Figure 3-3 Simple Mode - Choose Region

Select the region where MA4000 is being installed, then click Next. Figure 3-4 displays.

Figure 3-4 Simple Mode - Release Notes

Read the Release Notes then click Next >.

MA4000 Management System Installation Guide Revision 28


Installation 3-4
Figure 3-5 Simple Mode - License Agreement

Read the License Agreement. To continue, select the I accept the terms of the of the license
agreement option then click Next >. If the installer does not detect that the WMI and SNMP
Requirements are installed Figure 3-6 will display, otherwise skip to Step 8.

Figure 3-6 Simple Mode - WMI Services Warning

Click Next > to continue.

MA4000 Management System Installation Guide Revision 28


Installation 3-5
Figure 3-7 Simple Mode - Installation Mode

Select the Simple Mode option and then click Next >.

Figure 3-8 Simple Mode - Choose a base URL

Figure 3-8 displays if your web server supports multiple HTTPS access URLs. If an HTTPS base URL
has already been selected during a recent NEC application install this step may not be required.
If applicable, choose the URL which will be used to host the MA4000 application, then click Next >.
If the installer does not detect that NEC CAS is installed Figure 3-9 displays, otherwise skip to Step
12.

MA4000 Management System Installation Guide Revision 28


Installation 3-6
Figure 3-9 Simple Mode - Authentication Service

Select one of the available options then click Next >.

Figure 3-10 Simple Mode - Destination Drive

If the machine has multiple storage drives select the drive to use for MA4000 and click Next >.
If the installer does not detect an existing “MA4000” or a default instance of SQL Server a new
“MA4000” named instance will be installed to the selected disk drive.
Microsoft SQL Server Management Studio will be installed on system drive.

MA4000 Management System Installation Guide Revision 28


Installation 3-7
Figure 3-11 Simple Mode - Copy Files

Click Next > after you have verified the information displayed under Current Settings.

Figure 3-12 Simple Mode - License Settings

Enter the IP address or DNS name of the machine hosting the NEC License Manager Client
application. If license information is not configured MA4000 will run in demo mode. Click Next >.

MA4000 Management System Installation Guide Revision 28


Installation 3-8
Figure 3-13 Simple Mode - Display Passwords

The passwords used during the installation process can be viewed and copied by clicking Show.
The Read Only SQL Account credentials can also be viewed within MA4000 by navigating to the
Administration > Registered Applications page as an Administrator.
Click Next > to continue.

Figure 3-14 Simple Mode - Installation Complete

When the installation has finished, Figure 3-14 displays. Click Finish to close the MA4000 installer.

Advanced Mode Installation


This mode will prompt the user for all information needed to install the MA4000 Management System. This
allows maximum flexibility for installing the database and configuring other installation parameters.

MA4000 Management System Installation Guide Revision 28


Installation 3-9
To install the MA4000 Management System using Advanced Mode, complete the following steps.

Insert the disc into the appropriate drive and launch the MA4000 Management System installation.

Figure 3-15 Advanced Mode - Choose Language

If prompted, choose the language that will be used by the installer, then click Next >.

Figure 3-16 Advanced Mode - Welcome

Click Next > to continue.

MA4000 Management System Installation Guide Revision 28


Installation 3-10
Figure 3-17 Advanced Mode - Choose Region

Select the region where MA4000 is being installed, then click Next >.

Figure 3-18 Advanced Mode - Release Notes

Read the Release Notes then click Next >.

MA4000 Management System Installation Guide Revision 28


Installation 3-11
Figure 3-19 Advanced Mode - License Agreement

Read the License Agreement. To continue, select the I accept the terms of the of the license
agreement option, then click Next.
If the installer does not detect that the WMI and SNMP Requirements are installed Figure 3-20
displays, otherwise skip to Step 8.

Figure 3-20 Advanced Mode - WMI Services Warning

Click Next > to continue.

MA4000 Management System Installation Guide Revision 28


Installation 3-12
Figure 3-21 Advanced Mode - Installation Mode

Select the Advanced Mode option then click Next >.

Figure 3-22 Advanced Mode - Use previous HTTPS/HTTP Settings

If HTTPS settings from previous NEC web application install are detected Figure 3-22 displays.
If you choose to use the existing settings, skip to Step 13; otherwise continue to the next step.

MA4000 Management System Installation Guide Revision 28


Installation 3-13
Figure 3-23 Advanced Mode - Choose a certificate

Select a valid certificate that is trusted within your organization, which will secure client connections to
MA4000. You can use an existing certificate on the local machine or import a PFX certificate file.
If you do not have a certificate yet, you can create a temporary certificate by following the steps
described in the Create Self-Signed Certificate for HTTPS section of the Miscellaneous Procedures
chapter.
If you do not want to use HTTPS you can choose to skip this step and use the insecure HTTP
protocol. NEC recommends using HTTPS whenever possible.

Figure 3-24 Advanced Mode - Choose a base URL

Figure 3-24 displays if your web server supports multiple HTTPS access URLs. If applicable, choose
the URL that will be used to host the MA4000 application, then click Next >.
If an HTTPS base URL has already been selected during a recent NEC application install this step
may not be required.
MA4000 Management System Installation Guide Revision 28
Installation 3-14
If the installer does not detect that NEC CAS is installed Figure 3-25 Advanced Mode - Authentication
displays, otherwise skip to the next step.

Figure 3-25 Advanced Mode - Authentication

Select one of the available options then click Next >.

Figure 3-26 Advanced Mode - Destination Drive

If the machine has multiple storage drives select the drive to use for MA4000 and click Next >.
If the installer does not detect an existing “MA4000” or a default instance of SQL Server a new
“MA4000” named instance will be installed to the selected disk drive.
Microsoft SQL Server Management Studio will be installed on system drive.

MA4000 Management System Installation Guide Revision 28


Installation 3-15
Figure 3-27 Advanced Mode - Database Installation

Choose Use an existing database server if a compatible instance of SQL Server is already
available for use, or select the Install SQL Server 2017 Express Edition option to create a new
instance on the local server. SQL Server 2017 Express Edition is not supported on servers running
Windows Server 2008 R2.
If an existing database server is to be used, specify if it is On this computer or On an external
computer. For an external computer, use the Browse button to select the Computer Name or enter
it manually.
Be sure to read the Remote Database Connections section of this document if you are installing
MA4000 using a remote database server.
Select the Use Default Database Instance check box to use a default (unnamed) database server
instance, or enter the desired instance name in the Database Instance field.
In the Database Name field, type the desired name for the database that will be used be MA4000.
If your database instance already contains an MA4000 database that you wish to reuse, select the
Use existing database option, otherwise select Create new database.
You may also choose to Create new tables which will clear any existing data from the database, or
Use existing tables to preserve the contents of the database.
Click Next > to proceed. If a new instance of SQL Server 2017 Express is to be installed, Figure 3-28
displays. Otherwise, skip to Step 22.

MA4000 Management System Installation Guide Revision 28


Installation 3-16
Figure 3-28 Advanced Mode - Database Password

Enter a strong/complex password that will be assigned to the SA (System Administrator) account of
the new SQL Server 2017 Express instance.
A random password will be generated for you automatically. You may use it, or change it to another
of your choosing.
Click Next to proceed with the installation of SQL Server Express along with any necessary SQL
Server Express Prerequisites.

Figure 3-29 Advanced Mode - Windows Authentication

In the FULL ACCESS ACCOUNT section, input the desired SQL Login Name and Password that
will used to connect to the existing SQL Server instance and create the MA4000 database. This
authentication information is not saved or used after the installation process has been completed.
Windows Authentication can be used if you are logged into Windows as a user which has
administrator rights to the database server. This is the usual case if MA4000 and the database reside
on the same computer.
MA4000 Management System Installation Guide Revision 28
Installation 3-17
SQL Server Authentication can be used if your current Windows login does not have administrator
rights to the database server.
Click Next to proceed. Figure 3-30 displays.

Figure 3-30 Advanced Mode - Account Creation

In the FULL ACCESS ACCOUNT section, input the desired SQL Login Name and Password that
the MA4000 application will use to access its database, or use the default name and randomly
generated password. The password should meet the complexity requirements of your SQL Server
instance.
In the READ ONLY ACCOUNT section, input the desired SQL Login Name and Password that the
integrating applications will use to access its database, or use the default name and randomly
generated password. The password should meet the complexity requirements of your SQL Server
instance.

Figure 3-31 Advanced Mode - Data and Log Path

MA4000 Management System Installation Guide Revision 28


Installation 3-18
Enter the Data and Log file locations where the MA4000 database files will be stored on the
database server. If a remote database instance is being used, be sure to enter a valid and preexisting
location on that server. The MA4000 installer cannot automatically create folders for the log or data
files on a remote database server.
Select the Database Collation that will be used by the MA4000 database, then click Next >.

Figure 3-32 Advanced Mode - Assign-Create User

The MA4000 application requires a Windows User Account with limited privileges, which it uses to
access its file and other computer resources. Select the Create New User option or Use existing
user account option.
Enter the desired Username and a strong/complex Password. For new user accounts a random
password will be generated for you automatically. You may use it, or change it to another of your
choosing.
Use the Domain drop-down list to select the domain where the Windows User account resides, then
click Next >. For new user accounts the current Windows login being used to install MA4000 must
have access rights to create new accounts on the selected domain.

MA4000 Management System Installation Guide Revision 28


Installation 3-19
Figure 3-33 Advanced Mode - MA4000 Destination Location

Enter the location where the MA4000 application files will be installed, then click Next >.

Figure 3-34 Advanced Mode - Copying Files

Review the current settings, then click Next > to proceed. When the installation has finished.

MA4000 Management System Installation Guide Revision 28


Installation 3-20
Figure 3-35 Advanced Mode - Configure License Settings

Enter the IP address or hostname of the server running the License Manager Client application. If
License Manager Client is installed on the same system as MA4000, enter the hostname localhost.
If this information is not available, leave the IP Address or DNS Name field blank and this
information can be configured later within the MA4000 application. MA4000 will run in demo mode if
no license information is configured.
Click Next >.

Figure 3-36 Advanced Mode - Display Passwords

The passwords used during the installation process can be viewed and copied by clicking Show.
The Read Only SQL Account credentials can also be viewed within MA4000 by navigating to the
Administration > Registered Applications page as an Administrator.
Click Next > to continue.

MA4000 Management System Installation Guide Revision 28


Installation 3-21
Figure 3-37 Advanced Mode - Installation Complete

When the installation has finished, Figure 3-37 displays. Click Finish to close the MA4000 installer.

Installing MA4000 IP-PBX and Dterm Manuals


The large size of our reference documents requires them to be installed separately. To install these
documents, complete the following procedure:
Insert the disc into the appropriate drive.
Launch the MA4000 IP-PBX and Dterm Manuals installer from the autorun menu.
Follow the prompts of the installation wizard to complete the installation.

MA4000 Management System Installation Guide Revision 28


Upgrade 4-1

4
Upgrade
If there is an update available for the Call Audit feature, it should be
applied after MA4000 is upgraded.

Upgrading MA4000
To upgrade the MA4000 Management System application, complete the following steps:
Insert the disc into the appropriate drive, and launch the MA4000 installation.

Figure 4-1 MA40000 Upgrade Welcome

Click Next >.

MA4000 Management System Installation Guide Revision 28


Upgrade 4-2
Figure 4-2 MA40000 Upgrade Release Notes

Read the Release Notes then click Next >.

Figure 4-3 MA40000 Upgrade License Agreement

Read the License Agreement. To continue, select the I accept the terms of the of the license
agreement option, then click Next >.
If MA4000 is managing any devices that are incompatible with the new version of MA4000, Figure 4-4
displays. Once MA4000 has been upgraded, it will be unable to connect to the listed devices to
perform updates or synchronize any changes that have been made to them. To continue, select the I
acknowledge the condition option, then click Next >.

MA4000 Management System Installation Guide Revision 28


Upgrade 4-3
Figure 4-4 Incompatible Device

If there are Alarm Setup definitions in MA4000 that are using Alarm Client notification type, Figure 4-5
displays. The MA4000 Alarm Client application is no longer supported. Any existing Alarm Clients
should be uninstalled. To continue with the upgrade click OK.

Figure 4-5 Remove Alarm Client Notifications

If there is a database compatibility issue, Figure 4-6 Manual Migrate displays indicating that the
MA4000 database will need to be manually migrated to a compatible database instance. This applies
if the MA4000 database resides on a remote unsupported database instance.
To proceed, click OK to exit the MA4000 installer and then refer to the Move MA4000 Database to a
Different Database Server Instance section for guidance on how to manually migrate the MA4000
database to a compatible database instance. Once the database has been migrated, manually re-
launch the MA4000 upgrade and restart at Step 1 of the upgrade procedure.

MA4000 Management System Installation Guide Revision 28


Upgrade 4-4
Figure 4-6 Manual Migrate

If there are applications integrated with MA4000, Figure 4-7 displays. When the MA4000 database is
migrated to its new database instance, any application that is directly connected to it will need to be
updated to reference its new location. If the application connects to the MA4000 database using its
default full-access or read- only database user account, those credentials will not need to be updated.
If a different database user account is used, that account will need to be recreated in the new
database instance.
Click Next to proceed to Step 8.

Figure 4-7 Registered Applications

MA4000 Management System Installation Guide Revision 28


Upgrade 4-5
Figure 4-8 Upgrade Complete

Click Finish to complete the installation process

MA4000 Management System Installation Guide Revision 28


Migrate 5-1

5
Migrate
This section describes how to migrate an MA4000 system to a new server. An MA4000 server migration
may be necessary if it is running on an older operating system that is no longer supported, if your server
hardware is failing, or if you want to improve your system's performance beyond the capabilities of your
current server hardware. This process should be used when moving the MA4000 software and/or database
to a new server. This is most likely the case for any simple mode installations. For instructions on migrating
the MA4000 database while leaving the MA4000 software installation in place, see the Move MA4000
Database to a Different Database Server Instance section.
As with most tasks, there is more than one way to go about migrating an MA4000 system. This chapter
recommends various procedures based on the scenarios that have been tested by NEC. Please adapt these
procedures as needed to fit your environment.

File Locations
For this guide, there are many file locations mentioned. Table 5-1 shows the default location for the main
directories.

Table 5-1 Default Location for Main Directories

Folder 32-bit Default 64-bit Default

{MA4000 Installation Folder} C:\Program Files\NEC\Agile C:\Program Files (x86)\NEC\Agile

{NEC CAS Installation Folder} C:\Program Files\NEC\NECCAS C:\Program Files (x86)\NEC\NECCAS

Server Hostnames
When configuring your destination server, NEC recommends setting the server up using the same hostname
that will be used after the migration has been completed (i.e. don't rename the new MA4000 server after
installing software). Renaming an application server after its applications have already been installed and
configured introduces an added layer of complexity and work. If the destination server must be renamed
after installing applications, please review the documentation for each of the applications to ensure the
rename has not affected them.
One possible solution for migrating from an old MA4000 server to a new MA4000 server is to give the
destination server the same exact name as the source server. Using this method would require that one of
the servers remain off of the customer's network for the duration of the migration.
Another possible solution for minimizing disruptions would be to isolate the old server from the main data
network, then add a Domain Name System (DNS) entry to the main network that maps the old server's
hostname to the new server. This way, a user can browse to the old server name or the new server name
and it should work seamlessly with the new server. If you are using HTTPS you may see browser security

MA4000 Management System Installation Guide Revision 28


Migrate 5-2
warnings if you navigate to the new server using a hostname that does not match the configured
certificate.
An alternative to modifying the DNS is to reconfigure the Internet Information Services service (IIS / Web
Server Role) on the old server to display a page with a friendly notification that the server has changed if
someone browses to it accidentally. It can then redirect them to the new server. This requires you to keep
the old server turned on until you are comfortable that everyone knows to use the new server hostname /
URL.

Migrate Prerequisite Applications First if Applicable


MA4000 is dependent upon two other NEC applications in order for it to function properly, NEC Centralized
Authentication Service (NEC CAS) and License Manager Client (LMC). If you plan to migrate either of these
applications, we recommend you do so prior to relocating MA4000. NEC CAS and LMC are both easier to
migrate, so they will be good practice.
For help migrating NEC applications other than MA4000, please consult each application's documentation.

Back Up MA4000 Scheduled Tasks (Background Tasks)


In order to migrate your MA4000 Background Tasks to the new MA4000 server, you must have your
Windows Task Scheduler data backed up to the MA4000 database. This is done automatically in any MA4000
version greater than 11.5.0. With this in mind, make sure that MA4000 version
11.5.0 or greater is installed on your source server before migrating or the MA4000 scheduled task
information will be lost.
Note that Windows Server 2003 is no longer supported in MA4000 and above, so any migration coming
from Windows Server 2003 must use MA4000 version 11.5.0 or greater, but less than 12.0.0. A MA4000
version that fits this description is located in the MA4000\Setup\Upgrades folder on the installation
media.

Install MA4000 on Destination Server


When selecting your destination server environment, NEC recommends using the highest performing
server that you can acquire to ensure optimum performance and longevity. This includes selecting one of
the newest supported versions of Microsoft Windows and SQL Server. For a scaled list of server
configuration recommendations, please refer to the Web Server Requirements section of this manual. For a
list of all Microsoft Windows and Microsoft SQL Server versions that are supported by MA4000, please refer
to the Web Server Requirements and Database Server Requirements sections of this manual. The version
of Microsoft SQL Server on your destination server must be the same or newer than what was used for your
source server. The version of Microsoft Windows running on your old server is not important.
If you own a full version of Microsoft SQL Server that is supported by MA4000 that you wish to use on the
new server, please install and configure it before beginning your MA4000 installation. This manual specifies
settings that should be used during manual installation of Microsoft SQL Server in the Database Server
Requirements section. If you do not own a full edition of Microsoft SQL Server and wish to use the free
Microsoft SQL Server Express Edition bundled with MA4000, it does not have to be installed before MA4000
as the MA4000 installation will take care of this installation and configuration automatically.
Launch the MA4000 installer on the destination server and select your language and region if
prompted.
Choose the Advanced Mode install option and follow the instructions from the Advanced Mode
Installation section (Figure 5-1).

MA4000 Management System Installation Guide Revision 28


Migrate 5-3
Figure 5-1 Installation Mode

On the Web Site screen (Figure 5-2) enter the hostname that users will enter in their web browsers to
get to the MA4000 server into the Computer Name or TCP/IP address field, then continue. If you
are using HTTPS, be sure to use the same “friendly name” that your certificate is issued to.

Figure 5-2 Web Site

Choose from one of the following options once on the Database Installation screen:
OPTION A
If you already have a remote database server that is still supported and therefore are not migrating
your MA4000 database, choose Use an existing database server along with Use existing
database and Use existing tables and then fill out the rest of the information necessary to
connect to your database instance.
If you do not know the agile database account password it should be reset to a known value. Refer
to the Move MA4000 Database to a Different Database Server Instance section of this document
for instructions on how to reset this password.

MA4000 Management System Installation Guide Revision 28


Migrate 5-4
When you are prompted for the reader database account password it should be copied from the
Administration > Registered Applications page of the source MA4000 server.
OPTION B
If you want to migrate your MA4000 database to a new instance of the free Microsoft SQL Server
Express Edition on the new MA4000 server, simply continue with the default settings and allow
MA4000 to install a new database. This new database will be replaced in a later step.
OPTION C
If you want to migrate your MA4000 database to a different supported instance of Microsoft SQL
Server that is already installed and configured for Mixed Mode Authentication, follow the Move
MA4000 Database to a Different Database Server Instance section first and then choose Use an
existing database server and fill out the rest of the information necessary to connect to your
database instance based on the values you used in the Manual Database Migration section.
Complete the remainder of the installation following the standard procedure.
For detailed instructions refer to Step 25 of the Advanced Mode Installation section.

Migrate the MA4000 Database


If you are not migrating your MA4000 database or have separately migrated the database to another
supported instance, you can skip this section. This section explains how to migrate your MA4000 database
to a new instance of Microsoft SQL Server. You will need sysadmin access to the source and destination
instances of Microsoft SQL Server to migrate your MA4000 database.
Go to Control Panel > Administrative Tools > Services and stop all of the services with names that
begin with "NEC MA4000" on the source MA4000 server.
Launch Microsoft SQL Server Management Studio (SSMS) on the source database server and
connect to the database instance containing the MA4000 database.
Back up the MA4000 database on the source database instance to a file on the source server by
executing the SQL statements shown in the following example.
USE [master];GO
DECLARE @FILE NVARCHAR(100);
SET @FILE = 'MA4000_source_backup.bak' BACKUP DATABASE [MA4000]
TO DISK=@FILE;
DECLARE @FOLDER NVARCHAR(3900);
EXEC [master].dbo.xp_instance_regread N'HKEY_LOCAL_MACHINE',
N'Software\Microsoft\MSSQLServer\MSSQLServer', N'BackupDirectory',
@FOLDER OUTPUT, 'NO_OUTPUT';
DECLARE @BACKUPLOCATION NVARCHAR(4000); SET @BACKUPLOCATION =
(@FOLDER+'\'+@FILE);
SELECT @BACKUPLOCATION AS 'Database Backup Location';GO
Copy the database backup file from the source server to the root of C:\ on the destination server. The
location and filename of the source database backup can be found within the output results that
displayed in Microsoft SSMS after the SQL in Step 3 was executed.
Launch the MA4000 installation on the destination server, select Repair mode, and then click Next >.
The installation wizard will stop the NEC MA4000 services and display a dialog instructing you to
restore your database backup before continuing with the repair operation.

MA4000 Management System Installation Guide Revision 28


Migrate 5-5
Figure 5-3 Continue Repair

Launch Microsoft SSMS on the destination database server and connect to the database instance
containing the MA4000 database.
Restore the MA4000 database backup to the destination database instance, as shown in the
following example.
USE [master];GO
ALTER DATABASE [MA4000] SET SINGLE_USER WITH ROLLBACK IMMEDIATE;GO
DECLARE @MdfPath NVARCHAR(1024) DECLARE @IndexPath NVARCHAR(1024) DECLARE
@LogPath NVARCHAR(1024)
SET @MdfPath = (SELECT physical_name FROM sys.master_files WHERE
database_id = DB_ID(N'MA4000') AND physical_name LIKE '%.mdf')
SET @IndexPath = (SELECT physical_name FROM sys.master_files WHERE
database_id = DB_ID(N'MA4000') AND physical_name LIKE '%.ndf')
SET @LogPath = (SELECT physical_name FROM sys.master_files WHERE
database_id = DB_ID(N'MA4000') AND physical_name LIKE '%.ldf')
RESTORE DATABASE [MA4000]
FROM DISK='C:\MA4000_source_backup.bak' WITH MOVE 'MA4000_dat' TO @MdfPath,
MOVE 'MA4000_indx' TO @IndexPath, MOVE 'MA4000_log' TO @LogPath, REPLACE;GO
ALTER DATABASE [MA4000] SET MULTI_USER;GO
Reconfigure any database maintenance tasks such as scheduled backups and optimizations if
needed, and then exit Microsoft SSMS.
Go back to the NEC MA4000 installation dialog and click OK to continue the repair process. The
repair process will update the restored MA4000 database to be compatible with the new version of
MA4000 on the destination server. Click Finish to complete the repair.

Restore Windows Scheduler Info for MA4000 Tasks Scheduled To Run


(Background Tasks)
All of the MA4000 scheduled tasks that appear on the Background Tasks page on the destination MA4000
server will be missing from the Windows Task Scheduler. They must be recreated using the Restore
feature.

Migrate MA4000 Call Audit Feature


If the MA4000 Call Audit feature is being used by the site, it must be migrated after the core MA4000
application and its database have been migrated. For detailed Call Audit feature migration steps, please
refer to the "Call Audit Installation Guide” document.

MA4000 Management System Installation Guide Revision 28


Migrate 5-6
Update Integrated Applications with new MA4000 Database Connection
Information
Applications that integrate directly with the MA4000 database will need to be updated with new connection
information if the MA4000 database was migrated to a new location. To view this information, log into the
MA4000 application on the destination server as an Administrator and navigate to the Administration >
Registered Applications page. All of the required information will be listed in the CONNECTION
PARAMETERS section of the page.

Edit MA4000 Alarm URL in NEC CAS Private.config


If you have migrated NEC CAS to the same server as MA4000, you can skip this section. If you have not
migrated NEC CAS, complete the following steps to update the AlarmPage1 key in the Private.config file
for NEC CAS to send login audits and alarms to the destination MA4000 server.
On the NEC CAS server browse to {NEC CAS Installation Folder} and open the Private.config file
using your preferred text editor.
Locate key="AlarmPage1" and change the URL in its value to use the destination MA4000 server
hostname.
<add key="AlarmPage1" value="http://NewServer/MA4000/AlarmGenerator.aspx"/>

Release MA4000 Licenses in LMC


If you have migrated LMC to the same server as MA4000, you can skip this section. If your destination
server MA4000 is unable to acquire licenses from LMC, your licenses may still be locked to your source
MA4000 server. To resolve this issue, do the following:
Go to Control Panel > Administrative Tools > Services and stop the "NEC MA4000 License Service"
on the source MA4000 server.
Log in to the LMC application on the source MA4000 server.
Navigate to Licenses > Manage Licenses and click the Release All Licenses button.
Go to Control Panel > Administrative Tools > Services and start/restart the "NEC MA4000 License
Service" on the destination MA4000 server.
Log in to the MA4000 application on the destination MA4000 server and navigate to Help > License
Information.
Verify that the destination MA4000 is able to acquire its licenses from the LMC application.

Migrate IP-PBX Backups


Copy the contents of {MA4000 Installation Folder}\Maintenance\backup\ from your source server to your
destination server to preserve and migrate your IP-PBX backup files.

Migrate DAPS CSV Files if Stored on MA4000 Server


If you are not using the Directory Auto-Provisioning Service (DAPS) feature with CSV files, this section can
be skipped. If you are using this feature and you store your CSV files on the MA4000 server, the files
should be migrated to a different location.
Log in to the MA4000 application on your destination MA4000 server and navigate to System >
Directory Source Management.

MA4000 Management System Installation Guide Revision 28


Migrate 5-7
Click the Edit link for a CSV Directory Source and review the File Path value.
If the value refers to a network location or share, you must ensure that the same location or share is
available from the destination MA4000 server.
If the value refers to a local drive/folder that corresponds to a location on the source MA4000 server,
do the following:
- Copy the contents the specified folder from the source MA4000 server to a different location (i.e
to the same directory on the destination MA4000 server).
- Update the File Path value to point to the new file location.
- If there are any outside scripts/tools used to automatically generate the CSV file(s) and place it
on the server, they will need to be updated to output the CSV file to the new location.
From the Directory Source Setup page, click the Test Connection button to verify access to the
directory source file.
Repeat steps 2 and 3 for every CSV-based Directory Source defined in MA4000.

Migrate Advanced Import/Export Scenario Files


If you are not using the Advanced Import/Export feature of MA4000, this section can be skipped. If you
are using this feature, all of your scenario CSV files must be migrated to the new server.
Copy the contents of {MA4000 Installation Folder}\Manager\Scenario\ from your source server to your
destination server.

Migrate SIP Terminal Profile/Directory Files


If you are not using the SIP Terminal Management feature, this section can be skipped. Each SIP Profile
definition uses a Storage Path and a Directory Files Path. These paths and their content must be
accessible on the new MA4000 server.
If the paths refer to a location on the source MA4000 server (instead of being located on a separate FTP
server) you should relocate the contents of these folders to a different location.
Log in to the MA4000 application on your destination MA4000 server and navigate to System > SIP
Profile Management.
Click the Edit link for a SIP Profile and review the Storage Path and Directory Files Path values. If
a value refers to a local drive/folder that corresponds to a location on the source MA4000 server, the
contents of that folder should be copied from the old server to a different location. Once the files have
been relocated, update the SIP Profile in MA4000 to reference the new path(s).
Once you have finished updated the SIP Profile paths, click the Test Folders button to verify that
everything is OK.
Repeat steps 2 and 3 for every SIP Profile.
For migrating the SIP Profile Software Versions, you need to copy the contents of the {MA4000
Installation Folder}\Manager\PrivateBin\DefaultSipCfgFiles\ folder from your source server to the same
path on your destination server. If you are notified during the copy that some files or folders already exist,
choose the option to overwrite the existing ones.

Migrate Log Files (Optional)


If you wish to preserve and migrate your log file data do the following. This is an optional step.
Log in to the MA4000 application on your source server and navigate to Utilities > Log File Viewer.

MA4000 Management System Installation Guide Revision 28


Migrate 5-8
Click the Compress Logs button and wait for a new file to display in the COMPRESSED LOG FILES
list.
Copy the contents of {MA4000 Installation Folder}\Manager\PrivateBin\Logs\ZipLog\ from your source
server to your destination server.

Migrate Custom Config File Settings


If you have customized any of the settings in your configuration files for MA4000 and you wish to preserve
them, they must be copied manually from the source server to your destination server using a text-editor.
That part that must be copied is red.
Here is a list of the most frequently modified config file settings. If the key does not exist in your source
server's config file, it can be ignored.

{MA4000 Installation Folder}\Manager\PrivateBin\Agile.config

{MA4000 Installation Folder}\Manager\PrivateBin\MEM_HDD.config

MA4000 Management System Installation Guide Revision 28


Migrate 5-9
If this file exists on your source server, copy it to the same location on your destination server. If this file
does not exist on your old server this step can be skipped.
{MA4000 Installation Folder}\Manager\PrivateBin\AlarmSubstitution.xml
If you have a file specified in key="AlarmSubstitutionFile" of {MA4000 Installation
Folder}\Manager\PrivateBin\Agile.config, then the specified file will need to be accessible to your
destination MA4000 server. If it does not have a value assigned, this step can be skipped.
If the paths reference a file on the source MA4000 server, you should relocate the file and update the
agile.config key to match the reference the new file location. The name of the file does not have to be
AlarmSubstitution.xml.

Restart New MA4000 Server


Now that you have finished migrating all of your MA4000 data to the new server, restart it to ensure that
MA4000 is using the correct data/ files. After the restart has completed log into any applications that were
migrated, or are dependent on an application that was migrated, in order to verify that everything is
working correctly

MA4000 Management System Installation Guide Revision 28


Miscellaneous Procedures 6-1

6
Miscellaneous Procedures
This chapter provides the steps needed to perform special installations, and how to make changes to the
configuration after an installation is performed.

Licensing MA4000
If no licensing method was selected during the MA4000 installation process, MA4000 will operate under a
limited courtesy license until licensing is manually configured.
The License Manager Client (LMC) obtains licenses from a central NEC License Server using the internet,
and is maintained by the LMC at each site. The only requirements are that the LMC be installed on your
network, and MA4000 is able to connect to the LMC using the network. The LMC is then able to connect to
the NEC License Server using the internet; or alternatively, an administrator can upload a license to it
using its web interface.
If the connection between MA4000 and the LMC is disconnected, a 14 day grace period will begin and an
alarm will be triggered containing the date and time when the grace period will expire. In addition to the
alarm, a message will display on the MA4000 home page stating that a grace period is in effect and when it
will expire. If the grace period expires before the LMC connection is re-established, MA4000 will revert to
using its courtesy license.
The information for the LMC connection must be entered within MA4000. If you do not know this information,
please refer to the License Manager Client Operations Guide for instructions on how to obtain this
information from the LMC server.

License Manager Client (LMC) Installation and Configuration Online


Training is available at www.myneclearning.com.

To configure the MA4000-to-LMC connection, do the following.


From within MA4000, select Help > License Information.
Click the Configure license connection hyperlink.
Enter the hostname or IP address of the LMC in the Host IP Address / Name field.
Enter the port used by the LMC in the Port field.
Click Save.
Verify the status is listed as OK. Possible status messages are listed in Table 6-1.

Table 6-1 Status Messages

Message Description

OK Indicates the license is valid and functioning properly.

MA4000 Management System Installation Guide Revision 28


Miscellaneous Procedures 6-2
Message Description

License Indicates that MA4000 is not able to communicate with the


Manager LMC using the provided connection information. If this
Client is not message displays, perform the following:
available
• Verify that the LMC is accessible from the MA4000 server,
and is functioning properly.
• Verify the Host IP Address / Name and Port values are
correct.
• Verify status is listed as OK.
If problems persist, contact NEC Customer Support.

License Indicates that the license is for an older version of MA4000. A


version is new license for the correct Major Version is required. Contact
less than your NEC Sales Representative.
product
version

MA4000 Event Log Configuration


Each alarm that meets the alarm definition criteria will cause an entry to be added to the MA4000 Event
Log. All Windows Event Logs are configurable for size and limit behavior. The MA4000 Event Log must be
manually configured.

Configuration
The Event Viewer is available with the Administration Tools folder.
From Windows Desktop, select Start and type in eventvwr and press Enter. This will launch the
Windows Event Viewer.
Expand the Applications and Services Logs section, right-click MA4000 Event Log and select
Properties, Figure 6-1 displays. The maximum log size limit may be increased. This will allow a
longer history of MA4000 Event Log entries within the log file. The Overwrite events as needed
option should also be selected to ensure that the log contains the most recent log entries and does
not generate system errors indicating that the log file is full.SNMP Configuration

MA4000 Management System Installation Guide Revision 28


Miscellaneous Procedures 6-3
Figure 6-1 MA4000 Properties - Event Log Configuration

Trap Configuration

Event to Trap Translator


The generation of traps from Event Log events is controlled by the Event to Trap Translator. The Event to
Trap Translator configuration tool is accessed by running evntwin.exe.

See WMI and SNMP Requirements prior to attempting this procedure.

Figure 6-2 Running Evntwin.exe

Open a Command Prompt by clicking Start > Run, then enter evntwin.exe. Executing the Event to
Trap Translator displays Figure 6-3.

MA4000 Management System Installation Guide Revision 28


Miscellaneous Procedures 6-4
Figure 6-3 Event to Trap Translator - Custom Settings

Select the Custom option in order to edit the settings.


Click Edit >>. Further configuration information displays in Figure 6-4.

Figure 6-4 Event to Trap Translator - Custom Settings Editing

In the Event sources section, expand the MA4000 option to list the NEC MA4000 Event Source.

MA4000 Management System Installation Guide Revision 28


Miscellaneous Procedures 6-5
Figure 6-5 Event to Trap Translator - Custom Settings - NEC MA4000 Event Source

Select Event IDs 0 through 3 from the Events: list then click Add. See Figure 6-6. Clicking Add
displays the configuration information for Event IDs 0 through 3 (see Figure 6-7). No changes need to
be made, since the default configuration will generate a trap for every Event Log entry.

Figure 6-6 Event to Trap Translator - Custom Settings - All Required Event IDs Selected

MA4000 Management System Installation Guide Revision 28


Miscellaneous Procedures 6-6
Figure 6-7 Properties - Event Source NEC MA4000 Event ID Configuration

Click OK. Figure 6-8 displays the four required Event IDs in the Events to be translated to traps list.

Figure 6-8 Event to Trap Translator - Custom Settings - All Required Event IDs

Click OK to save the Event to Trap Translator configuration. This completes the Windows Event to
Trap Translator configuration requirements.

Known Limitations
The Windows Event to Trap Translator (evntwin.exe) does not allow specification of an OID to use for the
trap or any control of the MIB format for the trap. The traps generated from the Event Log are identified by
OID:
1.3.6.1.4.1.311.1.13.1.10.78.69.67.32.77.65.52.48.48.48.0.0
This OID is a Microsoft Enterprise-specific OID. The MIB definition for this OID is fixed. There is an MA4000
Event Log.mib file on the MA4000 disc under the Miscellaneous folder.

MA4000 Management System Installation Guide Revision 28


Miscellaneous Procedures 6-7
Service Configuration
For the traps generated from the Event Log to be sent to another host; the SNMP service must be
configured to forward traps for the public community to that destination.

Configuration
The Services configuration screen is available with the Administration Tools folder. The Administration Tools
folder is available from the Windows menu.
From the Microsoft Windows Desktop, select Start, type in services.msc and press Enter. Figure 6-9
displays.

Figure 6-9 Services

Right-click SNMP Service. Figure 6-10 displays.

Figure 6-10 SNMP Service Properties - Traps Configuration Tab

Click the Traps tab.


Click Add to specify the destination host. Figure 6-11 displays.

MA4000 Management System Installation Guide Revision 28


Miscellaneous Procedures 6-8
Figure 6-11 SNMP Service Configuration - Destination Host Specification

Enter the resolvable hostname or IP Address and click Add. The added destination host displays in
the Hosts list of the Traps tab (Figure 6-12).

Figure 6-12 SNMP Service Properties - Traps Tab with Added Destination

Click OK to update the SNMP Service configuration. This completes the SNMP Service configuration
requirements.

Known Limitations
The Event to Trap Translator generates traps within the public community and is not configurable.

Adding URLs to Trusted Site Zone


To avoid unnecessary Internet Explorer warnings and security setting issues, when the installation for
MA4000 has completed, add the URL (IP address, or server name) of the server to the Trusted Sites Zone
of any browser that accesses it. See Microsoft’s Help and Support Knowledge Base web site for
instructions on adding sites to the Trusted Sites zone.

HTTPS Access Configuration


In order to increase security, NEC recommends configuring the host machine for secure HTTPS client
connections. This will help encrypt any sensitive information transmitted between MA4000 and its clients.

Update MA4000 using HTTPS Utility


MA4000 is distributed with an HTTPS Utility (HttpsUtility.exe) which can be used to configure HTTPS
access to enable secure connections for MA4000 clients.
Once you have a valid and trusted certificate for your host machine, the HTTPS Utility can be used to
update the machine’s certificate store and web site configuration to allow HTTPS connections. It will also
update the connection settings of any supported NEC applications that are installed on the local machine,
including MA4000.

MA4000 Management System Installation Guide Revision 28


Miscellaneous Procedures 6-9
Complete the following steps to use the HTTPS Utility:
Launch the HttpsUtility.exe application from the MA4000 installer package files.
If the machine is already configured for HTTPS a dialog will display containing the current access
URLs and certificate information.

Figure 6-13 Change existing HTTPS settings

Click Yes to continue and modify the settings, or No to keep the current configuration.
Next, you will be asked to configure the certificate that will be used to validate connections to the
machine. You may select an existing certificate or import a new one using a PFX file.

Figure 6-14 Choose a certificate

If you do not have a certificate yet, you can select the “Create a Certificate Signing Request (CSR)”
option to create a CSR file that can be used to obtain a certificate from a trusted authority.

MA4000 Management System Installation Guide Revision 28


Miscellaneous Procedures 6-10
Figure 6-15 Certificate Signing Request

After you fill in the required fields and click Next you will be asked where to save the CSR file. After
the file is saved the HTTPS Utility will close. After you have used the CSR file to obtain a certificate
file from a trusted authority, relaunch the HTTPS Utility.
A warning dialog will display if the HTTPS Utility detects that the machine is hosting resources which
might be affected by changing to the new certificate.

Figure 6-16 Certificate change warning

Click Yes to continue and modify the settings, or No to keep the current configuration.
If the selected certificate supports more than one access URL, or it contains a wildcard, you will be
asked to configure the URL that will be used to access applications hosted on this machine.

MA4000 Management System Installation Guide Revision 28


Miscellaneous Procedures 6-11
Figure 6-17 Choose a URL

Finally, a screen will display a list of the supported applications installed on the machine. If the
“Configure applications” setting is enabled, the listed applications will be updated to use the new
HTTPS access URL. If it is disabled, only the certificate store and IIS web site settings will be
modified.

Figure 6-18 Configure applications

After clicking Next, the requested changes will be applied and a confirmation message window will
appear.

MA4000 Management System Installation Guide Revision 28


Miscellaneous Procedures 6-12
Figure 6-19 Changes applied

Create Self-Signed Certificate for HTTPS


This section describes how to generate a self-signed certificate that the MA4000 host machine can use to
create secure HTTPS connections to its clients. NEC recommends that you contact your organization’s IT
department or a well-known commercial certificate authority to obtain a certificate. Self-signed certificates
should only be used as a temporary solution until a more permanent certificate can be obtained from a
trusted source because browsers on other computers will not trust self-signed certificates by default.
Complete the following steps to create a certificate for the MA4000 web server and export a copy of the
certificate to a PFX file. These steps require a machine running Windows Server 2016 or Windows 10.
Open a Microsoft PowerShell console with administrative rights; preferably on the MA4000 host
machine.
Execute the following script to create a new certificate within the Personal store of the local machine.
Replace the highlighted values at the top of the script to match your desired values.
# Assign certificate hostname, filename, and password
$hostname = 'YourHostUrl.prv'
$filename = 'HTTPS-Certificate.pfx'
$password = 'p@$$w0rd'

# Generate a certificate in the Personal store of machine


$cert = `
New-SelfSignedCertificate `
-FriendlyName $hostname `
-Subject CN=$hostname `
-TextExtension @("2.5.29.17={text}dns=$hostname") `
-NotAfter 12/31/2039 `
-CertStoreLocation cert:\LocalMachine\My `
-HashAlgorithm SHA512 `
-KeyExportPolicy Exportable `
-KeyLength 2048 `
-Provider "Microsoft Strong Cryptographic Provider"
To export the new certificate to a PFX file in your current directory, run the following additional
statements in the same PowerShell window from the previous step. This exported file can be
imported into other certificate stores or machines.
# Export certificate to a PFX file
$certPath = 'cert:\LocalMachine\My\' + $cert.thumbprint
$certPfxPwd = ConvertTo-SecureString -String $password -Force -AsPlainText
Export-PfxCertificate -Cert $certPath -FilePath $filename -Password $certPfxPwd

Complete the following steps to import the certificate PFX file into machines that will host or access
MA4000, including browser clients and application servers (for example, OW5000). These steps do not
require Windows Server 2016 or Windows 10.
Copy your PFX certificate file to the target machine(s) if it is different from the machine that generated
the certificate.
Execute the following statements on the target machine using a PowerShell console window that has
administrative rights. Replace the highlighted values at the top of the script to match your desired
values. This script must be run from the same directory as the PFX file.
MA4000 Management System Installation Guide Revision 28
Miscellaneous Procedures 6-13
# Specify certificate filename and password
$password = 'p@$$w0rd'
$filename = 'HTTPS-Certificate.pfx'

$certPfxPwd = ConvertTo-SecureString -String $password -Force -AsPlainText

# Import certificate PFX file into Trusted Root Certificate Authorities store of
local machine
Import-PfxCertificate -CertStoreLocation cert:\LocalMachine\Root -FilePath
$filename -Password $certPfxPwd

# Import certificate PFX file into Personal store of local machine


Import-PfxCertificate -CertStoreLocation cert:\LocalMachine\My -FilePath
$filename -Password $certPfxPwd

The self-signed certificate will only be trusted on machines that have a copy of the certificate in both their
local Personal and Trusted Root Certificate Authorities stores.

Modifications for Sites that Wish to Exclusively Use HTTPS Protocol


If a site wants to disable HTTP access and require that all MA4000 access must use HTTPS, modifications
must be made to the MA4000 web.config file in order for MA4000 to function in this configuration.
Disable HTTP access within Internet Information Services.
Browse to the MA4000 Manager folder (Default: C:\Program Files (x86)\NEC\Agile\Manager\).
Open the web.config file using a text editor.
Within the <services> section, comment out part of the HTTP endpoints for the "ConfigService",
"RegistrationService", "OrgLevelPortalService", "PbxPortalService", "UserPortalService", and
"AuthCodePortalService" services as shown on the next page:
<services>
<service name="ConfigService" behaviorConfiguration="Behavior_HTTP">
<!-- <endpoint address="" contract="IConfigService" binding="wsHttpBinding"
bindingConfiguration="Binding_HTTP" /> -->
<!-- <endpoint address="mex" contract="IMetadataExchange" binding="mexHttpBinding" /> -
->
<endpoint address="" contract="IConfigService" binding="wsHttpBinding"
bindingConfiguration="Binding_HTTPS" />
<endpoint address="mex" contract="IMetadataExchange" binding="mexHttpsBinding" />
<!-- Begin-CustomEdit-Block -->
<!-- End-CustomEdit-Block -->
</service>
<service name="RegistrationService" behaviorConfiguration="Behavior_HTTP">
<!-- <endpoint address=""
contract="NEC.Agile.Suite.Admin.Contracts.Service.IRegistrationService"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTP_UserName" /> -->
<!-- endpoint for RegistrationService java clients -->
<!-- <endpoint address="sv2"
contract="NEC.Agile.Suite.Admin.Contracts.Service.IRegistrationService"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTP_JAVA_UserName" /> -->
<!-- <endpoint address="mex" contract="IMetadataExchange" binding="mexHttpBinding" /> -
->
<endpoint address=""
contract="NEC.Agile.Suite.Admin.Contracts.Service.IRegistrationService"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTPS_UserName" />
<endpoint address="mex" contract="IMetadataExchange" binding="mexHttpsBinding" />
<!-- Begin-CustomEdit-Block -->
<!-- End-CustomEdit-Block -->
</service>
<service name="OrgLevelPortalService" behaviorConfiguration="Behavior_HTTP">
<!-- <endpoint address=""
contract="NEC.Agile.Integration.Contracts.Service.IOrgLevelPortal"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTP_UserName" /> -->
<!-- <endpoint address="mex" binding="mexHttpBinding" contract="IMetadataExchange" /> -
->
<endpoint address=""
contract="NEC.Agile.Integration.Contracts.Service.IOrgLevelPortal"
MA4000 Management System Installation Guide Revision 28
Miscellaneous Procedures 6-14
binding="wsHttpBinding" bindingConfiguration="Binding_HTTPS_UserName" />
<endpoint address="mex" binding="mexHttpsBinding" contract="IMetadataExchange" />
<!-- Begin-CustomEdit-Block -->
<!-- End-CustomEdit-Block -->
</service>
<service name="PbxPortalService" behaviorConfiguration="Behavior_HTTP">
<!-- <endpoint address=""
contract="NEC.Agile.Integration.Contracts.Service.IPbxPortal"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTP_UserName" /> -->
<!-- <endpoint address="mex" binding="mexHttpBinding" contract="IMetadataExchange" /> -
->
<endpoint address="" contract="NEC.Agile.Integration.Contracts.Service.IPbxPortal"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTPS_UserName" />
<endpoint address="mex" binding="mexHttpsBinding" contract="IMetadataExchange" />
<!-- Begin-CustomEdit-Block -->
<!-- End-CustomEdit-Block -->
</service>
<service name="UserPortalService" behaviorConfiguration="Behavior_HTTP">
<!-- <endpoint address=""
contract="NEC.Agile.Integration.Contracts.Service.IUserPortal"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTP_UserName" /> -->
<!-- <endpoint address="mex" binding="mexHttpBinding" contract="IMetadataExchange" /> -
->
<endpoint address="" contract="NEC.Agile.Integration.Contracts.Service.IUserPortal"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTPS_UserName" />
<endpoint address="mex" binding="mexHttpsBinding" contract="IMetadataExchange" />
<!-- Begin-CustomEdit-Block -->
<!-- End-CustomEdit-Block -->
</service>
<service name="AuthCodePortalService" behaviorConfiguration="Behavior_HTTP">
<!-- <endpoint address=""
contract="NEC.Agile.Integration.Contracts.Service.IAuthCodePortal"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTP_UserName" /> -->
<!-- <endpoint address="mex" binding="mexHttpBinding" contract="IMetadataExchange" /> -
->
<endpoint address=""
contract="NEC.Agile.Integration.Contracts.Service.IAuthCodePortal"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTPS_UserName" />
<endpoint address="mex" binding="mexHttpsBinding" contract="IMetadataExchange" />
<!-- Begin-CustomEdit-Block -->
<!-- End-CustomEdit-Block -->
</service>
<service name="ExtensionPortalService" behaviorConfiguration="Behavior_HTTP">
<!-- <endpoint address=""
contract="NEC.Agile.Integration.Contracts.Service.IExtensionPortal"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTP_UserName" /> -->
<!-- <endpoint address="mex" binding="mexHttpBinding" contract="IMetadataExchange" /> -
->
<endpoint address=""
contract="NEC.Agile.Integration.Contracts.Service.IExtensionPortal"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTPS_UserName" />
<endpoint address="mex" binding="mexHttpsBinding" contract="IMetadataExchange" />
<!-- Begin-CustomEdit-Block -->
<!-- End-CustomEdit-Block -->
</service>
<service name="SecurityCodePortalService" behaviorConfiguration="Behavior_HTTP">
<!-- <endpoint address=""
contract="NEC.Agile.Integration.Contracts.Service.ISecurityCodePortal"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTP_UserName" /> -->
<!-- <endpoint address="mex" binding="mexHttpBinding" contract="IMetadataExchange" /> -
->
<endpoint address=""
contract="NEC.Agile.Integration.Contracts.Service.ISecurityCodePortal"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTPS_UserName" />
<endpoint address="mex" binding="mexHttpsBinding" contract="IMetadataExchange" />
<!-- Begin-CustomEdit-Block -->
MA4000 Management System Installation Guide Revision 28
Miscellaneous Procedures 6-15
<!-- End-CustomEdit-Block -->
</service>
<service behaviorConfiguration="Behavior_HTTP" name="ConnectionService">
<!-- <endpoint address=""
contract="NEC.Agile.DisasterRecovery.Contracts.IConnectionService"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTP" /> -->
<!-- <endpoint address="mex" contract="IMetadataExchange" binding="mexHttpBinding" /> -
->
<endpoint address=""
contract="NEC.Agile.DisasterRecovery.Contracts.IConnectionService"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTPS" />
<endpoint address="mex" contract="IMetadataExchange" binding="mexHttpsBinding" />
<!-- Begin-CustomEdit-Block -->
<!-- End-CustomEdit-Block -->
</service>
</services>

Within the <behaviors> section, locate the serviceMetadata key and set the httpGetEnabled value
to false as shown below:
<serviceMetadata httpGetEnabled="false" httpsGetEnabled="true" />
Save, then close the web.config file.

Modifications for Sites that Wish to Exclusively Use HTTP Protocol


If a site wants to disable HTTPS access and require that all MA4000 access must use HTTP, modifications
must be made to the MA4000 web.config file in order for MA4000 to function in this configuration.
Disable HTTPS access within Internet Information Services.
Browse to the MA4000 Manager folder (Default: C:\Program Files (x86)\NEC\Agile\Manager\).
Open the web.config file using a text editor.
Within the <services> section, comment out part of the HTTPS endpoints for the “ConfigService",
"RegistrationService", "OrgLevelPortalService", "PbxPortalService", "UserPortalService", and
"AuthCodePortalService" services as shown below:
<service name="ConfigService" behaviorConfiguration="Behavior_HTTP">
<endpoint address="" contract="IConfigService"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTP"
/>
<endpoint address="mex" contract="IMetadataExchange" binding="mexHttpBinding" />
<!-- <endpoint address="" contract="IConfigService" binding="wsHttpBinding"
bindingConfiguration="Binding_HTTPS" /> -->
<!-- <endpoint address="mex" contract="IMetadataExchange" binding="mexHttpsBinding" />
-->
<!-- Begin-CustomEdit-Block -->
<!-- End-CustomEdit-Block -->
</service>
<service name="RegistrationService" behaviorConfiguration="Behavior_HTTP">
<endpoint address=""
contract="NEC.Agile.Suite.Admin.Contracts.Service.IRegistrationService"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTP_UserName" />
<!-- endpoint for RegistrationService java clients -->
<endpoint address="sv2"
contract="NEC.Agile.Suite.Admin.Contracts.Service.IRegistrationService"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTP_JAVA_UserName" />
<endpoint address="mex" contract="IMetadataExchange" binding="mexHttpBinding" />
<!-- <endpoint address=""
contract="NEC.Agile.Suite.Admin.Contracts.Service.IRegistrationService"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTPS_UserName" /> -->
<!-- <endpoint address="mex" contract="IMetadataExchange" binding="mexHttpsBinding" />
-->
<!-- Begin-CustomEdit-Block -->
<!-- End-CustomEdit-Block -->
</service>
<service name="OrgLevelPortalService" behaviorConfiguration="Behavior_HTTP">

MA4000 Management System Installation Guide Revision 28


Miscellaneous Procedures 6-16
<endpoint address=""
contract="NEC.Agile.Integration.Contracts.Service.IOrgLevelPortal"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTP_UserName" />
<endpoint address="mex" binding="mexHttpBinding" contract="IMetadataExchange" />
<!-- <endpoint address=""
contract="NEC.Agile.Integration.Contracts.Service.IOrgLevelPortal"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTPS_UserName" /> -->
<!-- <endpoint address="mex" binding="mexHttpsBinding" contract="IMetadataExchange" />
-->
<!-- Begin-CustomEdit-Block -->
<!-- End-CustomEdit-Block -->
</service>
<service name="PbxPortalService" behaviorConfiguration="Behavior_HTTP">
<endpoint address="" contract="NEC.Agile.Integration.Contracts.Service.IPbxPortal"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTP_UserName" />
<endpoint address="mex" binding="mexHttpBinding" contract="IMetadataExchange" />
<!-- <endpoint address=""
contract="NEC.Agile.Integration.Contracts.Service.IPbxPortal"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTPS_UserName" /> -->
<!-- <endpoint address="mex" binding="mexHttpsBinding" contract="IMetadataExchange" />
-->
<!-- Begin-CustomEdit-Block -->
<!-- End-CustomEdit-Block -->
</service>
<service name="UserPortalService" behaviorConfiguration="Behavior_HTTP">
<endpoint address="" contract="NEC.Agile.Integration.Contracts.Service.IUserPortal"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTP_UserName" />
<endpoint address="mex" binding="mexHttpBinding" contract="IMetadataExchange" />
<!-- <endpoint address=""
contract="NEC.Agile.Integration.Contracts.Service.IUserPortal"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTPS_UserName" />
<!-- <endpoint address="mex" binding="mexHttpsBinding" contract="IMetadataExchange" />
<!-- Begin-CustomEdit-Block -->
<!-- End-CustomEdit-Block -->
</service>
<service name="AuthCodePortalService"
behaviorConfiguration="Behavior_HTTP">
<endpoint address="" contract="NEC.Agile.Integration.Contracts.Service.IAuthCodePortal"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTP_UserName" />
<endpoint address="mex" binding="mexHttpBinding" contract="IMetadataExchange" />
<!-- <endpoint address=""
contract="NEC.Agile.Integration.Contracts.Service.IAuthCodePortal"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTPS_UserName" /> -->
<!-- <endpoint address="mex" binding="mexHttpsBinding" contract="IMetadataExchange" />
-->
<!-- Begin-CustomEdit-Block -->
<!-- End-CustomEdit-Block -->
</service>
<service name="ExtensionPortalService" behaviorConfiguration="Behavior_HTTP">
<endpoint address=""
contract="NEC.Agile.Integration.Contracts.Service.IExtensionPortal"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTP_UserName" />
<endpoint address="mex" binding="mexHttpBinding" contract="IMetadataExchange" />
<!-- <endpoint address=""
contract="NEC.Agile.Integration.Contracts.Service.IExtensionPortal"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTPS_UserName" /> -->
<!-- <endpoint address="mex" binding="mexHttpsBinding" contract="IMetadataExchange" />
-->
<!-- Begin-CustomEdit-Block -->
<!-- End-CustomEdit-Block -->
</service>
<service name="SecurityCodePortalService" behaviorConfiguration="Behavior_HTTP">
<endpoint address=""
contract="NEC.Agile.Integration.Contracts.Service.ISecurityCodePortal"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTP_UserName" />
<endpoint address="mex" binding="mexHttpBinding" contract="IMetadataExchange" />

MA4000 Management System Installation Guide Revision 28


Miscellaneous Procedures 6-17
<!-- <endpoint address=""
contract="NEC.Agile.Integration.Contracts.Service.ISecurityCodePortal"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTPS_UserName" /> -->
<!-- <endpoint address="mex" binding="mexHttpsBinding" contract="IMetadataExchange" />
-->
<!-- Begin-CustomEdit-Block -->
<!-- End-CustomEdit-Block -->
</service>
<service behaviorConfiguration="Behavior_HTTP" name="ConnectionService">
<endpoint address=""
contract="NEC.Agile.DisasterRecovery.Contracts.IConnectionService"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTP" />
<endpoint address="mex" contract="IMetadataExchange" binding="mexHttpBinding" />
<!-- <endpoint address=""
contract="NEC.Agile.DisasterRecovery.Contracts.IConnectionService"
binding="wsHttpBinding" bindingConfiguration="Binding_HTTPS" /> -->
<!-- <endpoint address="mex" contract="IMetadataExchange" binding="mexHttpsBinding" />
-->
<!-- Begin-CustomEdit-Block -->
<!-- End-CustomEdit-Block -->
</service>
</services>

Within the <behaviors> section, locate the serviceMetadata key and set the httpsGetEnabled value
to false as shown below:
<serviceMetadata httpGetEnabled="true" httpsGetEnabled="false" />
Save, then close the web.config file.
Restart IIS.

Replacing the MA4000.com Encryption Certificate


This section describes how to replace the certificate that the MA4000 application’s WCF (Windows
Communication Foundation) web services use for encryption. For this action, you will need administrator
access to the machine hosting MA4000.

NEC only supports the use of certificates that use the Subject name
“MA4000.com”. If the new certificate uses a different Subject it will cause
applications that rely on MA4000 web services (e.g.OW5000, ACD WebMAT,
Call Audit) to stop working.

Repeat this procedure if the MA4000 application is upgraded or repaired.

Update MA4000 Host Machine


Complete the following steps to replace the certificate used by the MA4000 application’s web services:
Open the Microsoft Management Console (MMC) application (Start > Run > mmc.exe)
Select File > Add/Remove Snap-in, and then choose Certificates from the available snap-ins. When
prompted, choose the Computer account option and then select the Local computer.
Within the Certificate Manager snap-in, browse to Personal > Certificates.
Delete all existing certificates that are Issued To the Subject value MA4000.com.
MA4000 Management System Installation Guide Revision 28
Miscellaneous Procedures 6-18

If the machine has more than one certificate with the Subject value
“MA4000.com” it will cause applications that rely on MA4000 web
services (e.g. OW5000, ACD WebMAT, Call Audit) to stop working.

Create a new certificate with the Subject value “MA4000.com”, which will be used by the web
services of MA4000, and place it in the Personal store of the local machine.

The following example script will create a new MA4000.com certificate using a Microsoft PowerShell
console with administrative rights on a Windows Server 2016 or Windows 10 machine and place it in
the machine’s Personal store.

$cert = `
New-SelfSignedCertificate `
-Subject CN=MA4000.com `
-CertStoreLocation cert:\LocalMachine\My `
-HashAlgorithm SHA512 `
-KeyExportPolicy Exportable `
-KeyLength 2048 `
-NotAfter 12/31/2039 `
-Provider "Microsoft Strong Cryptographic Provider" `
-FriendlyName MA4000.com-WcfCertificate

If your MA4000 machine is hosted on an older operating system, the following statements can be
added to the script to export the certificate to an MA4000.com-WcfCertificate.pfx file in your current
path/location which can be copied and imported into your older host machine.
$certPath = 'cert:\LocalMachine\My\' + $cert.thumbprint

$certPfxPwd = `
ConvertTo-SecureString `
-String 'p@$$w0rd' `
-Force -AsPlainText

Export-PfxCertificate `
-Cert $certPath `
-FilePath MA4000.com-WcfCertificate.pfx `
-Password $certPfxPwd

Refresh the Certificate Manager snap-in, and then confirm that your new MA4000.com certificate
displays. Also, verify that there are no other MA4000.com certificates on the machine.
Right-click on your new certificate and select All Tasks > Manage Private Keys.
Grant Read permissions to the machine’s IIS_IUSRS group and click OK.
Restart “NEC MA4000 Business Integration” Windows Service.
Using a web browser, navigate to the following URL to test if the MA4000 web services are working
correctly.
http://localhost/MA4000/WS/Public/ConfigService.svc
If the web service is working correctly, a message will display that states “You have created a
service.”

Update Third-Party MA4000 Client Applications


Third-party applications that use MA4000 web services may require additional changes if the encryption
certificate is replaced.
If you encounter errors using such an application after replacing the MA4000.com certificate, please refer
to that application’s documentation and support resources to determine what steps are necessary to
update it to use your new certificate.

MA4000 Management System Installation Guide Revision 28


Miscellaneous Procedures 6-19
Modify Server Host Name
NEC does not recommend renaming the MA4000 web server or database server. If the name of the server
must be renamed after MA4000 has been installed and operating, the procedure below can be used to
update the name in the MA4000 configuration file.
See Microsoft's Help and Support Knowledge Base web site for instructions on renaming web servers and
database servers. These tasks are outside the scope of this document and MA4000 technical support.

Web Server Host Name


Browse to the NECCAS folder on the NECCAS web server (Default: C:\Program Files
(x86)\NEC\NECCAS\).
Create a backup of the private.config file and then open the original using a text editor.
Locate the AlarmPage1 XML key and replace the ServerName portion of this example key with the
new name of the MA4000 server.

<add key="AlarmPage1"
value="http://ServerName/MA4000/AlarmGenerator.aspx"/>
Save, then close the private.config file.
If the host name of the NECCAS server changed, browse to the MA4000 PrivateBin folder of the
MA4000 web server (Default: C:\Program Files (x86)\NEC\Agile\Manager\PrivateBin\).
Create a backup of the agile.config file and then open the original using a text editor.
Locate the AuthUrl XML key and replace the ServerName portion of this example key with the new
name of the MA4000 server.

<add key="AuthUrl" value="http://ServerName/NecCas/">

Database Server Host Name


Browse to the MA4000 PrivateBin folder of the MA4000 web server (Default: C:\Program Files
(x86)\NEC\Agile\Manager\PrivateBin\).
Create a backup of the agile.config file and then open the original using a text editor.
Locate the DB:UnivergeAgile XML key and replace the InstanceName portion of this example key
with the new name of the MA4000 server.

<add key="DB:UnivergeAgile" value="workstation id=localhost;packet


size=4096;user id='agile';password='agile';data
source=InstanceName;persist security info=False;initial
catalog=MA4000"></add>
Locate the ODBC:UnivergeAgile XML key and replace the InstanceName portion of this example
key with the new name of the MA4000 server.

<add key="ODBC:UnivergeAgile" value="DRIVER=(SQL


Server);SERVER=InstanceName;UID=agile;PWD=agile;Database=MA4000"></add>
Save, then close the agile.config file.
Restart the Windows Services with names that begin with "NEC MA4000".

Modify Windows User Account and Password


During MA4000 installation, a Windows user account is created which the MA4000 application uses to
access its files and system resources. If this user account information needs to be updated, there are two
configuration files that must be modified.
MA4000 Management System Installation Guide Revision 28
Miscellaneous Procedures 6-20
Use the following procedure to modify/retrieve the MA4000 Windows user account username and/or
password of an existing installation.

If any of the following xml special characters are used in the password
values, they must be escaped.
< less than
> greater than
‘ apostrophe
" quote
& ampersand

MA4000 Web.Config Modifications


Browse to the MA4000 Manager folder (Default: C:\Program Files (x86)\NEC\Agile\Manager\).
Open the web.config file using a text editor.
Locate the identity XML key and replace the Username and Password values.

<identity impersonate="true" userName="Username" password="Password"/>


Save, then close the web.config file.
MA4000 Agile.Config Modifications
Browse to the MA4000 PrivateBin folder (Default: C:\Program Files
(x86)\NEC\Agile\Manager\PrivateBin\).
Open the Agile.config file using a text editor.
Locate the SchedulerUsername XML key and replace the Username value.

<add key="SchedulerUsername" value="Username"></add>


Locate the SchedulerPassword XML key and replace the Password value.

<add key="SchedulerPassword" value="Password"></add>


Save, then close the Agile.config file.

This must be a valid Windows user account with the appropriate


security permissions in order to function properly.

Execute EncryptConfigPasswords.exe which is also located in the PrivateBin folder to encrypt the
updated password within the Agile.config file.
Restart the Windows Services with names that begin with "NEC MA4000".

Create a new Windows User Account


During MA4000 installation, a Windows user account is created which the MA4000 application uses to
access its files and system resources. If there is a need to change the account being used, there are some
configuration file changes along with file permission changes that must be made. For example, MA4000
may have been installed with a local MA4000User account but later you want to change it to a domain
account.

Use the following procedure to modify/retrieve the MA4000 Windows user account username and/or
password of an existing installation.

MA4000 Management System Installation Guide Revision 28


Miscellaneous Procedures 6-21

If the requirement for a network user is known up front, this should be


done during the installation process in Advanced Mode when the
installer asks for the Windows User Account.

On the MA4000 server:


Create the new user using your existing IT processes. This should be a normal user account with no
administrative privileges.
Follow the Modify Windows User Account and Password section above to enter the new user and
password information. If the user is part of a domain, be sure to include the domain identifier (e.g.
domain\username) when editing the files.
Grant the new user account Full Control permission to the following folders. All items require rights to
be inherited for all child objects.
 C:\Windows\Microsoft.NET\Framework\v4.0.30319\Temporary ASP.NET Files\
 C:\Windows\Tasks\
 C:\Program Files (x86)\NEC\Agile\Data\
 C:\Program Files (x86)\NEC\Agile\EmergencyExport\
 C:\Program Files (x86)\NEC\Agile\Maintenance\
 C:\Program Files (x86)\NEC\Agile\Manager\AutoInclude\
 C:\Program Files (x86)\NEC\Agile\Manager\Export\
 C:\Program Files (x86)\NEC\Agile\Manager\Import\
 C:\Program Files (x86)\NEC\Agile\Manager\PrivateBin\
 C:\Program Files (x86)\NEC\Agile\Manager\Protected\PBX\NECSV\Clipboard\DATA\
 C:\Program Files (x86)\NEC\Agile\Manager\Scenario\
 C:\Program Files (x86)\NEC\Agile\PatchFolder\
 C:\Program Files (x86)\NEC\Agile\Reports\
 C:\Program Files (x86)\NEC\Agile\Temp\
Open an administrative command prompt (Start > CMD > right-click and Run as Administrator) and
run the following command to allow the new user to access the MA4000 key. Be sure to replace
domain\username below with your actual domain and username:
C:\Windows\Microsoft.NET\Framework\v4.0.30319\aspnet_regiis.exe -pa
MA4000KeyStore domain\username
Make sure that “Allow log on locally” and “Log on as batch job” are both enabled for the new user
(see the Troubleshooting section if needed for this).
Restart the MA4000 Application Pool (Start > inetmgr > Server > Application Pools > MA4000)
Run a test background task to ensure that the change is working.

Modify Database User Accounts and Passwords

If the MA4000 ReadOnlyUserID or ReadOnlyPassword values are


modified, any registered application (e.g., OW5000) or feature
(e.g.,Call Audit) that directly accesses the MA4000 database will also
need to be modified to use the new account credentials.

During an MA4000 installation, SQL Server login accounts are created for accessing the MA4000 database.
Use the following procedure to modify the SQL Server login accounts that are used for the MA4000
database.
MA4000 Management System Installation Guide Revision 28
Miscellaneous Procedures 6-22
If any of the following xml special characters are used in the password
values, they must be escaped.
< less than
> greater than
‘ apostrophe
" quote
& ampersand
The } closing curly bracket character cannot be used in the database
password value.

On the SQL Database Server:


Open Microsoft SQL Server Management Studio and connect to the instance that contains the
MA4000 database.
Open a new query (ctrl+N) and run the following SQL after updating it with the appropriate username
(e.g. agile) and password (e.g. a$trongAgi1eP@ssw0rd).

ALTER LOGIN username WITH PASSWORD = 'password';


On the MA4000 server:
Browse to the MA4000 PrivateBin folder (Default: C:\Program Files
(x86)\NEC\Agile\Manager\PrivateBin\).
Open the Agile.config file using a text editor.
Locate the DB:UnivergeAgile XML key and replace the Username and/or Password values. When
changing the password, replace everything between the ' apostrophe characters.

<add key="DB:UnivergeAgile" value="workstation id=localhost;packet


size=4096;user id='Username';password='Password’ ;data
source=InstanceName;persist security info=False;initial
catalog=MA4000"></add>
Locate the ODBC:UnivergeAgile XML key and replace the Username and/or Password values.
When changing the password, replace everything between the { and } curly brace characters.

<add key="ODBC:UnivergeAgile" value="DRIVER={(SQL


Server};SERVER={InstanceName};UID={Username};PWD={Password}
Database={MA4000}"></add>
Locate the ReadOnlyUserID XML key and replace the Username value.

<add key="ReadOnlyUserID" value="Username"></add>


Locate the ReadOnlyPassword XML key and replace the Password value. When changing the
password replace everything between the " quote characters.

<add key="ReadOnlyPassword" value="Password"></add>


Save, then close the Agile.config file.
Execute EncryptConfigPasswords.exe which is also located in the PrivateBin folder to encrypt the
updated password within the Agile.config file.
Restart the Windows Services with names that begin with "NEC MA4000".

Reset SA Password
During a MA4000 installation there is an option to install an instance of Microsoft SQL Server 2017 Express
Edition. If the default SA password was used, or if MA4000 was installed in Simple Mode, the SA account

MA4000 Management System Installation Guide Revision 28


Miscellaneous Procedures 6-23
password may not be known. If needed, it is possible to reset the SA account password by logging into the
database instance using Windows Authentication.
Use the following procedures to reset the SA account password for an instance of SQL Server using
Windows Authentication:
Log into Windows on the server containing the SQL Server instance using the local administrator
account or another account with equivalent privileges.
Open a Command Prompt window.
Use the SQL Server Command Line Tool to access the database system using Windows
Authentication.

sqlcmd.exe -S InstanceName –E
Type the following SQL commands within the SQL Server Command Line Tool, substituting the new
password.

sp_password @old = null, @new = 'NewPassword’,


@loginame = 'sa'
go

Manual Database Creation


This section describes how to install MA4000 without obtaining the system administrator's account
password. The database administrator will need to perform a few steps prior to running the MA4000
installation.
In the install directory for MA4000 there is a file called Database.sql. This is the file that creates the
database. This file must be run as a SQL administrator because it creates the database and the SQL logon
to be the owner of the database. All other database scripts are run as the SQL logon.
Locate the Database.sql file located on the installation disc under the Setup\MA4000 directory.
Working with the database administrator, use a text editor (i.e., Notepad) to replace the macros in the
Database.sql file. This file contains macros that would normally be replaced by the MA4000
installation. The macros are text strings contained in braces. For example,
— {DATABASE_NAME} - The name of the database.
— {PATH_DATA} - The full path on the SQL server where the SQL data files (.mdf
and .ndf) will be stored.
— {PATH_LOG} - The full path on the SQL server where the SQL log file (.ldf) will be
stored.
— {DB_USERNAME} - The name of the SQL logon to create that will be the owner of
the database.
— {DB_PASSWORD} - The password for the SQL logon named by
— {DB_USERNAME}
— {DB_READONLY_USERNAME} - The name of the read-only SQL logon to create that
can be used by third-party applications.
— {DB_READONLY_PASSWORD} - The password for the read-only SQL logon named by
{DB_READONLY_USERNAME}.

You will need to know the values used for {DATABASE_NAME},


{DB_USERNAME},
DB_PASSWORD}, {DB_READONLY_USERNAME}, and
{DB_READONLY_PASSWORD} when the MA4000 installation is run.

MA4000 Management System Installation Guide Revision 28


Miscellaneous Procedures 6-24
Have the database administrator execute the modified Database.sql file against the SQL server using
Query Analyzer or osql.exe. The script should be run as an SQL administrator using the sa account
or a Window account with administrator access to the SQL server.
Run the MA4000 installation, choosing the Advanced mode.
On the Database Installation screen, choose the Use an existing database server option and
choose either the On this computer or On an external computer option.
- If the On an external computer option is selected, ensure the correct computer name is
entered
- Choose the correct instance of the SQL server and set the Database Name field to the same
value that was selected for the {DATABASE_NAME} macro earlier.
- Select the Use existing database and Create new tables options, then click Next.
The next screen will prompt for the SQL accounts to be used.
- For the SQL logon name, enter the value used for the {DB_USERNAME} macro.
- For the password, enter the value used for the {DB_PASSWORD} macro.
- For the read-only SQL logon name, enter the value used for the
{DB_READONLY_USERNAME} macro.
- For the read-only logon password, enter the value used for the {DB_READONLY_PASSWORD}
macro.
The remainder of the installation will proceed normally. When the installation reaches the database
creation step, the installation will not run the Database.sql file, connect to the existing database
specified, then run the rest of the SQL scripts as the SQL user specified.

Move MA4000 Database to a Different Database Server Instance


This section describes how to move the MA4000 database from one SQL Server instance to another.
Database administrator access is required on both the source and target database instances in order to
use this procedure.
This procedure was assembled using the following MSDN articles as a reference.
- How to: Move a Database Using Detach and Attach (Transact-SQL) -
http://msdn.microsoft.com/en-us/library/ms187858.aspx
- sp_detach_db (Transact-SQL) - http://msdn.microsoft.com/en-us/library/ms188031.aspx
- CREATE DATABASE (Transact-SQL) - http://msdn.microsoft.com/en-us/library/ms176061.aspx
- sp_addlogin (Transact-SQL) - http://msdn.microsoft.com/en-us/library/ms173768.aspx
- ALTER USER (Transact-SQL) - http://msdn.microsoft.com/en-us/library/ms176060.aspx

This process should be used when moving the MA4000 database to a new server while keeping the
existing MA4000 software installation in place. This is most likely the case for remote database
installations. For instructions on migrating the MA4000 software installation and the database together,
see the Migrate section.

Stop all of the NEC MA4000 services within Administrative Tools > Services and close all connections
to the MA4000 database.
Detach the database from the source database instance using the sp_detach_db stored procedure,
as shown in the following example.
USE master;GO
EXEC sp_detach_db @dbname = N'MA4000';GO
Copy the MA4000 database files from the source location to the target location. The following list is
an example of the files associated with a MA4000 database.

MA4000 Management System Installation Guide Revision 28


Miscellaneous Procedures 6-25
- C:\Program Files\Microsoft SQL Server\MSSQL.1\MSSQL\Data\MA4000_dat.mdf
- C:\Program Files\Microsoft SQL Server\MSSQL.1\MSSQL\Data\MA4000_indx.ndf
- C:\Program Files\Microsoft SQL Server\MSSQL.1\MSSQL\Data\MA4000_log.ldf
Create the MA4000 database in the target database instance and attach the copied database files
using the CREATE DATABASE Transact-SQL statement with a FOR ATTACH clause, as shown in
the following example.

If the target database instance does not contain MA4000 SQL login accounts, such as 'agile' and
'reader', create them using the sp_addlogin stored procedure, as shown in the following example. If
you wish to use the same database account passwords, copy them from the MA4000 Agile.config file

Map the MA4000 SQL login accounts to the MA4000 database user accounts using the ALTER
USER Transact-SQL statement, as shown in the following example.
USE [MA4000];GO
ALTER USER agile WITH LOGIN = agile;GO
ALTER USER reader WITH LOGIN = reader;GO
Update the database connection settings in the Agile.config file to use the target database instance
and database user passwords.

NEC SV8100 Connector


The NEC SV8100 Connector requires .NET Framework 3.5. If the framework is not installed, the MA4000
installer sets the NEC SV8100 Connector service startup type to Manual after installing /upgrading the
service.
If you would like to manage SV8100 IP-PBXs using MA4000 then the Microsoft .NET Framework version
3.5 must be enabled/installed manually. Once installed, the startup setting for the NEC SV8100 Connector
service should be changed from Manual to Automatic.

MA4000 Management System Installation Guide Revision 28


Troubleshooting 7-1

7
Troubleshooting
This chapter provides some troubleshooting information for issues that may occur during use of MA4000.
Each section below describes a separate potential issue for troubleshooting.

Background Tasks fail with Access Denied Error


If the following error message appears when trying to run a scheduled task in MA4000, follow the
troubleshooting steps provided in this section.
Access Denied: Exception from HRESULT: 0x80070005 (E-ACCESSDENIED).
The cause of this issue is most likely domain security policies that are pushed out and remove the
Windows MA4000User account's rights to the Windows Tasks folder.
Perform the following steps on the MA4000 server to resolve this issue:
Log into the MA4000 server as an administrative user.
Open a command prompt window by (Start > Run > cmd.exe).
Type in the command shown below. This command will grant the MA4000User account read and
write privileges to the Windows Tasks folder. Please note that you will need to replace “servername”
with the name of your MA4000 server or the domain that contains the MA4000User account if this
account was added to a domain. MA4000User is the default Windows user account, but if your
MA4000 was configured to use a custom Windows user account, you will need to replace
“MA4000User” with that user account.
cacls C:\Windows\Tasks /E /G servername\MA4000User:F
Browse to MA4000 > Administration > Web Updates and run a web update task to see if the
background task is properly started. If the task runs and completes, this problem is fixed.
Take this information to the customer's Information Technology department and explain this situation.
The MA4000User account must have read and write access to the Windows Tasks folder in order to
operate background tasks (e.g. IP-PBX Synchronization and IP-PBX Backup). Without an exception
in the domain policies, this problem will continue to occur.

Background Tasks Fail with HRESULT: 0x80070520 Error


If the following error message appears when trying to run a scheduled task in MA4000, follow the
troubleshooting steps provided in this section.
Updating scheduled task in database
Saving scheduled task entry
A specified logon session does not exist. It may already have been terminated.
(Exception from HRESULT: 0x80070520)
The cause of this issue is most likely a domain security policy that prevents the MA4000User Windows
account from running MA4000 background tasks.
Perform the following steps on the MA4000 server to resolve this issue:

MA4000 Management System Installation Guide Revision 28


Troubleshooting 7-2
Log into the MA4000 server as an administrative user.
Open the Local Group Policy Editor (Start > Run > gpedit.msc).
In the Local Group Policy Editor, browse to Computer Configuration > Windows Settings >
Security Settings > Local Policies > Security Options
Double click on the following item to open its properties: Network access: Do not allow storage of
passwords and credentials for network authentication. This policy must be set to Disabled for
MA4000 to be able to run background tasks.
Browse to MA4000 > Administration > Web Updates and run a web update task to see if the
background task is properly started. If the task runs and completes, this problem is fixed.
Take this information to the customer's Information Technology department and explain this situation.
The Network access: Do not allow storage of passwords and credentials for network
authentication security policy must be set to Disabled in order to operate background tasks (e.g. IP-
PBX Synchronization and IP-PBX Backup). Without an exception for the MA4000 server in the
domain policies, this problem will continue to occur.

Background Tasks fail due to Windows Account Credentials Error


If the following message appears when trying to run a scheduled task, follow the troubleshooting steps
provided in this section.
The Windows account credentials specified by the "SchedulerUserName" and
"SchedulerPassword" keys in Agile.config are not valid or the account is locked.
The most likely cause of this issue is domain security policies that are pushed out and alter the rights of
the Windows MA4000User account. However, it could be that the MA4000User account has been locked or
the password has been changed. This section contains the necessary steps to determine the issue and fix
it.
Perform the following steps on the MA4000 server:
Log into the MA4000 server as an administrative user.
Browse to Agile.config and open it with a text editor.
The default location for Agile.config is C:\Program Files
(x86)\NEC\Agile\Manager\PrivateBin\Agile.config
Copy the value parameter (without the quotes) from the SchedulerUserName key. Paste this into a
new text document for use later. The SchedulerUserName is MA4000User by default, and the rest
of this article will use MA4000User in the examples. If this user has been named differently on your
MA4000 server, you will need to replace MA4000User in the examples below with the
SchedulerUserName value from your Agile.config file.
Go to Computer Management > Local Users and Groups > Users, right-click and view the
properties of the MA4000User account.
Verify that the specified user account is not disabled or locked out. If the account is disabled or locked
out, uncheck the boxes next to Account is disabled and Account is locked out as applicable.
To check if the issue has been resolved, browse to MA4000 > Administration > Web Updates and
run a web update task to see if the background task is properly started. If the task is runs and
completes, this problem is fixed. If not, verify again that the account is not locked or disabled and then
continue to the next step.
If you know the password to the MA4000User, skip this step. If you do not know the password for the
MA4000User, follow the Modify Windows User Account and Password section of this guide to set a
new, strong password for the MA4000User.
Open a Command Prompt window (Start > Run > cmd.exe) and execute the following command:
RunAs.exe /User:MA4000User Notepad.exe

MA4000 Management System Installation Guide Revision 28


Troubleshooting 7-3
This command will try to run Notepad.exe as MA4000User. Running this command will prompt you to
enter the password for the MA4000User. Enter the password for this user at the prompt.
If you get one of the following responses, return to step 4:
1326: The user name or password is incorrect
1327: Account restrictions are preventing this user from signing in
1909: The referenced account is currently locked out and may not be logged
on to
Continue to the next step if you get the following response, otherwise skip to step 17:
1385 Logon failure: the user has not been granted the requested login type
at this computer
Open the Local Group Policy Editor (Start > Run > gpedit.msc).
Browse to Computer Configuration > Windows Settings > Security Settings > Local Policies >
User Rights Assignment
Verify that the Allow log on locally policy setting is allowed for the MA4000User account or the
group that contains MA4000User (by default, MA4000User is a part of the Users group). If this policy
setting is not enabled for MA4000User or its group, double-click this policy setting and add
MA4000User or its group to this policy setting.
Verify that the MA4000User and the group that contains MA4000User are both not listed in the Deny
log on locally policy setting. If this policy setting includes the MA4000User or its group, double-click
this policy setting and remove them from this policy setting.
Go back to step 8 to verify that the runas command works fine for the MA4000User account.
In order to verify that the issue is resolved, browse to MA4000 > Administration > Web Updates
and run a web update task to see if the background task is properly started. If the task runs and
completes, this problem is fixed.
If the problem was related to the group policy, take this information to the customer's Information
Technology department and explain this situation. This problem will continue to occur until it has been
resolved in the domain policies.

Background task starts, but has no updates and runs indefinitely


If a background task runs indefinitely with no updates, perform the following steps on the MA4000 server:
Log on to the MA4000 server as an administrative user.
Browse to Agile.config and open it with a text editor.
The default location for Agile.config is C:\Program Files
(x86)\NEC\Agile\Manager\PrivateBin\Agile.config.
Copy the value parameter (without the quotes) from the SchedulerUserName key. Paste this into a
new text document for use later. The SchedulerUserName is MA4000User by default, and the rest of
this section will use MA4000User in the examples. If this user has been named differently on your
MA4000 server, you will need to replace MA4000User in the examples below with the
SchedulerUserName value from your Agile.config file.
Open the Local Group Policy Editor (Start > Run > gpedit.msc)
Browse to Computer Configuration > Windows Settings > Security Settings > Local Policies >
User Rights Assignment
Verify that the Log on as batch job policy setting is allowed for the MA4000User account or the
group that contains MA4000User (by default, MA4000User is a part of the Users group). If this policy
setting is not enabled for MA4000User or its group, double-click this policy setting and add
MA4000User or its group to this policy setting.

MA4000 Management System Installation Guide Revision 28


Troubleshooting 7-4
Verify that the MA4000User and the group that contains MA4000User are both not listed in the Deny
log on as batch job policy setting. If this policy setting includes the MA4000User or its group,
double-click this policy setting and remove them from this policy setting.
In order to verify that the issue is resolved, browse to MA4000 > Administration > Web Updates
and run a web update task to see if the background task is properly started. If the task runs and
completes, this problem is fixed.
Take this information to the customer's Information Technology department and explain this situation.
This problem will continue to occur until it has been resolved in the domain policies.

MA4000 Management System Installation Guide Revision 28


Troubleshooting 7-1
For additional information or support on this product, contact your NEC Corporation
representative.

MA4000 Management System Installation Guide Revision 28

You might also like