CI Class KpiObjective

Inheritance diagram for KpiObjective

Summary

Display Name	KpiObjective
Name	kpi_objective
Description	A KPIObjective is a translation of business objectives into set of thresholds against which a particular KPI is measured.

Attributes

Attributes defined for KpiObjective
Name	Display Name	Type	Default Value	Description	Factory	Key	Hidden
calendar_period	CalendarPeriod	calendar_period_enum		The calendar period used for KPI calculation. For example: working hours, 24x7, etc.	true	false	false
kpi_comparison_operator	KpiComparisonOperator	comparison_operator_enum		Comparison operator that is used when comparing kpi calculated value to its thresholds.	true	false	false
kpi_context	KpiContext	string		KpiContext is needed to differentiate between KPIs that belong to different SLAs and contains Id of the SLA.	true	false	false
kpi_lower_threshold_critical	KpiLowerThresholdCritical	double		The threshold that defines the lower end of the Crticial range for a KPI.When used to express centralized ranges this may be referred to as RangeTo.	true	false	false
kpi_lower_threshold_major	KpiLowerThresholdMajor	double		The threshold that defines the lower end of the Major range for a KPI.	true	false	false
kpi_lower_threshold_minor	KpiLowerThresholdMinor	double		The threshold that defines the lower end of the Minor range for a KPI.	true	false	false
kpi_lower_threshold_ok	KpiLowerThresholdOk	double		The threshold that defines the lower end of the OK range for a KPI.When used to express centralized ranges this may be referred to as GoodFrom.	true	false	false
kpi_lower_threshold_warning	KpiLowerThresholdWarning	double		The threshold that defines the lower end of the Warning range for a KPI Objective.When used to express centralized ranges this may be referred to as WarningFrom.	true	false	false
kpi_measurement_type	KpiMeasurementType	kpi_measurement_type_enum		Describes what is being measured by the KPI (e.g. time, capacity, etc)	true	false	false
kpi_status	KpiStatus	kpi_status_enum		KPI status for status based KPIs. For value based KPIs this attribute will be empty.	true	false	false
kpi_threshold_critical	KpiThresholdCritical	double		Used to describe the Kpi Threshold for critical status	true	false	false
kpi_threshold_major	KpiThresholdMajor	double		Used to describe the KPI threshold for major status.	true	false	false
kpi_threshold_minor	KpiThresholdMinor	double		Used to describe the KPI threshold for minor status	true	false	false
kpi_threshold_ok	KpiThresholdOk	double		Used to describe the KPI threshold for OK status	true	false	false
kpi_threshold_warning	KpiThresholdWarning	double		Used to describe the KPI threshold for Warning status	true	false	false
kpi_unit_of_measure	KpiUnitOfMeasure	string[100]		Specifies the unit of measure associated with the particular KpiObjective. Knowledge of the unit of measure is needed for conversions (e.g., converting from seconds to minutes). Possible values could be time-based (e.g., seconds, minutes, etc), currency-based (e.g., USD, EUR, etc), bandwidth (e.g., MBit/s, GBit/s), etc.	true	false	false
kpi_value	KpiValue	double		KPI value for value based KPIs. For status based KPIs this attribute will be empty	true	false	false
score	Score	double		Holds the Score for a survey or other such things that have a Score. A higher value is the better Score.	true	false	false
tracking_period	TrackingPeriod	tracking_period_enum		Tracking period defines the granularity of KPI calculatation. For example, calculations might be done at tracking period levels of day, week, or month. If TrackingPeriod 'other' is specified, it can correspond to some other time interval such as the period associated with an SLA.	true	false	false
trend	Trend	trend_enum	nochange	Trend that apllies to some measure, like it is going up, going down or not changing.	true	false	false
Attributes defined for Managed Object
Name	Display Name	Type	Default Value	Description	Factory	Key	Hidden
TenantOwner	Owner Tenant	string[32]		The Tenant Owner ID	true	false	false
TenantsUses	Consumer Tenants	string_list		The IDs of the Tenants who are associated with the CI	true	false	false
Attributes defined for Object
Name	Display Name	Type	Default Value	Description	Factory	Key	Hidden
document_list	Documents	string		Documents	true	false	true
MENU		xml			true	false	true
Attributes defined for Data
Name	Display Name	Type	Default Value	Description	Factory	Key	Hidden
~~data_adminstate~~	~~Admin State~~	adminstates_enum	0	Admin State	true	false	true
data_allow_auto_discovery	Allow CI Update	boolean[250]	true		true	false	false
~~data_changecorrstate~~	~~Change Corr State~~	changestates_enum	0	Change State	true	false	true
~~data_changeisnew~~	~~Change Is New~~	boolean	false	Change State	true	false	true
~~data_changestate~~	~~Change State~~	changestates_enum	0	Change State	true	false	true
data_externalid	External ID	string[50]		external source id: snmp index, data sources index etc.	true	false	true
data_note	Note	string[250]			true	false	false
~~data_operationcorrstate~~	~~Operation Corr State~~	operationstates_enum	0	Operation State	true	false	true
~~data_operationisnew~~	~~Operation Is New~~	boolean	false	Operation State	true	false	true
~~data_operationstate~~	~~Operation State~~	operationstates_enum	0	Operation State	true	false	true
data_origin	Origin	string[100]			true	false	false
data_source	Created By	string[512]			true	false	false
~~data_testcorrstate~~	~~Test Corr State~~	teststates_enum	0	Test State	true	false	true
~~data_testisnew~~	~~Test Is New~~	boolean	false	Test State	true	false	true
~~data_teststate~~	~~Test State~~	teststates_enum	0	Test State	true	false	true
data_updated_by	LastModifiedBy	string[512]			true	false	false
description	Description	string[1000]		Description	true	false	false
digest	Digest	string[40]			true	false	true
display_label	Display Label	string[900]		Used as calc attribute for display	true	false	false
MENU		xml			true	false	true
name	Name	string[900]			true	false	false
user_label	User Label	string[900]		Used as user label	true	false	false
Attributes defined for Root
Name	Display Name	Type	Default Value	Description	Factory	Key	Hidden
BODY_ICON		string	general		true	false	true
calculated_id	Calculated ID	bytes[16]		Calculated ID	true	false	true
create_time	Created Time	date		When was this CI created	true	false	false
FAMILY_ICON		string			true	false	true
global_id	Global Id	string[32]		A globally unique identifier for the entity represented by the object	true	false	false
global_id_scope		string	Default		true	false	true
last_discovered_by	LastDiscoveredBy	string[512]		Who discovered this CI	true	false	false
last_discovered_by_probe	LastDiscoveredByProbe	string		Which probe discovered this CI	true	false	false
last_discovered_time	LastDiscoveredTime	date		When was this CI discovered	true	false	false
last_modified_time	LastModifiedTime	date		When was this CI last updated	true	false	false
root_actualdeletetime	Actual Delete Time	date		When will this CI be deleted	true	false	true
root_actualdeletionperiod	Actual Deletion Period	integer	40	What is the period after the CI will be deleted	true	false	false
root_candidatefordeletetime	Candidate For Deletion Time	date		When will this CI be warned about deleting	true	false	true
root_class	CI Type	string[100]		Class name of the CI	true	false	true
root_container	Container	string[32]		Container CI of this CI	true	false	false
root_deletioncandidateperiod	Deletion Candidate Period	integer	20	What is the period after the CI will be candidate for delete	true	false	false
root_enableageing	Enable Aging	boolean	false	Is aging enabled	true	false	false
root_iconproperties		string[100]			true	false	true
root_iscandidatefordeletion	Is Candidate For Deletion	boolean	false	Is candidate for deletion	true	false	false
root_lastaccesstime	Last Access Time	date		When was this CI last accessed	true	false	false
~~root_system~~	~~System~~	string[2]			true	false	true

