Installation

Requirements

Before starting this tutorial, make sure that the following requirements are met:

Note: Make sure that you also have the license keys for Semarchy Convergence for MDM and Semarchy Convergence for DI.

Installing the Semarchy Convergence for MDM Demo

Tip: If you have already installed and configured Semarchy Convergence for MDM for the Getting Started with MDM Projects tutorial, the following configuration is not necessary. Simply start the Tomcat server and connect to the Convergence Workbench. In the menu, select Help > Getting Started > Open Demo Application.... In the demo application, use the Reset Sample Data button to restore the sample data to its original state. After performing these steps, you can directly go to the Installing Semarchy Convergence for DI section.

Configure the Database Schemas

Convergence for MDM uses three schemas for the demonstration environment:

  1. SEMARCHY_DEMO_REPOSITORY contains the Convergence for MDM Repository.
  2. SEMARCHY_DEMO_MDM is the schema into which you will deploy your MDM Hub.
  3. SEMARCHY_DEMO_SOURCE contains sample source data used to load the MDM Hub.

To configure the database schemas:

  1. Connect with a system account to the Oracle Database.
  2. Run the following script to create the Convergence for MDM demo schemas:
CREATE USER SEMARCHY_DEMO_REPOSITORY IDENTIFIED BY 
SEMARCHY_DEMO_REPOSITORY DEFAULT TABLESPACE USERS 
TEMPORARY TABLESPACE TEMP;

CREATE USER SEMARCHY_DEMO_SOURCE IDENTIFIED BY 
SEMARCHY_DEMO_SOURCE DEFAULT TABLESPACE USERS 
TEMPORARY TABLESPACE TEMP;

CREATE USER SEMARCHY_DEMO_MDM IDENTIFIED BY 
SEMARCHY_DEMO_MDM DEFAULT TABLESPACE USERS 
TEMPORARY TABLESPACE TEMP;

GRANT CONNECT,RESOURCE TO SEMARCHY_DEMO_REPOSITORY, 
SEMARCHY_DEMO_SOURCE, SEMARCHY_DEMO_MDM;

If you have already created these schemas and wish to delete them beforehand, use the following script:

DROP USER SEMARCHY_DEMO_REPOSITORY CASCADE;
DROP USER SEMARCHY_DEMO_SOURCE CASCADE;
DROP USER SEMARCHY_DEMO_MDM CASCADE;

Install and Start the Convergence for MDM Server

Convergence for MDM runs as a web application in a Java Application Server. A simple Apache Tomcat Server, pre-configured with Convergence for MDM is used for this tutorial.

In the following section, the semarchy_with_tomcat.zip file refers to the Semarchy Convergence for MDM – Full Setup with Apache Tomcat file that you can download to install Semarchy Convergence for MDM. The name of this file varies as it includes the Convergence for MDM version and build number.

Tip: For the tutorial, it is recommended to install Convergence for MDM and Convergence for DI side-by-side in a /semarchy folder. For example, install Convergence for MDM in a C:\semarchy\semachy_mdm folder and Convergence for DI in a C:\semarchy\semachy_di folder on your disk.

  1. Download the Semarchy Convergence for MDM distribution. Make sure to download the version that includes the pre-configured Tomcat Server. It is named semarchy_with_tomcat.zip.
  2. Install and start the Apache Tomcat Server:

Warning: The Apache Tomcat server starts by default on the port 8088. If this port is already used by another application and you wish to start the server on a different port, edit the /conf/server.xml file with a text editor, and change the port value in the following line: <Connector port="8088" protocol="HTTP/1.1"

Warning: The Convergence for MDM server is preconfigured with three JDBC datasources pointing to the three schemas you created (called SEMARCHY_DEMO_REPOSITORY, SEMARCHY_DEMO_SOURCE and SEMARCHY_DEMO_MDM), stored in an Oracle XE instance started on the local machine and listening on port 1521 (that is: localhost:xe:1521). If the Oracle instance that you are using is configured differently: First, stop the Convergence for MDM server, edit the /conf/catalina/localhost/semarchy.xml to change the configuration of the datasources and then restart the Convergence for MDM server.

To shutdown the Convergence for MDM server, run the shutdown.bat (Windows) or shutdown.sh (UNIX/Linux) script in the /bin folder.

Install the Repository

