Adding a License Key

When you install the Reveal SDK, a license key must be provided or the SDK will not function. There are two types of license keys

• Trial - obtained when requesting a trial from the Reveal SDK Website
• Licensed - obtained when the Reveal SDK is purchased and is available in the customer portal

Key File

By default, the Reveal SDK will look for a valid license in a file called license.key within a folder named .revealbi-sdk in the user's "Home" directory.

The "Home" directory differs depending on the OS you are using.

• Windows: C:/Users/your-user-name/
• Mac: /Users/your-user-name/
• Linux: /home/your-user-name/

When you receive your license key, create a text file named license.key within a directory named .revealbi-sdk located in your "Home" directory. Populate this file with your license key as its content.

[Contents of Lisense Key File]

Make sure the file contains only the raw license string. Do not include any additional code, comments, quotes, or formatting. Otherwise, the application may throw a runtime exception indicating that the file does not contain a valid Base64 string.

For example; if using Windows the license file location should be located at C:/Users/your-user-name/.revealbi-sdk/license.key.

Set In Code

The license key can also be provide in the application code.

ASP.NET

services.AddMvc().AddReveal(builder => 
{
    builder.AddSettings(settings =>
    {
        settings.License = "LICENSE_KEY";
    });
});

Java

RevealEngineInitializer.initialize(new InitializeParameterBuilder().
    setLicense("LICENSE_KEY").
    build());

Node.js

const revealOptions = {
	license: "LICENSE_KEY",
};
app.use("/", reveal(revealOptions));

Node.js - TS

const revealOptions: RevealOptions = {
	license: "LICENSE_KEY",
};
app.use("/", reveal(revealOptions));