Welcome to Semarchy.

This tutorial shows you how to get a license key to be able to use Semarchy xDM beyond the 7-day trial period to complete the tutorials available on the Semarchy website.

What you'll learn

What you'll need


Before you start

If you have not already done so, you need to install xDM first. You can follow the tutorials to install xDM on-premises or in the Cloud.


Enjoy this tutorial!

To get a license key, you must have an account on Semarchy's License Server. This section walks you through how to create an account and request your license key.

To create an account on the Semarchy License Server:

  1. Log into your Semarchy xDM instance. You will land on the Welcome Page.
  2. Go to the Manage License page. You should see the "Activation Required" page.
  3. Go to the link license.semarchy.com. Create a new account (if you don't already have an account; if you have an account, log in).
  4. Go to the SIGN UP tab and create a new account.

  1. You should receive an email from the Semarchy License Server to confirm that you have successfully created an account. Follow the instructions in the email.
  2. You should see a message that your email was verified.

In the next section, you will sign into the License Server and request a license key.

Now that you have an account, it is time to request a license key and register your Semarchy instance. If you are evaluating Semarchy and your organization does not yet have a license, this section takes you through the steps to request a trial license. Once your license is approved, you can proceed to the next step to add a new instance.

To request a trial license:

  1. Log into the Semarchy License Server and open the License Server application.
  2. Click on "Request a trial".
  3. Fill out the form with your information to request a trial license.
  4. You should receive a confirmation email that is similar to the one below.

    Once your trial license is granted, you can log in to the License Server and add your new xDM instance.

Once you have been granted a license (whether that is a customer license or a trial license), the next step is to add your new xDM instance as one of the instances using your license.

To get a license key to activate your new xDM instance:

  1. Go back to your Semarchy instance. On the Manage License page, click the Activate button.
  2. Copy the instance ID.
  3. Log into the Semarchy License Server. Click on "Add instance".
  4. Fill in the form to add your instance and click Finish. Be sure to give your instance a meaningful name in the Name field like "Alice's Tutorial Instance" or "Product Domain POV".
    You will receive an email from Semarchy confirming that you added the new instance. This email will contain your license key.
  5. Copy and paste the license key from the email.

  1. Paste the license key into the step that prompts for the license key.
  2. Activate the license key.
  3. You can choose to ENABLE AUTO-SYNC the instance with the Semarchy License Server which will allow updates to your license to automatically apply to your instance.

    If you click CANCEL, you will need to manually apply license key changes to your instance, including annual updates.

If you see this screen, it means you have successfully registered your instance and your license key is valid.


You got a license key and registered your xDM instance to use it beyond the 7-day trial window. In this part, you learned how to:

There are common issues that customers may run into. Your question may be answered in this section. If you run into problems that are not addressed in his FAQ, please contact Semarchy Support.

The license key expired and is not auto-updating

If you have auto-sync turned on and your license key expires, there could be a problem with your instance synchronizing with the license server. Check that your server is connected to the Internet.

Try these 3 troubleshooting tips to update the server (if you have auto-sync turned on):

  1. Does Auto-Sync work? Check that your server has access to the Internet. Read more in our documentation on Networking Requirements.
  2. Click SYNC NOW. Does the Manage License information update? If not, check that your server has access to the Internet.
  3. Go to the License Server and request a new license key by choosing the "Send License Key" option. Go back to this Manage License page and click UPDATE. Paste the license key JSON string you will have received in your email

If you do not have auto-sync turned on and your license key expired, then you must manually request a new license key and manually update your xDM instance with a new license key. Follow the below "I don't want to Auto-Sync. What should I do?" section on instructions for how to manually request a license key.

I never received any emails from Semarchy about my license key

When I create an account, I cannot see any licenses granted to me.

Are you the first person at your organization to request a license key? If yes, then you need Semarchy support to add you as the first "admin" user at your organization. Email Semarchy support to request that someone add you as an admin user for your organization so you can administer the license and grant future team members access.

If you are not the first user at your organization and you know your organization already has "admin" users, there might be a problem cross-referencing the email address you used. Are you using a different email address, such as name@company.com versus name@thecompany.com? Use the email where you currently receive correspondence from Semarchy.

This is a common situation we run into when someone works at a subsidiary and has 2 email addresses, one from the parent company and the other from the subsidiary. Please try a different email address if you have more than one.

Another issue people run into is case sensitivity. Please try signing up with an email that has only lowercase letters if you continue to experience a problem, such as firstname.lastname@company.com instead of Firstname.LastName@Company.com.

If you still do not see any licenses after trying the above tips, contact Semarchy Support to ask what email address we have on file for you.

I have an active license but it says it is not active when I try to apply a license key to my instance. Why?

Do you have Auto-Sync turned on? If yes, check the tips above that cover the question "The license key expired and is not auto-updating". Make sure you do not have a proxy or a caching technology that is preventing you from correctly applying your new license key.

If you are not auto-syncing that could be why your instance does not show as active. You may need to get a new license key and apply it manually if you do not use Auto-Sync. Follow the below "I don't want to Auto-Sync. What should I do?" section on instructions for how to manually request a license key.

What does Auto-Sync do?

Auto-sync automatically updates your license information on your instance. This is useful for keeping your licenses up to date. The auto-sync process also collects some license and data usage information. For more details on what the License Server Synchronization process entails, read the documentation on what information we collect from the auto-sync process.

If you need more information about what Auto-Sync does that is not covered in our documentation, email Semarchy Support.

If you do not want to auto-sync and would prefer to manually apply your license, see the section below "I don't want to auto-sync. What should I do?".

I don't want to Auto-Sync. What should I do?

You will need to log into the license server and email yourself the license key.

  1. Log into the License server
  2. Go to Manage Instances
  3. Select your instance from the collection (table)
  4. Click on the menu button (the ellipsis)
  5. Select Send license key.

You will need to manually update your license key once a year (or whatever your renewal period is). If there are any changes or updates to your license, you will also need to manually request that Semarchy send you a license key, which you can do from the License Server.

I started with a trial license. Now that we are customers, we converted to full license. How does the license key work with a full license?

If you have auto-sync turned on, everything should update automatically. This means you should be able to keep using xDM and the license will update itself from a trial license to a full license the next time your environment synchronizes with the License server.

However, if you have not turned on auto-sync, and you are manually applying license key updates, then you must manually request a new license key. Follow the instructions above in the question "I don't want to Auto-Sync. What should I do?" for instructions on how to request a license key be sent to your email so you can manually apply the license key.

If you want to check what is the status of your license now that you have converted to a full license, see the question "How do I get back to the Manage License page?" on this FAQ page.

I have a .SEMKEY license key file. When I want to activate a license, I can't upload any files, only paste a key. How can I use this file?

You may have a license key file with a SEMKEY extension. The file with a .semkey suffix is used for installations of xDM running on versions 4.x and 5.0. For v5.1 and beyond, there is a new licencing mechanism using the Semarchy License Server.

If you are running xDM v5.1 and beyond, you must use the new License Server mechanism to register your xDM instance and request a license key. Follow the instructions above in this tutorial to activate your xDM instance.

You can also communicate with the person in your organisation who administers the licence and ask for help.

After I accept the End-User License Agreement, I am asked to upload a license key instead of installing a repository. How do I register this instance and upload a license key?

You must be running a version 5.0 or earlier of xDM before Semarchy implemented the License Server. You have two options:

  1. Upgrade to the latest version of xDM, v5.1 or beyond and follow the steps in this License Key tutorial.
  2. Discuss whether you need a .semkey license key with the Semarchy sales team (unlikely to happen, see option 1).

How do I get back to the Manage License page?

You may want to learn more about your license, update your license key, or set up auto-sync. To achieve this, you must go back to the Manage License page. Follow the instructions to navigate back to your License page.

  1. Go to the About section in the Application Builder.

  1. Go to the Manage License link.

  1. You should see license information on your license page. For example:

Why can't I see the Manage License page? After I log into the instance, I try to manage the license and click activate. Nothing happens.

Only users with the semarchyAdmin role can update licenses. Double check whether you have that role.

What's the difference between an admin and a delegate?

An admin can add other team members to the license as well as add new instances. A delegate can only add new instances to the license server. You should have at least one admin at your organization to administer the license.

As an Admin, how do I add other team members to the license?

Log into the License Server and go to your license. Click on the TEAM tab. Click on the menu button next to the Team label.

Select the Add member option. Add your team member's email and give them a role, either None, Admin, or Delegate. To understand the difference between admin and delegate, read the question above "What's the difference between an admin and a delegate?".

Can you add me to the customer license "Organization ABC"?

With the new license server, you can self-serve and request the Semarchy license server generate a license key for you as long as you already have an "admin" user at your organization. Ask your "admin" user to add you as a user under your organization's license, under the Team tab. It is up to your "admin" user whether to add you as another "admin" or to give you the role "delegate".

Then you need to create an account, following the instructions under the previous Create An Account section of this tutorial. You should now login and see the license under your account. You can now follow the instructions in the previous Add Your New Instance section to request a license key.

If you are using a different email than the one registered in the License Server by your admin, then you should read the earlier question in this FAQ "When I create an account, I cannot see any licenses granted to me" for instructions on what to do.

We are not able to log in to license.semarchy.com. We have tried it from different networks and browsers.

Notify our support team asap that the license server is not working. They will be in touch to let you know when the license server is up and available.

I tried to log in but I ran into this error message. What should I do?

Try logging in again. If you continue to struggle, email Semarchy support to report your problem.

We cannot access the license management page. I see an unrendered HTML page in Chrome. What should I do?

The issue occurs because your app server is configured with an option that adds a header that blocks content type sniffing (blockContentTypeSniffingEnabled). You can try another browser, such as Firefox or Edge, or find the configuration to disable this header.

How often does the License Server update the existing License Keys?

The instance reaches out to the License Server to update the license key that is applied to the instance. The instance follows this schedule if Auto-Sync is turned on:

License synchronization shows "Synching" but never ends, what should I do?

Description of the issue: after clicking on the "Synchronize" button, the License Server is showing "Synching" but the operation never ends, even after logging out/logging in.

Potential root cause: the license key server is not allowed to access the instance.


  1. Request a new license key
  2. Manually update the license in the instance.

What should I do in case of "License synchronization error"?

Description of the issue: the following error can occur during synchronization:

Resolution: if you see this message, check for errors in the PDE Log and the Catalina.out files, which will provide details about the root cause of the error. If you have difficulty troubleshooting this error, contact the Semarchy support.

You learned to add a license key to your new xDM instance. Let's summarize:

Great job going through this tutorial!

Now that you have set up xDM, you can continue to other tutorials.

The next step is to proceed to two different tutorial tracks:

  1. How to use xDM applications as a business user, following the Product Retail Demo and the Customer B2C tutorials
  2. How to design applications as a developer, following the Data Authoring and Data Consolidation tutorials.

Go back to the main menu to find these tutorials.


Go further with xDM

This tutorial taught you how to install xDM. xDM is capable of addressing all types of data, including customer data, location data, reference data, organization data, supplier data, and other domains.

Visit our website to learn about the different solutions we provide.