24
Perform Various Avaya CM Commands Execution On ASA Readme Version 1.0 12/Mar/2021
Perform Various Avaya CM Commands Execution On ASA
Readme Version 1.0
12/Mar/2021
Table of Contents
Page 2 of 24
Table of Contents
1. Introduction .................................................................................................................... 3
1.1 Overview ......................................................................................................................... 3
1.2 Common Use cases ......................................................................................................... 7
2. Requirements & Prerequisites .......................................................................................... 8
2.1 System Requirements ..................................................................................................... 8
2.2 Prerequisites ................................................................................................................... 8
2.3 Security Measures........................................................................................................... 8
2.4 Disclaimers ...................................................................................................................... 9
3. Getting Started .............................................................................................................. 10
3.1 Skill Matrix .................................................................................................................... 10
3.2 Installation Hierarchy .................................................................................................... 10
3.3 Quick Start .................................................................................................................... 11
3.3.1 Setup ...................................................................................................................... 11
3.3.2 Configuration ......................................................................................................... 11
4. Reports .......................................................................................................................... 18
5. Logs ............................................................................................................................... 19
6. Troubleshooting & Support ............................................................................................ 21
6.1 Support ......................................................................................................................... 21
6.2 FAQs .............................................................................................................................. 21
Appendix A: Record of Changes ........................................................................................... 22
Appendix B: Acronyms......................................................................................................... 23
Appendix C: References ....................................................................................................... 24
Page 3 of 24
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
This bot will be useful to execute major Communication Manager commands on Avaya site administration and share captured details over mail. As above processes are manual and time consuming activities. 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 time and at the end of the execution a consolidated detailed report will be attached and send to respective configured email id.
Detailed steps are as follows:
1) Beginning of the process
2) Bot will run Meta bot logic to verify bot license whether it’s expired or not
3) Bot will Initialize the configuration file path, read and reinitialize all the key values and store into user created variable. Which can be Use by the bot dynamically and hence there won’t be tight coupling or code level any dependencies.
4) Bot will create folder structure (Bot will create folders as per bot framework for example: - Error, logs, snapshots and output folders)
5) Bot will delete all the downloaded files during last/previous run
6) Bot will copy AvayaCMCommands.xlsx file from input folder to output folder
7) Bot will open report excel file (AvayaCMCommands.xlsx) and activate sheet name present as “Avaya CM Commands”
8) Bot will Launch Avaya site administration application and login with user credential using credential vault.
9) Bot will execute all the listed 15 CM commands one by one, capture screenshots and save into project output folder
10) Bot will exit and close the Avaya site administration windows
11) Bot will insert all the captured screenshots to their respective places in the report excel sheet
Page 4 of 24
12) Save and close excel after updating the details. Then bot will send an email to the configured email id with AvayaCMCommands.xlsx report excel file attachment
13) Ending of the process
Visual Flow:
Page 5 of 24
Example of a Sample Input & Output
Input configuration file: -
Page 6 of 24
Output final report excel sheet: -
Page 7 of 24
1.2 Common Use cases
Apart from above Avaya CM major commands execution on ASA automation, we can also create automation bot on 3rd party tool such as Putty CLI based software. Where after login with CM user credential bot can execute all major and useful commands and generate reports.
Page 8 of 24
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
OS: Windows 10
.Net Framework: 4.6+
Microsoft VC 2013 or higher
2.2 Prerequisites
Software’s needed; Avaya site administration (ASA) 6.0.x SP14
Avaya CM 6.0.x or higher (Support only Linux OS Redhat 6.8+)
Avaya provided Linux OS 6.8+
AA Enterprise Client 11.3.x
Microsoft Excel 2013 or 2016
Accounts/License needed; Avaya CM license
Avaya CM admin user or user with admin privilege
AA Enterprise client V11 License (Bot Runner)
2.3 Security Measures There are some security best practice recommendations that you may follow with your bot; • It is not recommended to provide Avaya Communication Manager 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 Communication Manager user credential every quarter to ensure data security.
Page 9 of 24
2.4 Disclaimers
Instructions: User/Bot should use Avaya Communication Manager user credential stored in the credential vault only rather than hard coded, user variable or configuration file key values.
Page 10 of 24
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 metabots map to these skills:
Skill Task Files MetaBot Files
Open Avaya Site Administration, execute CM major commands and capture details reports
AvayaCMASACommandExecutionBot.atmx No Metabot Use
Integrating License using MetaBot Utility for Task Bot
AvayaCMASACommandExecutionBot.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
Description
<AA Application Path> 1. My Tasks
1.1. Bot Store
1.1.1. Perform Various Avaya CM Commands Execution On ASA - VIS Global Pty Ltd
Error Folder • Logs o Error logs Month-Day-Year Hour Min Sec.txt
<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 Perform Various Avaya CM Commands Execution On ASA - VIS Global Pty Ltd This folder gets created by the installer and contains files and folders needed for the bot
Page 11 of 24
• Snapshots o Error Snap Month-Day-Year.png Input Folder • Configuration.txt • AvayaCMCommands.xlsx My Tasks • AvayaCMASACommandExecutionBot.atmx 2. My MetaBots LicenseHelper.mbot
execution. Error folder is where logs and snapshots of screens will be placed if something goes wrong with the bot during execution Input Folder is where the input files that the bot needs for execution of the use case is saved • Configuration.txt is where the values need to be setup for the bot to run. • AvayaCMCommands.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 2. My MetaBots folder contains the Developed Metabots needed for the bot execution.
3.3 Quick Start
3.3.1 Setup
Step-1: Download Avaya site administration software from Avaya website
Download URL: https://support.avaya.com/downloads/download-details.action?contentId=C201851016296940_9&productId=P0433&releaseId=6.0.x
Step-2: Download Avaya CM software from Avaya website
Download URL: https://support.avaya.com/downloads/download-details.action?contentId=C2018791143363860_2&productId=P0001
Step-3: After followed above steps Avaya related software, you can setup/install in your server with the help of lab admin or document provided by Avaya. Also you can visit https://support.avaya.com/ and search for CM and ASA related docs.
3.3.2 Configuration
- 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
Page 12 of 24
Locker Name= AvayaSystemCLILocker
Credential Name= AvayaSystemCLIVault
Credential attributes name= CMUser and CMPass
o For External File –
CREDENTIAL VARIABLES: Credential Variables to be mentioned in this Table
Variable Name Type Mandatory
Purpose Example Input
AvayaSystemCLILocker Text Yes User has to provide same
locker name as mentioned on Control room
NA
AvayaSystemCLIVault Text Yes User has to provide same
credential name as mentioned on
Control room
NA
Page 13 of 24
CMUser Text Yes User has to provide same
credential attribute name
as mentioned on Control room
NA
CMPass Number and Text
Yes User has to provide same
credential attribute name as mentioned
on Control room
NA
INPUT VARIABLES: Input Variables to be mentioned in this Table
Variable Name Type Mandatory
Purpose Example Input
vAccessCode Text Yes Use to store Access Code and has to provide to
run bot
An example of the Input access code= 10126eab68e1ec30ff0
44d30cf34b……
vBotName Text Yes Use to store bot name
Example=Perform Various Avaya CM Commands Execution on ASA
vAvayaASAPath Text Yes Use to store Avaya site
administrator path
Example=C:\Users\****\Desktop\ASiteAdministration.Ink
vAvayaCMCommands Text Yes Use to store Avaya major CM
commands report excel sheet name
Example=
AvayaCMCommandst.xlsx
Page 14 of 24
vAvayaCMUrl
Url
Yes
Use to store CM
webpage url
Example url: https://172.*.*.199/
vEmailID Text Yes Use to store email id for
sending mail
Example: [email protected]
vErrorFolder Text Yes Use to store error folder path
Example= C:\Users\VIS\Documents\Automatio
n Anywhere Files\Automation Anywhere\My Tasks\Bot Store\
Perform Various Avaya CM Commands Execution on ASA – Vis
Global Pty Ltd\Error Folder
vErrorHandling Text Yes Use to store error status as true if any error occur
Example =true
vHighDelay Number Yes Use for dynamic delay in task
Example= 8
vInputFolder Text Yes Use to store input folder path
Example= C:\Users\VIS\Documents\Automatio
n Anywhere Files\Automation Anywhere\My Tasks\Bot Store\
Perform Various Avaya CM Commands Execution on ASA – Vis
Global Pty Ltd \Input Folder
vLogFolder Text Yes Use to store log folder path
Example= C:\Users\VIS\Documents\Automatio
n Anywhere Files\Automation Anywhere\My Tasks\Bot Store\
Perform Various Avaya CM Commands Execution on ASA – Vis Global Pty Ltd \Error Folder\Logs
Page 15 of 24
vLowDelay Number Yes Use for dynamic delay in task bot
Example = 2
vMidDelay Number Yes Use for dynamic delay in task bot
Example= 4
vMsguse Text Yes Use for dynamic message box
Example= True/ False
vLoop Number Yes Use to store loop value
Example=3
vOutputFolder Text Yes Use to store output folder
path
Example= C:\Users\VIS\Documents\Automatio
n Anywhere Files\Automation Anywhere\My Tasks\Bot Store\
Perform Various Avaya CM Commands Execution on ASA – Vis
Global Pty Ltd \Output Folder
vProjectFolder Text Yes Use to store project folder
path
Example= C:\Users\VIS\Documents\Automatio
n Anywhere Files\Automation Anywhere\My Tasks\Bot Store\
Perform Various Avaya CM Commands Execution on ASA – Vis
Global Pty Ltd
vProjectName Text Yes Use to store project name
Example= Perform Various Avaya CM Commands Execution on ASA –
Vis Global Pty Ltd
Page 16 of 24
vRootFolder Text Yes Use to store configuration file
path
Example=
C:\Users\VIS\Documents\Automation Anywhere Files\Automation
Anywhere\My Tasks\Bot Store\ Perform Various Avaya CM
Commands Execution on ASA – Vis Global Pty Ltd \Input
Folder\Configuration File.txt
vSheet1 Text Yes Use to store excel file sheet
name
Example=
Avaya CM Commands
vSheet2 Text Yes Use to store excel file sheet
name
Example=
Avaya CM Checklists
vSnapshotFolder Text Yes Use to store snapshot folder
path
Example= C:\Users\VIS\Documents\Automatio
n Anywhere Files\Automation Anywhere\My Tasks\Bot Store\
Perform Various Avaya CM Commands Execution on ASA – Vis
Global Pty Ltd \Error Folder\Snapshots
vSystem Text Yes Use to store local machine user
name
Example= VIS
vVendorName Text Yes Use to store vendor name
Example= Vis Global Pty Ltd
Page 17 of 24
OUTPUT VARIABLES: Output Variables to be mentioned in this Table.
Variable Name Type Mandatory Purpose Example Output
vValidationOutput Text Yes Use to check whether license is
still valid or not while running paid
bot
True/False
Page 18 of 24
4. Reports
There are no Bot Insight Reports generated for this Bot
Page 19 of 24
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) o Error 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:
Note: There are no Custom Logs generated for this Bot.
Page 20 of 24
Example of Screenshot Generated Error File:
Page 21 of 24
6. Troubleshooting & Support
6.1 Support
User can reach out to provided support email ID for the further setup, help desk and production support
Note: - Free bots and trial bots are currently not supported directly.
6.2 FAQs
Please get connect to our email for further or any type of supports.
Support Contact
Sales Contact
Page 22 of 24
Appendix A: Record of Changes
No. Version Number Date of Change Author Notes
1 1.0 12/03/2021 Ravindra Kumar Version 1 Release
Page 23 of 24
Appendix B: Acronyms
No. Acronym Description
1 AA Automation Anywhere
2
CR Control room
3 PC Personal Computer
4 RAM Random Access Memory
5 OS Operating System
6 CSV Comma Separated File
7 ASA Avaya Site Administration
8 CM Communication Manager
9 CR Credential Vault
10 GB Gigabytes
Page 24 of 24
Appendix C: References
No. Topic Reference Link
1 System Requirements – Client hardware https://docs.automationanywhere.com/bundle/enterprise-v11.3/page/enterprise/topics/aae-
architecture-implementation/deployment-planning/requirements-server-
hardware.html#Zj0vY2F0ZWdvcnkvZXhwbG9yZT9wPUV4cGxvcmU=
2 System Requirements – Client OS https://docs.automationanywhere.com/bundle/enterprise-v11.3/page/enterprise/topics/aae-
architecture-implementation/deployment-planning/requirements-operating-system-
compatibility.html#Zj0vY2F0ZWdvcnkvZXhwbG9yZT9wPUV4cGxvcmU=
3 A people Community Site https://apeople.automationanywhere.com/s/?language=en_US
4 Product Documentation portal https://docs.automationanywhere.com/
