Welcome to the AI Mentor Studio API Integration documentation.
In order to use this component you will need your infrastructure's activation code, an AI Mentor Studio API Key and you will also need a service account for use with the Lifetime API V2
Find your activation code: https://success.outsystems.com/support/enterprise_customers/licensing/manage_and_upgrade/find_the_activation_code_and_the_serial_number/
AIMS API Key instructions: https://success.outsystems.com/documentation/11/reference/outsystems_apis/ai_mentor_studio_api/ai_mentor_studio_api_authentication/
Service account instructions:
https://success.outsystems.com/documentation/11/reference/outsystems_apis/lifetime_api_v2/rest_api_authentication/
Once you have these three pieces of information you are ready to get started.
What is in the AI Mentor Studio API Integration?
The component is made up of three modules.
AIMS_API_IS: The integration service module for the AIMS API. This module contains the REST API calls, the service actions to wrap those calls and the support structures necessary to use the API.
AIMS_API_CS: The core service module contains the entities necessary to store the information gathered from the AIMS API. Additional entities have been included for storing infrastructure information and for entering customer code analysis pattern weights. The server actions for interacting with the entities are also included in this module.
AIMS_API_BL: The business logic module contains server actions that provide some of the basic functionality one would desire when interacting with the AIMS API including:
Getting the overall technical debt rating for an application.
Getting the count of occurrences per technical debt category for an application and its modules.
Getting the list of code analysis patterns found in an application and its modules.
Getting a list of code analysis patterns found in an application and its modules that match a list of code patterns of interest.
Getting a detailed object of all technical debt information available for an application.
The AI Mentor Studio Integration Demo application
The AI Mentor Studio Integration has absolutely no interface. With that in mind, the best way to get started is to install the demo application.
The demo application has two dependencies that must be installed:
JSON Pretty Format Reactive: https://www.outsystems.com/forge/component-overview/10136/json-pretty-format-reactive
Multiple Selection Dropdown (ReactAndMob): https://www.outsystems.com/forge/component-overview/9239/multiple-selection-dropdown-reactandmob
This application also requires a Lifetime API Authorization token, the AIMS API key, and the infrastructure's activation code.
Once entered, press the "Get Lifetime Values" button and the application connects to the Lifetime API V2 in order to gather a list of applications, and application versions, in your infrastructure.
After an application and version are selected, the demo application allows you to process several types of technical debt checks on the application including:
Check the application's overall technical debt:
Check the application's technical debt counts per category:
Check the application for specific code patterns:
Get full details of the application, and its modules, technical debt:
You can also download the information from the AI Mentor Studio API into the core entities. After pressing the "Sync Base Tables Then Do A Technical Debt Request" button you must wait until the data download is complete.
Clicking the "Refresh Technical Debt requests" button will refresh the status of the current technical debt requests. When the most recent technical debt request shows that it "Is Concluded" you can click the activation code for that technical debt request and be brought to the Module Findings for that technical debt request.
The Module Findings screen provides a useful example of how to interact with the core entities.
Please note, pressing the "Wipe Data" button will empty all of the technical debt request tables, but not the lookup tables. The tables highlighted in the screenshot below will be emptied. The others will be untouched.
Thank you for your interest. I hope you find this component helpful.
The AI Mentor Studio Integration has absolutely no interface. With that in mind, the best way to get started is to install the demo application. This application requires the Lifetime API Authorization token, the AIMS API Key, and the infrastructure's activation code.
Once entered the application connects to the Lifetime API V2 in order to gather a list of applications, and application versions, in your infrastructure.