Valid Relations

Valid direct incoming and outgoing relations defined on KpiObjective

Relations defined for KpiObjective
From	To	Type	Description
KpiObjective	KpiObjective	Aggregation
Kpi	KpiObjective	Composition	Represents a relation between 2 objects where one is contained within the other, and the included object can not exist without its container. Therefore, when the container is deleted, all its contained object will be automatically removed
Period	KpiObjective	Connection
Relations defined for Managed Object
From	To	Type	Description
Managed Object	History Change	History Link
Tenant	Managed Object	Connection

Combined inheritance and relation diagram for KpiObjective

Potential Data Providers

Adapters providing CIs of type Object
Adapter Name	Description	Adapter Type
ALMAdapter	Federate defects from ALM	Integration
AMGenericAdapter	This adapter pushes/populates data between UCMDB and Asset Manager. Follow the Quick Start guide supplied with the AM Generic Adapter documentation before creating this integration point.	Integration
Application Portfolio Management Push Adapter	This adapter pushes data from UCMDB to HP Application Portfolio Management. Follow the APM Push Adapter documentation included in the HP UCMDB Discovery and Integration Content Guide before creating this integration point.	Integration
UCMDB API Population	Allows defining Reconciliation Priority for API Data In flows	Integration
Data Push into Atrium	Pushes CIs and relationships to BMC Atrium	Integration
AutomationFlowAdapter	Provide API to Operation Orchestration	Integration
BSMKpiAdapter	Federate KPIs from BSM	Integration
CA CMDB	Pushes CIs and relationships to CA CMDB	Integration
UCMDB 10.x and later	Used for Populating and Federating data from a remote UCMDB 10.x(or later) and for Pushing to a remote UCMDB 10.x(or later)	Integration
UCMDB 9.x	Used for Populating and Federating data from a remote UCMDB 9.x server and for Pushing to a remote UCMDB 9.x	Integration
UCMDB History Adapter [local instance only]	Used to federated data from the UCMDB's History	Integration
Push Adapter DB Example	Push data into Oracle \ MSSQL database	Integration
GenericDBAdapter	An example Adapter that uses the GDB-Framework	Integration
IAM UI Push Adapter	Push IAM Universal Inventory data into MSSQL database on-premises or on cloud-based Azure.	Integration
Java_Adapter_Template	Adapter Description	Integration
Kafka Push Adapter 2019.05	Push function for Kafka Push Adapter	Integration
Local State Push Adapter	Used for populating data between the states of the same UCMDB Server	Integration
Pulsar Push Adapter	Push function for Pulsar Push Adapter	Integration
Push Adapter	Push Adapter	Integration
Remedyforce Push Integration	Remedyforce Push Integration	Integration
SMA-X Push Adapter	This adapter pushes data from UCMDB to Service Anywhere.	Integration
System Center Configuration Manager	Uses the GDB-Framework to Populate and Federate data from a System Center Configuration Manager. The adapter is also backward compatible with the SMS DB	Integration
Service Manager 9.41	Discovery Pattern Description	Integration
Service Manager 9.xx	Discovery Pattern Description	Integration
Service Manager Enhanced Generic Adapter	Push and Populate CI data between UCMDB and Service Manager	Integration
ServiceNow Enhanced Generic Adapter	Push, Populate and Federation of CI data between UCMDB and ServiceNow	Integration
UCMDB to XML	Export data into XML from UCMDB	Integration