Set Up Your Joget DX Enterprise License

This documentation provides a comprehensive guide to set up your Joget DX Enterprise License, allowing you to harness the full power of Joget for your organization's workflow and business process management requirements.

Activation steps

Once you have installed and configured your Joget DX Enterprise instance, you need to activate your license to access all the platform's features and capabilities.

Important
Even without a license, users of the enterprise edition can still access all features. However, there is a limitation: users without a license key can only log in with up to three users, meaning users without a license are restricted to the top three users in alphabetical order in the dir_user database table.

Follow these steps to complete the activation process:

Get the system key 

There are two ways for you to open the License Page : 

  1. Login page http://localhost:8080/jw/web/console/home (Change the domain name accordingly). Scroll down to the footer and click on the License: Joget DX Enterprise 8 hyperlink.
    Note:
    Note that NO Footer will be shown if there is already an active license in place for the domain.

  1. Admin Bar > Settings > General Settings > Purchase License.


    Note: 
    From the General Settings section, you also have the option to purchase a license online. Click the Purchase License button, and you will be redirected to an online form to complete the purchase.
  2. Note down the product edition and version that you have installed - (i.e., Joget DX Enterprise) and version (i.e., Version 8)
  3. Click on the license link to obtain the System Key.
  4. A pop-up window will open, where you will see the license details, such as the system key, admin username, admin password, and license.


    Note: 

    The Joget System Key ties to the following:

    1. Server network MAC address.
    2. Database profile name.
    3. The Joget license is tied to the Joget edition DX8 Enterprise Edition.

     

    Note that you will require a new license reactivation if any of the above changes.

Get your license

Before beginning, ensure your license is ready to activate your Joget system. Follow the steps below to get your license:

  1. On your web browser, go to the License Activation site.
  2. Select Request for Joget License from the menu to access the Request for Enterprise License request form.

    Note: The Request for Enterprise License form is only for customers who have purchased Joget software.
  3. Fill up the form. You must paste the System Key string you obtained in Step 1.
  4. To fill in the License Holder/Licensed To field, consider the following:
    • Alphanumeric characters, dots, underscores, hyphens, spaces, or round brackets are accepted.
    • The first character must be alphanumeric.
    • The last character must be alphanumeric or a closing round bracket.

      Example: 

    • XYZ Inc (Production)
    • XYZ Inc. - Production 
  1. Select the correct license version.
  2. Select the appropriate License Category. In most cases, you select the User-Based License category unless instructed otherwise. Below you find the other available categories.
  1. Select the required users. Selection is done in blocks of 5 users, for example, 5, 10, 15, 20, etc.
  2. Complete the fields for Licensee Contact Details and Requester Details.
  3. Once you have completed all the fields, click Submit.
  4. After submitting your Request Enterprise License form, you will receive an email with the approved license within 24 hours.

You are now ready to activate your system.

Activate your license

To activate your license and unlock full access to Joget features, follow these steps:

  1. Make sure you log in as an administrator.
  2. From the Admin Bar, click Settings.
  3. Click the Joget Dx Enterprise 8 link to open the pop-up license activation window.
  4. Paste the License into the License field.
  5. Ensure that you enter your correct administrator username and password.
  6. Click Submit to activate Joget. The form will close after activation.
  7. Reload the page to ensure that the activation was successful.

License category types

Depending on your organizational needs and deployment scenarios, it's important to understand the different options available for licensing Joget. Choose the license that best suits your requirements. Below, we outline the main features of each of these licenses.

Joget license based on user (User-Based License)

The User-Based License, licenses the platform based on the number of named users, allowing organizations to pay for only the specific users who access the system. This model provides flexibility to scale as the organization grows, with predictable costs and straightforward user management. It ensures compliance by maintaining clear access control and typically includes support and updates, making it an ideal solution for businesses seeking a cost-effective and manageable licensing approach.

In most cases, the category would be "User-Based License" unless the consultant has advised you to select another category.

The Joget user license for 25 users means that the first 25 usernames in ascending order can log in to Joget. A Joget license for 25 users means 25 active logins at a time, but only for the first 25 usernames in ascending order, regardless of whether the usernames are local users or connected to AD/LDAP. It counts all usernames regardless of their active or inactive status in Setup Users.

Joget license based on total apps (App-Based License)

 You can request for a Joget license with app count protection. For example, request a Joget license for unlimited users for a maximum of three apps only. The app license count applies to the first three apps based on appId in ascending order for published apps. See App Protection for more information.      

  • License Category:  App-Based License.
  • Required Number of apps: 5, for example.      

 

Note: 
If you want to exclude the app center from being counted, you can delete the default app center app. Then, go to System Settings > General Settings > Default User view and select another app as the default view. This process ensures that deleted apps are not included in the total license count.

Joget license for container based deployments

The Container-Based Deployment License for Joget Workflow Platform supports deployment in Red Hat certified and Kubernetes environments.
Ideal for organizations using containerization for scalability and efficiency, it aligns with modern DevOps practices for easy deployment, scaling, and management of Joget applications.

 This license category is only valid for Red Hat certified and Kubernetes container images, starting from Joget DX 7.

  • License Category: Container-Based License.
  • Required Number of apps: 2, for example.  
Note that the Kubernetes Deployment UID serves as the basis for the system key of the container images.
For Amazon Elastic Container Service (ECS), there is no Deployment ID available. In this case, you may need to activate the license using the Domain as the System Key. Also, remember to add the following parameter to the JAVA_OPTS key as an Environment Variable to change the system key and use the Domain.

-Dwflow.systemkey=domain

Joget license for container app-based deployments

This license category is only valid for Red Hat certified and Kubernetes container images, starting from Joget DX 8.

It is identical with Container-Based License, but with added advantage of having app license count.

  • License Category: Container App-Based License
  • Required Number of Pods: 1 (for example)
  • Required Number of Apps : (for example)

Video tutorial

This video tutorial is a comprehensive guide that helps you set up your Joget DX Enterprise license, providing visual assistance to execute the process effectively.

Server Migration Preparation 

It is essential to consider preparing for future server migrations when activating your Joget DX Enterprise license. Understanding how changes to your server environment can affect the validity of your license is key to avoiding service interruptions and ensuring business continuity. When setting up your license, document all system parameters linked to the license, such as the server's MAC address and the database profile. This information will be invaluable to ensure a smooth and trouble-free transition if you decide to migrate to a new server. For more details on preparing your license for server migration, see the Preparing Joget License For Server Migration guide.

Created by Julieth Last modified by Aadrian on Dec 13, 2024