Installing the MDM server and Talend Data Stewardship Console manually - 6.4

Talend MDM Platform Installation Guide for Windows

EnrichVersion
6.4
EnrichProdName
Talend MDM Platform
task
Installation and Upgrade
EnrichPlatform
Talend Activity Monitoring Console
Talend Administration Center
Talend Artifact Repository
Talend CommandLine
Talend Data Preparation
Talend Data Stewardship
Talend DQ Portal
Talend ESB
Talend Identity Management
Talend Installer
Talend JobServer
Talend Log Server
Talend MDM Server
Talend MDM Web UI
Talend Project Audit
Talend Repository Manager
Talend Runtime
Talend SAP RFC Server
Talend Studio

Note

In the following documentation, <TomcatPath> designates the path where Tomcat has been installed, and <$INSTALLDIR> specifies the path where the MDM server has been installed.

To install the MDM server and Talend Data Stewardship Console manually, see:

Installing the MDM server and Talend Data Stewardship Console using the jar file

The Talend Data Stewardship Console is deprecated since Talend 6.4. Consider migrating to Talend Data Stewardship.

The jar file allows you to launch a cross-platform MDM-dedicated graphical installer to install the Tomcat server (optional) and deploy the MDM Server and the Talend Data Stewardship Console in simple click-next steps. The jar file is usually used with platforms other than Windows and Linux.

Using the jar file provided by Talend, you can install the MDM modules in three different modes:

Installing in GUI mode

Talend Studio and Talend MDM Web User Interface require that you install an MDM server.

When installing the MDM server, you can also install a Data Stewardship Console integrated within Talend MDM Web User Interface. The installation process proposes using either an embedded H2 database or a MySQL database with the Data Stewardship Console. If you want to use another of the supported databases, you must manually modify the file <$INSTALLDIR>/conf/tdsc-database.properties. For further information on the stewardship console, see the Talend Data Stewardship Console User Guide.

The Talend Data Stewardship Console is deprecated since Talend 6.4. Consider migrating to Talend Data Stewardship.

Prerequisite(s):

  • JRE 1.8.0 or higher must be installed. You should also make sure that the JAVA_HOME environment variable is set to point to the JRE directory.

    For example, if the path is C:\Java\JREx.x.x\bin, you must set the JAVA_HOME environment variable to point to: C:\Java\JREx.x.x.

  • Make sure you have read and write access to the folder where the MDM server will be installed (C:\Talend for example).

Warning

- It is highly recommended that the full path to the server installation directory is as short as possible and does not contain any space character.

- If you already have a suitable JRE installed in a path with a space, you need to put quotes around the path when setting the values for the environmental variable.

To install the MDM server and the stewardship console using a .jar file, follow the procedures below.

Launching the installer

  1. Right-click the .jar file and select with your Java runtime environment to run the installer.

    A language selection pop-up opens.

  2. From the language selection pop-up, select an installation language from the list and click OK to close the pop-up and proceed to the next step.

  3. On the Talend MDM welcome page, click Next to proceed to the next step.

  4. Read the license agreement and select the accept option. Click Next to proceed to the next step.

  5. Read the license information and click Next to proceed to the next step.

Selecting the packs

  1. Select the check boxes of the packs you want to install, and then click Next to proceed to the next step.

    If you have a Tomcat application server already installed on your machine and you do not want to re-install it, clear the Tomcat check box.

    You can also deploy the MDM modules as a web application on the Tomcat server using a .war file together with a zipped HOME file provided by Talend. For more information, see Installing MDM modules using the war file.

    The check boxes of required packs are already selected and unavailable: Talend MDM Application and Talend DSC Application in this case.

    Note

    By default, the Talend DSC Application check box is selected so that this tool is embedded within Talend MDM Web User Interface.

  2. If needed, select the Bonita BPM Server check box to install the open source BPM application together with other selected packs.

    You can also choose to install the Bonita BPM application manually. For more information, see Installing the Bonita BPM server manually.

  3. Once you have made your choice, click Next to proceed to the next step.

  4. Browse to where you want to install the selected packs, and then click Next to proceed to the next step.

    If you cleared the Tomcat check box, you also need to specify the directory where Tomcat is installed.

    A message is displayed to inform you that the target directory will be created.

  5. Click OK to close the message and proceed to the next step.

Selecting the MDM server ports configuration

  • From the Ports list, select the set of ports to be used by the MDM server, and then click Next. By default, ports-1 (8180) is selected.

    If needed, you can change the default ports to be used by the MDM server in Tomcat. For more information, see Changing the default ports used by the MDM server in Tomcat.

