CI Class Location

Inheritance diagram for Location

Summary

Display Name	Location
Name	location
Description	Location of devices and business organizations/people that support a function (i.e. data center, company/client site). Can vary from country to city or low level like building or room. It can be connected to devices and logical CIs representing end users or data center location.

Attributes

Attributes defined for Location
Name	Display Name	Type	Default Value	Description	Factory	Key	Hidden
classification		classification_enum	location		true	false	false
cloud_location_type	CloudLocationType	cloud_location_type_enum		Describes the type of Cloud location. Check the possible values in CloudLocationType enum.	true	false	false
country_or_area	CountryOrArea	string[250]		Represents the country or area name.	true	false	false
extended_street_address	ExtendedStreetAddress	string[250]		Represents the extended street address (of address microformat) of a physical address. Can be for example "Suite 207".	true	false	false
latitude	Latitude	string[250]		Latitude of the geographical location.	true	false	false
layer		layer_enum	facilities		true	false	false
locality	Locality	string[250]		Represents the locality (of address microformat) of a physical address. For example, it can be "San Francisco".	true	false	false
location_bar_code	LocationBarCode	string[250]		Locations that are rooms have a barcode (close to the door usually) that is used to do the inventory. If barcode scanning is not used for doing physical inventory, this attribute will then represent the ID of the room.	true	false	false
location_type	LocationType	location_type_enum		Describes the type of physical location. This is an extensible enumeration with values as Building, Room, Floor, Site...etc.	true	false	false
longitude	Longitude	string[250]		Longitude of the geographical location.	true	false	false
post_office_box	PostOfficeBox	string[250]		Represents the post office box (of address microformat) of a physical address.	true	false	false
postal_code	PostalCode	string[250]		Represents the postal code (of address microformat) of a physical address. For example, it can be "94107".	true	false	false
region	Region	string[250]		Represents the region (of address microformat) of a physical address. For example, it can be "CA" for USA California.	true	false	false
street_address	StreetAddress	string[250]		Represents the street address (of address microformat) of a physical address. For example, can be "665 3rd St."	true	false	false
Attributes defined for ConfigurationItem
Name	Display Name	Type	Default Value	Description	Factory	Key	Hidden
ack_cleared_time		long			true	false	true
ack_id		string[80]			true	false	true
bit_position	Bit Position	integer			true	false	true
bitmap_id	Bitmap ID	integer			true	false	true
BODY_ICON		string	it_world		true	false	true
~~city~~	~~City~~	string[50]		City location	true	false	true
classification		classification_enum			true	false	false
contextmenu	Context Menu	string_list[100]		Context menu	true	false	true
~~country~~	~~Country or Province~~	string[50]		Country or province location	true	false	true
data_tags	Tags	json[4000]		A tag is a label assigned to a resource.Each tag consists of a key and a value.	true	false	false
discovery_state	Discovery State	discovery_state_enum		State of UD discovery	true	false	false
is_save_persistency	Store KPI History For Over Time Reports	boolean	false	Store KPI history for over time reports	true	false	true
layer		layer_enum			true	false	false
metaphase	Meta Phase	string[50]		Meta Phase of a CI in SMAX. The attribute is owned by SMAX exclusively	true	false	false
monitor_state	Monitor State	string[50]		Monitor State of a CI in OpsB. The attribute is owned by OpsB exclusively.	true	false	false
provision_state	Provision State	string[50]		Provision State of a CI in HCMX. The attribute is owned by HCMX exclusively.	true	false	false
sd_type	SD Type	string[32]			true	false	false
~~state~~	~~State~~	string[50]		State location	true	false	true
track_changes	Track Configuration Changes	boolean	false	Track configuration changes	true	false	true
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[300]		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 Location

