Component XML Structure

A device component uses XML to define a class of component items that are associated with a device. Many factory-defined components are provided, but a custom component is typically defined for a custom metric family. Components can define an optional ItemSyncDefinition, which synchronizes component items to npc. You can then view the components in Inventory lists, groups, and context pages.
capm350
HID_Component_XML_Structure
A device component uses XML to define a class of component items that are associated with a device. Many factory-defined components are provided, but a custom component is typically defined for a custom metric family. Components can define an optional ItemSyncDefinition, which synchronizes component items to
Performance Center
. You can then view the components in Inventory lists, groups, and context pages.
You must list some properties in the XML in a particular order. The properties included in the XML example and listed in the following descriptions are presented in the recommended order.
2
Example:
This example shows a custom component named frPVC:
If you view the component XML in a browser, certain tags are hidden. For this reason, copy and paste the component XML only from a REST client
<?xml version="1.0" encoding="UTF-8"?>
<!--Auto-generated by the type catalog local manager.-->
<DataModel namespace="http://im.ca.com/inventory" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="ComponentFacet.xsd">
  <Author>Custom</Author>
  <Version>1.0</Version>
  <FacetType name="frPVC">
    <Documentation>A Frame Relay PVC</Documentation>
    <FacetOf namespace="http://im.ca.com/core" name="Item" />
    <Component>true</Component>
    <ItemSyncDefinition itemTypeName="component" itemSubtypeName="frpvc" itemTypeLabel="FrameRelayPVC" itemTypeLabelPlural="FrameRelayPVCs" categorize="false" groupBy="false" context="true">
    </ItemSyncDefinition>
  </FacetType>
</DataModel>
Set the context in the ItemSyncDefinition to “true” to enable a link to a custom context page. You can navigate to this page from the frPVC device component where it appears in the Inventory, Device Components list. Setting it to “true” also enables you to select the metric family as a “context,” which makes your custom metric family available in the Dynamic Trend chart type.
Basic Properties
The basic properties of your custom component help to distinguish it from other custom components that you create.
In the following list, only the documentation property can be updated.
  • FacetType/name
    Specifies the component name. Each component must have a unique name that identifies it internally within the system. Carefully choose a name with a minimal possibility of naming conflicts with future similar components. For example, define a naming scheme that ensures that these component names are unique.
     This name is never exposed externally. To display a component name in the user interface, use the
    ItemSyncDefinition
    ,
    itemTypeLabel
    ,
     
    and
    itemTypeLabelPlural
    elements.
    Possible values:
    Alphanumeric and underscore. Dot and dash are not permitted.
    • Documentation
      Specifies internal comments for the component. To make these comments useful, describe why and when you added or changed the component.
      Possible values:
      Plain text
      Effect of updating:
      None
      When does the update take effect:
      Immediately
      Required Actions for updates to take effect:
      None
       This property and the
      FacetOf
      property must be listed before the
      Component
      and
      ItemSyncDefinition
      properties in the XML.
    • FacetOf
      Asserts that this component is an item.
      Possible values: namespace="http://im.ca.com/core" name="Item"
       This property and the
      Documentation
      property must be listed before the
      Component
      and
      ItemSyncDefinition
      properties in the XML.
    • Component
      Asserts that this item is a component.
      Possible values:
      true
