Category & Component

Last Updated OnOctober 18, 2023

This section describes the Topology API for adding customized Categories and Components in HEAL.

Category

KPIs having a similar impact on the performance of the system are tagged together as a Category. Forensic actions can be in general mapped to a category.

API Name – categories

Format – POST /api/accounts/< account_identifier >/categories

JSON Format

{ “name”: “<Name of category>”, “identifier”: “<identifier of category>”, “description”:”<description of category>”, “subType”:”<category sub-type>”, “workLoad”: “<Flag to specify the category is for Workload or Behavior KPI>”, “status”: “<status of category>”}

Input Parameters

Name	Description	Constraints	Mandatory/Optional
Name	Name of the category	It must be unique across the account. It can be up to a maximum of 64 characters.	Mandatory
Identifier	Identifier of the category. If the identifier is not specified by the user, API creates the identifier.	It should be unique across the account. It can be upto maximum 64 characters.	Optional
workLoad	Workload KPIs can be either transaction or component KPIs. This attribute defines whether the category is of type workload or behavior. For a workload category, value needs to be “true”. Default value is “false”.	It is a Boolean. It should be either true or false.	Optional
description	This describes the category.		Optional
subType	Sub-type of the category	It should be Info or Non-info.	Mandatory
status	Status of the category. It can enabled or disabled. If enabled, category is visible in HEAL UI else category is invisible in UI.	It should be 1 or 0. Default value is 1.	Optional

Sample JSON

Following JSON generates a Category named DB_ERRORS.

{ “name”: “DB_ERRORS” “identifier”: “3aa82ecf-ea46-4c19-9abe-fa23ebe241b9”, “workLoad”: true, “description”: “DB category”, “subType”: “Non-info”,”status”:1 }

Success Rest Response

{ “message”: “Created Successfully”, “responseStatus”: “SUCCESS”, “data”: 12 }

Failure Rest Response

{ “message”: “Category already exists.”, “responseStatus”: “FAILURE” }

Component

A component is a software element that runs on the host server. HEAL’s components allows you to create customized Components to suit your environment.

API Name: components

Format: POST /api/accounts/<account_identifier>/components

JSON Format

{ “componentName”: “<Name of the component>”, “type”: “<Type of the component>”, “commonVersion”: “< Common version for the component>”, “version”: “< Component version>”, “description”:”< Component description>”, “attributes”: [, { “name”: “<Attribute name>”, “type”: “<Attribute type>”, “defaultValue”: “<Attribute default value>”, “mandatory”: “<Attribute mandatory or optional>”, “maxLength”: “<Maximum length of attribute value>”, “minLength”: “<Minimum length of attribute value>” }] }

Input Parameters

Name	Description	Default Value	Predefined Values	Mandatory	More Info
componentName	Name of the component	–	–	Yes
type	Type of the component	–	“Host”, “Web Server”, “Application Server”, “Database Server”, “Services”, “Workload”	Yes
commonVersion	Common major Version for the component	–	–	Yes
version	The current version of the component	–	–	Yes
description	Description for the component added	–	–	Yes
Object – attributes
name	Name of the attribute	–	–	Yes
type	Type of the attribute	–	TextBox, Password	Yes
defaultValue	The default value for the attribute	–	–	Yes
mandatory	Specifies whether the attribute is mandatory for the component	false	false, true	Yes
maxLength	The maximum length of the attribute value	–	–	No
minLength	Minimum length of the attribute value	–	–	No

Sample JSON

Sample JSON to create a new component named Booking Component is as follows:

{ “componentName”: “BookingComponent”, “type”: “Application Server”, “commonVersion”: “1.x”, “version”: “1.1”, “description”: “Component that is customised for booking hotel and flights”, “attributes”: [{ “name”: “HostAddress”, “type”: “TextBox”, “defaultValue”: “”, “mandatory”: “true”, “maxLength”: “64”, “minLength”: “10” }, { “name”: “MonitorPort”, “type”: “TextBox”, “defaultValue”: “”, “mandatory”: “true”, “maxLength”: “8”, “minLength”: “3” } ] }

Success Rest Response

{ “message”: “Created successfully.”, “responseStatus”: “SUCCESS”, “data”: { “id”: 26, “name”: “BookingComponent” } }

Failure Rest Response

Failure message when the ‘type’ parameter was removed from the sample JSON

{ “message”: “Invalid request”, “responseStatus”: “FAILURE”, }

How Can We Help?

Category

Component