You are on page 1of 66

Application Suite

Administration Guide
Version 10.0
November 2013
Table of Contents
Table of Contents ................................................................................................................ 2
1 Introduction ................................................................................................................. 3
1.1 General Minimum Requirements ........................................................................ 3
1.2 Administrator permissions .................................................................................. 4
2 Installation................................................................................................................... 5
2.1 Installing the Application .................................................................................... 5
2.2 Quick Setup ....................................................................................................... 12
2.2.1 Quick Setup - Introduction............................................................................ 12
2.2.2 General .......................................................................................................... 12
2.2.3 Company Properties ...................................................................................... 13
2.2.4 Organization Import ...................................................................................... 13
2.2.5 Email Settings ............................................................................................... 15
2.2.6 Create User.................................................................................................... 16
2.2.7 Advanced Settings ........................................................................................ 17
2.2.8 Rates.............................................................................................................. 18
2.2.9 Collection ...................................................................................................... 21
2.2.10 Add a Data Source .................................................................................... 21
2.2.11 Collection Toolbar .................................................................................... 22
2.3 Patches Installation ........................................................................................... 24
2.4 Install Language Pack Only .............................................................................. 25
2.5 Language Settings ............................................................................................. 28
3 Administration Tools ................................................................................................ 29
3.1 Management Utility .......................................................................................... 29
3.1.1 Backup/ Restore ............................................................................................ 29
3.1.2 System ........................................................................................................... 30
3.1.3 Vlist Convert ................................................................................................. 32
3.1.4 Printers .......................................................................................................... 34
3.1.5 Log Settings .................................................................................................. 35
4 Appendix A – Distributed Installation ...................................................................... 37
5 Appendix B – Uninstall ............................................................................................ 42
5.1 Uninstall ............................................................................................................ 42
5.2 Manual Actions ................................................................................................. 42
6 Appendix C - Organization Import Guide ................................................................ 43
6.1 Introduction ....................................................................................................... 43
6.2 Generic Personnel Import ................................................................................. 43
6.3 MA4000 Import ................................................................................................ 51
7 Appendix D: Minimum Technical Specifications ................................................... 59
7.1 System Requirements........................................................................................ 59
7.2 General Software Requirements ....................................................................... 60
7.3 Web Browsers ................................................................................................... 61
8 Appendix E – General Settings ................................................................................. 62

Administration Guide EM_ Ver 10 2


1 Introduction
This document defines the installation requirements and step-by-step instructions for the
installation and setup of the Application Suite.

1.1 General Minimum Requirements

The license is hardware dependent. It examines the motherboard configuration. If


the hardware parameters no longer fit the license, a new license must be requested.

In case the server receives the IP address as part of a DHCP network, do not disconnect
the server from the network. The disconnection will result not recognizing the license
settings after reboot and Application Suite will return a license error.

Application Suite minimum requirements are listed in Appendix D

Administration Guide EM_ Ver 10 3


1.2 Administrator permissions

The person performing the installation should have full administrative rights on
the server. In case of a distributed installation he should have administrative rights on
both servers. Please refer also to the ‘Distribution Installation – IT Requirements’
document

Before starting the installation, verify that the hardware and software requirements are
met. The installation adds a virtual directory to IIS, and databases to SQL. Ensure that
there is adequate permission to do that. Familiarity with the products configuration is
required.

Below are the minimal permissions needed per folder:


Note: There is no need to check these permissions before installation. They are most
likely available by default. The list below will help for troubleshooting.

Anonymous user must be set to the IUSER_ account


The following folders should have the permissions as specified (Make sure, that there is
no special inheritance security from one of the root folders)
C:\Inetpub\wwwroot\aspnet_client folder and subfolders,
C:\Inetpub\wwwroot\ig_common folder and subfolders,
C:\Inetpub\wwwroot\ig_grid2_images folder and subfolders,
C:\Inetpub\wwwroot\ig_grid2_scripts folder and subfolders,
C:\Inetpub\wwwroot\ig_images2 folder and subfolders,
C:\Inetpub\wwwroot\ig_scripts2 folder and subfolders,
C:\Inetpub\wwwroot\ig_webbars2_images folder and subfolders,
C:\Inetpub\wwwroot\ig_webbars2_scripts folder and subfolders:
IUSR* account: Read permission.
C:\ Program Files\TABS \APPUI folder and subfolders:
SYSTEM account: Modify, Read & Execute, List Folder Contents, Read, and
Write permissions.
IUSR* account: Read permission.
C:\ Program Files\TABS \Bin folder and subfolders:
SYSTEM & IUSR* accounts: Modify, Read & Execute, List Folder Contents,
Read, and Write permissions.
C:\ Program Files\TABS \Runtime folder and subfolders:
SYSTEM & IUSR* accounts: Modify, Read & Execute, List Folder Contents,
Read, and Write permissions.
C:\Program Files\Common Files\Crystal Decisions folder and subfolders:
SYSTEM account: Modify, Read & Execute, List Folder Contents, Read, and
Write permissions.

IUSR* account: Read & Execute, List Folder Contents, Read permissions.

Administration Guide EM_ Ver 10 4


2 Installation
2.1 Installing the Application

1. Copy over the contents from the CD to the Hard disk, remove the Read-Only
properties and run Setup.exe.

2. Click Next and Yes for the following two questions. The InstallShield
Wizard Window is displayed:

3. Type User Name, Company Name and select the Anyone who uses this
computer (all users) option.

4. Click Next to choose the Installation Destination:

Administration Guide EM_ Ver 10 5


5. Click Next.
The specific definition of the MA4000 server and Database are entered:

6. Click Next. The InstallShield Wizard window is displayed:

Administration Guide EM_ Ver 10 6


7. Leave the default Web application name that is showing in this field.

Note: When a user starts to use the Application Suite user interface, the user
name must first be authenticated. There are 2 optional authentication modes
for the application:
Application – A user table is maintained in the database with user names and
passwords.
Windows – Authentication is done by comparing the user name, password
and domain that are taken from the windows login. There will be no login
screen to the application. If the user exists in the application database, he or
she will enter the application immediately.

8. At this stage you can go Back to change the destination folder or click Next
the Define SQL User window is displayed:

Administration Guide EM_ Ver 10 7


In the Instance field, type the instance that was installed (see SQL install), or
the instance that will be installed (light version).

