Using Your Plug-ins

Using Plug-ins

Plug-ins designed with the Plug-in Architecture can be used as regular plug-ins.
See the "Integration Process Design" chapter "Semarchy Convergence for MDM Developer’s Guide" for more information.

Using the Plug-in Example in the Getting Started Environment

You can use the sample plug-in example created with this guide in the demonstration environment provided for the "Semarchy Convergence for MDM Getting Started Guide", or in your own projects.

Note: Before using your plug-in in the demonstration environment, it is recommended that you first get comfortable with the Semarchy Workbench and the demonstration environment by running the entire Getting Started.

Setting up the Getting Started Environment

To set up a Getting Started environment for testing the plug-in:

  1. Follow the instructions in the "Semarchy Convergence for MDM Getting Started Guide" until the Create the Demo Model section. In this section, select Full Setup instead of selecting Partial Setup. This will create the entire model.
  2. Deploy the Plug-in to the platform as explained in the Deploying the Plug-in section.

Using the Enricher in the Model.

Note: In this example, we will use the International Phone Standardizer enricher to standardize the phone numbers from the Phone1 attribute in the Contact entity. Note that we set the Nullify On Error parameter to false in order to preserve the original phone numbers that cannot be standardized.

To use the enricher in the model:

  1. Go to the Overview perspective.
  2. Open the CustomerAndFinancialMDM [0.0] model edition.
  3. Expand the Entities > Contact > Enrichers node.
  4. Right-click the Enrichers node and then select Add Plug-in Enricher.
  5. In the Create New Plug-in Enricher wizard, enter StandardizePhone for the Name field.
  6. In the Plug-in ID, select International Phone Standardizer.
  7. Click Finish. The Plug-in Enricher editor opens.
  8. In the Plug-in Params section, click the Value cell on the Nullify on Error line, and enter in the cell false.
  9. In the Plug-in Inputs section, click the Value cell on the InputPhone line, and enter in the cell Phone1.
  10. In the Plug-in Outputs section, click the Define Plug-in Output button in the upper-right corner. The Define Output Bindings dialog appears. Double-click the Phone1 attribute and then click Finish.
  11. In the Plug-in Inputs section, select the Output Name cell on the Phone1 line, and select Standardized Phone in the selection list.
  12. Press CTRL-S to save the editor.

Deploying the Updated Model

To deploy the updated model:

  1. Go back to the Overview perspective, and open the data location into which the model is currently deployed.
  2. Expand the model edition that is deployed, right-click and select Update Deployed Model Edition (Design-Time).
  3. In the Update Model Edition wizard, un-check the Update the Database Schema of the Data Location option and then click Finish.

Note: In a development environment only, it is possible to update existing deployment without creating a version of the model edition. In addition, only the integration processes need to be updated, as the data structure is not modified by the addition of the enricher.

Running the Enricher

To run the enricher:

  1. In the menu, select Help > Getting Started > Open Demo Application....
  2. Click the Reset Sample Data button to restore the sample data to its original state.
  3. Click the Publish Data to MDM... button in the editor toolbar.
  4. In the Publish Data to MDM dialog, for Data Edition select CustomerAndFinancialMDM [0.0].
  5. Click Finish to start the loading process.
  6. A Data Submit Succeeded dialog appears. Click OK to close it.
  7. View the log and expand the Contact task. You will now see your StandardizePhone enricher task and the number of records processed.
  8. Review the Contact golden records. Certain values of Phone1 have been standardized and appear with a “+33” prefix.