Working with Data Models › Macro Toolbox › Macro Documentation

Macro Documentation

The information for each macro includes a description, macro syntax, the usage of the macro (that is, the statements or code segments in which it can be used), and, typically, a syntax example and corresponding expanded code. Occasionally a macro may also include more descriptive syntax and syntax examples (Full Syntax).

• Syntax. Provides the syntax for each macro, including keywords, user-specified variables, and required punctuation.
• Syntax Example. Shows the syntax in a code sample.
• Expansion. The SQL code or text that is generated by the macro based on the model information. Models are referenced where applicable. All expanded code examples are based on a subset of the tables in the erwin DM Emovies model (SQL Server target) shown in the erwin DM Macro Toolbox.
• Usage. The usage is given for each macro that cannot be used globally. It specifies:
  • The "%ForEach" commands in which a given macro can be inserted.
  • Whether the macro can be used as the predicate in a conditional "%If" statement.
  • The specific templates of each template type in which a given macro can be inserted: RI or Rel Override, Trigger Override, and Global.

Important! For information on the macros you can use in the Template Editor (used during Forward Engineering), please refer to the Template Language and Macro Reference document installed with the product.