Installation Verification

This section describes how to verify that XDM was installed correctly, can connect to your databases, and can execute tasks.

Before starting the installation verification, make sure that the installation and configuration process, as described in sections Installation and Configuration, has been finished.

Login on to XDM

  • Open a web browser and navigate to the XDM user interface. By default, the address is http://<server-name>/, where <server-name> is the host name of the machine where XDM is installed. If you are using a non-standard port, use http://<server-name>:<port>/ instead. If you have configured SSL, use https instead of http.

  • Login with a valid user name and password. By default, there is an administrative account with the following credentials:

    user: admin
password: default

    If you have changed the user names and passwords either through XDM’s built-in user management or by connecting XDM to an LDAP server, you may need to use different credentials.

  • You are now redirected to the XDM dashboard.

Creating a database connection

This step verifies that XDM can connect the databases that you want to use as either source or target of a copy operation. Repeat this step for all databases you plan to use.

XDM uses the JDBC API to connect to databases. All required JDBC drivers must be copied into the directory jdbc-drivers, which is located in the XDM configuration directory. Refer to the configuration guide for detailed information on how to provide the JDBC drivers.

JDBC connections use URLs to identify individual database servers and databases. Make sure that you know the JDBC URL for the database to which you want to connect. A JDBC URL typically has the following format:

jdbc:<subprotocol>://<host>:<port>/<database><?properties>

  • subprotocol is vendor specific. See the examples below for a list of subprotocols.

  • host is the host name of the machine where the database server is installed.

  • port is the TCP port number under which the database server accepts incoming JDBC connections.

  • database is the name of the database to which to connect. For Db2 for z/OS databases, specify the location name instead.

  • properties are optional and vendor specific. Refer to the documentation of your database system for more information on which JDBC connection properties exist and how to specify them in a JDBC URL.

Table 1. Typical JDBC URLs for different database systems
Database system JDBC URL syntax

Db2 for Linux, UNIX, and Windows

jdbc:db2://<host>:<port>/<database>

Db2 for z/OS

jdbc:db2://<host>:<port>/<location>

Oracle

jdbc:oracle:thin://<host>:<port>/<database>

PostgreSQL

jdbc:postgres://<host>:<port>/<database>

Microsoft SQL Server

jdbc:sqlserver://<host>:<port>/<database>

MySQL

jdbc:mysql://<host>:<port>/<database>?sessionVariables=sql_mode=ANSI

MariaDB

jdbc:mariadb://<host>:<port>/<database>?sessionVariables=sql_mode=ANSI
For MySQL and MariaDB, you must append the connection property ?sessionVariables=sql_mode=ANSI to the JDBC URL.

In addition to the JDBC URL, you also need either user name and password or user name and certificate to connect to the database. For the purpose of this installation verification, a user name and password will be used.

Execute the following steps to perform the database connection verification:

  1. After logging in, click Infrastructure on the left side bar to expand the category.

  2. Click Connections.

  3. Select the database type you want to connect to. If your database type is specifically listed, use that type. Otherwise, use Generic JDBC Connections.

  4. Click Create button. This will open a dialog window where you can enter the connection details.

  5. Enter a display name for the connection.

  6. Enter the JDBC URL for the connection.

  7. Click + next to the drop-down box labeled Credential. This will open a dialog window titled Create Credential.

  8. Enter a display name for the credential.

  9. Enter the username to connect to the database.

  10. Enter the password for the username.

  11. Click Create to confirm the credentials. You will be taken back to the previous dialog window.

  12. Click Redirect to created object to activate the checkbox.

  13. Click Create to confirm the connection.

  14. Click Test connection.

If the connection can be established successfully, a green notification box labeled Success will appear in the bottom right corner of your browser window.

If the connection attempt is not successful, a red notification box will appear in the bottom right corner of your browser window. This notification contains details about the problem. Use the provided information to correct the problem (for example, if the notification indicates that the user name or password are incorrect, change the credentials for the connection and try again).

Creating and running an XDM task

This verifies that the XDM Installation can execute a simple task.

Prerequisites:

  • You have successfully created a database connection.

Execute the following steps to perform the database connection verification:

  1. Click Tasks on the left side bar to expand the category.

  2. Click Task Templates.

  3. In the main area of the window, click PII Finder Task Templates to expand the category.

  4. Select Create PII Finder Task Template. This will open a dialog window.

  5. Enter a display name for the task template.

  6. Click Redirect to created object to activate the checkbox.

  7. Click Create to confirm the creation of the new task template.

  8. In the bottom panel of the main area of the window, select the tab Selection rules.

  9. In the selection rule panel, click Create.

  10. Click Browse Schemas & Tables to expand the object browser.

  11. In the drop-down box Source connection, select the database connection that you have created previously.

    The database connection that you select here will only be used to fetch a list of schemas and tables so that you can easily browse them and create new selection rules. You will later be able to separately specify the database connection where the task is executed.

  12. Click Update view. The schema list will be populated with a list of available schemas in your database.

  13. Select a schema in the schema list. The table list will be populated with the list of tables that exist in the schema you selected.

  14. Select a table. The object browser will collapse and the selected schema name and table name will be inserted into the fields Schema pattern and Name pattern.

  15. Click Save Changes. You will be taken back to the task template. The selection rule list now contains one entry.

  16. In the bottom panel of the main area of the window, select the tab Tasks.

  17. In the task list panel, click Create. This will open a dialog window.

  18. Enter a display name for the task

  19. In the drop-down box, select the database connection that you created previously.

    This is the database connection to which the task will connect when it is executed.

  20. Click Redirect to created object to activate the checkbox.

  21. Click Create to confirm the creation of the new task.

  22. On the right side of your browser window, click Execute. This will open a dialog window.

  23. Make sure that all stages of the task are selected. Then click Execute and view. The main window will change to a view of the running task. Initially, the panel Execution logs will be empty.

  24. Wait for several seconds, then click Update view.

  25. Eventually, you will see the results of the task. Under Execution logs, you should be able to see a list of stages, result files and logs.

Checking, whether objects are stored correctly

This verifies whether tasks and other objects are stored correctly in XDM. Prerequisites:

  • You have successfully executed a PII finder task. Perform the following steps:

    1. Execute docker-compose down for the XDM docker environment.

    2. Execute docker-compose up -d for the XDM docker environment.

    3. Check whether all objects created in the installation verification are still available.

This concludes the installation verification.