Skip to main content

Data Model Designer Scripts

In the Data Model Designer, scripts link a data model to global scripts. When a data model uses custom SQL objects—such as views, tables, or stored procedures—a global script should be created to generate those objects, and then attached to the specific data model. When the data model is exported, any related global scripts are exported with it. These scripts are executed automatically when the data model is imported.

important

You must define fields for the data model before attaching scripts.

When to execute scripts​

  • Creating custom SQL objects: Generate views or tables used by the data model.
  • Updating dependent database objects: Modify SQL objects that the data model relies on.
  • Synchronizing environments: Import or export a data model to keep environments aligned.

Execute scripts​

  1. In Data Models and Views, right-click a data model and select Data Model Designer.
  2. On the Tools tab, click Data Model Scripts.
    Or click Data Model Scripts in the toolbar.
  3. In Global Scripts, select the script you want to execute and click the arrow to move it to Scripts to Execute. Hold Ctrl to select multiple scripts at once.
  4. To preview the script content, click the magnifying glass icon next to the script.
  5. (Optional) Use the up and down arrows to arrange scripts in execution order. Some scripts must be executed in a specific sequence.
  6. Click Execute.
  7. Select the target environment and click Ok.
  8. Enter any required parameters in the Parameters dialog.
  9. Click Run.

Review execution report​

  1. In the Execution Report dialog, find the script you want to review.
  2. Click the success or error icon to open the script details.
  3. Review the execution results in the Report Preview window.
  4. Click Cancel when finished.
  5. Click Save.
  6. On the File tab, click Save Data Model.

Report Preview fields​

FieldDescription
Environment DescriptionName of the environment where the script ran.
Script DescriptionText label identifying the script.
Server TypeDatabase server type where the script is intended to run (for example, SQLSERVER, ORACLE).
Script ContentFull SQL definition of the script to be executed.
Revert Script ContentSQL code used to undo the effects of the script.
Error MessageDetails of any error encountered during execution.

tip

Review scripts at any time by clicking Errors in the Execute Scripts dialog.