CI Class KpiObjective

Inheritance diagram for KpiObjective

Summary

Display NameKpiObjective
Namekpi_objective
DescriptionA KPIObjective is a translation of business objectives into set of thresholds against which a particular KPI is measured.

Attributes

Attributes defined for KpiObjective
NameDisplay NameTypeDefault ValueDescriptionFactoryKeyHidden
calendar_periodCalendarPeriodcalendar_period_enumThe calendar period used for KPI calculation. For example: working hours, 24x7, etc.truefalsefalse
kpi_comparison_operatorKpiComparisonOperatorcomparison_operator_enumComparison operator that is used when comparing kpi calculated value to its thresholds.truefalsefalse
kpi_contextKpiContextstringKpiContext is needed to differentiate between KPIs that belong to different SLAs and contains Id of the SLA.truefalsefalse
kpi_lower_threshold_criticalKpiLowerThresholdCriticaldoubleThe 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.truefalsefalse
kpi_lower_threshold_majorKpiLowerThresholdMajordoubleThe threshold that defines the lower end of the Major range for a KPI.truefalsefalse
kpi_lower_threshold_minorKpiLowerThresholdMinordoubleThe threshold that defines the lower end of the Minor range for a KPI.truefalsefalse
kpi_lower_threshold_okKpiLowerThresholdOkdoubleThe 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.truefalsefalse
kpi_lower_threshold_warningKpiLowerThresholdWarningdoubleThe 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.truefalsefalse
kpi_measurement_typeKpiMeasurementTypekpi_measurement_type_enumDescribes what is being measured by the KPI (e.g. time, capacity, etc)truefalsefalse
kpi_statusKpiStatuskpi_status_enumKPI status for status based KPIs. For value based KPIs this attribute will be empty.truefalsefalse
kpi_threshold_criticalKpiThresholdCriticaldoubleUsed to describe the Kpi Threshold for critical statustruefalsefalse
kpi_threshold_majorKpiThresholdMajordoubleUsed to describe the KPI threshold for major status.truefalsefalse
kpi_threshold_minorKpiThresholdMinordoubleUsed to describe the KPI threshold for minor statustruefalsefalse
kpi_threshold_okKpiThresholdOkdoubleUsed to describe the KPI threshold for OK statustruefalsefalse
kpi_threshold_warningKpiThresholdWarningdoubleUsed to describe the KPI threshold for Warning statustruefalsefalse
kpi_unit_of_measureKpiUnitOfMeasurestring[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.truefalsefalse
kpi_valueKpiValuedoubleKPI value for value based KPIs. For status based KPIs this attribute will be emptytruefalsefalse
scoreScoredoubleHolds the Score for a survey or other such things that have a Score. A higher value is the better Score.truefalsefalse
tracking_periodTrackingPeriodtracking_period_enumTracking 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. truefalsefalse
trendTrendtrend_enumnochangeTrend that apllies to some measure, like it is going up, going down or not changing.truefalsefalse
Attributes defined for Managed Object
NameDisplay NameTypeDefault ValueDescriptionFactoryKeyHidden
TenantOwnerOwner Tenantstring[32]The Tenant Owner IDtruefalsefalse
TenantsUsesConsumer Tenantsstring_listThe IDs of the Tenants who are associated with the CItruefalsefalse
Attributes defined for Object
NameDisplay NameTypeDefault ValueDescriptionFactoryKeyHidden
document_listDocumentsstringDocumentstruefalsetrue
MENUxmltruefalsetrue
Attributes defined for Data
NameDisplay NameTypeDefault ValueDescriptionFactoryKeyHidden
data_adminstateAdmin Stateadminstates_enum0Admin Statetruefalsetrue
data_allow_auto_discoveryAllow CI Updateboolean[250]truetruefalsefalse
data_changecorrstateChange Corr Statechangestates_enum0Change Statetruefalsetrue
data_changeisnewChange Is NewbooleanfalseChange Statetruefalsetrue
data_changestateChange Statechangestates_enum0Change Statetruefalsetrue
data_externalidExternal IDstring[50]external source id: snmp index, data sources index etc.truefalsetrue
data_noteNotestring[250]truefalsefalse
data_operationcorrstateOperation Corr Stateoperationstates_enum0Operation Statetruefalsetrue
data_operationisnewOperation Is NewbooleanfalseOperation Statetruefalsetrue
data_operationstateOperation Stateoperationstates_enum0Operation Statetruefalsetrue
data_originOriginstring[100]truefalsefalse
data_sourceCreated Bystring[512]truefalsefalse
data_testcorrstateTest Corr Stateteststates_enum0Test Statetruefalsetrue
data_testisnewTest Is NewbooleanfalseTest Statetruefalsetrue
data_teststateTest Stateteststates_enum0Test Statetruefalsetrue
data_updated_byLastModifiedBystring[512]truefalsefalse
descriptionDescriptionstring[1000]Descriptiontruefalsefalse
digestDigeststring[40]truefalsetrue
display_labelDisplay Labelstring[900]Used as calc attribute for displaytruefalsefalse
MENUxmltruefalsetrue
nameNamestring[900]truefalsefalse
user_labelUser Labelstring[900]Used as user labeltruefalsefalse
Attributes defined for Root
NameDisplay NameTypeDefault ValueDescriptionFactoryKeyHidden
BODY_ICONstringgeneraltruefalsetrue
calculated_idCalculated IDbytes[16]Calculated IDtruefalsetrue
create_timeCreated TimedateWhen was this CI createdtruefalsefalse
FAMILY_ICONstringtruefalsetrue
global_idGlobal Idstring[32]A globally unique identifier for the entity represented by the objecttruefalsefalse
global_id_scopestringDefaulttruefalsetrue
last_discovered_byLastDiscoveredBystring[512]Who discovered this CItruefalsefalse
last_discovered_by_probeLastDiscoveredByProbestringWhich probe discovered this CItruefalsefalse
last_discovered_timeLastDiscoveredTimedateWhen was this CI discoveredtruefalsefalse
last_modified_timeLastModifiedTimedateWhen was this CI last updatedtruefalsefalse
root_actualdeletetimeActual Delete TimedateWhen will this CI be deletedtruefalsetrue
root_actualdeletionperiodActual Deletion Periodinteger40What is the period after the CI will be deletedtruefalsefalse
root_candidatefordeletetimeCandidate For Deletion TimedateWhen will this CI be warned about deletingtruefalsetrue
root_classCI Typestring[100]Class name of the CItruefalsetrue
root_containerContainerstring[32]Container CI of this CItruefalsefalse
root_deletioncandidateperiodDeletion Candidate Periodinteger20What is the period after the CI will be candidate for deletetruefalsefalse
root_enableageingEnable AgingbooleanfalseIs aging enabledtruefalsefalse
root_iconpropertiesstring[100]truefalsetrue
root_iscandidatefordeletionIs Candidate For DeletionbooleanfalseIs candidate for deletiontruefalsefalse
root_lastaccesstimeLast Access TimedateWhen was this CI last accessedtruefalsefalse
root_systemSystemstring[2]truefalsetrue

Valid Relations

Valid direct incoming and outgoing relations defined on KpiObjective

Relations defined for KpiObjective
FromToTypeDescription
KpiObjectiveKpiObjectiveAggregation
KpiKpiObjectiveCompositionRepresents 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
PeriodKpiObjectiveConnection
Relations defined for Managed Object
FromToTypeDescription
Managed ObjectHistory ChangeHistory Link
TenantManaged ObjectConnection

Combined inheritance and relation diagram for KpiObjective

Potential Data Providers

Adapters providing CIs of type Object
Adapter NameDescriptionAdapter Type
ALMAdapterFederate defects from ALMIntegration
AMGenericAdapterThis 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 AdapterThis 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 PopulationAllows defining Reconciliation Priority for API Data In flowsIntegration
Data Push into AtriumPushes CIs and relationships to BMC AtriumIntegration
AutomationFlowAdapterProvide API to Operation OrchestrationIntegration
BSMKpiAdapterFederate KPIs from BSMIntegration
CA CMDBPushes CIs and relationships to CA CMDBIntegration
UCMDB 10.x and laterUsed 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.xUsed for Populating and Federating data from a remote UCMDB 9.x server and for Pushing to a remote UCMDB 9.xIntegration
UCMDB History Adapter [local instance only]Used to federated data from the UCMDB's HistoryIntegration
Push Adapter DB ExamplePush data into Oracle \ MSSQL databaseIntegration
GenericDBAdapterAn example Adapter that uses the GDB-FrameworkIntegration
IAM UI Push AdapterPush IAM Universal Inventory data into MSSQL database on-premises or on cloud-based Azure.Integration
Java_Adapter_TemplateAdapter DescriptionIntegration
Kafka Push Adapter 2019.05Push function for Kafka Push AdapterIntegration
Local State Push AdapterUsed for populating data between the states of the same UCMDB ServerIntegration
Pulsar Push AdapterPush function for Pulsar Push AdapterIntegration
Push AdapterPush AdapterIntegration
Remedyforce Push IntegrationRemedyforce Push IntegrationIntegration
SMA-X Push AdapterThis adapter pushes data from UCMDB to Service Anywhere. Integration
System Center Configuration ManagerUses the GDB-Framework to Populate and Federate data from a System Center Configuration Manager. The adapter is also backward compatible with the SMS DBIntegration
Service Manager 9.41Discovery Pattern DescriptionIntegration
Service Manager 9.xxDiscovery Pattern DescriptionIntegration
Service Manager Enhanced Generic AdapterPush and Populate CI data between UCMDB and Service ManagerIntegration
ServiceNow Enhanced Generic AdapterPush, Populate and Federation of CI data between UCMDB and ServiceNowIntegration
UCMDB to XMLExport data into XML from UCMDBIntegration

© Copyright 2018 Micro Focus or one of its affiliates