Overview
ATTRIBUTES: SUMMARY | DETAIL RELATIONSHIP CLASSES: LOCAL | INHERITED
BMC Atrium CMDB
Data Model

Class BMC.CORE.CONFIG:BMC_FederatedInterface

BMC.CORE.CONFIG:BMC_ConfigBaseElement

  |
  +--BMC.CORE.CONFIG:BMC_FederatedInterface
Direct Known Subclasses:
BMC.CORE.CONFIG:BMC_FederatedDataInterface
Class used to store information about accessing federated data in products outside BMC Atrium CMDB. Each instance provides necessary information for retrieving a specific set of data from a specific product and has two relationships. The federated interface is related to either a configuration item (CI) or a CI class by a BMC_FederatedInterfaceLink relationship and to a federated product by a BMC_FederatedProductLink relationship. This class has no corresponding DMTF CIM class.

Properties

Name Value Scope Options
namespaceName BMC.CORE.CONFIG None None
classId BMC_FEDERATEDINTERFACE None None
FormName BMC.CORE.CONFIG:BMC_FederatedInterface None None
Exposure usedVisible TOSUBCLASS=false OVERRIDABLE=false
Attributes Summary

Data type Name and description
enumeration ARAccessMethod
Attribute that specifies the method used by the APIto access AR System forms. (CI Relationship Viewer uses whichever method makes sense in the context.) When FederationAccessMethod is AR, this attribute is required. Otherwise, it is ignored. Values are Native (0, default) and Web (1). No default value.
character ARFormName
Attribute that specifies the name of the AR System form to access.
character ARQuery
Attribute that specifies the qualification that selectsthe AR System entries to return. When FederationAccessMethod is AR, this attribute is required. Otherwise, it is ignored. Enclose field names in single quotation marks. To give context to this string, you can include any combination of the following keywords: $<Attribute-Name>$ -- Value of any specified attribute of the instance from which this interface is launched in context. $#KEY#$ -- Value of the foreign key on the relationship between the federated product being launched in context and the instance from which it is being launched. $#WEBPATH#$ -- Default Web path for this AR System server. $#CLASSNAME#$ -- Class name of the instance from which this interface is launched in context. $#CLASSNAMESPACE#$ -- Namespace of the class of the instance from which this interface is launched in context. Example: 'ComputerName' = $Name$. This returns entries where the value of the ComputerName field in the external form matches the Name attribute of the instance in context.
character ARServerName
Attribute that specifies the name of the AR System server. When FederationAccessMethod is AR, this attribute is required. Otherwise, it is ignored.
integer ARServerPort
Stores AR Server RPC port for 'remote' launching.
character ARViewName
Attribute that specifies the name of the view of ARFormName to open. When FederationAccessMethod is AR, this attribute is required. Otherwise, it is ignored.
character DataSource
Attribute that specifies the data needed by the integration layer to create SQL views.
enumeration FederationAccessMethod
Attribute that specifies the method used by the API to access federated data. The value you enter in this attribute determines what to enter in the FederationAccessString attribute. Values are AR (0, default), URL (1), Run Process (3), Manual (4), and Data Store (5). Data Store (5) is not supported in this release.
character FederationAccessString
Attribute that specifies information used by the specified FederationAccessMethod to launch federated data. This attribute is required for all access methods other than AR. It can contain a URL to open, a process to run, or manual steps to perform to gain access to the federated instance. You can use all the keywords specified for the ARQuery attribute to give context to this string. A Run Process command should include appropriate parameters and a path if needed. If a path is not specified, make sure the executable to launch is in the system's path. For manual access methods, specify the steps to perform. Example: (1) Locate the box from here, (2) open it like this, (3) set the monitor up, and so on.
enumeration FederationActionType
Attribute that specifies whether the API simply launches the federated product in context to display the appropriate data or launches the product and returns the data. In this release, the only available value is Launch (0).
character FederationProductInstanceId
character FederationProductName
character Name
Attribute that specifies the name of the federated interface. Can be used as a subcategory of the name of the related federated product.
character Result1
Attribute is the character field used to map returned data when the FederationActionType is Launch and Return. Not used in this release.
character Result10
Attribute is the character field used to map returned data when the FederationActionType is Launch and Return. Not used in this release.
character Result2
Attribute is the character field used to map returned data when the FederationActionType is Launch and Return. Not used in this release.
character Result3
Attribute is the character field used to map returned data when the FederationActionType is Launch and Return. Not used in this release.
character Result4
Attribute is the character field used to map returned data when the FederationActionType is Launch and Return. Not used in this release.
character Result5
Attribute is the character field used to map returned data when the FederationActionType is Launch and Return. Not used in this release.
character Result6
Attribute is the character field used to map returned data when the FederationActionType is Launch and Return. Not used in this release.
character Result7
Attribute is the character field used to map returned data when the FederationActionType is Launch and Return. Not used in this release.
character Result8
Attribute is the character field used to map returned data when the FederationActionType is Launch and Return. Not used in this release.
character Result9
Attribute is the character field used to map returned data when the FederationActionType is Launch and Return. Not used in this release.


