Connect to and manage erwin Mart servers in Microsoft Purview (Preview)

This article outlines how to register erwin Mart servers, and how to authenticate and interact with erwin Mart Servers in Microsoft Purview. For more information about Microsoft Purview, read the introductory article.

Important

This feature is currently in preview. The Supplemental Terms of Use for Microsoft Azure Previews include additional legal terms that apply to Azure features that are in beta, in preview, or otherwise not yet released into general availability.

Supported capabilities

Metadata Extraction Full Scan Incremental Scan Scoped Scan Classification Access Policy Lineage Data Sharing
Yes Yes No Yes No No Yes No

The supported erwin Mart versions are 9.x to 2021.

When scanning erwin Mart source, Microsoft Purview supports:

  • Extracting technical metadata including:

    • Mart
    • Libraries
    • Models
    • Entities including the attributes, foreign keys, indexes, index members, candidate keys, and triggers
    • Default values
    • Synonyms
    • Sequences
    • Domains
    • Subject areas
    • Relationships
    • Validation rules including the valid values
    • ER diagrams
    • Views including the attributes
    • Stored procedures including the parameters
    • Schemas
    • Subtype relationships
    • View relationship
    • User defined properties
  • Fetching static lineage on assets relationships among entities, views and stored procedures.

When setting up scan, you can choose to scan an entire erwin Mart server, or scope the scan to a list of models matching the given name(s).

Prerequisites

Register

This section describes how to register erwin Mart servers in Microsoft Purview using the Microsoft Purview governance portal.

The only supported authentication for an erwin Mart source is Server Authentication in the form of username and password.

Steps to register

  1. Navigate to your Microsoft Purview account in the Microsoft Purview governance portal.
  2. Select Data Map on the left navigation.
  3. Select Register
  4. On Register sources, select erwin. Select Continue. register erwin source

On the Register sources (erwin) screen, do the following:

  1. Enter a Name that the data source will be listed within the Catalog.

  2. Enter the erwin Mart Server name. This is the network host name used to connect to the erwin Mart server. For example, localhost

  3. Enter the Port number used when connecting to erwin Mart. By default, this value is 18170.

  4. Enter the Application name

    Note

    The above details can be found by navigating to your erwin Data Modeler. Select Mart -> Connect to see details related to server name, port and application name.

    find erwin details

  5. Select a collection or create a new one (Optional)

  6. Finish to register the data source.

    register source

Scan

Follow the steps below to scan erwin Mart servers to automatically identify assets. For more information about scanning in general, see our introduction to scans and ingestion

Create and run scan

To create and run a new scan, do the following:

  1. In the Management Center, select Integration runtimes. Make sure a self-hosted integration runtime is set up on the VM where erwin Mart instance is running. If it isn't set up, use the steps mentioned here to set up a self-hosted integration runtime.

  2. Navigate to Sources.

  3. Select the registered erwin Mart.

  4. Select + New scan.

  5. Provide the below details:

    1. Name: The name of the scan

    2. Connect via integration runtime: Select the configured self-hosted integration runtime.

    3. Server name, Port and Application name are auto populated based on the values entered during registration.

    4. Credential: Select the credential configured to connect to your erwin Mart server. While creating a credential, make sure to:

      • Select Basic Authentication as the Authentication method
      • Provide your erwin Mart server's username in the User name field.
      • Save your user password for server authentication in the key vault's secret.

      To understand more on credentials, refer to the link here.

    5. Use Internet Information Services (IIS) - Select True or False to notify if Microsoft Internet Information Services (IIS) must be used when connecting to the erwin Mart server. By default this value is set to False.

    6. Use Secure Sockets Layer (SSL) - Select True or False to Notify if Secure Sockets Layer (SSL) must be used when connecting to the erwin Mart server. By default, this value is set to False.

      Note

      This parameter is only applicable for erwin Mart version 9.1 or later.

    7. Models - Scope your scan by providing a semicolon separated list of erwin model locator strings. For example, mart://Mart/Samples/eMovies;mart://Mart/Erwin_Tutorial/AP_Physical

    8. Maximum memory available: Maximum memory (in GB) available on customer's VM to be used by scanning processes. This is dependent on the size of erwin Mart to be scanned.

    trigger scan

  6. Select Test connection.

  7. Select Continue.

  8. Choose your scan trigger. You can set up a schedule or ran the scan once.

  9. Review your scan and select Save and Run.

View your scans and scan runs

To view existing scans, do the following:

  1. Go to the Microsoft Purview governance portal. Select the Data Map tab under the left pane.

  2. Select the desired data source. You will see a list of existing scans on that data source under Recent scans, or can view all scans under the Scans tab.

  3. Select the scan that has results you want to view.

  4. This page will show you all of the previous scan runs along with the status and metrics for each scan run. It will also display whether your scan was scheduled or manual, how many assets had classifications applied, how many total assets were discovered, the start and end time of the scan, and the total scan duration.

Manage your scans - edit, delete, or cancel

To manage or delete a scan, do the following:

  1. Go to the Microsoft Purview governance portal. Select the Data Map tab under the left pane.

  2. Select the desired data source. You will see a list of existing scans on that data source under Recent scans, or can view all scans under the Scans tab.

  3. Select the scan you would like to manage. You can edit the scan by selecting Edit scan.

  4. You can cancel an in progress scan by selecting Cancel scan run.

  5. You can delete your scan by selecting Delete scan.

Note

  • Deleting your scan does not delete catalog assets created from previous scans.
  • The asset will no longer be updated with schema changes if your source table has changed and you re-scan the source table after editing the description in the schema tab of Microsoft Purview.

Lineage

After scanning your erwin source, you can browse data catalog or search data catalog to view the asset details.

Go to the asset -> lineage tab, you can see the asset relationship when applicable. Refer to the supported capabilities section on the supported erwin lineage scenarios. For more information about lineage in general, see data lineage and lineage user guide.

erwin lineage view

Next steps

Now that you've registered your source, follow the below guides to learn more about Microsoft Purview and your data.