Structure XML des composants

Un composant d'unité utilise une entrée XML pour définir une classe d'éléments de composant associés à une unité. Plusieurs composants prédéfinis sont fournis, mais un composant personnalisé est généralement défini pour une famille de mesures personnalisée. Les composants peuvent définir un élément ItemSyncDefinition facultatif, qui synchronise les éléments de composant dans CA npc. Vous pouvez afficher les composants dans des listes d'inventaire, des groupes et des pages de contexte.
capm280
HID_Component_XML_Structure
Un composant d'unité utilise une entrée XML pour définir une classe d'éléments de composant associés à une unité. Plusieurs composants prédéfinis sont fournis, mais un composant personnalisé est généralement défini pour une famille de mesures personnalisée. Les composants peuvent définir un élément ItemSyncDefinition facultatif, qui synchronise les éléments de composant dans CA
NetOps Portal
. Vous pouvez afficher les composants dans des listes d'inventaire, des groupes et des pages de contexte.
Vous devez répertorier des propriétés dans le fichier XML dans un ordre particulier. Les propriétés incluses dans l'exemple XML et répertoriées dans les descriptions suivantes sont présentées dans l'ordre recommandé.
2
Exemple :
Cet exemple présente un composant personnalisé nommé frPVC :
Certaines balises sont masquées lorsque vous affichez le fichier XML de composants dans un navigateur. C'est pourquoi vous devez copier et coller ce fichier uniquement à partir d'un client REST.
<?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>
Définissez le contexte dans l'élément ItemSyncDefinition sur True pour activer un lien vers une page de contexte personnalisée. Vous pouvez accéder à cette page à partir du composant d'unité frPVC qui s'affiche dans la liste d'inventaire Composants d'unité. Définir cet élément sur True vous permet également de sélectionner la famille de mesures en tant que contexte, ce qui rend votre famille de mesures personnalisée disponible dans le graphique de type Vue de tendance dynamique.
Propriétés de base
Les propriétés de base de votre composant personnalisé permettent de le distinguer des autres composants personnalisés que vous avez créés.
Dans la liste suivante, seule la propriété de documentation peut être mise à jour.
  • FacetType/name
    Spécifie le nom du composant. Chaque composant doit être associé à un nom unique qui l'identifie dans le système. Choisissez un nom significatif peu susceptible d'entraîner des conflits avec les noms des futurs composants similaires. Par exemple, définissez un schéma d'attribution des noms qui garantit que les noms de composant sont uniques.
    Ce nom est uniquement affiché en interne. Pour afficher un nom de composant dans l'interface utilisateur, utilisez les éléments
    ItemSyncDefinition
    ,
    itemTypeLabel
    et
    itemTypeLabelPlural
    .
    Valeurs possibles :
    valeurs alphanumériques et trait de soulignement. Les points et les traits d'union ne sont pas permis.
    • Documentation
      Commentaires internes pour le composant. Pour que ces commentaires soient utiles, décrivez le moment et les circonstances de l'ajout ou de la modification du composant.
      Valeurs possibles
      : texte brut
      Effet de la mise à jour :
      aucun
      Application de la mise à jour
      : immédiate
      Actions requises pour l'application des mises à jour
      : aucune
      Cette propriété doit apparaître en premier sous
      FacetType/Name
      . Cette propriété et la propriété
      FacetOf
      doivent être répertoriées avant les propriétés
      Component
      et
      ItemSyncDefinition
      dans le fichier XML.
    • FacetOf
      Confirme que le composant est un élément.
      Valeurs possibles : namespace="http://im.ca.com/core" name="Item"
      Cette propriété et la propriété
      Documentation
      doivent être répertoriées avant les propriétés
      Component
      et
      ItemSyncDefinition
      dans le fichier XML.
    • Composant
      Confirme que l'élément est un composant.
      Valeurs possibles
      : true
