Skip to content

4. Output

Nevin Kaplan edited this page Dec 7, 2023 · 11 revisions

ARG (Assessment Report Generator) produces a PowerPoint presentation comprising one or several applications and multiple spreadsheets holding corroborating data, all originating from either the highlight or cast REST APIs. This version offers two distinct templates - one solely designed for Highlight and the other specifically catered towards AIP and Highlight decks.

Out of the Box

One of the key benefits of working with ARG is our ability to create professional and client-ready PowerPoint presentations using our supplied templates. Our team understands the importance of delivering a visually appealing and cohesive presentation to your clients, and we have the skills and expertise to make it happen. We also know that your time is valuable, which is why we have pre-made templates ready to use, saving you time and ensuring a consistent and polished final product. You can trust us to create a professional and engaging presentation that will impress your clients and effectively communicate your message. Let ARG help you make a lasting impression with our PowerPoint deck services.

Manual Effort Required

It is important to note that while our provided templates offer a great starting point for creating your decks, there may be some information that cannot be automatically retrieved through our REST API's. This means that certain sections may need to be manually updated by the user. These sections will be marked with a yellow highlight or a sample page banner for easy identification. Additionally, when running ARG to generate supporting artifacts, these will also need to be manually attached to the deck. This ensures that your final product is accurate and reflects all necessary information. We appreciate your understanding and attention to detail in this process.

Unfortunately, there are certain situations in which tag replacement may not be successful. In these cases, the original tag will remain in the final deck and the user will need to manually replace it with the correct information. However, it is important to note that this is not something ARG should be doing. If you encounter this issue, please report it to us so we can address and fix it as soon as possible. Our goal is to provide a seamless and efficient experience for our users, and we appreciate your help in ensuring that our services meet those standards.

Custom Templates

Creating and maintaining ARG templates can greatly improve efficiency and consistency when working with CAST Highlight or AIP REST API data. An ARG template is essentially a PowerPoint deck that contains TAGS, Table, and Chart markers, which can be easily replaced with data collected from these sources. This page offers comprehensive information on the process of creating and maintaining ARG templates, allowing users to effectively present and analyze their data in a professional and streamlined manner. By utilizing ARG templates, users can save time and ensure accuracy in their data analysis and reporting. Whether you are new to ARG templates or looking to improve your skills, this page has all the necessary information to help you succeed.

TAGS

Enclosed by curly brackets, {tag name} are textual elements that can be replaced with relevant text from either the configuration file, the Highlight REST API, AIP REST API, or calculated by ARG. These tags are not limited to a singular category, but rather subdivided into subcategories like portfolio or application-level tags.

Configuration

TAG Name Description
company configuration company element value
project project element value
app_cnt application count

Highlight

When working with the Highlight REST API, it is important to understand the two types of Highlight tags used by ARG: portfolio (port_hl) and application (app1_hl). The portfolio tag provides information gathered from all applications listed in the configuration file, while the application tag provides information specific to each application. It is important to note that when using the ARG template, it should only refer to application 1. If the configuration file includes multiple applications, ARG will automatically replace the app1 in the template with the corresponding number for each application.

The following list shows all Highlight tags currently available for use in an ARG template. To use the tag in a template the TAG name must be prefixed with either "port_hl_" or "app1_hl_".

TAG Name Description Notes
cloudReady_score The score found in the Cloud Ready tile
greenIndex_score The score found in the Green Impact tile
openSourceSafety_score The score found in the Open Source Safety tile
oss_total_components number of open source components Disctinct count for all application in the portfolio
oss_total_licenses number of open source components Disctinct count for all application in the portfolio
softwareAgility_score The score found in the Agility tile
softwareElegance_score The score found in the Elegance tile
softwareHealth_score The score found in the Health tile
softwareResiliency_score The score found in the Resiliency tile
technology List of all technologies In order of LOC count
total_loc Total number of lines Sum of the each application for portfolio tag

Benchmark

TAG Name Description Notes

Calculated

TAG Name Description Notes

AIP TAGS

TAG Name Description Notes

AIP Calculated TAGS

TAG Name Description Notes

Tables and Charts

TAG Name Description Notes

Clone this wiki locally