Selecting and configuring the database

  1. Select the type of database you want to use from the Database Type drop-down list and then click Next to proceed to the next step.

    Note

    For licensing reasons, if you want to use any of the supported SQL databases other than the H2 database embedded with the product, you need to download and manually install the database drivers in <TomcatPath>\webapps\talendmdm\WEB-INF\lib before using Talend products. Note also that you should only have one version of the drivers at each time, or else errors may occur.

  2. If you selected an RDBMS database, configure its connection parameters:

    When H2 Embedded is selected:

    1. Choose the database generation policy. You have a choice between creating a database for each container, or using a single database for all containers.

    2. Enter the User name and Password to use for connecting to the database.

    When MySQL, Microsoft SQL Server, or PostgreSQL is selected:

    1. Choose the database generation policy. You have a choice between creating a database for each container, or using a single database for all containers.

    2. Enter the Host, Port, User and Password to use for connecting to the database.

    When Oracle or DB2 is selected:

    1. Read the information at the top of the dialog box.

    2. Enter the parameters required for connecting to the database.

    For more information, see Using Oracle for the MDM server.

  3. Click Next to proceed to the next step.

Specifying the location for the fulltext search index directory

  1. Browse to the directory where you want to store the database fulltext search index.

  2. Click Next to proceed to the next step.

    A message is displayed to inform you that the target directory will be created.

Configuring the Talend Data Stewardship Console database

  1. In this page you can set the parameters to the stewardship console database that will be used to store the data values held in the task that are listed in the console.

  2. From the Type list, select the database type.

    Note

    If you select the H2 database, you do not need to set the database parameters; you may only want to set a name for this database or use the default name.

    If you select MySQL, proceed as the following after you create the database:

  3. Enter a name for this database in the corresponding field or use the default name.

  4. In the Host field, enter the database server IP address.

  5. In the Port field, enter the listening port number of the database server.

  6. Enter the login information for this database and click Next to proceed to the next step.

Note

If you select the Advanced connection check box and click Next, you will have a page where you can modify the connection information in any of the connection fields on the page.

Note

If you select the Bonita BPM Server to be installed together with other selected packages, you will have a page where you can browse to the installation folder for the Bonita BPM server and click Next to proceed to the next step.

The installation settings you defined in the previous steps will be displayed in the wizard.

  1. Click Next to proceed to the next step and start the installation.

    Two progress bars indicate how much of the installation has been completed.

  2. When the progress bars indicate the end of the installation, click Next to have a confirmation message that the installation is completed successfully.

    Note

    Click Generate an automatic installation script to generate a script for MDM server installation.

    You can use this script to install the MDM server on any platform without using the graphical installer.

  3. Click Done to close the installer.

    The MDM server is installed along with the Talend Data Stewardship Console.

To run the MDM server, execute startup.bat in the <TomcatPath>/bin folder.

To shut the MDM server down, press Ctrl + C in the console window, or run bin/shutdown.bat.

Using Oracle for the MDM server

When you select to use Oracle as the database for the MDM server, you must make specific configurations before starting the MDM server.

You can use a single Oracle database with different tablespaces: one tablespace for the master container, one for system objects, and another for the staging container.

The configurations for different Oracle versions are the same. For more information about the supported Oracle versions, see Compatible Databases.

MDM also supports other types of databases. For more information, see Managing MDM databases.

To use Oracle for the MDM server, do the following with your Oracle development tool (Oracle SQL developer, for example):

  1. Create a user per container.

    In this example, create three users: mdm_master, mdm_staging, and mdm_system.

  2. Create a tablespace for each user.

    For example, create a tablespace MDMMASTER for the user mdm_master:

    CREATE TABLESPACE
    MDMMASTER DATAFILE 'C:\oraclexe\app\oracle\oradata\XE\MDMMASTER.DBF'  SIZE 20M
    AUTOEXTEND ON NEXT 5M
    MAXSIZE 100M;

    Make sure you see the output: "tablespace MDMMASTER created."

  3. Grant access right to users on the tablespaces.

    ALTER USER mdm_master
    QUOTA 100M ON MDMMASTER;

    Make sure you see the output: "user mdm_master altered."

  4. Alter the users so that each one uses a different tablespace.

    In this example, mdm_master uses the tablespace MDMMASTER, and mdm_staging uses MDMSTAGING.

  5. Make sure that each user has the permissions for "System Privileges". For more information, see Privileges in databases.

