Managing the Platform

The platform consists of several components that can be managed from the Administration Console perspective.
These components include the Engine, the Integration Batch Poller, the Notification Servers and Notification Policies, the Plug-ins and the Web Services.

Managing the Execution Engine

Accessing the Execution Engine

To access the execution engine:

  1. In the Administration view, double-click the Execution Engine node.

The Execution Engine editor opens.

The Execution Engine Editor

This editor displays the list of queues grouped by clusters. Queue currently pending on suspended jobs appear in red.

The list of queues and clusters displays the following information:

From the Execution Engine editor, you can perform the following operations:

Stopping and Starting the Execution Engine

To stop and start the execution engine:

  1. In the Administration view, double-click the Execution Engine node. The Execution Engine editor opens.
  2. Use the Stop this component and Start this component buttons in the editor’s toolbar to stop and start the execution engine.

Note: Stopping the execution engine does not kill running jobs. The engine stops after all running jobs are completed. Beside, the content of the queues is persisted. When the execution engine is restarted, the execution of queued jobs proceeds normally.

Managing the Integration Batch Poller

The Integration Batch Poller polls the integration batches submitted to the platform, and starts the integration jobs on the execution engine. The polling action is performed on a schedule configured in the batch poller.

Stopping and Starting the Integration Batch Poller

To stop and start the integration batch poller:

  1. In the Administration view, double-click the Integration Batch Poller node. The Integration Batch Poller editor opens.
  2. Use the Stop this component and Start this component buttons in the editor’s toolbar to stop and start the integration batch poller.

Note: Stopping the batch poller does not kill running jobs, and does not prevent new batches to be submitted. When this component is stopped, the submitted batches are simply not taken into account and no jobs is queued on the execution engine until the batch poller is restarted.

Configuring the Integration Batch Poller

The integration batch poller configuration determines the frequency at which submitted batches are picked up for processing.

To configure the integration batch poller:

  1. In the Administration view, double-click the Integration Batch Poller node.
  2. In the Integration Batch Poller editor, choose in the Configuration section the polling frequency:
  3. Press CTRL+S to save the configuration.

Note: It is not necessary to restart the integration batch poller to take into account the configuration changes.

In the Advanced section, set optionally the following logging parameters:

Configuring Notifications

Notifications are emails sent to users via Notification Servers. These notifications are sent under certain conditions when a job finishes.

Configuring Notification Servers

A Notification Server is an SMTP server used for sending notification emails. This server is either:

Note: Notifications servers are also used by Human Workflows to send notifications to roles when a task is assigned. Make sure to configure a default working notification server if you want to enable notifications in human workflows.

Creating a Notification Server

To create a notification server:

  1. In the Administration view, double-click the Notification Servers node. The Notification Servers editor opens.
  2. Select the Notification Servers list, right click and select New Notification Server. The Create New Notification Server wizard opens.

Configuring Notification Server Properties

SMTP servers may require advanced parameters to handle authentication and security. These parameters must be provided as properties of the notification server.

To configure the notification server properties:

  1. In the Notification Servers editor, double-click the notification server that you want to edit. The Notification Server editor opens.
  2. Expand the Notification Server Properties option group, and use this table to add new properties as value pairs.
  3. Press CTRL-S to save the configuration.

Commonly used properties include:

Refer to the JavaMail API documentation for a list of supported properties.

Testing a Notification Server

After configuring the notification server, it is recommended to run a test email on this server.

To test a notification server:

  1. In the Notification Servers editor, select the notification server that you want to test, right-click and select Test Configuration.
  2. Enter a comma-separated list of email address recipients for this test and then press OK.
  3. If the test is successful, a test email is sent from the platform to the recipients. If not, an error window appears.

Configuring a Job Notification Policy

With a notification server configured, it is possible to create notification policies.

To create a notification policy:

  1. Open the Data Locations perspective.
  2. In the Data Editions view, right-click the Job Notification Policies node and select New Job Notification Policy. The Create New Job Notification Policy wizard opens.
  3. In the first wizard page, enter the following information:
  4. Click Next.
  5. Click the Add Recipient button.
  6. In the Define Job Notification Recipients dialog, select the recipients (roles) of the notification email, click the Add >> button and then click Finish.
  7. Click Next.
  8. Enter the conditions for sending a notification. These conditions apply to a completing job and include:
  9. Click Finish.

