Topology Synchronization Rules

The filter and mapping rules that process the discovered data are gathered in a synchronization package. You can apply multiple synchronization packages to the topology data discovered by a topology policy.

Topology Synchronization Packages

A synchronization package consists of the following files:

  • package.xml. The package descriptor file defines the name of the synchronization package and contains a description and the priority level. The priority level determines the order in which synchronization packages are applied.

  • contextmapping.xml. The context mapping file defines the filter that is applied to the discovered data. Filtering involves assigning a context to those CIs you want to process and send to OMi. Configuring the context enables you to apply mapping rules selectively to CIs of the same context.

  • typemapping.xml. The type mapping file defines the mapping from the type of a discovered CI to the type of a CI in OMi.

  • attributemapping.xml. The attribute mapping file defines the mapping between the attributes of a discovered CI and the attributes of a CI in OMi.

    Attribute mapping enables you to change CI attributes and add new attributes to better describe a CI and create a more detailed view of the environment.

  • relationmapping.xml. Using the relation mapping file, you can define the CI relationships created in OMi between specified discovered CIs.

    Make sure that the specified discovered CIs are created as CIs in the RTSM. Otherwise it is not possible for topology synchronization to create a relationship in the RTSM.

Synchronization packages must be uploaded to the OMi system. See Uploading the Sync Package to the OMi server.

Package Descriptor File: package.xml

A topology synchronization package must include the package descriptor file (package.xml). The package.xml file defines a topology synchronization package and includes:

  • <Name> The name of the package must be the same as the name of the subdirectory in which you place the synchronization package:

    %topaz_home%\conf\opr\topology-sync\sync-packages\

  • <Description> Description of the package.

  • <Priority> Priority level of the package.

    The highest priority is represented by 1. The default synchronization package is assigned the lowest priority of 10. A higher priority rule result overwrites a result from a lower priority rule.

    There may be more than one synchronization package with the same priority. The order of execution of the rules between synchronization packages with the same priority is not specified.

Example:

<?xml version="1.0" encoding="utf-8"?>
<Package xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
         xsi:noNamespaceSchemaLocation="Schemas/Package.xsd">
   <Name>mysyncpkg</Name>
   <Description>Integrate My Topology in  OMi</Description>
   <Priority>5</Priority>
</Package>

Context Mapping (Filtering): contextmapping.xml

The context mapping file assigns a context to CIs that match specified conditions. Operations Connector synchronizes all the CIs that you map to any context, and ignores all other CIs.

In the following example, the context myTopology is assigned to all discovered CIs that have the attribute myAttribute with a value of myAttributeValue.

Example:

<?xml version="1.0" encoding="utf-8"?>
<Mapping xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"          xsi:noNamespaceSchemaLocation="Schemas/Mapping.xsd"> <Rules> <Rule name="Filter my discovered CIs"> <Condition>
<Equals>
<OMAttribute>myAttribute</OMAttribute>
<Value>myAttributeValue</Value>
</Equals>
</Condition>
 <MapTo>
<Context>myTopology</Context>
</MapTo>
</Rule>   </Rules> </Mapping>

Type Mapping File: typemapping.xml

The type mapping file maps the type of a discovered CI to the type of a CI in OMi.

In the following example, the CIs with the context myTopology that have the attribute myType with a value of myTypeValue are mapped to the CI type myCIType in OMi.

Example:

<?xml version="1.0" encoding="utf-8"?>
<Mapping xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"          xsi:noNamespaceSchemaLocation="Schemas/Mapping.xsd">
  <Rules Context="myTopology">
    <Rule name="Map myTypeValue to myCIType">
<Condition>
        <Equals>
          <OMAttribute>myType</OMAttribute>
          <Value>myTypeValue</Value>
        </Equals>
</Condition>
      <MapTo>
        <CMDBType>
          <Value>myCIType</Value>
        </CMDBType>
      </MapTo>
    </Rule>   </Rules> </Mapping>

Attribute Mapping File: attributemapping.xml

The attribute mapping file maps the attributes of a discovered CI to the attributes of a CI in OMi.

In the following example, for the CIs with the context myTopology that have the attribute myAttribute with a value of myAttributeValue, the attribute title is mapped to the CI attribute name in OMi.

Example:

<?xml version="1.0" encoding="utf-8"?>
<Mapping xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"              xsi:noNamespaceSchemaLocation="Schemas/Mapping.xsd">
<Rules Context="myTopology">
<Rule name="Map my attributes to RTSM CI attributes">
<Condition>
<Equals>
<OMAttribute>myAttribute</OMAttribute>
<Value>myAttributeValue</Value>
</Equals>
</Condition>
 <MapTo>
        <CMDBAttribute>
          <Name>name</Name>
          <SetValue>
            <OMAttribute>title</OMAttribute>
          </SetValue>
        </CMDBAttribute>
      </MapTo>
    </Rule>   </Rules> </Mapping>

Relation Mapping File: relationmapping.xml

Using the relation mapping file, you can create CI relationships in OMi between specified discovered CIs.

In the following example, for CIs with the context myTopology, the CI myAttributeValue1 creates a contains relationship to CIs that have the attribute myAttribute1 with a value of myAttributeValuew or myAttributeValuey.

Example:

<?xml version="1.0" encoding="utf-8"?>
<Mapping xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"          xsi:noNamespaceSchemaLocation="Schemas/Mapping.xsd">
  <Rules Context="myTopology">
    <Rule name="Create relation from myAttributeValuew to myAttributeValue (root)">
      <Condition>
        <Equals>
          <OMAttribute>myAttribute1</OMAttribute>
          <Value>myAttributeValuew</Value>
        </Equals>
      </Condition>
      <MapTo>
        <RootContainer>
          <DependentCI relationType="contains">
            <Equals>
              <OMAttribute>myAttribute</OMAttribute>
              <Value>myAttributeValue</Value>
            </Equals>
          </DependentCI>
        </RootContainer>
      </MapTo>
    </Rule>     <Rule name="Create relation from myAttributeValuey to myAttributeValue (root)">
      <Condition>
        <Equals>
          <OMAttribute>myAttribute1</OMAttribute>
          <Value>myAttributeValuey</Value>
        </Equals>
      </Condition>
      <MapTo>
        <RootContainer>
          <DependentCI relationType="contains">
            <Equals>
              <OMAttribute>myAttribute1</OMAttribute>
              <Value>myAttributeValue1</Value>
            </Equals>
          </DependentCI>
        </RootContainer>
      </MapTo>
    </Rule>   </Rules> </Mapping>