If the default instance had been installed on the SQL server, leave the Use Default
box checked.

In case of a distributed installation (see Chapter 8, Appendix A), Ucheck the


‘On this computer’ box.

The Remote Name field will become enabled. Type in the name of the
Remote SQL Server or browse for by clicking on the browse button next to
the field.

9. Click Next to continue. The application will try to connect to the SQL server
and if it succeeds the Advanced Settings window will be displayed:

Administration Guide EM_ Ver 10 8


10. Select one or multiple printers (optional).
Note: The application can automatically send reports to a printer. It is
necessary to define the printer for the application at the installation stage.
As the application may be available for many users, it is recommended to
assign a printer by the administrator (installer) that will be available for the
application. Note that remote users can not change the printer selection from
their station.
An organization may have many network printers available; The user may not
want all of them to be available.

11. The option to define a user name and password for the SQL user on the SQL
server is presented. This user is an internal user that is used to access data
from the SQL server for reporting purposes. It is recommended to leave the
default settings but in some cases the system administrator of the organization
will want to choose an organization standard user name and password.
12. The specific NEC Settings are entered at this stage: defining the address of the
license server.
Note: These screens appear depending on the Install ini file definition, under
the setup directory of the installation.

Administration Guide EM_ Ver 10 9


13. Click Next - the system will start the installation, giving you an indication of
the status of the process. You may choose to go Back to review any of the
defined settings.

14. When the installation is completed, the Installation Wizard window is


displayed:

Administration Guide EM_ Ver 10 10


15. It is recommended to make a backup of the database and/or create an image of
the hard disk, using an imaging tool such as the Norton Ghost.

16. During installation a shortcut to the Application Suite is created on the


Desktop of the server:

Use it to login to the application and begin the initial setup of the system.

Administration Guide EM_ Ver 10 11


2.2 Quick Setup
2.2.1 Quick Setup - Introduction
The Quick Setup provides you with a quick access to the tools and options that are
necessary to configure your system . This will enable the application to collect calls,
perform costing, and run reports.
The Quick Setup is displayed automatically after the first login.
After the initial configuration, you can access the Quick Setup in the Maintenance
module at any time to enter additional definitions.
The Quick Setup includes 3 tabs:
 General: Setting General Company Definitions
 Rates: Defining the system default rate table
 Collectors: Defining Data source (s) and collection definitions

2.2.2 General
Use the General tab to define the basic company settings:
 Company Properties: Use the Company Properties fields to select the Company
Logo that is displayed on reports.
 Organization Import: Use the Organization Import fields to specify the
synchronization type.
 Email Settings: Use the Email Settings fields to define the parameters of your
email server. This is required in order to distribute reports and system alerts via
email.
 Create User: Use the Create User button to create the user who acts as the
System Administrator.
 Advanced Settings: Use the Advanced Settings link to define required system
settings.

Administration Guide EM_ Ver 10 12


2.2.3 Company Properties
In the Company Properties section, you can select the Company Logo that is displayed on
reports.

To set the company properties:


1. Locate the Company Properties area.
2. Complete the following field:

Option Description

Company The Company Logo is displayed on reports. Click


Logo Browse to select an image file for your company logo.

2.2.4 Organization Import


In the Organization Import section, you can specify the synchronization type.
 For Siemens Installation, the following options are available: Organization File,
HiPath Manager, and User Management.
 For NEC installation, the following options are available: Organization File and
MA4000 Synch.

Administration Guide EM_ Ver 10 13


 For a market installation, all options are available.

To import an Organization file:


1. For the Import Type, select Organization File.
2. Click Browse to select the CSV file. After you select the file, you have the
option to preview it.
3. Click Preview to review the data before importing it into the system. If
necessary, make any changes to the file, save it, and click Browse to reload it.
4. Click Run Now to import the organization file.

To import a User Management or HiPath Manager file:


Note You can click Previous at any time during this
process to return to the previous window.

1. For the Import Type, select HiPath Manager or User Management.


2. Click Edit.
3. On the General tab, enter a new or update the existing job Name.
4. Click Next.
5. On the Component tab, define the Type Parameters. The User Name
and Password are required.
6. Click Next.
7. Choose one of the following options:
 Click Run Now to process the job.
 Click Save to save the job information.
 Click Schedule to run the job at a later date. The Job Scheduler is
displayed. Enter the date and time information and click OK. The job is
added to the list of scheduled jobs. Review the information and exit the
window.

To import data from a MA4000:

Note: You can click Previous at any time during this process to return to the previous
window.

1. For the Import Type, select NEC Sync.


2. Click Edit.
3. Complete the following fields:

Field Description
MA4000 server \ Enter the name of the MA4000 server and the instance.
Instance name

Administration Guide EM_ Ver 10 14


MA4000 server \ Enter the database name.
Database name
MA4000 server \ Enter the user name used to connect to the MA4000 server.
Database Username

MA4000 server \ Enter the password used to connect to the MA4000 server.
Database Password
NEC CAS URL Enter the URL used to access the CAS application.

Expense Enter the URL used to access the expense management


Management access application.
URL
Select the entities that you want to synchronize:
Synchronize
Organization Units Select this option to synchronize
organization units.
Extensions Select this option to synchronize
extensions
Personnel Select this option to synchronize
personnel.
Pin Codes Select this option to synchronize
pin codes.
User Defined Fields Select this option to define and
synchronize custom fields.
4. Click Run Now to import the organization data.

2.2.5 Email Settings


Use Email Settings to define the parameters of your email server.

To define email settings:


1. Consult with IT personnel to get the necessary information for these settings.
2. Complete the following fields:

Option Description
Mail Server Enter the Exchange server name or the IP.
Name/IP
Server Port Enter the port of the Exchange Server.
Number
Email Account Enter the email address of the Application Suite

Administration Guide EM_ Ver 10 15


Name server. This will be used in the From field of emails
sent from the application server.
Server If you select this option:
Requires  User Name: Enter <domain name>\user name.
Authentication
 Password: Enter user’s password.
 Confirm Password: Re-enter the password.
Otherwise, a V is displayed if the SMTP is already
configured.
Alerts- Enter an email address to where the system alerts will
Destination be sent. This email will be assigned to the default
Email Address Admin user that the application comes with.

3. Click Test & Save to verify and save the settings you have defined. If you have
entered invalid information, a notification is displayed. Make the necessary
changes and click Test & Save again.

