Manage the Semarchy xDM license

Semarchy xDM stores in the repository the information about your license as well as the license key.

Licenses in Semarchy xDM work as described below:

  • A newly installed xDM instance runs for a limited "grace period" with no license key.

  • Before this period is over, you should activate the instance using that license key. This license key may extend your evaluation period of Semarchy xDM.

  • If the license key expires or is modified (when switching from an evaluation license to a full customer license, for example), you must update the license.
    Alternately, you may synchronize the license key automatically or manually to keep your license up-to-date.

Each license key is unique to one installed xDM instance, and should not be used on another instance.

Activate an instance

A newly installed Semarchy xDM instance runs for a limited time—the grace period—without a license. Within that grace period, you must activate your instance.

When the grace period is over, the instance will stop working: the applications, as well as the data stored in Semarchy xDM, will no longer be available, and incoming data will no longer be processed. The data stored in the hub is preserved as is.
You will need an Internet access and a valid corporate email address to activate your instance and receive the license key.

To activate an instance:

  1. In the Semarchy Configuration user menu, select About.

  2. In the About dialog, select the Manage License link.

  3. On the Manage License page, click the Activate button.

  4. Follow the instructions on the Activate xDM Instance page to collect your license key.

  5. Paste your license key, and then click Activate.

The instance is activated, and the license information appears on the Manage License page.

Update the license key

When the license key expires or is modified, you must update that license key.

The license key update is a manual process. To simplify license management, you may choose to synchronize the license key.

To update the license key:

  1. In the Semarchy Configuration user menu, select About.

  2. In the About dialog, select the Manage License link.

  3. On the Manage License page, click the Update button.

  4. Follow the instructions on the Update License page to collect your updated license key.

  5. Paste your license key, and then click Update.

The license key is updated, and the updated license information appears on the Manage License page.

Synchronize the license key

Synchronizing the license key automatically updates the license key. For example, if your subscription is renewed, the synchronization extends this subscription without having to update the license key manually.

You can perform the synchronization with a single-click operation, or run this synchronization on an automated schedule using auto-sync.

Synchronizing the license does not require any external access to your instance. The instance will send to Semarchy the information listed using an HTTP connection. For more information, see Network requirements.

To synchronize the license key:

  1. In the Semarchy Configuration user menu, select About.

  2. In the About dialog, select the Manage license link.

  3. On the Manage license page, click the Sync Now button, and then confirm the synchronization if prompted.

The synchronization starts. You can review the Last Sync field that shows the current synchronization status.

If the license is about to expire or has expired, the instance attempts to connect to the license server every day randomly between midnight and 1 AM in the local timezone of the server.

In ordinary situations, the instance attempts to connect to the license server every Saturday randomly between midnight and 1 AM in the local timezone of the server.

To enable auto-sync:

  1. In the Semarchy Configuration user menu, select About.

  2. In the About dialog, select the Manage license link.

  3. On the Manage license page, select the Auto-sync checkbox.

  4. Review the terms and confirm that you want to Enable auto-sync.

Auto-sync is enabled. You can review later the synchronization status on the Manage license page, in the Last Sync field that shows the latest synchronization timestamp.

Network requirements

The license key synchronization process does not require additional configuration on the server hosting the instance, and does not require incoming network access to the instance. However, you should make sure that this server has access to the internet to send and receive information during the synchronization process.

During the synchronization process, the instance sends information to the Semarchy license server and retrieves the updated license key. This is performed using REST API calls (HTTP/S POST and GET requests) from the instance to the license-api.semarchy.com server.

Synchronized information

During the synchronization process, the instance connects to the license server and sends a report composed of the information detailed below. The updated license key is returned to the instance automatically.

If you do not want the report to be sent, do not use the Sync Now button, and do not select the Auto-sync checkbox. Instead, use the Update button to manually update your license.

If you did not activate automatic synchronization and are requested to send license information to Semarchy, you can download a usage metrics report from the Manage license page at any time, using the usage metrics file Download icon next to the xDM Instance information section title.

The exported file is encoded and signed so that this information may be securely transferred to Semarchy for technical support or billing purposes.

The report contains the following instance information:

  • The base URL and version number (e.g., 5.1.0) of the application.

  • The name, type (Design or Deployment), version number, creation, and latest upgrade date of the repository.

  • Repository database information: JDBC URL, database server name, technology, version, and schema name.

The report contains, for each data location:

  • The name, label, datasource name, deployment date, type (development or production), internal version number, and status of the data location.

  • The data location database information: JDBC URL, database server name, technology, version, and schema name.

The report contains, for each entity[1] deployed in a data location:

  • The physical table name (e.g., PARTY), the entity name (e.g., Party), and the type of entity (BASIC, FUZZY_MATCHED, or ID_MATCHED).

  • The total number of attributes and the number of attributes of type BLOB or BLOB in the entity.

  • The count of golden records, authored golden records (fuzzy-matched entities only), historized golden records, master records (fuzzy- or ID-matched entities only), historized master records (fuzzy- or ID-matched entities only), source data records (fuzzy- or ID-matched entities only), and source authoring records.

Important Notes

The reported information:

  • Does not contain any personal details, users, passwords, or connection credential information.

  • Does not contain any data from your MDM hub tables.

  • Is intended for statistical and technical support purposes.

  • Is transmitted using secured (HTTPS) connections.

  • Is not visible by anyone outside Semarchy.

  • Is stored in secured servers located in Ireland.
1. For a group of entities in an inheritance relationship, only the parent entity from which all child entities inherit appear in the report, with all the attributes of its child entities.