ItemSyncDefinition
L'attribut ItemSyncDefinition est facultatif. Cet attribut spécifie la méthode de synchronisation et d'affichage des éléments de composant dans CA
NetOps Portal
. Si les éléments de composant ne sont pas spécifiés, ils ne s'affichent pas dans les listes d'inventaire de CA
NetOps Portal
(par exemple, composants d'unité). Toutefois, vous pouvez les utiliser dans les vues personnalisées.
Sauf exception, aucune action n'est requise pour que les mises à jour prennent effet.
  • ItemSyncDefinition/itemTypeName
    Spécifie le type d'élément. Pour les composants personnalisés, cette valeur doit être component.
    Mise à jour possible
    : non
    Valeurs possibles
    : component
  • ItemSyncDefinition/itemSubtypeName
    Nom interne du composant dans
    NetOps Portal
    . Cette valeur doit être unique pour tous les composants. Utilisez une convention d'attribution de nom qui évite les conflits entre les futurs composants prédéfinis et personnalisés : préfixe représentant votre organisation (acmeFan), etc.
    Mise à jour possible
    : non
    Valeurs possibles
    : valeurs alphanumériques uniques pour tous les composants
  • ItemSyncDefinition/itemTypeLabel
    Spécifie l'étiquette d'interface utilisateur utilisée lors de l'affichage d'un seul composant de ce type. Par exemple, cette valeur est utilisée dans la colonne Type de la liste d'inventaire des interfaces utilisateur des composants d'unité.
    Mise à jour possible
    : oui
    Valeurs possibles
    : texte brut unique pour tous les composants
    Effet de la mise à jour
    : affichage de l'étiquette dans les interfaces utilisateur d'inventaire de CA
    NetOps Portal
    .
    Application de la mise à jour
    : resynchronisation et délai de 15 minutes pour l'application des mises à jour
  • ItemSyncDefinition/itemTypeLabelPlural
    Spécifie l'étiquette d'interface utilisateur utilisée lors de l'affichage de plusieurs composants de ce type. Utilisé par le menu Inventaire (voir groupBy) et le nom de groupe (voir categorize).
    Mise à jour possible
    : oui
    Valeurs possibles
    : texte brut unique pour tous les composants
    Effet de la mise à jour
    : affichage de l'étiquette dans les interfaces utilisateur d'inventaire de CA
    NetOps Portal
    Application de la mise à jour
    : resynchronisation et délai de 15 minutes pour l'application des mises à jour
  • ItemSyncDefinition/categorize
    Indique à CA
    NetOps Portal
    de créer un groupe d'inventaires sous Inventaire, Tous les éléments. Ce groupe contient tous les éléments de ce type de composant. Le groupe est nommé
    {itemTypeLabelPlural}
    .
    Vous ne pouvez pas utiliser le groupe d'inventaires créé pour les tableaux de bord de génération de rapports. Ce groupe est réservé à des fins d'inventaire uniquement. Si le groupe est sélectionné pour la génération de rapports, aucune donnée ne s'affiche. Vous pouvez utiliser d'autres groupes d'inventaires basés sur une unité (sous Inventaire, Tous les éléments) pour la génération de rapports : Routeurs, Serveurs, etc. Toutefois, vous ne pouvez pas utiliser les groupes d'inventaires basés sur un composant, tels que Composants d'unité, dans ce but.
    Mise à jour possible
    : oui
    Valeurs possibles
    : true, false
    Effet de la mise à jour
    : création ou suppression d'un groupe d'inventaire dans CA
    NetOps Portal
    . Pour les administrateurs de groupes CA
    NetOps Portal
    , le groupe est créé sous Inventaire, Tous les éléments,
    {itemTypeLabelPlural}
    sur la page Gérer les groupes.
    Application de la mise à jour
    : resynchronisation et délai de 30 minutes pour l'application des mises à jour
    Actions requises pour l'application des mises à jour
    : en général, les éléments sont affichés dans le groupe dans les 30 minutes. Dans le cas contraire, resynchronisez manuellement la source de données du Data Aggregator. Sélectionnez l'option Effectuer une resynchronisation complète avant de cliquer sur le bouton de confirmation Resynchroniser.
  • ItemSyncDefinition/groupBy
    Indique à CA
    NetOps Portal
    de créer un élément de menu d'inventaire (sous Inventaire) pour afficher tous les éléments de ce type d'élément de composant. Le groupe est nommé
    {itemTypeLabelPlural}
    . Cet attribut permet également d'afficher le type de composant dans la liste déroulante Type de contexte lorsque vous définissez un contexte de vue. Lorsque la valeur est false (faux), les composants sont répertoriés dans la table Inventaire, Composants d'unité avec le type
    {itemTypeLabel}
    . La propriété groupBy ne crée pas de groupe (voir categorize).
    Mise à jour possible
    : oui
    Valeurs possibles
    : true, false
    Effet de la mise à jour :
    création de l'élément de menu lorsque la valeur est True ou suppression de l'élément lorsque la valeur est False
    Application de la mise à jour
    : resynchronisation et délai de 15 minutes pour l'application des mises à jour
  • ItemSyncDefinition
    /
    context
    Permet de convertir chaque nom d'élément de composant en un lien hypertexte de contexte dans les vues de composant d'inventaire qui, lorsque vous le cliquez, renvoie à la page de contexte de composant.
    Mise à jour possible
    : oui/non
    Valeurs possibles
    : texte brut
    Effet de la mise à jour :
    conversion de chaque nom d'élément de composant en un lien hypertexte de contexte dans les vues de composant d'inventaire
    Application de la mise à jour
    : resynchronisation et délai de 15 minutes pour l'application des mises à jour
Suppression d'une section ItemSyncDefinition
Pour supprimer complètement une section ItemSyncDefinition, vous devez suivre une procédure spécifique.
Procédez comme suit :
  1. Supprimez la section ItemSyncDefinition, y compris les balises de début et de fin <ItemSyncDefinition>.
  2. Une fois la modification de composant appliquée au Data Aggregator, connectez-vous en tant qu'administrateur à CA
    NetOps Portal
    .
  3. Dans la page Sources de données, sélectionnez la source de données du Data Aggregator
    .
  4. Cliquez sur
    Resynchroniser
    .
  5. Sélectionnez l'option Effectuer une resynchronisation complète, puis cliquez sur le bouton de confirmation Resynchroniser.
    Le processus de resynchronisation démarre. La synchronisation des modifications peut durer entre 15 et 30 minutes.
    A l'issue du processus, tous les comportements de CA
    NetOps Portal
    définis pour le composant par l'élément ItemSyncDefinition sont supprimés.
Propriétés non prises en charge par les composants personnalisés
Les propriétés suivantes ne sont
pas
prises en charge pour les composants personnalisés et ne doivent pas être présentes dans votre fichier XML :
  • Attribute
  • WebService
  • ItemSyncDefinition/isDeviceComponent
  • ItemSyncDefinition/mapped
  • ItemSyncDefinition/ItemProperty