ItemSyncDefinition
The ItemSyncDefinition attribute is optional. This attribute specifies how the component items are synchronized and displayed in CA
Performance Center
. If the component items are not specified, they do not display in the CA
Performance Center
Inventory lists (for example, Device Components). But, they can still be reported on in custom views.
Unless otherwise, there are no required actions for the updates to take effect.
  • ItemSyncDefinition/itemTypeName
    Specifies the item type. For custom components, this value must be “component.”
    Can be updated:
    No
    Possible values:
    Component
  • ItemSyncDefinition/itemSubtypeName
    Specifies the internal name of the component in CA
    Performance Center
    . This value must be unique for all components. Use a naming convention that avoids conflicts with future factory and custom components, such as using a prefix representing your organization, 'acmeFan'.
    Can be updated:
    No
    Possible values:
    Alphanumeric, unique for all components
  • ItemSyncDefinition/itemTypeLabel
    Specifies the user interface label that is used when displaying a single component of this type. For example, this value is used in the Inventory, Device Components UI “Type” column.
    Can be updated:
    Yes
    Possible values:
    Plain text, unique for all components
    Effect of updating:
    Label is displayed in CA
    Performance Center
    Inventory user interfaces.
    When does the update take effect:
    Allow for resync to occur and up to 15 minutes to complete updates.
  • ItemSyncDefinition/itemTypeLabelPlural
    Specifies the user interface label that is used when displaying multiple components of this type. Used by the Inventory menu (see groupBy) and the Group name (see categorize).
    Can be updated:
    Yes
    Possible values:
    Plain text, unique for all components
    Effect of updating:
    Label is displayed in CA
    Performance Center
    Inventory UIs.
    When does the update take effect:
    Allow for resync to occur and up to 15 minutes to complete updates.
  • ItemSyncDefinition/categorize
    Instructs CA
    Performance Center
    to create an inventory group under Inventory, All Items. This group contains all items of this component type. The group is named '
    {itemTypeLabelPlural}'.
    The inventory group that is created cannot be used for reporting dashboards. Instead, this group is for inventory purposes only. If the group is selected for reporting, then no data displays. Other, device-based inventory groups (under Inventory, All Items) can be used for reporting, such as Routers and Servers. However, component-based inventory groups cannot, such as Device Components.
    Can be updated:
    Yes
    Possible values:
    true, false
    Effect of updating:
    Creates or removes an Inventory group in CA
    Performance Center
    . For CA
    Performance Center
    group administrators, on the Manage Groups page, the group is created under Inventory, All Items,
    {itemTypeLabelPlural}
    .
    When does the update take effect:
    Allow for resync to occur and up to 30 minutes to complete updates.
    Required actions for updates to take effect:
    Items typically appear in the group within 30 minutes. If they do not, manually resync the Data Aggregator datasource. Select 'Perform a Full Resynchronization' before clicking the Resync confirmation button.
  • ItemSyncDefinition/groupBy
    Instructs CA
    Performance Center
    to create an inventory menu item (under Inventory) for viewing all items of this component item type. The menu is named "
    {itemTypeLabelPlural}.
    " This attribute also causes the component type show up in the Context Type drop-down list when setting a view context. When false, the components are listed in the Inventory, Device Components table with the type of "
    {itemTypeLabel}
    ." The groupBy property does not create a group (see categorize).
    Can be updated:
    Yes
    Possible values:
    true, false
    Effect of updating:
    The menu item is created when true, or removed when false.
    When does the update take effect:
    Allow for resynchronization to occur and allow up to 15 minutes to complete updates.
  • ItemSyncDefinition
    /
    context
    Makes each component item name a context hyperlink in the Inventory component views that, when clicked, navigate to the individual component context page.
    Can be updated:
    Yes/No
    Possible values:
    Plain text
    Effect of updating:
    Makes each component item name a context hyperlink in the Inventory component views.
    When does the update take effect:
    Allow for resynchronization to occur and allow up to 15 minutes to complete updates.
Remove an ItemSyncDefinition
Completely removing an ItemSyncDefinition requires a specific procedure.
Follow these steps:
  1. Remove the ItemSyncDefinition section, including the <ItemSyncDefinition> start and end tags.
  2. After you apply the component change to Data Aggregator, log in to CA
    Performance Center
    as the administrator.
  3. Select the DataAggregator
    datasource on the Data Sources page.
  4. Click the Resync
    button.
  5. Check the “Perform a Full Resynchronization” option, then click the Resync confirmation button.
    The resync process begins. Allow between 15-30 minutes for the changes to synchronize.
    When this process completes, all CA
    Performance Center
    behaviors that the ItemSyncDefinition defined for the component are removed.
Unsupported Properties for Custom Components
The following properties are
not
supported for custom components and should not be present in your XML:
  • Attribute
  • WebService
  • ItemSyncDefinition/isDeviceComponent
  • ItemSyncDefinition/mapped
  • ItemSyncDefinition/ItemProperty