Overview
ATTRIBUTE: SUMMARY \| DETAIL	RELATIONSHIP: BASE \| INHERITED

CMDB Common
Data Model

Class BMC_FederatedInterface

BMC_ConfigBaseElement

  |
  +--BMC_FederatedInterface

Direct Known Subclasses:: None.

The BMC_FederatedInterface class stores 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.

Name	Value	Scope	Options
`Name_Space`	BMC.CORE.CONFIG	None	None

Attribute Summary
`integer`	`ARAccessMethod` Method used by the API to 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` Name of the AR System form to access.
`character`	`ARQuery` Qualification that selects the 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` Name of the AR System server. When FederationAccessMethod is AR, this attribute is required. Otherwise, it is ignored.
`character`	`ARViewName` Name of the view of ARFormName to open. When FederationAccessMethod is AR, this attribute is required. Otherwise, it is ignored.
`character`	`DataSource` Data needed by the integration layer to create SQL views.
`integer`	`FederationAccessMethod` 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` 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.
`integer`	`FederationActionType` Attribute that indicates 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`	`Name` Name of the federated interface. Can be used as a subcategory of the name of the related federated product.
`character`	`Result1` Character field used to map returned data when the FederationActionType is Launch and Return. Not used in this release.
`character`	`Result10` Character field used to map returned data when the FederationActionType is Launch and Return. Not used in this release.
`character`	`Result2` Character field used to map returned data when the FederationActionType is Launch and Return. Not used in this release.
`character`	`Result3` Character field used to map returned data when the FederationActionType is Launch and Return. Not used in this release.
`character`	`Result4` Character field used to map returned data when the FederationActionType is Launch and Return. Not used in this release.
`character`	`Result5` Character field used to map returned data when the FederationActionType is Launch and Return. Not used in this release.
`character`	`Result6` Character field used to map returned data when the FederationActionType is Launch and Return. Not used in this release.
`character`	`Result7` Character field used to map returned data when the FederationActionType is Launch and Return. Not used in this release.
`character`	`Result8` Character field used to map returned data when the FederationActionType is Launch and Return. Not used in this release.
`character`	`Result9` Character field used to map returned data when the FederationActionType is Launch and Return. Not used in this release.

Attributes inherited from class BMC_ConfigBaseElement

AccountID, AssignedTo, AttributeDataSourceList, ClassId, CMDBRowLevelSecurity, CMDBWriteSecurity, CompareActionCode, CreateDate, DatasetId, deleted, DeleteInstanceTrigger, FailedAutomaticIdentification, InstanceId, LastModifiedBy, LastREJobrunId, MarkAsDeleted, ModifiedDate, OpIdWeakReference, ReconciliationIdentity, RelLeadClassId, RelLeadInstanceId, RequestId, ShortDescription, Status, Submitter, TmpOpOriginationForm

Attribute Detail

ARAccessMethod

integer ARAccessMethod

Method used by the API to 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
`Name_Space`	BMC.CORE.CONFIG	None	None
`Required`	true	None	None
`ValueMap`	0, 1	None	None
`Values`	Native, Web	None	TRANSLATABLE= true

ARFormName

character ARFormName

Name of the AR System form to access.

Name	Value	Scope	Options
`FieldId`	530003300	None	None
`MaxLen`	254	None	None
`Name_Space`	BMC.CORE.CONFIG	None	None

ARQuery

character ARQuery

Qualification that selects the 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
`Name_Space`	BMC.CORE.CONFIG	None	None

ARServerName

character ARServerName

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
`MaxLen`	254	None	None
`Name_Space`	BMC.CORE.CONFIG	None	None

ARViewName

character ARViewName

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
`MaxLen`	254	None	None
`Name_Space`	BMC.CORE.CONFIG	None	None

DataSource

character DataSource

Data needed by the integration layer to create SQL views.

Name	Value	Scope	Options
`FieldId`	530003500	None	None
`Name_Space`	BMC.CORE.CONFIG	None	None

FederationAccessMethod

integer FederationAccessMethod

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
`Name_Space`	BMC.CORE.CONFIG	None	None
`Required`	true	None	None
`ValueMap`	0, 1, 3, 4, 5	None	None
`Values`	AR, URL, Run Process, Manual, Data Store	None	TRANSLATABLE= true

FederationAccessString

character FederationAccessString

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
`Name_Space`	BMC.CORE.CONFIG	None	None

FederationActionType

integer FederationActionType

Attribute that indicates 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
`Name_Space`	BMC.CORE.CONFIG	None	None
`Required`	true	None	None
`ValueMap`	0	None	None
`Values`	Launch	None	TRANSLATABLE= true

Name

character Name

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
`MaxLen`	80	None	None
`Name_Space`	BMC.CORE.CONFIG	None	None
`Required`	true	None	None