Readme Version 1
2. Requirements & Prerequisites
................................................................................
9
3. Getting Started
.......................................................................................................
11
3.3 Quick Start
......................................................................................................
12 3.3.1 Setup
........................................................................................................
12
3.3.2 Configuration
............................................................................................
13
4. Reports
...................................................................................................................
29
5. Logs
........................................................................................................................
30
Appendix B: Acronyms
...............................................................................................
34
Appendix C: References
.............................................................................................
35
Page 3 of 35
1. Introduction
This document contains all essential information for the user to
make full use of the Bot. This manual includes a description of the
functions, capabilities, step-by-step procedures for setup and
configuration of the Bot.
1.1 Overview
Avaya Experience Portal health checkup bot is extremely beneficial
for the contact center domain where daily service checks like EPM
services, MPP services, telephony ports status, VoIP connection and
System monitor are typically performed manually. With the help of
this bot the entire process will be automated without any human
involvement. The bot can be scheduled to run as per business
requirement on predefined intervals which can be hourly / daily /
weekly or any desired interval and at the end of the execution a
detailed report will be sent to the respective email id as defined
by the user in a structured csv / excel format.
Detailed steps are as follows:
1) Start of the process
2) Run Meta bot logic to verify bot license whether it’s expired or
not
3) Initialize the configuration file path, read and reinitialize
all the key values and store into user created variable. Which can
be used by the bot dynamically and hence there won’t be tight
coupling or code level any dependencies.
4) Create folder structure (Bot will create folders as per bot
framework for example: - Error, logs, snapshots and output
folders)
5) Delete all the downloaded CSV files during last/previous
run
6) Copy AvayaAEPHealthCheckupReports.xlsx file from input folder to
output folder
7) Open report excel file (AvayaAEPHealthCheckupReports.xlsx) and
activate sheet name “Avaya Server Health Checklist”
8) Launch Avaya Experience Portal and login with user credential
using credential vault.
9) Go to EPM manager, MPP manager, Port distribution, VoIP
connection, System monitor options available in AAEP webpage
10) Download respective reports in the csv format such as
EPMManager.csv, MPPManager.csv, PortDistribution.csv, CMReport.csv,
SMReport.csv, MPPCPUData.csv and SMReport.csv
11) After downloading respective reports, Bot will logout from the
AAEP webpage
12) Open Putty CLI software
13) Go to logging option and set session log file as printable
output and in the csv format
Page 4 of 35
14) Again go to session and enter EPM server Ip address and click
open button to login
15) Login with root user (mandatory)
16) Write list of commands to get desired details such as system
uptime, disk space, RAM, CPU utilization, OS details, Platform
details, System version
17) Exit from the Putty CLI
18) Read stored value into user created variable, loop through all
CSV files downloaded from the AAEP. Update respective data into
AAEP report excel sheet as per filter, logic and conditions.
19) Save and close excel after updating the details. Then bot will
send an email to the configured email id with AAEP report excel
file attachment
20) End of the process
Visual Flow:
Input configuration file:-
Page 8 of 35
1.2 Common Use cases
Apart from listed EPM, MPP, telephony Ports, VoIP connection,
System monitor status and reports. Bot can also perform real time
monitoring of the EPM and MPP related alarms, trace, audit logs,
license utilization and download standard reports such as
application details, contact details, session details, application
summary, session summary, contact summary, POM campaign details,
POM campaign summary, POM agent summary, POM agent activity
details, POM callbacks status details and so on
Page 9 of 35
2. Requirements & Prerequisites
2.1 System Requirements
For the PC/Laptop or server where the bot needs to run;
RAM: 8GB or higher PROCESSOR: 2.6+ GHz Intel Core i5 or higher and
equivalent with 4 core processer
Hard Disk: Up to 32GB+ of overall free space in the AA Client
installation drive (C Drive 100 GB atleast)
Network: 1GbE
2.2 Prerequisites
Software’s needed; Avaya Experience Portal 7.2.0 with 7.2.3
patch
Avaya Provided Linux OS 6.8+ or Redhat Linux OS 6.8+
Microsoft Excel 2013 or 2016
AA Enterprise Client 11.3.x
Accounts/License needed; Avaya AEP license (WebLM License) Avaya
AEP user credential AA Enterprise client V11 License (Bot
Runner)
2.3 Security Measures There are some security best practices which
we recommend to be followed; • It is not recommended to provide
AAEP user credential access to the windows User Account executing
the Bots. Instead advisable to create credential vault feature and
provide user as a consumer of the credential vault. • It is
recommended to update/change Avaya AEP user credential every
quarter to ensure data security.
Page 10 of 35
2.4 Disclaimers
Instructions: User/Bot should use AEP user credential stored in the
credential vault only rather than hard coded, user variable or
configuration file key values.
Page 11 of 35
3. Getting Started
3.1 Skill Matrix
The functionality of the Bot has been divided into set of skills.
Below is an overview of how the task bots and meta bots are mapped
to these skills:
Skill Task Files MetaBot Files
Login to AAEP and monitor EPM, MPP and telephone ports status and
generate reports
AvayaExperiencePortalHealthCheklistupBot.atmx No Metabot used
AvayaExperiencePortalHealthCheklistupBot.atmx
LicenseHelper.mbot
3.2 Installation Hierarchy Once the bot is downloaded and
installed, the installer creates the files in the folder structure
as shown below.
Folder Structure on your Machine
Folder Structure
1.1. Bot Store
1.1.1. Avaya Experience Portal HealthCheckup Bot - VIS Global Pty
Ltd
Error Folder • Logs
<AA Application Path> is the location where AA files are
stored on your machine 1. My Tasks My Task Folder is the default
directory where Bot Files are saved. 1.1 Bot Store Bot Store Folder
contains the Bot Name Folder which the installer creates while
Installation of the Bot. 1.1.1 Avaya Experience Portal
HealthCheckup Bot - VIS Global Pty Ltd This folder gets created by
the installer and
Page 12 of 35
• LicenseHelper.mbot
contains files and folders needed for the bot to execute tasks.
Error folder is where logs and snapshots of screens will be placed
if there is an error during execution Input Folder is where the
input files that the bot needs for execution of the use cases are
saved • Configuration.txt is where the values need to be setup for
the bot to run. • AvayaAEPHealthCheckupReports.xlsx provides an
example of the type of content that can be provided as an input to
the bot. My Tasks folder contains all the Developed Platform Source
Code •AvayaExperiencePortalHealthCheklistupBot.atmx is a task bot
which will perform all the highlighted points 2. My MetaBots folder
contains the Developed Metabots needed for the bot execution. •
LicenseHelper.mbot is a Metabot which will contain global ID for
the license purpose
3.3 Quick Start
Download Base version 7.2.x:
https://support.avaya.com/downloads/download-
details.action?contentId=C20177251224226130_8&productId=P0407&releaseId=7.2.x
Download patch version 7.2.3.x:
https://support.avaya.com/downloads/download-
details.action?contentId=C20198281416485200_3&productId=P0407&releaseId=7.2.x
Step-2: Download Avaya Provided Linux OS
Download URL: https://support.avaya.com/downloads/download-
details.action?contentId=C2017724190489700_5&productId=P0407&releaseId=7.2.x
Step-3: After downloading above Avaya software’s, you can
setup/install in your server with the help of lab admin or document
provided by Avaya. You can visit
https://support.avaya.com/documents/ and search for AEP and Linux
OS related docs.
3.3.2 Configuration
To find MPP server and telephony ports status, first it should be
configured with EPM system or else user will not be able to access
MPP and telephony ports mode and state status.
- Configuration of MPP with EPM;
Please follow Avaya provided document or check with IT
administrator
- Configuration of Telephony ports (SIP and H.323);
Please follow Avaya provided document or check with IT
administrator
- Locker, Credential vault creation and assigning consumer role to
runner machine user;
For the procedure, please follow Automation Anywhere provided
document and create locker, credential vault with attributes as
mentioned below for your reference
Locker Name= AEPLocker
Credential Name= AEPVault
Page 14 of 35
o For External File –
CREDENTIAL VARIABLES: Credential Variables to be mentioned in this
Table
Variable Name Type Mandator y
Purpose Example Input
locker name as mentioned on Control room
Example: AEPLocker
credential name as
credential attribute name as mentioned
on Control room
credential attribute name as mentioned
on Control room
INPUT VARIABLES: Input Variables to be mentioned in this
Table
Variable Name Type Mandator y
Purpose Example Input
vAccessCode Text Yes Used to store Access Code and has to
provide to run bot
44d30cf34b……
vendor
vAEPLoginRTrue Text No Used to store AEP login related
recommendation
Example: NA
comments
address
version
details
sheet file name
Example: Avaya Experience Portal HealthCheckup Bot
vCMReport Text Yes Used to store CM reports file name
Example: CMReport.csv
vCMServer IP Yes Used to store CM server ip address
Example: 172.*.*.1
status
Example: 90
Example: 10
number
Example: Automation Anywhere
ip address
Example: 172.*.*.1
Example: 60
vEmailID Email
sending mail
Example:
[email protected]
vEPMCPU Text No Used to store dynamic EPM CPU related
comments
Example: EPM server CPU utilization is
vEPMCPUTrue Text No Used to store EPM CPU related
recommendation
Example: CPU utilization is normal
vEPMCPUFalse Text No Used to store EPM CPU related
recommendation
Example: CPU utilization is more than 90%
vEPMDiskspace Text No Used to store EPM disk space
related comment
vEPMDiskspaceTrue Text No Used to store EPM disk space
related recommendation
vEPMDiskspaceFalse Text No Used to store EPM disk space
related recommendation
Example: Disk space utilization is more than 80%
vEPMManagerReport Text No Used to store EPM Manager report csv
file
name
Example: EPMManagerReport.csv
vMPPManagerReport Text No Used to store MPP manager report csv
file
name
Example: Online
comments related to EPM
vEPMRAMTrue Text No Used to store EPM RA related
recommendation s
vEPMRAMFalse Text No Used to store EPM RA related
recommendation s
vEPMServiceRTrue Text No Used to store EPM service
related comments
Example: NA
related recommendation
vEPMState Text No Used to store EPM service
state
uptime related comments
vEPMUptimeTrue Text No Used to store EPM server
uptime related recommendation
uptime related recommendation
vErrorFolder Text Yes Used to store error folder path
Example: C:\Users\VIS\Documents\Automatio
n Anywhere Files\Automation Anywhere\My Tasks\Bot Store\
Avaya Experience Portal Checklist Bot – Vis Global Pty Ltd\Error
Folder
vErrorHandling Text Yes Used to store error status as
true if any error occur
Example =true
server
Example: 80%
Example= 8
Example: C:\Users\VIS\Documents\Automatio
n Anywhere Files\Automation Anywhere\My Tasks\Bot Store\
Avaya Experience Portal HealthCheckup Bot – Vis Global Pty
Ltd\Input Folder
Example: C:\Users\VIS\Documents\Automatio
n Anywhere Files\Automation Anywhere\My Tasks\Bot Store\
Avaya Experience Portal HealthCheckup Bot – Vis Global Pty
Ltd \Error Folder\Logs
server ip address
vLowDelay Number Yes Used for dynamic delay in task bot
Example = 2
value
vMidDelay Number Yes Used for dynamic delay in task bot
Example= 4
Example= True or False
vMPPCPU Text No Used to store dynamic MPP CPU related
comments
Example: MPP server CPU utilization is
vMPPCPUData Text No Used to store MPP system
monitor server details csv file
name
related comment
vMPPManagerReport Text No Used to store MPP manager
report file name
Example: Online
related comments
Page 23 of 35
related comments
Example: All MPP ports are available and but some respective states
are
not in service or connected state
vMPPPortsFalse1 Text No Used to store MPP ports
related comments
vMPPPortsRCustom Text No Used to store MPP ports
related recommendation
MPP
related recommendation
Example: For more info please find attached MPP ports report
vMPPPortsRFalse Text No Used to store MPP ports
related recommendation
Example: For more info please find attached MPP ports report
vMPPPortsTrue Text No Used to store MPP ports
related comments
vMPPRAM Text No Used to store dynamic
comments related to MPP
Page 24 of 35
address
related comments
Example: NA
related recommendation
vMPPState Text No Used to store MPP service
state
uptime related comments
vMUptime Number No Used to store MPP uptime in
days
Example:
2.6.32-696.3.1.el6.x86_64
path
n Anywhere Files\Automation Anywhere\My Tasks\Bot Store\
Avaya Experience Portal HealthCheckup Bot – Vis Global Pty
Ltd \Output Folder
value
value
details
file name
Example: PortDistribution.csv
counts
counts
Example: 5
path
n Anywhere Files\Automation Anywhere\My Tasks\Bot Store\
Avaya Experience Portal HealthCheckup Bot – Vis Global Pty
Ltd
Example= Avaya Experience Portal HealthCheckup Bot – Vis Global
Pty
Ltd
printable output file name
printable output file name
path
Example: Working
Example: Not working
path
Example=
Anywhere\My Tasks\Bot Store\ Avaya Experience Portal
HealthCheckup Bot – Vis Global Pty Ltd \Input
Folder\Configuration
File.txt
vSMReports Text No Used to store SM reports file name
Example: SMReports.csv
vSMServer Ip yes Used to store SM server ip address
Example: 172.*.*.1
path
n Anywhere Files\Automation Anywhere\My Tasks\Bot Store\
Avaya Experience Portal HealthCheckup Bot – Vis Global Pty
Ltd \Error Folder\Snapshots
Example: Yes
Example: No
memory value
Example: 9999
vSub2 Number No Used to store total used RAM memory value
Example: 5999
report csv file name
Example: Vis Global Pty Ltd
OUTPUT VARIABLES: Output Variables to be mentioned in this
Table.
Variable Name Type Mandatory Purpose Example Output
vValidationOutput Text Yes Used to check whether license
is still valid or not while running
paid bot
There are no Bot Insight Reports generated for this Bot
Page 30 of 35
5. Logs
In case of Errors, Error Logs & Screenshots are generated
within Error Folder (Highlighted below in yellow) o My Tasks • Bot
Store • Bot Name • Error Folder • Logs (Folder) oError Logs
Month-Day-Year.txt •Snapshots (Folder) o Error Snap Month-Day-Year
HourMinSec.png
Error Logs will contain the below information; • Error Line Number
• Error Description • Generated Timestamp
Example of Log File:
Page 31 of 35
Note: - There are no Custom Logs generated for this Bot.
Page 32 of 35
6.1 Support
User can reach out to the support email ID for the further setup,
help desk and production help
Note: - Free bots and trial bots are currently not supported
directly.
6.2 FAQs
Please feel free to reach us for any kind of support. We will be
more than happy to help
Support Contact
No. Version Number Date of Change Author Notes
1 1.0 11/11/2020 Ravindra Kumar Version 1 Release
Page 34 of 35
5 OS Operating System
7 Avaya AEP Avaya Aura Experience Portal
8 CR Credential Vault
architecture-implementation/deployment-
planning/requirements-server-
architecture-implementation/deployment-
planning/requirements-operating-system-
4 Product Documentation portal
https://docs.automationanywhere.com/