Once you have made configurations in Oracle, you need to make configurations for the MDM server as follows:

  1. Update the datasource configuration file <$INSTALLDIR>/conf/datasources.xml.

    The template is as follows:

        <datasource name="Oracle-Default">
            <master>
                <type>RDBMS</type>
                <rdbms-configuration>
                    <dialect>Oracle11g</dialect>
                    <connection-driver-class>oracle.jdbc.driver.OracleDriver</connection-driver-class>
                    <connection-url>jdbc:oracle:thin:@localhost:1521:TMDM_DB</connection-url>
                    <connection-username>mdm_master</connection-username>
                    <connection-password></connection-password>
                    <connection-pool-minsize>5</connection-pool-minsize>
                    <connection-pool-maxsize>50</connection-pool-maxsize>
                    <fulltext-index-directory>E:\Talend\Talend-MDMServer\data\indexes\Oracle-Default</fulltext-index-directory>
                    <schema-generation>update</schema-generation>
                    <properties>
                        <property name="hibernate.show_sql">false</property>
                        <property name="hibernate.default_schema">mdm_master</property>
                    </properties>
                </rdbms-configuration>
            </master>
            <staging>
                <type>RDBMS</type>
                <rdbms-configuration>
                    <dialect>Oracle11g</dialect>
                    <connection-driver-class>oracle.jdbc.driver.OracleDriver</connection-driver-class>
                    <connection-url>jdbc:oracle:thin:@localhost:1521:TMDM_DB</connection-url>
                    <connection-username>mdm_staging</connection-username>
                    <connection-password></connection-password>
                    <connection-pool-minsize>5</connection-pool-minsize>
                    <connection-pool-maxsize>50</connection-pool-maxsize>
                    <schema-generation>update</schema-generation>
                    <properties>
                        <property name="hibernate.show_sql">false</property>
                        <property name="hibernate.default_schema">mdm_staging</property>
                    </properties>
                </rdbms-configuration>
            </staging>
            <system>
                <type>RDBMS</type>
                <rdbms-configuration>
                    <dialect>Oracle11g</dialect>
                    <connection-driver-class>oracle.jdbc.driver.OracleDriver</connection-driver-class>
                    <connection-url>jdbc:oracle:thin:@localhost:1521:TMDM_DB</connection-url>
                    <connection-username>mdm_system</connection-username>
                    <connection-password></connection-password>
                    <connection-pool-minsize>5</connection-pool-minsize>
                    <connection-pool-maxsize>50</connection-pool-maxsize>
                    <schema-generation>update</schema-generation>
                    <properties>
                        <property name="hibernate.show_sql">false</property>
                        <property name="hibernate.default_schema">mdm_system</property>
                    </properties>
                </rdbms-configuration>
            </system>
        </datasource>

    For more information about the file, see Talend Help Center.

    Note

    The staging area does not define any full text index directory.

  2. Update the configuration file <$INSTALLDIR>/conf/mdm.conf as follows:

    db.autoPrepare=false
    db.default.datasource=Oracle-Default
  3. Restart the MDM server.

Installing the Bonita BPM server manually

To install the Bonita BPM server manually, do the following:

  1. Download the Bonita BPM server version compatible with your product from http://www.bonitasoft.com/downloads-v2.

  2. Unzip the BPM archive file BonitaBPMCommunity-<Version> (for example, BonitaBPMCommunity-6.5.0) into a local directory which will be referred to as <Bonita_Home>.

  3. Browse to the directory <Bonita_Home>\bonita\client\conf, and then open the file bonita-client.properties.

  4. Edit the file according to your actual situation, which allows the MDM server to connect to the Bonita BPM server correctly, and save the file after you have made your changes.

    An example of the file is shown below:

    org.bonitasoft.engine.api-type = HTTP
    server.url = http://localhost:8080
    application.name = bonita

    Warning

    The server.url must use the host name or IP address of the actual machine which hosts the Bonita BPM server and the port number must correspond to the HTTP port for Bonita chosen during installation. By default, it is 8080.

  5. Browse to the file mdm.conf under the directory <Bonita_Home>\bonita\mdm\.

  6. Edit the file to provide the details for your installation, which allows the Bonita BPM server to connect to the MDM server correctly, and save the file after you have made your changes.

    An example of the file is shown below:

    admin.user=admin
    admin.password=talend
    mdm.endpoint.url=http://localhost:8180/talendmdm/services/soap

    Warning

    The mdm.endpoint.url must use the host name or IP address of the actual machine which hosts the MDM server and the port number must correspond to the chosen HTTP port for MDM server during installation. By default, it is 8180.

Installing in Command/Console mode

You can install the MDM server and the stewardship console in a non-GUI mode using the command-line.

Prerequisite(s):

  • JRE 1.8.0 or higher must be installed. You should also make sure that the JAVA_HOME environment variable is set to point to the JRE directory.

    For example, if the path is C:\Java\JREx.x.x\bin, you must set the JAVA_HOME environment variable to point to: C:\Java\JREx.x.x.

  • Make sure you have read and write access to the folder where the MDM server will be installed (C:\Talend for example).

  • A MySQL server must be installed on which you create a database dedicated to Talend Data Stewardship Console.

    The Talend Data Stewardship Console is deprecated since Talend 6.4. Consider migrating to Talend Data Stewardship.

