Synchronize Universes with Domains

As an administrator of a large environment with multiple users, you can define users, groups, and permissions in the domains.xml file. Team Center can then automatically create read-only universes for the domains, and synchronize the domain information. These universes are named domain universes and appear in the list of universes. The default SuperDomain universe is the top-level domain universe that propagates user permissions and filter settings down to other domain universes.
apmdevops106
As an administrator of a large environment with multiple users, you can define users, groups, and permissions in the
domains.xml
file. Team Center can then automatically create read-only universes for the domains, and synchronize the domain information. These universes are named domain universes and appear in the list of universes. The default
SuperDomai
n
universe is the top-level domain universe that propagates user permissions and filter settings down to other domain universes.
Use domains to partition agents and monitoring logic for a specific set of APM users. Universes in Team Center let you organize components from your application environment into easy-to-use groups. You then assign users or groups of users access to the universes. To access a specific area of your application environment, select a universe from the drop-down list of universes. For more information about universes, see Configure Universes.
You cannot modify domain universes in Team Center because the
domains.xml
file is the single point of data entry. Modify the user and filter options in the
domains.xml
file.
2
Configure Domain Universe Synchronization
Configure Team Center to create domain universes for domains that are defined in the
domains.xml
file. Automatic synchronization then transfers filter settings and access rights from the
domains.xml
file to the domain universes in Team Center.
  • For Enterprise Team Center (ETC), configure the Domain Universe Synchronization on the master EM.
  • The domain universe properties can be overwritten by the
    domains.xml
    file.
  • The domain universes configuration does not require a restart of the Enterprise Manager.
  • If you disable the domain universes configuration, the domain universes automatically disappear from Team Center.
Follow these steps:
  1. Go to the
    <EM_Home>\config
    directory.
  2. In the
    IntroscopeEnterpriseManager.properties
    file for the MOM, configure the following domain universe properties as needed:
    • introscope.apmserver.domainuniverses.enable
      Enables the EM to create domain universes automatically. Set the value to true to enable the creation of domain universes.
      Default:
      false
    • introscope.enterprisemanager.domainsconfiguration.dynamicupdate.enable
      Enables synchronization. Set the value to
      true
      to enable synchronization.
      Default:
      false
    • introscope.enterprisemanager.domainsconfiguration.dynamicupdate.detectioninterval
      Defines the frequency with which the
      domains.xml
      file is checked and updated in Team Center.
      Default:
      1 minute
    • introscope.apmserver.domainuniverses.followtransactionpath
      Shows components on the map that are upstream from the filtered components. Set the value to
      true
      to include the upstream components.
      This setting corresponds to the
      FOLLOW TRANSACTION PATH
      option in the Team Center filter settings. For more information about filter settings, see Identify Areas of Concern Using Filters.
      Default:
      false
    • introscope.apmserver.domainuniverses.includestartpoint
      Shows the component on the map from which the transaction was initiated. Set the value to
      true
      to include the initial component.
      This setting corresponds to the
      INCLUDE EXPERIENCE NODE
      option in the Team Center filter settings. For more information about filter settings, see Identify Areas of Concern Using Filters.
      Default:
      false
    • introscope.apmserver.domainuniverses.customname
      Defines the domain universe name. Team Center replaces
      {0}
      with the domain name.
      Default:
      {0} domain
      Universes are sorted alphabetically in the universe list. You can group domain universes in your list of universes by applying a prefix, for example,
      domain: {0}.
  3. Save the file.
Disable Domain Universe Creation
To disable domain universe creation, edit the
universe
element in the
domain.xml
file.
You cannot modify the filters or assigned users in the
SuperDomain
and domain universes in Team Center. You can only rename these universes and modify the users in the domains.xml file.
Follow these steps:
  1. Go to the
    <EM_Home>\config
    directory.
  2. In the
    domains.xml
    file, edit the
    universe
    element under an existing domain or superdomain. Set a value for the following parameter:
    • create
      Controls the creation of domain universes. Set the value to false to disable domain universe creation.
      Default:
      true
      Example:
      <?xml version="1.0" encoding="UTF-8"?>
      <domains xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="domains0.3.xsd" version="0.3">
      <domain description="WebLogic Domain" name="WebLogic">
      <agent mapping="(.*)\|WebLogic-(.*)\|(.*)"/>
      <grant permission="full" user="WLAdmin"/>
      <universe create="false"/>
      </domain>
      <SuperDomain>
      <agent mapping="(.*)"/>
      <grant permission="full" user="introscopeldapuser"/>
      <grant permission="full" user="Admin"/>
      <grant permission="full" user="soiadmin"/>
      <grant permission="read" user="Guest"/>
      </SuperDomain>
      </domains>
  3. Save the file.
    The changes appear in Team Center at the beginning of the next detection interval.
  4. Log out from Team Center to refresh the list of universes. New domain universes appear in Team Center when you log back in.
  5. (Optional) Open the
    IntroscopeEnterpriseManager.log
    file from the
    <EM_Home>\logs
    directory to confirm that the data loaded correctly. For example, the following log report shows a finished update:
    4/25/18 01:29:07.707 PM CEST [INFO] [TimerBean] [Manager.Domain] Permissions file changed. Reloaded permissions from C:\automation\deployed\em\.\config\domains.xml
    4/25/18 01:29:07.709 PM CEST [INFO] [TimerBean] [Manager.AppMap] Synchronization of Universes from Domains started.
    4/25/18 01:29:07.740 PM CEST [INFO] [TimerBean] [Manager.AppMap] An update of permissions started.
    4/25/18 01:29:07.752 PM CEST [INFO] [TimerBean] [Manager.AppMap] Synchronization of Universes from Domains finished.
Troubleshooting
Symptom:
The
IntroscopeEnterpriseManager.log
file displays an error that indicates a domains-related attribute value contains an invalid character:
4/25/18 01:26:07.432 PM CEST [INFO] [TimerBean] [Manager] Detected hot config change to C:\automation\deployed\em\.\config\IntroscopeEnterpriseManager.properties
4/25/18 01:26:07.622 PM CEST [ERROR] [TimerBean] [Manager.Domain] XML Problem while parsing at line 5 and column 10: The value of attribute "mapping" associated with an element type "agent" must not contain the '<' character.
Solution:
Check the
domains.xml
file for syntax errors.