AI-Powered Data Modeling

erwin DM offers an AI-powered data modeling feature that enables you to streamline reverse engineering tasks. With AI assistance, you can generate data models automatically, reducing the need for manual setup. This capability helps you save time, minimize errors, and improve overall efficiency.

The AI is available only for Reverse Engineering.

Prerequisites

Ensure that the following prerequisites are in place:

  • Purchase of the erwin Data Modeler AI Add-On and receipt of a welcome email with the licensing portal URL and license number. If you haven't received the email, contact your support team.

  • Access to the Quest Licensing portal at https://licensing.ism.quest.com

  • Internet connectivity for key generation and validation

  • Access to erwin Mart Portal

  • AI Credentials

    • AI License Key: Available in the welcome email or under your active license details in the Quest Licensing Portal.

    • Client ID and Client Secret: These can be generated in the My Access Keys section of the Quest Licensing Portal.

Workflow

The AI workflow for reverse engineering includes the following steps:

  1. Assign Users to Licenses

  2. Enabling the Feature

  3. Creating Access Keys

  4. Enabling AI Licenses

  5. Using AI for Reverse Engineering

Assigning Users to Licenses

To assign users to an activated license in the Quest Licensing Portal, follow these steps:

  1. Log in to the Quest Licensing portal using the same email address that received the welcome email.

    The account info empty page appears. By default, the Overview tab opens and displays the active licenses.

  2. On the Overview tab, under Account Info Empty Licenses, click View Licenses.

    The Organization Licenses tab opens, and you can view your active license here.

  3. On the active license, click Manage.

    The license page opens.

  4. Click the Seats tab and click to assign users.

    The Assign Users dialog box appears.

  5. Enter your email address and click Assign.

Enabling the Feature

Once the users are assigned, you need to enable the AI feature.

To enable the AI feature, follow these steps:

  1. On the Settings tab, click Features.

  2. Under Features, click Enable Feature.

    The Enable AI dialog box appears.

  3. Review and accept the terms of usage, then click Apply.

Creating Access Keys

You can now create the access key required to initiate erwinAI.

To create access keys, follow these steps:

  1. On the Profile menu, select My Access Keys or go to https://licensing.ism.quest.com/user/access-keys.

    The My Access Keys page opens.

  2. Click Add Access Key.

  3. Enter a key identifier in the corresponding field, and then click Add. For example, erwinDMAI_key_client. The Access key is generated from your email address and this unique identifier.

    In the Access Secret dialog box, Access Key Identifier and Access Key Secret are displayed.

  4. Click Copy Secret to copy. Save the Access Key Secret. It will not be displayed again.

Enabling AI Licenses

By default, AI features are disabled. To enable them, you need to configure your license using AI credentials through erwin Mart Portal and ensure that erwin DM is connected to the erwin Mart Portal.

To enable AI features, follow these steps:

  1. Log in to the erwin Mart Portal.

  2. Go to Application Menu > Settings > General.

    The General page appears.

  3. Scroll to the DM AI Credentials section.

  4. Enter your AI License Key, Client Id, and Client Secret in the appropriate fields.

  5. Click Save.

    Your AI credentials are saved, and AI features are enabled in erwin DM.

Using AI for Reverse Engineering

You can use Generative AI to generate scripts from natural language prompts during the Reverse Engineering process. This section walks you through the process of reverse engineering a MongoDB model from scripts using AI as an example. Similarly, you can reverse engineer data models for other target databases.

You can describe the models that you want to generate to the AI assistant. Based on the description, AI generates a script and the corresponding model. For example, to create a healthcare industry-based model, you can describe the model as follows:

"Create a MongoDB schema for a hospital system with patients, doctors, appointments, and prescriptions."

To generate DDL scripts and models using AI, follow these steps:

  1. In erwin Data Modeler (erwin DM), click Actions > Reverse Engineer.

    The New Model screen appears.


  2. Click Logical/Physical and select a Database.

  3. Click Next.

    The Reverse Engineering Wizard appears.

    RE Wizard-AI Validate Option

  4. Select the Enable AI Prompt Input checkbox. Clicking this option enables the prompt box.

  5. Enter your model description in the AI prompt box. For example, Create a MongoDB schema for a hospital system with patients, doctors, appointments, and prescriptions.

  6. Click AI Generate.

    The AI-generated script based on your description is displayed. You can review, edit, save, and reuse this script.

  7. Click Ok.

  8. Enter appropriate values in the fields for the other tabs.

  9. Click Ok.

    The reverse engineering process starts.

    Once the process is complete, a schema and a model are generated based on your selections.

    You can also use the following options on the AI-generated script:

    • Search (): Use this option to search for a word or characters in the schema.

    • Save (): Use this option to save the generated script.

    • Copy (): Use this option to copy the script.

    • Replace (): Use this option to find and replace characters in the script.

    • Text Options (): Use this option to configure the preview text editor's look and feel, such as window, font, and syntax color settings.

    • AI Terms of Use: Use this option to view terms and conditions for AI-powered features in erwin DM.

    • Was this helpful?: Use this option to provide feedback on the AI-generated script. Click or to submit positive or negative feedback.