Warning

- It is highly recommended that the full path to the server installation directory is as short as possible and does not contain any space character.

- If you already have a suitable JRE installed in a path with a space, you simply need to put quotes around the path when setting the values for environmental variable.

To use the command-line capabilities to install the MDM server and the stewardship console:

  1. Unzip the .jar server file provided by Talend.

  2. Open your console server depending on the platform you have.

  3. Enter the below command, and then press the Enter key on your keyboard to launch the installation procedure through this text-only interface.

    java -jar <jar name>.jar -console

  4. Follow the instructions to install the MDM server and the stewardship console.

Installing in Silent mode

When installing the MDM server and the stewardship console using the graphical installer as outlined in Installing in GUI mode, you can generate an installation script at the last step in the graphical installer. This script is an XML file that contains the installation configuration settings.

You can later use this generated script from your console to install the MDM server and the stewardship console. The installation can be run by passing the installation script as a parameter to the installer as the following:

java -jar <jar name>.jar -<script name>

Installing MDM modules using the war file

With a .war file (Talend-MDMServer-YYYYMMDD-<revision number>-VA.B.C.war) and a zipped HOME file (Talend-MDMServer-YYYYMMDD-<revision number>-VA.B.C-HOME.zip) provided by Talend, you can also install MDM modules by deploying the .war file to Tomcat and then updating some configuration files after unzipping the HOME file.

Here, A.B.C stands for Major, Minor, Patch version respectively. Note that you must use the same versions/revisions of each module.

This installation mode assumes that you are familiar with or have some knowledge of MDM server configuration.

The following lists all the modules involved in this installation mode. To ease their management, you are recommended to centralize all the modules on one single system.

  • An application server, Apache Tomcat server in this case, which hosts the MDM web application.

  • A war file, which contains the MDM server application required to use Talend MDM Web User Interface.

    Note that Talend Data Stewardship Console is embedded.

    The Talend Data Stewardship Console is deprecated since Talend 6.4. Consider migrating to Talend Data Stewardship.

  • A zipped HOME file, which contains files and resources for the MDM server.

  • (Optional) An open source Bonita BPM server application bundle.

Prerequisites:

  • JRE 1.8.0 or higher must be installed. Make sure that the JAVA_HOME environment variable is set to point to the JRE directory.

    For example, if the path is C:\Java\JREx.x.x\bin, you must set the JAVA_HOME environment variable to point to C:\Java\JREx.x.x.

  • Install the Apache Tomcat application server and stop the Tomcat service if it is already started.

    Note

    Tomcat can be installed and managed as a Windows Service. For more information, see Installing Tomcat as a service.

To install MDM modules using the .war file and the zipped HOME file provided by Talend, proceed as follows:

  1. Unzip the HOME file to a local folder. In the following procedure, this local folder will be referred to as MDM_ROOT.

  2. Copy the .war file into the directory <TomcatPath>\webapps\, and then rename it to be talendmdm.war.

    Note

    Once you have copied this war file, you can either unzip it manually under the same directory, or let Tomcat unzip the web application at startup.

  3. Browse to the directory <TomcatPath>\conf.

    If the folder Catalina does not exist, create a new folder Catalina under the directory <TomcatPath>\conf and then create a new folder localhost under <TomcatPath>\conf\Catalina.

  4. Under the directory <TomcatPath>\conf\Catalina\localhost, create a new XML file (for example, talendmdm.xml), and populate it with the following content:

    <?xml version='1.0' encoding='utf-8'?>
    <Context path="talendmdm">
    <Parameter name="mdmRootLocation"
    value="<MDM_ROOT>"
    override="false"/>
    </Context>

    Warning

    The value of the Context path must be identical to the name of your war file which has been placed under <TomcatPath>\webapps\, and the value for mdmRootLocation must be the local directory where the HOME file is unzipped.

  5. Under the directory <MDM_ROOT>\conf, do the following:

    • Edit the file datasources.xml to provide the connection information to the database. You can use datasources.xml to manage how MDM Server uses SQL databases. For more information, see Managing how MDM Server uses SQL databases.

    • Edit the file mdm.conf to complete the configuration for the MDM server. For more information, see Configuring MDM Server.

  6. For performance reasons, you can increase the memory of Tomcat. For more information about how to increase the memory size of Tomcat, see Increasing the memory of Tomcat.

The MDM server is installed along with the Talend Data Stewardship Console.

To run the MDM server, execute startup.bat in the <TomcatPath>\bin folder.

To shut down the MDM server, press Ctrl + C in the console window, or run bin\shutdown.bat.

If needed, you can install the Bonita BPM server manually. For more information, see Installing the Bonita BPM server manually.