Installing Timefold Solver Plus & Enterprise
In order to work with the commercial editions of Timefold Solver, 2 actions need to be taken:
License Key
A correctly configured and active license key is required in order for our commercial versions to function.
Obtaining a license key
Generate your license key using Timefold License Manager.
Take care not to leak the license file, for example by committing it to a public repository, logging the license file content in logs, or sharing it with unauthorized parties.
Consult Terms of Use for details on license key usage and restrictions.
Set up your license key
After obtaining your license file you can introduce it to your project by one of the following methods:
-
Store the license’s PEM string (the contents of the license file) in the
TIMEFOLD_LICENSEenvironment variable. -
Store the absolute path to the file in
TIMEFOLD_LICENSE_PATHenvironment variable. -
Name the file
timefold-license.pemand place it in the user’s home directory. Take care that the file name matches exactly, including letter case. -
Name the file
timefold-license.pemand place it in the root of your application classpath. Take care that the file name matches exactly, including letter case.
Use the enterprise artifacts
The commercial edition uses different artifacts than our open-source version. These artifacts are available from Maven Central, so no additional repositories need to be configured.
|
To avoid operational complexity, both Plus and Enterprise editions of Timefold Solver use the |
Replace references to open-source artifacts by their enterprise counterparts
as shown in the following table:
| Open source | Enterprise |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
If you were not using some of these open source artifacts until now, you do not need to add the enterprise counterparts to your project either.
Troubleshooting
After migrating to a commercial edition, most projects work out of the box.
When using the Enterprise version, automatic node sharing is the only feature that places additional restrictions on your code. If you run into unexpected behavior, try disabling that feature or align your code to comply.
If that did not resolve the issue, contact Timefold support.