| SrNo | Date | Script(zip) | Template | Config File |
|---|---|---|---|---|
| 1 |
| Automated Baseline Report | Automation Template - PPTX | Configuration file |
Objective
The script is used to generate Automated baseline report (PowerPoint deck) from the provided template, The main objective of this automation is to:
- Save time in generating the report
- Create consistency in report output across all the accounts
- Provide an output report which look more professional in terms of Data and relevant information
- Eliminate human error
How to Use:
Installation
- Install Python's latest version on the machine where you want to generate the deck.
Download and unpack the latest release of the Assessment Deck Generation Tool from the above Script(zip) location [Latest version: 08 April 2022]
Unpack the Source Code zip file (Assessment Deck Generation Tool.zip) and place it in a particular location
Once the python installation is complete, Install/update required third-party packages.
- Open a command prompt (from the location where the script file is placed)
- Go to the Source Code folder
- run: pip install -r requirements.txt
- Create an output folder for storing the generated file from automation script [Ex: D:/Automation/Output/{application name}]
- Download the Template - Application Baseline Report Template and place in the path such that this file should be referenced in the configuration file [Ex: D:/Automation/Template/Application_Baseline_Report_Template]
- Follow the same instruction for Configuration File to reference while executing the deck generation [Ex: --config D:/Automation/config.json]
Usage
The script is designed to run on the command line using one parameter, --config, used to identify the project and applications to include in the presentation.
To execute follow this command: py convert.py --config config.json (or) python convert.py --config config.json
Configuration file
The Assessment Deck Generation Tool is configured using a json formatted file. The file is divided into three sections, general configuration, application list and rest configuration.
General Configuration
The general configuration section contains four parts,
- company - the name of the company as it will appear on the report
- project name - the name of the project as it will appear on the report
- template - the absolute location of the report template
- output - the absolute location of the report output folder
Application list
This section contains a list of all applications that will be used in the report. It is divided into three parts,
- aip - the application schema triplet base
- highlight - the name of the application as it appears in the Highlight portal
- title - the name of the application to be used in the report
aip is the only required in this section. If Highlight or title are empty or left out the aip value will be used.
REST Configuration
The REST configuration is divided into two parts, AIP and Highlight. Both configurations contain
- Active - toggle to turn REST service on/off
- URL - the service base URL
- user - login user id
- password - login password (non-encrypted)
The Highlight configuration contains an additional field, instance, which refers to the login instance id.
Sample configuration
{
"company":"Sample Company Name",
"project":"Sample Project Name",
"template":"C:/com.castsoftware.uc.abr/Automation_Template.pptx",
"output":"C:/output/folder",
"application":[
{
"aip":"triplet_base_name",
"highlight":"highlight_name",
"title":"application title"
},
{
"aip":"triplet_base_name",
"highlight":"highlight_name",
"title":"application title"
}, ...
],
"rest":{
"AIP":{
"Active":true,
"URL":"http://<URL>:<Port>/rest/",
"user":"user_name",
"password":"user_pasword"
},
"Highlight":{
"Active":true,
"URL":"https://<URL>/WS2/",
"user":"user_name",
"password":"user_pasword",
"instance":"instance id"
}
}
}
Output
A single PowerPoint deck and one excel spread sheet is generated for each application configured in the properties file. The excel sheet holds the application Quick win plan information and divided into two tabs, summary, and detail. In this process, if the Quick action plan is not configured, for the application-the sheets and the slides of the deck will be empty.
Pls find the sample of the output Here
Known Issues
| SN | Issue | WA |
|---|---|---|
| 1 | Python Installation | Please check the below parameter while installing python.
|
| 2 | cannot import name 'MutableMapping' from collection | Comment out line 9 from convert.py file
|
| 3 | Folder Structure | One can create a folder structure something like below, before running the Automated Assessment Report:
Output : Location where Assessment Report will be generated Template : Place the Assessment Report template here Config.json : Modify the config.json as per your requirement |
| 4 | Avoid Space in Folder Path | Avoid whitespace in folder path as it can cause an error during report generation. |
