Installing and Configuring Automated Metadata Harvesting (AMH)

The AMH utility is one of the components in the erwin Data Modeler (DM) installer. Installing AMH installs erwinDG Queue Service and erwinDG DM Service on your environment. Also, the installation creates a Config folder at C:\Program Files\erwin\Data Modeler r9\, which contains the following:

  1. AMHSettings.cfg: Stores AMH services-related configuration. For more information, read the AMHSettings.cfg File topic.
  2. Mart.cfg: Stores erwin Mart-related configuration
  3. Platform.cfg: Stores erwin Data Governance (DG) platform-related configuration
  4. MartWP.cfg: Stores erwin Mart Web Portal-related configuration
  5. Databases.csv: Stores database connectivity-related configuration, used for reverse engineering
    Note: Table Owner, Mart Folder, RE Option Set, and Model Target and Use DBA Views are handled by the DG Server instead of Databases.csv. Also, Table Owner and Mart Folder's size limit is 255.
  6. REOptionSet folder: Contains three reverse engineering option sets for each database; custom, all, and default

Note: At a later point in time, if you wish to change the settings or update any of the above files manually, for the changes to take effect, run the following commands in Windows command line utility (in erwin home directory, with administrator privileges) and then restart AMH Windows services (erwinDG Queue Service and erwinDG DM Service):

  • AMHSettings.cfg: erwinDMAPI.exe -Settings
  • Mart.cfg / Platform.cfg / Databases.csv: erwinDMAPI.exe -encrypt

Other than the above files and folders, another file, DM_AMH_Trace.log, is created at C:\Program Files\erwin\Data Modeler r9\Logs. This file logs information about the actions performed by AMH.

Follow these steps to install AMH on your environment:

  1. On the erwin DM installer, select Automated Metadata Harvesting and click Next.

    InstallShieldAMH

  2. Enter values for erwin Mart Server settings and click Next.

    InstallShieldMartSettings

    Field descriptions:

    • Server Name: Indicates the name of the web server where you have installed erwin Mart. The default value is localhost.
      Note: Do not use an IP address as server name to avoid the naked domain problem.
    • Port: Indicates the port number to access the web server. The default value is 18170.
    • Use SSL (https): Indicates whether you want to connect to the mart through a secured connection. By default, this check box is not selected.
    • IIS Port: Indicates the IIS port number. The default value is set to 80.
    • Use IIS: Indicates whether you want to use IIS to connect to the Mart. By default, this check box is not selected.
    • User Name: Indicates your erwin Mart user name.
    • Password: Indicates your password to connect to erwin Mart.

    The settings you make here are saved to a configuration file, Mart.cfg, at C:\Program Files\erwin\Data Modeler r9\Config.

  3. Enter values for erwin DG platform settings and click Next.

    InstallShieldPlatformSettings

    Field descriptions:

    • Server Name: Indicates the name of the web server of the erwin DG platform. This format is <client Name>.<web server>. For example, erwin-poc-amh.myerwin.io. By default, the web server is set to myerwin.io. Client Name indicates the name of client page for each customer. For example, erwin-poc-amh.
    • Port: Indicates the port number to access the web server. The default value is 443.
    • Use SSL (https): Indicates whether you want to connect to the erwin DG platform through a secured connection. By default, this check box is selected.
    • User Name: Indicates your erwin DG platform user name.
    • Password: Indicates your password to connect to erwin DG platform.

    The settings you make here are saved to a configuration file, Platform.cfg, at C:\Program Files\erwin\Data Modeler r9\Config.

  4. Enter values for erwin Mart Web Portal settings and click Next.

    InstallShieldMartWebPortalSettings

    Field descriptions:

    • Server Name: Indicates the machine name of the Web Portal server running on the machine. By default, it is set to localhost.
    • Version: Indicates the Web Portal server's version. By default, it is set to 2018 R1.
    • Port: Indicates the port number to access the web portal. The default value is 11680.
    • Use SSL (https): Indicates whether you want to connect to the erwin Mart Web Portal through a secured connection. By default, this check box is not selected.
    • Published Configuration Name: Indicates the name of the folder under which models should be published on the Web Portal.

    The settings you make here are saved to a configuration file, MartWP.cfg, at C:\Program Files\erwin\Data Modeler r9\Config.

  5. Click Next and then click Install. AMH (ErwinDG Queue Service and ErwinDG DM Service) will be installed on your environment.

    Services

    Also, a Databases.csv file that contains all the information that you need for reverse engineering is created at C:\Program Files\erwin\Data Modeler r9\Config.