2.2.6 Create User


The Create User button enables you to create the user who acts as the System
Administrator.

To create the system administrator:


1. Locate the Create User area.
2. Click Create User.
3. Enter the User Name. The Initial password for the user is 123456.
4. Click OK.

Administration Guide EM_ Ver 10 16


2.2.7 Advanced Settings
Use the Advanced Settings link to define the required system settings. After you
complete the Quick Setup, you can modify these settings at any time. These options
reside in the Maintenance \ System Settings \ General settings.

To define the advanced settings:


1. Click the Advanced Settings link.
2. Complete the following fields:

Option Description
Person will be Select this option to refer to personnel in the system
defined in the and assign devices to the user. This is also known as
system a user-centric system.
Unique extensions Select this option to create a unique numbering
numbering plan plan. If there are two extensions with the same
number they will be merged, and treated as one.
Create extensions Select this option to create new extensions (through
automatically the collector) automatically.
Create pin codes Select this option to create new Pin Codes (through
automatically the collector) automatically.

Administration Guide EM_ Ver 10 17


2.2.8 Rates
The Rates tab enables you to customize the rates table to suit your needs. Rates define
how much specific call will cost. For example, calls to New York cost $0.50 per minute.
You can define the Price Per Minute, or add a new rate.
Use Advanced Rates when you need a more complex definition to accurately calculate
the cost of a call. For example: when different segments of the call have different units or
different prices; when different days of the week or hours of the day have different rates,
when you need to define a grace period, etc. Both National and International Rates can be
defined as Advanced Rates.

To add or modify a rate:


1. Click the Rates tab.
2. To add a rate, click in the top row or click New in the Action toolbar.
To modify a rate, double-click the field you want to modify.
3. Complete the following fields:

Option Description
Rate Name Enter a name for the new rate. The name must be
unique.
Rate Code Enter a code for the new rate. The code must be unique.
Price Per Enter the price per minute.
Minute

Administration Guide EM_ Ver 10 18


Advanced Rate Display only field. The Advanced Rate icon indicates an
advanced rate structure was defined for this rate.

4. Press Enter to save the new rate.


5. To make this rate an Advanced Rate, click in the new rate's row to select it,
and then click Advanced Rate in the action toolbar. The Advanced Rate dialog
box opens. For information on advanced rate fields, see below.

To define or edit an advanced rate:


1. Click in the row for which you wish to define or edit the Advanced rate to
select it, and then click Advanced Rate in the action toolbar. The
Advanced Rate dialog box opens.
2. Complete the following fields:

Tab Section/Option Option Description


General Name Name of the rate.

Description A short description of the rate.

Field Select whether the rate will be


defined according to duration or
units.
Grace Period The amount of initial call time that
a user is not charged for. E.g. the
first 30 seconds.
Fixed Cost A fixed amount that is charged for
placing the call.
Add fixed cost Select if the fixed cost should be
when duration is applied when calls are shorter than
shorter than the defined grace period.
grace period
Minimum Cost The minimum amount that is
always charged.
Rate Segments In the Rate Segment grid Action
toolbar, click to add a new
segment; or Click in a segment
row to select it, and then click
to edit the selected segment or
to delete it.
Complete the following fields:

Administration Guide EM_ Ver 10 19


Length Enter the duration
of the segment.
Meter Enter the duration
Unit of a metered unit.
Price Per Enter the price per
Meter metered unit.
Unit
Rounding Define how to
round numbers,
either up or down,
by selecting the
relevant option
from the drop-down
menu.
Click Update to save the new or
edited Rate Segment.
Conditions Time
Click New to create a new
Working Hours definition; or click
Edit to edit the previously
defined Working Hours definition.
When finished, click Update to
save the new or modified
definition. This definition applies
only to this Advanced rate, and
cannot be used for other rates.
Call Direction Check the applicable call direction
to be selected.
Call Duration Click to select the minimum
and/or maximum time for call
duration. When a check box is
selected, complete the time value
in numbers for the corresponding
field.
Dialed Numbers Type the specific dialed numbers
to be included and click to
enter the number. To delete an
error, or delete an already existing
number, highlight the number and
click .
3. Click Update to save the new or edited Advanced Rate.

Administration Guide EM_ Ver 10 20


2.2.9 Collection
Use the Collection tab to configure data sources, collectors, rating and routing as simply
as possible.

2.2.10 Add a Data Source

To add a data source:


1. Click the Collection tab.
2. To add a data source, click in the top row or click New in the Collection
toolbar.
To modify a data source, double-click the row or click Edit in the Collection
toolbar.

3. Complete the following fields:

Option Description

New Data Select this option to use a new data source.


Source

Existing Data Select this option to use an existing data source. Select
Source the data source from the list.

Administration Guide EM_ Ver 10 21


National Select a National Location table. To add a new *.TDA
Location Table file, click Add.
PBX Vendor Select a vendor.
PBX Type Based on the vendor, select the switch from which the
configuration file is retrieved.
If you select Siemens OSV, click the SIP EndPoints
Settings link to configure those settings.
Collection Select the collection type.
Type
Collection Define the parameters based on the collection type:
Type
Parameters

2.2.11 Collection Toolbar

To use the Collection toolbar:


Option Description

New Click this option to define a new data source.


Edit Click this option to edit an existing data source.
Delete Click this option to delete an existing collector.
Collector
Delete Data Click this option to delete an existing data source.
Source
Run Click this option to collect calls from the data source.
Collection
Show Click this option to view the top 200 calls that will be
Collection collected from the data source. You can determine if the
Information collector was defined accurately in regards to costing and
routing.
 Click Collection Log to view the collection log
for errors.
 Click Delete Collected Data, to clear the call
data.
 Click Close to exit the window.

Administration Guide EM_ Ver 10 22


The following information is displayed:
Section Description
Statistics Shows call statistics. The system
updates the statistics information every
5 seconds.
Calls The amount of calls
Collected collected.
Calls The amount of calls
Rejected rejected.
Raw Shows the first 200 rows of collection
Data raw data (from the file).
Collected Shows the first 200 calls after process
Calls and insertion.
Start Call The start time of the
call.
Device The device used to
Name make the call.
Call Type The type of call.
Dialed The number dialed to
Number place the call.
Duration The call's duration.
Cost The cost of the call.
Location The dialed- number
location based on the
routing.
Trunk The trunk group the
call originated from.