Relations defined for Location
From	To	Type	Description
Location	Amazon Auto Scaling Group	Containment
Location	Asset	Membership
Location	Amazon DynamoDB Service	Membership
Location	Amazon Lambda Function	Membership
Location	AWS Resource	Containment
Location	Amazon RESTful API	Membership
Location	Amazon SNS Subscription	Membership
Location	Amazon SNS Topic	Membership
Location	Amazon SQS Queue	Membership
Location	Amazon Virtual Private Cloud	Containment
Location	Azure API Management Service	Membership
Location	Azure App Service Environment	Membership
Location	Azure App Service Plan	Membership
Location	Azure Application Gateway	Membership
Location	Azure Automation Account	Containment
Location	Azure Automation Account	Membership
Location	Azure Availability Set	Containment
Location	Azure Availability Set	Membership
Location	Azure Container Registry	Membership
Location	Azure Cosmos DB Account	Containment
Location	Azure Cosmos DB Account	Membership
Location	Azure Data Factory Service	Membership
Location	Azure Data Lake Analytics	Membership
Location	Azure Databricks Workspace	Membership
Location	Azure Enterprise Redis Cache	Membership
Location	Azure Event Hub Namespace	Containment
Location	Azure Event Hub Namespace	Membership
Location	Azure Front Door	Membership
Location	Azure Key Vault	Containment
Location	Azure Key Vault	Membership
Location	Azure Log Analytics workspace	Containment
Location	Azure Log Analytics workspace	Membership
Location	Azure Local Network Gateway	Membership
Location	Azure Logical Server	Membership
Location	Azure MySQL Single Server	Membership
Location	Azure Network Security Group	Containment
Location	Azure Network Security Group	Membership
Location	Azure Onpremise Data Gateway	Membership
Location	Azure PostgreSQL Single Server	Membership
Location	Azure Redis Cache	Membership
Location	Azure Route Table	Membership
Location	Azure Scale Set	Containment
Location	Azure Scale Set	Membership
Location	Azure Traffic Manager Profile	Membership
Location	Azure Web App	Membership
Location	Cloud Service	Membership
Location	ConfigurationItem	Membership
Location	DB2 DB Service	Membership
Location	DB Service	Membership
Location	Disk Storage Service	Membership
Location	Google BigTable Cluster	Membership
Location	Google Cloud Subnet	Containment
Location	Google Dataflow Job	Membership
Location	Kubernetes Cluster	Membership
Location	Kpi	Connection
Location	Load Balancer	Containment
Location	Load Balancer	Membership
Location	Location	Containment
Location	MySQL DB Service	Membership
Location	Network File System Service	Membership
Location	Node	Containment
Location	Node	Membership
Location	Oracle Cloud Storage Volume	Membership
Location	Oracle DB Service	Membership
Location	Party	Membership
Location	PostgreSQL DB Service	Membership
Location	Project	Responsibility
Location	MSSQL DB Service	Membership
Amazon Account	Location	Membership
Azure MySQL Flexible Server	Location	Membership
Azure PostgreSQL Flexible Server	Location	Membership
ItProcessRecord	Location	Membership
MaintenanceContract	Location	Aggregation
Oracle Cloud Account	Location	Membership
Relations defined for ConfigurationItem
From	To	Type	Description
ConfigurationItem	Automation Flow Execution	Includes	This relationship connects two CIs, one of which is included into another. A child CI can be moved to another parent, but when the parent is deleted, the child will be deleted as well, except if a second includes link exist on it already. Moving of a child CI possible by creation of new link to another parent and deletion of the first one.
ConfigurationItem	ConfigurationItem	ConsumerProvider
ConfigurationItem	Kpi	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
ConfigurationItem	Outage	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
ConfigurationItem	PolicyResult	Aggregation
ConfigurationItem	ScheduledDowntime	Connection
ConfigurationItem	ServiceConnectionPoint	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
ConfigurationItem	ServiceConnectionPoint	Ownership
DefectsFilter	ConfigurationItem	Containment
ApplicationSystem	ConfigurationItem	Aggregation
Asset	ConfigurationItem	Connection
CiCollection	ConfigurationItem	Containment
CiCollection	ConfigurationItem	Membership
ItProcessRecord	ConfigurationItem	Connection
ItProcessRecord	ConfigurationItem	Membership
Location	ConfigurationItem	Membership
Tenant	ConfigurationItem	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 Location