Convergence for MDM holds all its information in a repository stored in a database schema. The first task when connecting Convergence for MDM is to create this repository structure in the database schema previously created.

  1. Open your web browser and connect to the following URL: http://localhost:8088/semarchy/ (update the port number if you changed it during the installation process)
  2. In the login prompt, enter the following:
  3. The Convergence for MDM Workbench opens with the license agreement. Review the End-User License Agreement.
  4. Check the I have read and accept Semarchy’s End-User License Agreement box and then click Next.
  5. In the License Key File page, select a valid license key by clicking the Upload a License Key File button and then click Next.
  6. In the Repository Creation wizard, select Design for the type of repository and then click Finish.
  7. Click OK when the Repository Successfully Created message appears.

The repository has been created and Convergence for MDM is now up and running.

Create the Demo Model

The Tutorial Environment contains a Customer and Financial Hub model. This model simulates an MDM project in progress. During this tutorial, you will finish the design of this model, deploy the MDM Hub and load it from sample data sources.

To seed the Customer and Financial Hub model:

  1. In the Convergence for MDM menu, Select Help > Getting Started > Create Demo Model...
  2. In the Getting Started Setup wizard, Select the Full Setup option and then click Next.
  3. The second wizard screen allows you to rename the model:
  4. Click Finish.
  5. Click OK in the confirmation window.

The demonstration model is seeded, the MDM Hub is installed, and the Model Edition view is opened.

Seed the Source Data

Note: For this tutorial, we use a demonstration application that accesses sample data stored in the SEMARCHY_DEMO_SOURCE schema.

Note: When you access the Demo Application for the first time, you are prompted to install the sample data for the demo application. Click OK to install the sample data. This step is executed only once.

To load sample data into the MDM Hub:

  1. In the menu, select Help > Getting Started > Open Demo Applications.... If you run the demo application for the first time, click OK to install the sample data when prompted. The Demo Applications editor opens.

Warning: Do not use the Publish Data to MDM... button. The purpose of this tutorial is to create the data integration flows to perform all the data publishing operations.

Installing Semarchy Convergence for DI

Install and Start Semarchy Convergence for DI

Convergence for DI includes two key components:

In the following section:

  1. Download the Semarchy Convergence for DI distribution ( semarchy-di-designer.zip) corresponding to your platform.
  2. Uncompress the semarchy-di-designer.zip file in your machine. This will create a semarchy_di sub-folder. This sub-folder will be referred to as <semarchy_di> (the Semarchy Convergence for DI installation directory).
  3. Start Convergence for DI Designer
  4. When the DI Designer starts, it prompts you for the license key.
  5. In the Please validate your product dialog, enter in the Key the key string that was provided to you by Semarchy.
  6. Click the Apply button.
  7. After registering the license key, you must create the folder into which the DI Designer will store its data. This folder in your local machine is the Workspace. Semarchy DI Designer prompts creates by default a workspace folder in its installation directory. To install it in a different location:
    1. In the Workspace Launcher window, click the Browse button.
    2. In the Select Workspace Directory dialog, select the folder into which the workspace will be created.
  8. Click OK to create the workspace and open it. The Semarchy Convergence for DI Designer window opens on the Introduction page. This page provides access Overview, Tutorials and Web Resource pages.
  9. Click the Workbench link to open the newly created workbench.

Directories Contents

The <semarchy_di> directory contains the following sub-folders:

Creating the Staging Area Schema

The E-LT architecture leverages the capabilities of a database for data integration. For the purpose of data processing, it may create temporary tables in the database it uses.
To host these temporary tables, it is recommended to create a schema called the Staging Area. We will create a schema called SEMARCHY_STAGING as our staging area.

  1. Connect with a system account to the Oracle Database.
  2. Run the following script to create the staging area schema:
CREATE USER SEMARCHY_STAGING IDENTIFIED BY 
SEMARCHY_STAGING DEFAULT TABLESPACE USERS 
TEMPORARY TABLESPACE TEMP;
GRANT CONNECT,RESOURCE,DBA TO SEMARCHY_STAGING;

Note: In a production environment, if a schema already exists for storing temporary objects in a database, this schema can be specified and used as the staging area. The user attached to this schema should have read access to the tables used as sources of the data integration flows, and write access to the tables used as targets of the integration flows. The user should have full access to the staging area schema.

Note: The DBA privilege is required for the user connecting with Semarchy Convergence for DI for working with the SQLExplorer component in the DI Designer to list the objects of the database instance. In production, when only processes need to run, it is recommended to implement a reduced set of privileges for this user.