Administration Guide EM_ Ver 10 23


2.3 Patches Installation

1. Copy over the patches fix.zip from the installation disks to the Program
Files\NEC\EM\Patches folder.

2. Run C:\Program Files\ NEC\EM\Utils\Utilities.Management.exe. The


Management Utility window is displayed:

3. Select the System tab. The System tab is displayed:


4. To install patches, click Run. It is.
5. In case there are problems with installing patches:

a. Investigate the Patcher.Log file under MASLogs directory. If you cannot


figure out the problem, send the log to MTS Support or consult them over the
phone.

Administration Guide EM_ Ver 10 24


2.4 Install Language Pack Only

The following steps are taken to install the language pack as a separate action from the
total installation.
1. Open the Process Synchronization Manager:

2. Browse to find the language csv file required:

Administration Guide EM_ Ver 10 25


3. Open the file:

Administration Guide EM_ Ver 10 26


4. The file is imported into the application:

Administration Guide EM_ Ver 10 27


2.5 Language Settings
The Application Suite enables the user to see the application UI in any language installed in the
system. At this stage a user can work in English or German.
A Part of the User definition is the language he will see in the application UI.
1. The user’s language is the first priority: if the user has a language defined, the application UI
will be in the user’s defined language.
2. If the user doesn’t have any language defined then:
- If System Settings\General Settings – USE IE Language=1:
 The application UI will be displayed in the client’s Internet Explorer
default language-only if this language was installed as the application
language pack.
 If the client’s Internet Explorer language was not installed as The
application language pack– the application UI will be displayed in the
language of the last application language pack that was installed.
- If System Settings - USE IE Language=0: The application UI will be displayed in the
language of the last The application language pack that was installed.

Administration Guide EM_ Ver 10 28


3 Administration Tools
3.1 Management Utility

The Management Utility window has a set of tools created for individuals with System
Administrator access. To access the Management Utilities window go to Start – All
Programs – MTS – Management.

3.1.1 Backup/ Restore

This allows restoring from backup files, do backup of Partial Database and restore
Partial Database.
5. To restore the database, in the Backup file field, click and select the backup
folder containing the backup files set.
6. In the Default path for archive files field, click and select a folder where you
want the archive database files to be restored.

Administration Guide EM_ Ver 10 29


7. Click Restore Data to continue.

8. Partial Database backup and restore is for advance use of MTS support team.

3.1.2 System

9. To disable the IIS Cache memory, check the box next to the function.
10. Click Apply to set the virtual directory for the web with the new settings.
11. To recreate the virtual directory to be in the same state as it was following the
initial installation, click Recreate Virtual Directory.
12. Click Delete Duplicate Calls to delete duplicated calls, based on revision of call
parameters.
13. To unlock all blocked users after 3 attempted logins, click Unlock administrator.
14. To install patches, click Run.

Administration Guide EM_ Ver 10 30


3.1.3 Clean DB

In this section you can delete various items from the database. Use extreme
cautious when using this function. It is irreversible! There is no Undo!

15. Click on the Clean DB tab. The Clean DB tab is displayed:

16. Select from the dropdown list the option you want to use for deleting information.
Click Clean to clean the selected information.

Note Information can include calls costing, organizational hierarchy


information and personnel data.

Administration Guide EM_ Ver 10 31


3.1.3 Vlist Convert

This tool is used to convert rate table in TDA file format to XML format before
loading the rates to a system that is using the old rate mechanism.

1. Click on the Vlist Convert tab. The Vlist Convert tab is displayed:

2. Click Prepare Vlist (after completing steps 14 and 15) to convert selected data
files.

3. Click in the Source vlist File (TDA or XML) field to enter the .tda file
accessed from the PBX in order to convert to The application format.

Administration Guide EM_ Ver 10 32


4. Click in the Target XML File field to enter a selected .xml file if converting
data from previous TABS versions or fill out a name of the file you want to be
created.

5. Deselect the Default ANSI encoding option in order to select the encoding of the
source file, e.g. for German or Hebrew. Otherwise, leave selected for default
options. This should be equal to the format of the input vlist file as when it was
saved.

6. Select Output Tabs7 format files to c:\tmp to debug the conversion files.

Field Name Explanation Values


Service Name Group Name to which Cost Plan Alphanumeric
will belong
DateFormat Not relevant E=English
IsSpecialPrefixFlag Not relevant F,T
LocationLength Maximum length of location Numeric, 32
name for prefix
NumberOf HolLines Number of lines present in vlists 1-12
in discount section that relates to
Holidays
BaseUnitCoefficient Multiplier value for basic rating 1-99
segment
IsCheckMinimumDigit Activate minimum digit check False,True
IsCostFromPBX Receive the cost from PBX or False,True
from Cost Plan
OverallAdjust Add on Percentage 0-99
ServiceCostType Costing Mechanism Duration, Pulse

7. In the Parameters table complete values for any required parameters - You have
to enter the Service Name, and click Save Parameters to save or click Restore
Parameters to revert back to the original settings.

8. In the Parameter grid you have to enter the Service Name

Administration Guide EM_ Ver 10 33


3.1.4 Printers

This tool enables selecting a printer for the application to use.

1. Click on the Printers tab. The Printers tab is displayed:

2. Select a network printer which will be used for output from The application, e.g.,
Reports, and click Apply.

Administration Guide EM_ Ver 10 34


3.1.5 Log Settings
Every operation is being logged in a particular log file that helps MTS technicians
troubleshoot problem and errors occurring in the system.
This tools enables MTS technicians to modify the level of Logging the system is doing
for the various operations.

3. Click on the Logs Settings, the Log Setting tab is displayed.

The list of all log files is displayed and you can set their size and trace level.
Select the required trace level:
Errors, Warning, Info or Debug
You can Edit the Maximal File size (in Mb), define the number of days to keep the file,
and check the box to have continues log file as oppose to daily file.

Administration Guide EM_ Ver 10 35


Note After changing specific log trace level to a different level than the original mode
and getting the expected results from the log, you have to change the trace mode
back to info.

Administration Guide EM_ Ver 10 36


4 Appendix A – Distributed Installation
It is highly recommended to review the Distributed Installation – IT Requirement
document to fully understand what is required from IT of the organization in this type of
environment.

Note: For Minimum Hardware and Software Requirements see Appendix D