Attributes inherited from class BMC.CORE.CONFIG:BMC_ConfigBaseElement
AttributeDataSourceList, ClassId, CMDBRowLevelSecurity, CMDBWriteSecurity, CreateDate, InstanceId, LastModifiedBy, MarkAsDeleted, ModifiedDate, RequestId, Submitter

Attribute Detail

ARAccessMethod

enumeration ARAccessMethod
Attribute that specifies the method used by the APIto access AR System forms. (CI Relationship Viewer uses whichever method makes sense in the context.) When FederationAccessMethod is AR, this attribute is required. Otherwise, it is ignored. Values are Native (0, default) and Web (1). No default value.

Name Value Scope Options
FieldId 530003100
None None
attributeId FEDDATA_AR_ACCESS_METHOD
None None
namespaceName BMC.CORE.CONFIG
None None
Required true
None None
ValueMap 0;1
None None
Values Native; Web
None TRANSLATABLE= true

ARFormName

character ARFormName
Attribute that specifies the name of the AR System form to access.

Name Value Scope Options
FieldId 530003300
None None
attributeId FEDDATA_AR_FORM_NAME
None None
namespaceName BMC.CORE.CONFIG
None None
MaxLen 254
None None

ARQuery

character ARQuery
Attribute that specifies the qualification that selectsthe AR System entries to return. When FederationAccessMethod is AR, this attribute is required. Otherwise, it is ignored. Enclose field names in single quotation marks. To give context to this string, you can include any combination of the following keywords: $<Attribute-Name>$ -- Value of any specified attribute of the instance from which this interface is launched in context. $#KEY#$ -- Value of the foreign key on the relationship between the federated product being launched in context and the instance from which it is being launched. $#WEBPATH#$ -- Default Web path for this AR System server. $#CLASSNAME#$ -- Class name of the instance from which this interface is launched in context. $#CLASSNAMESPACE#$ -- Namespace of the class of the instance from which this interface is launched in context. Example: 'ComputerName' = $Name$. This returns entries where the value of the ComputerName field in the external form matches the Name attribute of the instance in context.

Name Value Scope Options
FieldId 530003400
None None
attributeId FEDDATA_AR_QUERY
None None
namespaceName BMC.CORE.CONFIG
None None
MaxLen 0
None None

ARServerName

character ARServerName
Attribute that specifies the name of the AR System server. When FederationAccessMethod is AR, this attribute is required. Otherwise, it is ignored.

Name Value Scope Options
FieldId 530003200
None None
attributeId FEDDATA_AR_SERVER_NAME
None None
namespaceName BMC.CORE.CONFIG
None None
MaxLen 254
None None

ARServerPort

integer ARServerPort
Stores AR Server RPC port for 'remote' launching.

Name Value Scope Options
FieldId 530047701
None None
attributeId OB005056BE6784SK1zSAZnC9gwRocG
None None
namespaceName BMC.CORE.CONFIG
None None

ARViewName

character ARViewName
Attribute that specifies the name of the view of ARFormName to open. When FederationAccessMethod is AR, this attribute is required. Otherwise, it is ignored.

Name Value Scope Options
FieldId 530019600
None None
attributeId FEDDATA_AR_VIEW_NAME
None None
namespaceName BMC.CORE.CONFIG
None None
MaxLen 254
None None

DataSource

character DataSource
Attribute that specifies the data needed by the integration layer to create SQL views.

Name Value Scope Options
FieldId 530003500
None None
attributeId FEDDATA_DATA_SOURCE
None None
namespaceName BMC.CORE.CONFIG
None None
MaxLen 0
None None

FederationAccessMethod

enumeration FederationAccessMethod
Attribute that specifies the method used by the API to access federated data. The value you enter in this attribute determines what to enter in the FederationAccessString attribute. Values are AR (0, default), URL (1), Run Process (3), Manual (4), and Data Store (5). Data Store (5) is not supported in this release.

Name Value Scope Options
FieldId 530002700
None None
attributeId FEDDATA_ACCESS_METHOD
None None
namespaceName BMC.CORE.CONFIG
None None
Required true
None None
ValueMap 0; 1; 3; 4; 5; 6
None None
Values AR; URL; Run Process; Manual; Data Store; Class
None TRANSLATABLE= true

FederationAccessString

character FederationAccessString
Attribute that specifies information used by the specified FederationAccessMethod to launch federated data. This attribute is required for all access methods other than AR. It can contain a URL to open, a process to run, or manual steps to perform to gain access to the federated instance. You can use all the keywords specified for the ARQuery attribute to give context to this string. A Run Process command should include appropriate parameters and a path if needed. If a path is not specified, make sure the executable to launch is in the system's path. For manual access methods, specify the steps to perform. Example: (1) Locate the box from here, (2) open it like this, (3) set the monitor up, and so on.

Name Value Scope Options
FieldId 530003600
None None
attributeId FEDDATA_FED_ACCESS_STRING
None None
namespaceName BMC.CORE.CONFIG
None None
MaxLen 0
None None

