You can publish a read-only, searchable representation of your MDriven model so that developers, support staff, and business stakeholders can inspect model structure and usage without editing the source model.

What ModelMeta provides

ModelMeta is an exported representation of a model. You export it as a Model Information File (.mif) and import that file into the web-based ModelMeta Viewer.

The export includes information about:

• Classes and their content.
• OCL expressions and the model elements they use.
• ViewModels.
• Actions.
• State machines.

The ModelMeta export also analyzes expressions and records what each expression uses. This makes the viewer a cross-reference tool: you can start at a ViewModel, attribute, or association end and follow its usage to related model content.

For example, when investigating a ViewModel used by support staff, you can open that ViewModel in the viewer, inspect its displayed information and usage, and then follow a referenced attribute to find other places where that attribute is used.

When to use it

Publish a ModelMeta import when people need to understand the model but should not change it. It is useful for:

• Explaining the business concepts represented by the model.
• Helping support and development teams navigate ViewModels, actions, classes, and associations.
• Finding where an attribute, association end, or expression is used.
• Making model documentation available in a web browser.

ModelMeta is read-only documentation. Keep the source model as the authoritative place for changes.

Export the model information file

1. Open the model you want to document in MDriven Designer.
2. Export a Model Information File with the .mif extension.
3. Save the exported file where the person who performs the import can access it.

Export a new .mif whenever the model changes and you want the published documentation to reflect those changes. For example, after adding a new action that opens a ViewModel, export and import an updated file before asking users to review that navigation.

Import a model into the web viewer

Use the hosted ModelMeta Viewer at metamdriven.azurewebsites.net. Create an account, or sign in with an existing MDriven account.

1. Select Admin.
2. Select Model Imports For User.
3. Select Add New Model Import.
4. Import the exported .mif file.
5. Rename the new saved model import so that users can identify it. For example, use a name that identifies the application and model version.
6. Select Request Server Side Re Index.
7. Save the model import.

Server-side reindexing prepares the import for search. Request reindexing after importing the file; otherwise, searches may not reflect the imported model content.

Search and navigate the imported model

1. Go to Search.
2. Go to Model and select the model import you created.
3. Click SEARCH without entering a search term to return the available model content, including classes, ViewModels, and associations.
4. Enter a name or other search text to narrow the results.
5. Open a result to inspect its details and follow links to related model elements.

The viewer indexes names and code comments. Use terms that occur in an element name or its code comment. For example, searching for a business term used in a class name can locate that class; opening it then lets you navigate to its attributes and associations.

Follow usage links

When you open a ViewModel, review both the view and the usage information shown for it. When you open an attribute or association end, use the available links to see where it is used and to navigate to those related elements. These links turn the exported model into a navigable map rather than a static diagram.

Keep published documentation useful

• Give each import a clear name so users select the intended model.
• Re-export, re-import, and request server-side reindexing when model changes need to be published.
• Add meaningful code comments in the source model. Because code comments are indexed, they improve the terms users can search for.
• Use ModelMeta for discovery and cross-reference. Use the source model when you need to edit definitions, expressions, ViewModels, or actions.

For targeted inspection inside the model, see Practical expressions to get insights into your model content.

See also

• Practical expressions to get insights into your model content
• Learn OCL
• ModelMeta Viewer

Use ModelMeta in your governance process

Use ModelMeta to give business, development, support, and management participants a shared read-only view of the model during governance reviews.

Governance is the process your organization uses to review system decisions, decide which changes to make, and verify that the implemented system still represents the intended business rules. In MDriven, keep the system gist—the enduring business concepts, rules, and relationships—in the model, while delivery technology and user-interface choices can evolve separately. See What is next.

ModelMeta does not replace your existing approval, change-management, or review process. It supplies a searchable representation that participants can inspect without editing the source model. Keep the source model as the authoritative definition and make changes there first, in line with the model-driven practice described in Model Driven.

Review changes with a published import

1. Export and import a .mif from the model version proposed for review.
2. Give the import a name that identifies the application and model version so reviewers select the intended documentation.
3. Ask reviewers to inspect the affected classes, associations, OCL expressions, ViewModels, actions, and state machines in ModelMeta.
4. Use usage links to identify related model content before deciding the scope of a change. For example, when an action opens a ViewModel, review that ViewModel and the attributes and associations it uses before approving the navigation change.
5. Record review decisions and required changes in your organization's existing governance process.
6. Update the source model when the change is accepted. Then export, import, and request server-side reindexing for a new .mif so the published documentation reflects the reviewed model.

Assign review responsibilities

Agree who examines each type of model content in your existing governance framework. The following division gives reviewers a concrete starting point.

Review focus	What to inspect in ModelMeta	Example question
Business concepts	Classes, attributes, and associations	Does the class and its relationships still describe the business concept the organization intends to support?
Business rules	OCL expressions and state machines	Which model elements does a changed expression use, and does the state machine still reflect the intended rules for data change?
User work	ViewModels and actions	Which ViewModel does an action open, and what information and navigation does that ViewModel expose to its users?
Change impact	Usage information for an attribute or association end	Where else is the changed attribute or association end used?

Use the same review cycle for ongoing refinement. As users provide feedback, refine classes and views, publish an updated ModelMeta import for review, and keep the model aligned with the decisions made by the organization.

See also

• What is next
• Model Driven
• Learn OCL
• Practical expressions to get insights into your model content