Plug-in Development Guide

Overview

Using this guide, you will learn how to:

Tip: If you want to try Semarchy Convergence for MDM, you can use our demonstration environment and getting started guide: Getting Started with Semarchy.

Contents

  1. Plug-in Development Guide
    1. Overview
    2. Contents
  2. Preface
    1. Audience
    2. Document Conventions
    3. Other Semarchy Resources
    4. Obtaining Help
    5. Feedback
  3. Introduction to Semarchy Plug-in Architecture
    1. About the Plug-in Architecture
    2. Understanding the Plug-ins
      1. Plug-in Development
      2. Plug-in Packaging and Deployment
      3. Process for Creating a Plug-in
    3. About the Example
  4. Setting up the Environment
    1. Installing and Configuring Eclipse
    2. Installing the Semarchy Open Plug-in API for Eclipse
  5. Creating the Plug-in
    1. Creating the Plug-in Project
      1. Creating a New Plug-in Project
      2. Adding the Extensions to the Project
    2. Defining the Plug-in
      1. Declaring an Extension EndPoint
      2. Declaring the Parameters and Input/Output Fields
        1. Declaring the Parameters
        2. Declaring the Input Fields
        3. Declaring the Output Fields
    3. Implementing the Plug-in Code
      1. SetUp/TearDown Methods
      2. Transform Method (Enricher Plug-ins)
      3. isValid Method (Validation Plug-ins)
  6. Testing the Plug-in
    1. Creating a Test Project
    2. Creating a Test Case
    3. Implementing the Test Case
    4. Running the Test Case
  7. Releasing the Plug-in
    1. Generating the Plug-in Binary
      1. Generate the Plug-in Binary
      2. Incrementing the Plug-in Version
    2. Deploying the Plug-in
  8. Using Your Plug-ins
    1. Using Plug-ins
    2. Using the Plug-in Example in the Getting Started Environment
      1. Setting up the Getting Started Environment
      2. Using the Enricher in the Model.
      3. Deploying the Updated Model
      4. Running the Enricher
    3. Troubleshooting Plug-ins
      1. Troubleshoot Deployment
      2. Troubleshoot Execution
  9. Appendices
    1. Appendix A - Source Code of the Plug-in
    2. Appendix B - Source Code of the JUnit Test Class