acp manual(r3.02) · a. when selected, it stops the application server before taking the database...
TRANSCRIPT
ACP Manual(R3.02)
Revision History
Initiation date 04102014
Document Number 20140902000001
Current Draft v1.4.0
Modification Date 04102014
Revision by Garima Gautam
Confidential Page 1 SOW-AMEYO-v1.4.0-20140902000001
Table of Content 1. ACP
2. ACP Login
3. ACP Features
3.1. Reports
3.1.1. Ameyo Reports
3.1.2 Ameyo Reports Configuration
3.2. System Administration
3.2.1. Monitoring
3.3. IT Administration
3.3.1. Manage Backup
3.3.2. Manage Database
3.3.3. Manage Voicelog
3.3.4. Start Stop
3.3.5. VoIP Packet Capturing
3.4. System
3.4.1. Home
3.4.1. About ACP
3.4.1. Logout
Confidential Page 2 SOW-AMEYO-v1.4.0-20140902000001
1. ACP ACP stands for Ameyo Control Panel. It is a web based tool for managing, monitoring and
controlling the Ameyo Application.
ACP allows remote management of the Ameyo System. And can be used by remote users to
fetch the reports, manage voice logs, manage database. It also allows the user to monitor the
health of the system, capture and download debug logs.
ACP also allows the user to manage the various components and services on the system. All the
features are available to the users as User Friendly GUI.
2. ACP Login User can login to the ACP with the same username and password as created on the Ameyo
System by their Administrator.
The modules accessible to the users are based on the privileges assigned to the particular user in
the Ameyo System The Admin user can control the user access by user management module.
The user login can be categorized as:
1. Admin login
2. User Login
By default user can login to the ACP as admin and the default password would be admin
Confidential Page 3 SOW-AMEYO-v1.4.0-20140902000001
3. ACP Features Following are the main features of ACP available for users.
3.1. Reports
3.1.1. Ameyo Reports
Ameyo to come preintegrated with Ameyo Reports module, it will allow the users to
generate businessoriented comprehensive reports relative to process performance,
campaign productivity, call details, and call history, user session, workforce and system.
Confidential Page 4 SOW-AMEYO-v1.4.0-20140902000001
3.1.2 Ameyo Reports Configuration
Confidential Page 5 SOW-AMEYO-v1.4.0-20140902000001
3.2. System Administration The options available shall be used by Drishti support.
3.2.1. Monitoring
Under monitoring tab, Status of various application services like hard disk, CTU, Ameyo services,
Database, asterisk, Djinn services. Alert for critical services & warnings. Critical Alerts can be send by
email also.
Confidential Page 6 SOW-AMEYO-v1.4.0-20140902000001
3.2.2. User Management
Confidential Page 7 SOW-AMEYO-v1.4.0-20140902000001
Edit Privilege:
Under this user any user’s privilege for using the modules can be assigned. For assigning the Module’s
privilege for the selected user below steps need to be followed:
1. Under “System Administration” tab on the top, click on User Management.
2. Select User from the “Username” drop down field.
3. Click on “Edit Privilege” button.
4. Privileges can simply drag and dropped for the respective modules.
Sync Users:
Under this option all the users created under Ameyo would be synchronized in ACP. All the details as
defined under Ameyo would get applied in ACP as well post synchronizing users.
Confidential Page 8 SOW-AMEYO-v1.4.0-20140902000001
3.3. IT Administration
3.3.1. Manage Backup
The option will be used to manage the backups that have been taken earlier. Under this
option the backups taken earlier will be shown in the list view as shown in Figure. The
“Download” & “Delete” buttons will be provided against each of the record.
3.3.2. Manage Database
Database is software by which we can store the useful data in appropriate manner as well as it gives us a power to get that information in useful and in proper amount. This can be done via creating tables and columns and defining primary and secondary key within the database. Ex : call_history , process_exclusion etc. As you know our product is itself called Contact Center Solution and the data or information in proper and appropriate manner is very useful in contact center. In database generally we save all the customer specific data like telephone number,address,age,and other process related useful information. So it's necessary to manage the database properly and well as maintain for the sake of data integrity and security as well as speeding up the fetching of reports or other data from the database. So below mention tasks are like medicines for database.
Under Manage Database, the following 5 options will be available as shown in Figure –
Confidential Page 9 SOW-AMEYO-v1.4.0-20140902000001
3.3.2A: 1. Backup 2. Restore 3. Cleanup 4. Vacuum 5. Schedule
Backup:
DB Backup refers to storing the database in form of a .sql extension similar to making a copy of the snap
as shown in Figure – 3.3.2B
Confidential Page 10 SOW-AMEYO-v1.4.0-20140902000001
Following Steps to be followed for executing the DB Backup process
1. Select Backup TYPE
2. Select database for backup from list
Available Options:
1. Stop the server:
a. When selected, it stops the application server before taking the database backup. Server
needs to be restarted manually.
b. Backup History Tables.
2. When selected, backup history tables will be included in DB backup else it skips history tables
and takes backup of rest of the tables.
a. List of history tables
3. Analyze DB before backup:
a. When selected, Analyzes database before taking backup. Keeps metainfo of the
database and compares it with restored database metainfo when restored using ACP.
b. When selected, it will take more time to take backup, but restoration comparison will be
precise.
4. Click backup button and backup will be taken.
Confidential Page 11 SOW-AMEYO-v1.4.0-20140902000001
Restore:
This option is used to restore the database through its replica .sql file. Following steps to be followed to
perform the DB restoration process:
1. Select the required database from the available drop down options.
2. Click on “Continue” to proceed.
3. Input the required Database Host, Database Name, Database User and backup file Name for the
database that has to be restored.
4. Select the check box in case if previous database need to be removed.
5. Click on “Restore” to proceed with restoration process.
Confidential Page 12 SOW-AMEYO-v1.4.0-20140902000001
Cleanup:
The option is used to delete the unwanted data from the database called DB Cleanup. On selecting the
“Cleanup”, the screen will display as shown in Figure – 3.3.2 e.
Following steps to be followed for performing the cleanup activity:
1. Click on link Override cleanup schedule for individual tables to override the cleanup duration of the
specific tables. Set the properties values in json form for the tables to override the cleanup time.
ex {"day":2}
2. Click on save button
3. Select date to cleanup database records older than selected date or day to cleanup database
records older than the number of days specified.
4. Select the required database.
5. Click on cleanup button
Vaccum:
This option is used for Arranging and Sequencing database indexes as well as rearranging the data for the
sake for efficiency memory utilization.
User can start the process of vacuuming & re indexing by selecting any of the available options:
1. Vacuum and Reindex
2. Vacuum
3. Reindex
Click on “Vacuum” to proceed with the vacuuming & reindexing process as shown in Figure – 3.3.2f
Confidential Page 13 SOW-AMEYO-v1.4.0-20140902000001
Schedule:
To enable the backup & schedule process via script is called Scheduling. This option is used to perform
the backup and cleanup process in a sequential manner as shown in Figure – 3.2.2g.
Database backup and cleanup process can be scheduled on Daily, weekly basis or at some specific date
& time of each month
User can select the check box for “Analyze DB” to analyze the DB before starting the backup process. It
may take some additional time but is recommended for efficient performance.
User can also stop the server during the maintenance process.
Confidential Page 14 SOW-AMEYO-v1.4.0-20140902000001
But precaution needs to be taken as some feature will lead to server stop. The centers that don’t want any
downtime, it's highly suggested to not schedule anything and same can be done either manually or with
the help of /etc/crontab.
Confidential Page 15 SOW-AMEYO-v1.4.0-20140902000001
3.3.3. Manage Voicelog
We have to perform below mention tasks for the sake of efficient use of the hard disk
space of the call server because all the voice logs were saved on the call server
The voice logs can be managed through following two options: 1. Cleanup 2. Schedule
Confidential Page 16 SOW-AMEYO-v1.4.0-20140902000001
Cleanup:
We can clean/delete the voice logs from the callserver in order to make free space for upcoming voice logs
on the callserver as shown in Figure –3.3.3A.
The voice logs can be cleaned upon the basis of following criteria:
1. Date: Voice logs older than the mention date & time
2. Days (how many days)
3. Date Range (FROM and TO)
Schedule:
All above mention tasks are performed via script called Scheduling. We can also schedule the daily,
weekly or on some specific date & time of every month as shown in Figure – 3.3.3B.
3.3.4. Start Stop
The Ameyo services and other associated services can be started or stopped through this
option by selecting the “Start” or “Stop” button as shown in Figure – 3.3.4A.
3.3.5. VoIP Packet Capturing
The SIP or SIP+ RTP packets can be captured through this option as shown in Figure –
3.3.5A. Following steps to be followed for capturing the packets:
1. Select the appropriate packet type(SIP or SIP+RTP)
2. Select the Number of packets and time when packet capturing process to be
Confidential Page 17 SOW-AMEYO-v1.4.0-20140902000001
stopped
3. Select the appropriate call server on which the capturing process need to be run
4. Click on “Start “button to initiate the capturing the process.
Confidential Page 18 SOW-AMEYO-v1.4.0-20140902000001
3.4. System
3.4.1. Home
At Home page, dashboard is displayed. Shortcuts are available for different options on the dashboard.
Confidential Page 19 SOW-AMEYO-v1.4.0-20140902000001
3.4.1. About ACP
Under this section ACP version & release details would be shown. Configuration details would also
be shown under this section.
3.4.1. Logout
Confidential Page 20 SOW-AMEYO-v1.4.0-20140902000001