Request and Apply a New License Key

Visual Data Discovery Module

This applies to: Visual Data Discovery

Use the DevNet License Manager to obtain license keys. These are provided to the person in your organization we term the License POC (Point of Contact). If you don't know who your License POC is, please reach out to your Account Manager.

When a Symphony standard or trial license expires, only admins can log in (to update the license). Regular users are shown a message that the license has expired.

Manage your license keys in one of three ways:

Manage License Keys in the UI

Apply a new license key:

  1. In the environment for you which you need a new license key, log in as the Supervisor user.

    The default supervisor user is no longer installed; add users to the Supervisors group instead.

  2. Select Tools > License from the main menu. The Manage License page appears.

    Use this work area to download instance tokens, license keys, and manage new licenses

    This screen shows your current Symphony data discovery instance ID and its current expiration date.

    If you select Download Current Key, your current license key is downloaded in a license.key file.

  3. Select Download Instance Token. A .tok file is downloaded to your computer.

  4. Log into DevNet and visit the License Management page to create a license file. You do this by assigning one of your license keys to a specific instance of Symphony data discovery, by uploading the .tok file from the previous step. DevNet generates a license.key file, and downloads the file to your machine.

  5. From your Supervisor menu, select Browse and find the license key you just downloaded. Then, select Submit. Symphony data discovery applies the new license to your instance.

Manage License Keys Using the Licensing API

This applies to: Visual Data Discovery

Endpoint Method Description
/api/license GET Returns license information for the instance.
POST Updates license information for the instance

API documentation is provided with your Symphony installation at this link: <symphony-URL>/discovery/swagger-ui.html.

If a problem occurs, contact your sales or technical support representative.

Manage License Keys Using Configuration Properties or Environment Variables

This applies to: Visual Data Discovery

Add your license keys and installation id to zoomdata.properties. Format the variables as shown below:

zoomdata.license.key=<value>
zoomdata.installation.id=<value>

License information provided via configuration properties or environment variables have a higher priority than keys stored in the database previously provided via API or user interface. If you attempt to change the keys using the API in an environment where licensing information from configuration properties or environment variables are in use, Symphony data discovery returns a failure message. Update the license key in the configuration files instead.

For more information about extending licensing to a Kubernetes deployment, see Apply Licenses.

Licenses in Managed Dashboards

This applies to: Managed Dashboards, Managed Reports

Obtain your license file or text from your Symphony account manager.

Once you've applied a valid retail license, the evaluation watermark is removed the next time you log in.

Add a new license key:

  1. Open the Managed Dashboards work area.

  2. Select your Profile in the main menu, then Administration from the menu options. An Overview work area opens.

  3. Select Licensing to expand that menu, then select Licenses. A list of your licenses opens.

  4. Select Add New to add a new license. An Add License work area opens.

  5. Add the license information in one of the following ways:

    • Drag and drop the license file from your computer or networked location
    • Select Choose File to select a file from your computer or networked location
    • Copy and paste the license text into the field provided

  6. Save your license. The license list is updated with the new entry.

  7. Log out, then log back in to view the license update, and if applicable, the removal of the evaluation watermark.

View Licenses

To view the applied licenses, navigate to the Licenses work area and select a license. Select Details to view more information about the license:

  • License status (Valid or Expired)
  • Product Version
  • Multi-Tenancy status
  • Reserved Power User Seats (number of license seats for reserved/named power users)