Install the SQL software on the SQL Server (Computer B) according to the
installation instructions in section 3.1.

The RemoteSQL.exe must be installed on the SQL Server before the Application Suite is
installed on the Application Suite Server.
Following are step by step instructions for the installation of the distributed installation
component:

1. Copy Distributed Folder from the installation media to the SQL server and run
Setup.exe. The Choose Setup Language dialog box opens:

2. Open the combo box to select the installation language. Click OK. The
InstallShield Wizard window opens:

Administration Guide EM_ Ver 10 37


Wait while the InstallShield Wizard is being prepared. The Welcome window
opens:

3. Click Next. The Customer Information window opens:

Administration Guide EM_ Ver 10 38


4. Type in your User Name and Company Name.
The Anyone who uses this computer (all users) radio button is selected by
default. It is possible to change it by selecting Only for me.
Click Next, The Choose Destination Location window opens:

Administration Guide EM_ Ver 10 39


The Wizard displays the Destination Folder. Click Browse to choose a different
folder. Click Next. The SQL Server Instance window opens:

5. If the user used the default instance on the SQL server the Instance field should
be left blank. Otherwise type in the instance name entered during SQL
installation. Click Next. The Start Copying Files window opens:

6. Click Next. Setup is copying program files:

Administration Guide EM_ Ver 10 40


Remote SQL Configuration is complete. It is now possible to begin the Application
Suite installation on the Application Suite Server. See Section 2.1.

Note: the set up adds the registry for backup and saves database template to improve the
installation performance.

Administration Guide EM_ Ver 10 41


5 Appendix B – Uninstall
5.1 Uninstall

Before beginning the uninstall process please reboot the system.

 Language Pack
 Main
 SQL Express (For light versions only)
 Manuel Actions
Note Uninstall
After uninstall please make sure that the following folders were deleted:
 Web folder: C:\Inetpub\wwwroot\AppUI
 Applications folder: C:\Program Files\TABS
Restart the server.

5.2 Manual Actions

1. Navigate to the installation folder: C:\Program Files\NEC\EM Remove it.

Administration Guide EM_ Ver 10 42


6 Appendix C - Organization Import Guide
6.1 Introduction

Imports are an essential part of the application. It is very important that data from other
systems can be used to Import Personnel and their resources and administration structure
from another Management Application, rather than having to be entered manually into
the application. The imports detailed below allow the administrator to import data from a
variety of other systems.

6.2 Generic Personnel Import

The Generic Personnel Import is a tool that allows users to import personnel information
from other applications. The import saves a great deal of time and effort, since the users
do not have to individually enter the personnel data into the application.
The task is added as an additional component in the Maintenance\Task Manager, as an
additional task of the Import\Export.

1. Select Maintenance > Task Manager > Imports>Organization.