FederationActionType

enumeration FederationActionType
Attribute that specifies whether the API simply launches the federated product in context to display the appropriate data or launches the product and returns the data. In this release, the only available value is Launch (0).

Name Value Scope Options
FieldId 530002600
None None
attributeId FEDDATA_ACTION_TYPE
None None
namespaceName BMC.CORE.CONFIG
None None
Required true
None None
ValueMap 0;1
None None
Values Launch; Data
None TRANSLATABLE= true

FederationProductInstanceId

character FederationProductInstanceId

Name Value Scope Options
FieldId 530015800
None None
attributeId FEDDATA_PRODUCT_INSTANCE_ID
None None
namespaceName BMC.CORE.CONFIG
None None
MaxLen 38
None None

FederationProductName

character FederationProductName

Name Value Scope Options
FieldId 530016000
None None
attributeId OB000874CD4B4FAdsTQQmuCJBQyTQA
None None
namespaceName BMC.CORE.CONFIG
None None
MaxLen 255
None None

Name

character Name
Attribute that specifies the name of the federated interface. Can be used as a subcategory of the name of the related federated product.

Name Value Scope Options
FieldId 200000020
None None
attributeId FEDDATA_NAME
None None
namespaceName BMC.CORE.CONFIG
None None
Required true
None None
MaxLen 254
None None

Result1

character Result1
Attribute is the character field used to map returned data when the FederationActionType is Launch and Return. Not used in this release.

Name Value Scope Options
FieldId 530002800
None None
attributeId FEDDATA_RESULT1
None None
namespaceName BMC.CORE.CONFIG
None None
MaxLen 255
None None

Result10

character Result10
Attribute is the character field used to map returned data when the FederationActionType is Launch and Return. Not used in this release.

Name Value Scope Options
FieldId 530003070
None None
attributeId FEDDATA_RESULT10
None None
namespaceName BMC.CORE.CONFIG
None None
MaxLen 255
None None

Result2

character Result2
Attribute is the character field used to map returned data when the FederationActionType is Launch and Return. Not used in this release.

Name Value Scope Options
FieldId 530002900
None None
attributeId FEDDATA_RESULT2
None None
namespaceName BMC.CORE.CONFIG
None None
MaxLen 255
None None

Result3

character Result3
Attribute is the character field used to map returned data when the FederationActionType is Launch and Return. Not used in this release.

Name Value Scope Options
FieldId 530003000
None None
attributeId FEDDATA_RESULT3
None None
namespaceName BMC.CORE.CONFIG
None None
MaxLen 255
None None

Result4

character Result4
Attribute is the character field used to map returned data when the FederationActionType is Launch and Return. Not used in this release.

Name Value Scope Options
FieldId 530003010
None None
attributeId FEDDATA_RESULT4
None None
namespaceName BMC.CORE.CONFIG
None None
MaxLen 255
None None

Result5

character Result5
Attribute is the character field used to map returned data when the FederationActionType is Launch and Return. Not used in this release.

Name Value Scope Options
FieldId 530003020
None None
attributeId FEDDATA_RESULT5
None None
namespaceName BMC.CORE.CONFIG
None None
MaxLen 255
None None

Result6

character Result6
Attribute is the character field used to map returned data when the FederationActionType is Launch and Return. Not used in this release.

Name Value Scope Options
FieldId 530003030
None None
attributeId FEDDATA_RESULT6
None None
namespaceName BMC.CORE.CONFIG
None None
MaxLen 255
None None

Result7

character Result7
Attribute is the character field used to map returned data when the FederationActionType is Launch and Return. Not used in this release.

Name Value Scope Options
FieldId 530003040
None None
attributeId FEDDATA_RESULT7
None None
namespaceName BMC.CORE.CONFIG
None None
MaxLen 255
None None

Result8

character Result8
Attribute is the character field used to map returned data when the FederationActionType is Launch and Return. Not used in this release.

Name Value Scope Options
FieldId 530003050
None None
attributeId FEDDATA_RESULT8
None None
namespaceName BMC.CORE.CONFIG
None None
MaxLen 255
None None

Result9

character Result9
Attribute is the character field used to map returned data when the FederationActionType is Launch and Return. Not used in this release.

Name Value Scope Options
FieldId 530003060
None None
attributeId FEDDATA_RESULT9
None None
namespaceName BMC.CORE.CONFIG
None None
MaxLen 255
None None

Local Relationship Classes

Name Reference CI Class
BMC.CORE.CONFIG:BMC_FederatedInterfaceLink BMC.CORE:BMC_BaseElement
BMC.CORE.CONFIG:BMC_FederatedProductLink BMC.CORE.CONFIG:BMC_FederatedProduct

Inherited Relationship Classes

Name Superclass Reference CI Class
Overview
ATTRIBUTES: SUMMARY | DETAIL RELATIONSHIP CLASSES: LOCAL | INHERITED
BMC Atrium CMDB
Data Model
Copyright 2007 BMC Software, Inc. All rights reserved.