Note: If you define a Job Name Pattern, Notify on Failure and a Threshold, a notification is sent if a job matching the pattern fails or to reaches the threshold.

Configuring Variable Value Providers

Semarchy Convergence for MDM uses variables defined in models to enforce certain data governance policies for a user’s session.
For more information about model variables, see the "Semarchy Convergence for MDM Developer’s Guide".

A Variable Value Provider is a system that can be queried by Semarchy to retrieve the values for these variables. Typically, this system is a server containing information about the user connected to Semarchy Convergence for MDM.

Two type of variable value providers are supported out-of-the-box:

Variable value providers are configured in the repository, and can be used by any model in this repository.

Warning: When working with a deployment repository, make sure to configure the variable value providers used in the models before importing or deploying them in this repository.

Creating a Variable Value Provider

To create a variable value provider:

  1. In the Administration view, double-click the Variable Value Providers node. The Variable Value Providers editor opens.
  2. Select the Variable Value Providers list, right-click and then select New Variable Value Provider. The Install Variable Value Provider wizard opens.
  3. Enter the following information:
  4. Select the Plug-in ID corresponding to the variable value provider type: LDAP Variable Provider or JDBC Variable Provider.
  5. Click Next.
  6. Click the Edit Expression button.
  7. In the the Variable Value Configuration dialog, enter the configuration information. This information differs depending on the selected Plug-In.
  8. Click OK to close the Variable Value Configuration dialog.
  9. Click Finish.

The variable value provider is added to the list.

Testing the Variable Value Provider Configuration

After configuring a new variable value provider, it is recommended to test its configuration.

to test a variable value provider configuration:

  1. In the Variable Value Providers editor, select of the variable value provider in the list.
  2. Right-click and select Test Configuration.

A message indicates whether the connection test was successful or not.

Warning: The configuration test only tests the connection information, but does not check the privileges granted to the user to retrieve the values from the provider.

Managing Plug-ins

Semarchy Convergence for MDM allows extending its capabilities using Java code and external APIs. Using the Open Plug-in Architecture, existing services or information systems can contribute to the master data processing and enrichment. You can extend the Enrichment and Validation capabilities in Semarchy Convergence for MDM through user-defined plug-ins.

For detailed information about plug-in development and packaging, see the "Semarchy Convergence for MDM Plug-in Development Guide".

A Plug-in is delivered as a jar file bundle that must be deployed in each Semarchy Convergence for MDM application instance running integration jobs that use the plug-in. You do not need to restart the server to take new or updated bundles into account.

These bundles are tagged with a version number. As a consequence, updating an existing plug-in with a newer version of this plug-in will automatically make the platform work with the newer plug-in version. The deployment process installs a new plug-in or replaces an existing plug-in version with a new one.

To deploy a plug-in:

  1. Open the Administration Console perspective.
  2. Double-click the Plug-ins node in the Administration view.
  3. Click the Install or Update Plug-in button in the upper right corner of the Plug-ins editor. The Install/Update Plug-ins dialog opens.
  4. Click the Browse button and select the plug-in binary file. For example: com.acme.phoneStandardizer_1.0.0.jar.
  5. Click OK. A Status window shows the number of plug-ins installed or updated.
  6. Your session is closed to take this new plug-in into account. Click the link to restart the session on the Overview perspective.
  7. Open the Administration Console perspective.
  8. Double-click the Plug-ins node from the Administration view.

The plug-in now appears in the list, and can be used in the models and the integration jobs.

Warning: Make sure to install the plug-ins required by the jobs of a model before creating a data edition using this model. If a job requires a plug-in that is not installed, then the job fails. The plug-in can be installed and the job resumed after the installation.

To uninstall a plug-in:
Open the Administration Console perspective.

  1. Double-click the Plug-ins node in the Administration view.
  2. Select the plug-in in the list.
  3. Click the Uninstall Selected Plug-ins button in the editor’s toolbar.

Managing Web Services

The Web Services are not configured to start by default. It is possible to start them manually or configure them to start with the platform.

To access the Web Service Manager:

  1. Open the Administration Console perspective.
  2. Double-click the Web Services Manager node in the Administration view. the Web Services Manager Configuration editor opens.

This editor displays the various web services with their status, and allows managing web service startup: