This tutorial will guide you through obtaining a license key to be able to use Semarchy xDM beyond the 7-day trial period and complete the tutorials available on the Semarchy website.
A license grants permission to use Semarchy xDM, whether it is a trial or customer license. It specifies the duration of Semarchy usage and any limitations, like the data volume permitted under the license.
An instance refers to a single installation of Semarchy xDM—specifically, one repository installation of xDM.
A license key is a JSON string that enables one instance of xDM to use a specified license.
If you have not already done so, install xDM first. You can follow the tutorials available on the Semarchy website to install xDM on-premises or in the cloud.
To get a license key, you need an account on Semarchy's license server. This section walks you through how to create an account and request a license key.
You have successfully completed the account creation process. You are now ready to request your 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 have a license yet, this section will guide you through requesting a trial license. Once your license is approved, you can proceed to ④ Add a new instance.
You have successfully requested a license for your Semarchy instance.
Next, you will integrate your license for your xDM instance.
After receiving your license (whether it is a customer or trial license), the next step involves adding your new xDM instance as one of the instances covered by your license.
In this section, you need to register your xDM instance and associate it with your license. The goal is to obtain a license key for activating your instance.
If you see this screen, it means you have successfully registered your instance and your license key is valid.
You have obtained a license key and successfully registered your xDM instance to continue using it beyond the 7-day trial period.
This section covers common issues that customers may encounter. Your question might be addressed here. If you encounter problems that are not covered in this FAQ, please reach out to our Technical support team.
If auto-sync is enabled and your license key expires, your instance may encounter synchronization issues with the license server. Ensure that your server is connected to the Internet.
If auto-sync is enabled, follow these troubleshooting tips to update the server:
If auto-sync is not enabled and your license key expires, you must manually request a new license key and update your xDM instance accordingly. For instructions on how to manually request a license key, go to the "I don't want to enable auto-sync. What should I do?" section.
If you have not received any emails from Semarchy regarding your license key, please consider the following steps:
Are you the first person at your organization to request a license key? If so, you need Semarchy to designate you as the first "admin" user at your organization. Reach out to our Technical support team to request that someone adds you as an admin user for your organization so you can administer the license and grant access to future team members.
If you are not the first user at your organization and you know that your organization already has "admin" users, there might be an issue cross-referencing the email address you used. Are you using a different email address, such as firstname.lastname@example.org versus email@example.com? Use the email where you currently receive correspondence from Semarchy.
This situation commonly arises when an individual works at a subsidiary and possesses two email addresses, one from the parent company and the other from the subsidiary. If you have multiple email addresses, please try using a different one.
Another issue encountered is case sensitivity. If you continue experiencing problems, please attempt signing up with an email that contains only lowercase letters, such as firstname.lastname@example.org instead of Firstname.LastName@Company.com.
If you still do not see any licenses after trying the above suggestions, please contact our Technical support team to inquire about the email address on file for you.
Have you enabled auto-sync? If so, review the tips provided above regarding the scenario "The license key expired and is not auto-updating." Ensure that there are no proxies or caching technologies hindering the proper application of your new license key.
If you are not using auto-sync, this might explain why your instance does not appear as active. If you do not use auto-sync, you may need to obtain a new license key and manually apply it. For instructions on how to request a license key manually, see the "I don't want to enable auto-sync. What should I do?" section.
Auto-sync automatically updates your license information on your instance, ensuring your license remains up-to-date. It also gathers certain license and data usage details. For additional insight into the license server synchronization process and the information collected, see the Semarchy xDM documentation.
For further clarification on the auto-sync functionality not addressed in our documentation, please contact our Technical support team.
If you opt not to use auto-sync and prefer to apply your license manually, refer to the section below titled "I don't want to enable auto-sync. What should I do?"
If you prefer not to enable auto-sync, follow these steps:
You will need to manually update your license key annually or according to your renewal period. If there are any changes or updates to your license, you must also manually request Semarchy to send you a license key, which can be done from the license server.
If auto-sync is enabled, all updates should occur automatically. This means that transitioning from a trial license to a full license should happen seamlessly during the next synchronization of your environment with the license server.
However, if auto-sync is disabled and you are manually applying license key updates, you will need to request a new license key manually. For guidance on requesting a license key to be sent to your email, see the instructions provided in the question "I don't want to enable auto-sync. What should I do?", so you can manually apply the license key.
To verify the status of your license after converting to a full license, see the question "How can I return to the ‘Manage License' page?" on this FAQ section.
semkey license key file. However, I cannot upload files when attempting to activate a license; I can only paste a key. How can I use this file?
You might possess a license key file with a
.semkey extension. This file format is used for installations of xDM operating on versions 4.x and 5.0. However, for versions 5.1 and later, a new licensing mechanism is used through the Semarchy license server.
If you are running xDM 5.1 or a later version, it is necessary to use the new license server mechanism to register your xDM instance and request a license key. Follow the instructions provided in this tutorial to activate your xDM instance accordingly.
Additionally, you can seek assistance from the person within your organization who is responsible for administering the license.
You must be using xDM 5.0 or an earlier version before Semarchy introduced the license server. You have two options:
.semkey license key (though this option is unlikely).
If you wish to learn more about your license, update your license key, or configure auto-sync, you need to return to the "Manage License" page. Follow the instructions below to navigate back to your license page.
Updating licenses is restricted to users with the semadmin (i.e., Semarchy administrator) role. Verify whether you have been assigned that role.
An administrator has the ability to include additional team members in the license and to add new instances. A delegate can only add new instances to the license server. It is important for your organization to have at least one administrator to manage the license.
Here is the process for adding members to a license:
With the new license server, you can self-serve and request the Semarchy license server to generate a license key for you, provided there is already an admin user assigned at your organization. Request your admin user to include you as a user under your organization's license, in the Team tab. It is at the discretion of your admin user whether to designate you as another admin or assign you the role of delegate.
Next, you need to create an account, following the instructions provided in ② Create an account. Once logged in, you should see the license under your account. You can then proceed to follow the instructions outlined in ④ Add a new instance to request a license key.
If you are using a different email than the one registered in the license server by your admin, refer to the question in this FAQ titled "After creating an account, I am unable to view any licenses allocated to me" for instructions on what to do.
Please inform our Technical support team immediately regarding the license server's malfunction. They will contact you promptly to provide updates on the server's status and availability.
Try logging in again. If you still encounter difficulties, please contact our Technical support team to report your issue.
This issue occurs because your application server is set up with an option that includes a header blocking content type sniffing (i.e.,
blockContentTypeSniffingEnabled). You can try using another browser, such as Firefox or Edge, or find the configuration to disable this header.
The instance communicates with the license server to update the applied license key. The instance adheres to this schedule if auto-sync is enabled:
After clicking on the Synchronize button, the license server status shows Synching, but the operation remains ongoing even after logging out and back in.
This may be due to the license key server not being allowed to access the instance.
To try and fix this issue:
The following error can occur during synchronization:
If you see this message, inspect the PDE log and the
catalina.out files for errors, as they will offer insight into the underlying cause. If you have difficulty troubleshooting this error, reach out to the Technical support team for assistance.
Great job! You have learned how to add a license key to your new xDM instance.
xDM is designed to handle various data types, including customer data, location data, reference data, organizational data, supplier data, and other domains.
To learn how to harness the capabilities of xDM, you could now pursue two distinct paths:
Go back to the main menu to find these resources.
Thank you for completing this tutorial.