Potential Data Providers

Adapters providing CIs of type Location
Adapter Name	Description	Adapter Type
AWS Event Based Discovery	Discovers AWS topologies by using the AWS SDK for Java to access AWS SQS service.	Discovery
AWS Event Based Discovery using Tags	Read AWS messages from local DB using tags as filter and report the changes of AWS resources to UCMDB.	Discovery
AWS Discovery for HCM via API	Discovers AWS topologies of the EC2 services using Web Services	Discovery
AWS by Web Services	Discovers AWS topologies using the Amazon Web Services.	Discovery
AWS by Web Services using Tags	Discovers AWS resources with customized tags	Discovery
Azure Discovery by Tags	This adapter discovers resources on an Azure tenant	Discovery
Azure Discovery by Tenant	This adapter discovers subscriptions, resource groups, virtual machines, networks and storage accounts on an Azure tenant	Discovery
Azure Event Based Discovery	Azure Event Based Discovery	Discovery
Azure by WebServices	This adapter discovers subscriptions, resource groups, virtual machines, networks and storage accounts on an Azure tenant	Discovery
Basic AWS by Web Services	Discovers AWS topologies of the EC2 using Web Services	Discovery
Basic Azure by Webservices	Adapter Description	Discovery
Basic Google Cloud by RESTful API	Discovers Basic Google Cloud topology using RESTful API	Discovery
Google Cloud by RESTful API	Discovers Google Cloud topology using RESTful API	Discovery
Oracle Cloud by REST API	Discovers Oracle Cloud topologies of Oracle cloud infrastructure compute classic, Oracle database cloud service and Oracle mysql cloud service and services using REST API.	Discovery
SQL Discovery Tutorial	Getting Started Guide SQL Discovery Tutorial	Discovery
AWS via AWS Config	Discovers AWS topologies via AWS Config	Discovery
Adapters providing CIs of type ConfigurationItem
Adapter Name	Description	Adapter Type
Import from CSV	Imports data from a CSV file into CMDB using mapping of the CSV file columns to CIT attributes. Mapping is defined by the following parameters: ciType: to define the CIT name which you want to create, mappingString: to define the mapping of the CIT attributes to the CSV file columns. Mapping file is used for more complex mapping definitions. Mapping file name is specified by 'mappingFile' parameter.	Integration
Import from DB	Imports data from an external database into CMDB using mapping of table columns to CIT attributes. Mapping is defined by the following parameters: ciType: to define the CIT name which you want to create, mappingString: to define the mapping of the CIT attributes to the table columns Mapping file is used for more complex mapping definitions. Mapping file name is specified by 'mappingFile' parameter. A SQL 'select' query is generated automatically and selects all columns in specified table, which defined by parameter: tableName In advanced cases you can specify custom SQL query.	Integration
Import from properties file	Imports data from a Properties file into CMDB, using mapping of the CSV file columns to CIT attributes This mapping is usually defined by the setting adapter parameters: ciType: to define the CIT name which you want to create, mappingString: to define the mapping of the Properties attributes to the CSV file columns In cases you need more complex mapping abilities, such as conversion of the strings contained in Properties file to the appropriate type of CMDB object's attribute, you should use the mapping XML configuration file specified by the mappingFile parameter.	Integration
SCCM Installed Software Integration	This adapter queries the records from SCCM database and recognizes it as install software by UD SAI	Integration
Import from Excel Workbook	Imports data from Excel Workbooks. Parses through multiple worksheet XLS files. Uses 'CIImports.xls' (default) file to import data.	Integration
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
UCMDB to SaaS	Used for Pushing CIs and Relationships from an on-premises UCMDB 2019.02(or later) to Micro Focus SaaS CMS	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
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