The Generic Personnel Import Job wizard will appear. Give a meaningful name
to the job and select the Hierarchy (Administrative Cost center Mailing list you
want to import this information to.

Administration Guide EM_ Ver 10 43


2. The required Data Source, Full Update (in order to overwrite the existing info
for this site) and leave Base Org Unit empty in case the information will be
added to the highest available level. If you would like to add the info to a specific
level in the tree, select the Base Org Unit.

Note: When Full Update is checked, extensions that were previously imported
through Personnel Import but are not available anymore in the import file will be
deleted from the Organization Tree.

3. Select the Input tab and browse to select the file you wish to import:

Local Select the input file from TABS\Run Time\Input File. This
option will look for any file that has the string
‘genericimport.txt as part of its name.
Upload Copies the file from the location to TABS\Run Time\Input File
On FTP Fill out FTP details
Full Path Locates the file on the local server
Encoding Enter the Encoding Type of the input file (scroll down the Input
tab to reveal the selection).

Administration Guide EM_ Ver 10 44


4. Select the Fields tab and fill out the appropriate information for Start at row; the
Field Delimiter that is used in the file, and the OU Path Delimiter.

5. A list of fields will appear. Using the Control key for ‘pick and choose’ or the
Shift key for ranges, select the fields that exist in each record in the file. Select
them in the order as they appear in the row of the text file.

6. Click to move them to the list of selected fields


7. For each field you need to define its position in the record. You begin counting
from the first field as index 1 in input row and each field after next delimited is
assigned the appropriate number. Using the Ctrl key when selecting the fields will
save them in the order they were ‘picked’. That is why it is recommended to pick
them one by one using the Ctrl key.
8. When done click Finish or Next and save the Job. The Job is now available to
Run from the Scheduled Jobs list
9. To run the Job, select it from the list and click on the Run job now icon
10. Confirm that the job has finished running by selecting Maintenance / Monitor /
System Log and look for the message Job has been finished successfully
11. After the job is completed, check to see that all the required information was
imported.

Fields

Administration Guide EM_ Ver 10 45


Below is an outline of the fields that can automatically be populated. The data being
imported must be provided in a single file:
 Excel single worksheet (not a workbook, it must be saved as .CSV)
 ASCII comma or pipe delimited file (check with your switch vendor if file can be
generated from the PBX)
 Each Person in the organization should have one line per Device or more devices
(see the example below).

Field Name (*) (**) Type Field Requirement/Explanation


Field
Length
Device Name 20 A/N Mandatory when doing a Device Import,
otherwise optional
Device Type 3 A/N EXT-Extension; PIN-Pin Code;CC-
Calling Card; CEL-Mobile Mandatory
Data Source 50 A/N Mandatory
Site 256 A/N Optional, a default site will be created if
this field is not filled
Person Identity 255 A/N Mandatory when doing a Person Import,
unless Person Email Address or First
Name and Last Name (First Last name
or Last First Name) and OU Path are
specified. Mandatory when doing a User
Import unless another person identifier is
specified. Otherwise optional
First Name 50 A/N Mandatory when doing a Person Import,
unless Person Email Address or Person
Identity and OU Path are specified.
Otherwise optional
Last Name 50 A/N Mandatory when doing a Person Import,
unless Person Email Address or Person
Identity and OU Path are specified.
Otherwise optional
Personal Status 255 A/N Optional
Phone Number 50 A/N Optional
OU Path 1000 A/N Mandatory when doing a Person Import
and an Org Unit Import unless Sub OU
Path is specified. Otherwise optional

Administration Guide EM_ Ver 10 46


Field Name (*) (**) Type Field Requirement/Explanation
Field
Length
Sub OU Path 1000 A/N Mandatory when doing an Org Unit
Import unless OU Path is specified.
Otherwise optional.
OU Name 256 A/N OU Level Optional
Initial 5 A/N Optional
Salutation 20 A/N Optional
Title 20 A/N Optional
Job Title 20 A/N Optional
Address 150 A/N Optional
E-mail Address 50 A/N Preferred
Location 50 A/N Optional
Building 50 A/N Optional
Floor 50 A/N Optional
Room 50 A/N Optional
Info 1 100 A/N Optional
Info 2 100 A/N Optional
First, Last name 100 A/N Mandatory when doing a Person Import,
unless Person Email Address OR Person
Identity and OU Path are specified.
Otherwise optional
Last, First name 100 A/N Mandatory when doing a Person Import,
unless Person Email Address OR Person
Identity and OU Path are specified.
Otherwise optional
VIP 1 Use Y or Optional. This is also a privacy
N designation. If you select Yes to
designate this extension as a VIP
extension, the associated call details are
omitted on detailed reports; only the call
cost and price are displayed. The system
default is No.
User Name 20 A/N Mandatory when doing a User Import.

Administration Guide EM_ Ver 10 47


Field Name (*) (**) Type Field Requirement/Explanation
Field
Length
Otherwise optional
User Password 30 A/N Mandatory when doing a User Import.
Otherwise optional. User password
existence depends on the authentication
mode (AS/Windows/Network)
User Role 50 A/N Optional
User Language 8 Optional
Start Date 8 Datetime Optional
Termination 50 A/N Optional
Date
Device Cost 50 A/N Optional
Plan
Device Price 50 A/N Optional
Plan
Device COS 255 A/N Optional
Device A/N Optional
Function 255
Device Status 255 A/N Optional
Device A/N Optional
Comments 255
Boolean ( Optional
1,0,true,fal
Device Primary 1 or 0 se,t,f)
Boolean ( Optional
1,0,true,fal
Device Publish 1 or 0 se,t,f)
Device Info 1 100 A/N Optional
Device Info 2 100 A/N Optional
Device Info 3 100 A/N Optional

Administration Guide EM_ Ver 10 48


Field Name (*) (**) Type Field Requirement/Explanation
Field
Length
Device Info 4 100 A/N Optional
Device Info 5 100 A/N Optional
Device Info 6 100 A/N Optional
Device Info 7 100 A/N Optional
Device Info 8 100 A/N Optional
Device Info 9 100 A/N Optional
Device Info 10 100 A/N Optional
OU Description 50 A/N Optional
OU Contact 50 A/N Optional
Person
OU Telephone 50 A/N Optional
No
OU Fax 50 A/N Optional
Number
OU Address 50 A/N Optional
OU Email 50 A/N Optional
Address
OU Info 1 100 A/N Optional
OU Info 2 100 A/N Optional
OU Info 3 100 A/N Optional
OU Info 4 100 A/N Optional
Device Cost 8 Date time Optional
Plan Start Date
Device Price 8 Date time Optional
Plan Start Date
Pin Code BP 1 Optional
Status

Administration Guide EM_ Ver 10 49


Field Name (*) (**) Type Field Requirement/Explanation
Field
Length
Extension First A/N Optional
Name 50
Extension Last 50 A/N Optional
Name
Extension 50 A/N Optional
EMail
Extension A/N Optional
Location 50
Extension A/N Optional
Building 50
Extension A/N Optional
Room 50
50 A/N Optional
Extension Floor
Middle Name 50 A/N Optional

(*) The field lengths listed above is the maximum lengths allowed for each field. You
may have fewer characters in each field if you choose.
(**) A/N = Alpha Numeric

Sample data line


796,Coral-PBX,SF-Site,John,Smith,SFCA\Products\Support,john.smith@into.com,EXT 052-
2211045,Cell-File,SF -Site,Rachel, Lord,SFCA\Products\PM,rachel.lord@into.com,CEL

Device Data First Last OU Path Device Type


Source Name Name
796 NEC John Smith SF- EXT
PBX CA\products\suppor
t
052- Cell-File Rachel Lord SF-CA CEL
2211044 \Products\PM

Administration Guide EM_ Ver 10 50


For minimum information the following is required: Employee ID (optional), First Name,
Last Name, Device, Device Type (extension, PIN Code, mobile, pager, etc.), Site, Data
Source, E-mail address(optional), Organization Unit (OU) path.

The employee ID and or E-mail address will later be used as a unique key to enable the
user to make changes to the Personnel information in the organization. One of them must
be available in order to keep history information of OU change, name change and any
additional Personnel information that one may need to add at a later stage.

Generic Import Format Support


Generic Import supports UTF8, UTF7, Unicode and ASCII files (GI).
In Generic Personnel Import, the Input tab contains the Encoding selection. The selection
default value is Unicode and it must match the file encoding value.

To find out the file encoding format, open the file in Notepad. Click Save As and look in
the Encoding field at the bottom of the window. Use this encoding format to decode the
file.
For example: If the Import File as saved as Unicode – the Generic Personnel Import
should be defined with Unicode encoding. If the import file was saved as ANSI – the
Generic Personnel Import should be defined with UTF7 encoding.

6.3 MA4000 Import


NEC Installation Wizard

Administration Guide EM_ Ver 10 51


Administration Guide EM_ Ver 10 52
Administration Guide EM_ Ver 10 53
Administration Guide EM_ Ver 10 54
Administration Guide EM_ Ver 10 55
Administration Guide EM_ Ver 10 56
NEC Special Settings
In System Settings there is a Group of settings for NEC.

The following parameters have to be set and updated:


MA 4000 Database Instance
MA 4000 Database Name
MA 4000 Database User Name
MA 4000 Database Password
NEC CAS URL

Administration Guide EM_ Ver 10 57


Administration Guide EM_ Ver 10 58
7 Appendix D: Minimum Technical Specifications
Application Suite Environment 9.8 and Newer

7.1 System Requirements

Below are the minimum web server requirements that are needed to run Application Suite
server for a small site. MTS recommends deploying new systems using the highest
performing server that you can reasonably afford to ensure optimum performance and
longevity.
Please refer to the Application Suite Installation Guide for a list of minimum
requirements for Application Suite web clients.

Minimum Application/Database Server Requirements

• Pentium Intel Core 2.8GHz or higher (Hyper Threading = disabled)


• 6GB RAM
• Recommended Redundant Storage (RAID 1 or RAID 5 HD Array)
• Minimum of 150 GB disk space (see database sizing criteria for actual
database storage sizing)
• 1 Network Card configured to support TCP/IP
• Print Spooler – Status = Running

Recommended Configurations Sizing

Note: Based on 5 years of data in the database and 2 backups stored on the server:

Calls/Year 200,000 500 ,000 1M 3M 5M 10M >10000


RAM (GB) 4 4 4 4 4 8 Project
CPU (Ghz) 2.8 3.0 3.2 3.2 3.2 3.4 Project
Disk space 150 250 300 350 350 500 Project
(GB)
Disk for Data Recommend Required Required Required Required Required Required
only
Distributed Recommend Recommend Required Required
**
Environment
(DB & App
Servers)

** Distributed – Two (2) server architecture where the Application is on one server and
the Database is on a different server. This setup is used in Enterprise type
installations. It is very efficient when handling very big databases.

Administration Guide EM_ Ver 10 59


7.2 General Software Requirements

Feature Edition Note


Operating System Light Windows 2008 Server with latest service packs available (32
bit & 64 bit), Windows Server 2012, Windows 7, Windows 8.
Enterprise Windows 2008 Server with latest service packs available (32
bit & 64 bit), Windows Server 2012, Windows 7, Windows 8.
Database Light Express SQL 2008 (R2) **,
(See Express DB Note) Express SQL 2012

Enterprise SQL 2005 SP2 (all editions), SQL 2008 (all editions), SQL 2012
Microsoft Message When using distribution type installation, MSMQ should be
Queuing (MSMQ) installed only on the Application server
IIS Windows 7 – Ver 6.1 or higher
Windows 8
Windows Server 2008 – Ver. 7.0 or higher
Windows Server 2012
Adobe Acrobat Reader* 7 or above
Note: *PDF Reader must be installed in order to print reports from preview
**SQL Express Server for Light Editions will be provided by MTS
Application Suite also can be supported on a VM Server.

SQL Express DB Note:

SQL – License Guidance:


Installations which have up to 5000 devices, or up to 1,000,000 calls per month, can
use the MS-SQL Express which is free of cost. Otherwise, for larger installations it is
recommended to use MS-SQL server and pay by Processor.
Scalability & Hardware Support:
From the Microsoft Datasheet, SQL Express Edition:
• Supports up to 1 CPU, but can be installed on any server
• 1 GB Addressable RAM
• 10 GB Maximum Database Size

Note: When using SQL Express Edition, Application Suite can


function on any size of system.

Express Edition uses only 1GB of ram and 1 CPU, which does affect the performance
of Application Suite to some extent. In cases where the system is very high end and
where the volume of calls per day is higher than 1,000,000 calls per month, it is not
recommended to use a SQL Express database.

Administration Guide EM_ Ver 10 60


Note: Any other process in Application Suite uses the full number of
CPUs of the system.

7.3 Web Browsers

Below are the web browser versions that are compatible with Application Suite 9.9 and
above:
Application Min Version Max Version
Microsoft Internet Explorer 8.0 SP2 9.0
Notes:
IE8 - Internet Explorer Settings:
Uncheck Show friendly HTTP error messages

Administration Guide EM_ Ver 10 61


8 Appendix E – General Settings
The General Settings contains a list of settings which are centrally defined and affect the
behavior of the system. Those settings reside in the Maintenance Module under the
System Settings tree.

System Settings - General Settings


Setting Description Default Value
Add the Data Source Name Will add the Data Source name to any 0 (=No)
to Device Names? device in the UI.
Add the Data Source Name Will add the Data Source name to any 1 (=Yes)
to Trunk Names? trunk in the UI.
Added Data Source Character used to separate between Data .
Delimiter Character Source and Device\Trunk name
Alert Notification Interval Frequency of Alert verification and 600
(sec) highlighting it on the screen
Alert Notification Who is allowed to see the Alert button? Everyone
Permission
Alert Severity Indication Which level of alerts should be sent Low
for Subscription (minimum level) in the email
Notification
Alert Severity Indication Which level of alerts should be shown Critical
for UI (minimum level) in the application
Allow Publish Reports Enables the option to publish a user 0
defined report to all users
Archive Default Folder The Default folder for the Archive
Browser Title This will be the Name of the Application Application Suite
in the UI
Calls Monitor Auto- The refresh time of the ‘Calls Monitor’ 20 sec.
Refresh Timeout (sec) Viewer.
CDR Backup Root Folder Path to store Rawdata and Parser log. Path C\Program
may change for various vendors. Files\TABS\CDR
_Backup
CDR Private Setting If True True
Overrules Pins  And PIN = Business and CDR =
Business  Call=Business
 And PIN = Business and CDR =
Private  Call = Private
 And PIN = Private and CDR = Private
 Call = Private
 And PIN = Private and CDR =
Business  Call = Private

If False
 And PIN = Business and CDR =
Business  Call=Business
 And PIN = Business and CDR =
Private Call = Business
 And PIN = Private and CDR = Private

Administration Guide EM_ Ver 10 62


Setting Description Default Value
 Call = Private
 And PIN = Private and CDR =
Business  Call = Private
Characters Allowed When Allowed characters to be used for A-Z, a-z
Adding/Editing extensions extensions
Characters To Allow When Allowed characters to be used for pin
Adding/Editing a Pin Code codes
Characters To Allow When Allowed characters to be used for trunks A-Z, a-z
Adding/Editing a trunk
Collector retry attempts When the data collector fails, this value
specifies the number of additional
attempts for accessing the data collector
source
Collector retry interval The period between attempts to access the
(minutes) data collector source
Company Link Display a hyperlink of the web address in
the About window
Contact Email Display a hyperlink of the email address
in the About window
Contact Phone Displays the Support source telephone
number in the About window
Copyright Text A string that is displayed at the ® Copyright
bottom/center of the all UI screens 2004, MTS
Create New Devices An indication whether to create new 1
Automatically extensions when arriving from a CDR
during collection. When set to Zero (=No)
the system will save calls of new devices
(devices not yet in the database) in the
Rejected Calls tables for a reason of
Missing Device.
Create Non Existing An indication whether to create new 1
Account Codes Account Codes when arriving from a
Automatically CDR during collection.
Create Non Existing PIN An indication whether to create new PIN 1
Codes Automatically codes when arriving from a CDR during
collection. When set to Zero (=No) the
system will save calls of new Pin Codes
(pin codes not yet in the database) in the
Rejected Calls tables for a reason of
Missing Pin Code.
Date For New Assignment A date which will be used as default for 20000101
(YYYYMMDD) the “Start Date” of a new Assignment. To
be used when importing data from the
‘past’.
Days to keep Parser log How many days to keep the log of the 30
parser.
Default call type Used for calls that have no business or Business
personal information
Default Encoding Default Import file type encoding Default

Administration Guide EM_ Ver 10 63


Setting Description Default Value
Default Filter for Person Default Search by criteria for Person First Name
Assignment Assignment module in Org Utilities
Default Pin Code State Business or Private B
Default Tariff type Duration or Units Duration
Determines if we use today Overrides the “Date for New Assignment” 0
as the assignment Date and uses today’s date. Use when starting a
new system with calls from today forward
only. No past data.
Enable Special Location Enable the option to use a special location 0
Table in Rating table (list of special numbers) to be used
in the Rating Module to allow taking
priority over regular location table and
allowing special rates for this list.
Exports use reports Use precision settings for Reports (True) True
precision or Db precision settings (False)
Generate System Health Defines when to send a System Health Always
report report (if scheduled): Always or Only on
Alert
GI: Delete Import File Determines if to delete a Generic Import 0
After Processing file after it process it. Used when updating
organization on a recurring basis from
external source.
Import Tie Line Calls System will ignore calls on Trunks or 0
Trunk Groups that are defined of type Tie
Lines.
Import Virtual Extension Determine if to import Extensions of type False
Virtual from MA4000
Leading Zeros in Generic Zeros will be added before a cost or price 0
Calls Export to complete the number to the full length.
Mask Settings Changed Displays if masking settings were 0
changed by the user
Max Calls in Calls Viewer The maximum amount of calls to be 200
displayed in the Call Viewer.
Max Display Scope Objects The maximum number of scope objects to 10
in Reports display in a report.
Max Level in Personnel The maximum number of levels allowed 6
Tree in the personnel tree.
Max Print Records The maximum amount of calls to be 1000
displayed when printing the display of call
viewer of online monitor.
Max number of login Defines the number of login attempts 3
attempts before the system locks and one cannot
enter the system
Minimal Length of Defines the minimum characters required 6
password in a password
Months to keep CDR How many months should the CDR 0
backup file backup file be kept.
0 (zero) – Keep indefinitely.
No. of digits after the Number of digits after the decimal to be 5

Administration Guide EM_ Ver 10 64


Setting Description Default Value
decimal for DB saved in the database.
No. of digits after the Number of digits after the decimal to be 2
decimal for reports saved in the Reports.
Path for Create Output files Path for files created via Generic Export 'Program
Call and Generic Export Call Summaries. Files'\HiPath
AM2\RunTime\O
utputFiles
Path for search input files The default Path for searching the input 'Program
files. Files'\HiPath
AM2\
RunTime\InputFil
es
Rate 0 duration calls Indicate if to process Rating for zero 1
duration calls.
Report Customer Logo Path Path for the image file of the company
logo that will be used in Reports.
Reports Private Footer A string that is displayed on the bottom Report Private
center of the last page of each report. Footer
Search bar open Determine the Default mode of the Search 1
bar in Org Utilities
Show Additional Fields in Enable controlling the Additional Fields 0
System Settings Tree feature from the UI.
Show Confirmation of OU When enabled, deleting the 0
Child Delete Organizational unit will display additional
message relating to moving the child one
level up or deleting them
Show Descendants in Tree Define the default mode of the Show 1
descendant in the Tree, 1= the default is
Show all, 0= the default is do not show
all.
Show full path in reports Show the full path of an entity in the 0
report.
Show QoS Reports Show the Quality of Service Reports in 0
the Report tree
SMTP Account Size Limit Defines the maximum size allowed for 1
attachment (a report) in emails. A report
file that is larger than this value (in MB)
will not be emailed out and result an error
message.
SMTP mail account Account name that will be the sender of Administrator@te
Emails from the application – this will be st.com
displayed in the “From’ field of the email
SMTP password A password needed by the SMTP mail
server
SMTP server name/address Mail Server address
SMTP server port TCP/IP port used to send emails. 25
SMTP server requires If 1 (true) this flag indicates that the 1
UserName/Password SMTP server requires a username and
password for operating

Administration Guide EM_ Ver 10 65


Setting Description Default Value
SMTP User Name A username needed by the SMTP mail Username
server
SQL Server Name The name of the SQL server instance that
is used by the system.
Stop inserting till costing Stop Insertion of calls while the Costing 1
refresh running Refresh Job is running.
Symbols To Allow When Allows the determined symbols to be used
Adding/Editing a Pin Code for pin codes
Symbols To Allow When Allows the determined symbols to be used
Adding/Editing a trunk for trunks
Symbols To Allow When Allows the determined symbols to be used \x5B\x5D\X2D_\!
Adding/Editing an for extensions #$;?@\\/~
extension
Unblock User Timeout The number of Minutes to wait before 5
(minutes) automatically unblock the blocked user
Unique Extension names If 1 (true): in a case that an extension 0
number that is defined for a specific data
source, if a collected call has the same
extension number but a different data
source - the call will be inserted to ‘Calls’
table as if it was collected with the already
defined data source, instead of the one
that is in the CDR. A new extension with
the collected data source will not be
defined.
Unique PIN Codes If 1 (true) :The same as for unique 1
extension
Use Active Directory Use Active Directory Protocol for LDAP 0
Protocol for LDAP Imports Imports
Use Basic Rating 1 - Use the New Rating mode. 0 – Use old 1
Rating UI
Use Device Centric Mode True = Extensions will be the main False
Entities and not Person. Extensions will
be assigned to Org Units directly.
Personnel are required only for system
users.
Use IE Language Use the Internet Explorer regional settings 0
for the web application
Use Shrink Database Shrinking database will be part of the True
Application Maintenance jobs
Welcome message A message at the top right corner of the Welcome,{0}
UI screen. The value should be: [string]
{0}. {0} Is the full name of the logged in
user.

Administration Guide EM_ Ver 10 66

You might also like