Activation

Activate your Rapid BI Catalog license — via the web UI or the CLI, for machines with and without internet access.

Web UICLIOnline activationOffline activation

Activate Rapid BI Catalog using the login credentials associated with your app.rapidlens.com account. You can activate via the web UI or via the CLI. Activation ends when you create your admin password; once that is done, continue to Post-installation Setup to configure the application.

Before you begin
Rapid BI Catalog must already be installed and reachable over HTTPS. See Installation and HTTPS Configuration.

Via Web UI

Online — Machines With Internet Access

  1. Open the Rapid BI Catalog web page at <server-ip>:3333.
    Replace <server-ip> with the IP address or hostname of your server.
  2. Enter your app.rapidlens.com username and password, then click Submit.
  3. Select the machine you want to activate.
  4. After successful activation, the Create Password page appears. Create a password for your Rapid BI Catalog admin account.
Web UI activation login
Online activation: sign in with your app.rapidlens.com credentials.
Select the machine to activate
Select the machine you want to activate.
Create admin password
After successful activation, create your Rapid BI Catalog admin password.
Note
This password is specific to the Rapid BI Catalog application and is separate from your app.rapidlens.com Customer Portal password. If forgotten, it can be reset by another Admin or via the CLI — see Password Reset.
Activation complete
Your machine is now activated. Continue to Post-installation Setup to set your default directories, application domain, email, and authentication mode.

Offline — Machines Without Internet Access

Prerequisites: a separate machine with internet access, and your app.rapidlens.com credentials.

  1. Open the Rapid BI Catalog web page at <server-ip>:3333 and select the Offline activation option.
  2. Enter your username and click Submit.
  3. Copy the License Request Code shown on screen.
  4. From a machine with internet access, log on to app.rapidlens.com and go to License & Billing → Rapid BI Catalog.
  5. Select the machine to activate → Machines without Internet access tab → Activate using License Request Code.
  6. Paste the Request Code, click Generate a License Activation Code, and copy the generated code.
  7. Back on the server, paste the License Activation Code into the activation popup and click Submit.
  8. On the Create Password page, create your admin password.
Offline License Request Code
Offline activation: copy the License Request Code shown on the server.
Generate a License Activation Code in the portal
In the customer portal, paste the Request Code and generate a License Activation Code.
Enter the License Activation Code
Back on the server, paste the License Activation Code to complete activation.
Activation complete
Continue to Post-installation Setup.

Via CLI

Online — Machines With Internet Access

Use your app.rapidlens.com credentials:

Command

Terminal
bicatalog login -u <username>

You are prompted to enter your password securely — it is never passed on the command line. After login, choose the machine to activate:

Example

Terminal
bicatalog login -u john@organization.com
Enter password: ********
Available machines to activate:
| ID  | Machine type | Machine name
| 1   | production   | (prod)
| 2   | development  | (dev)
| 3   | uat          | (uat)
| 4   | qa           | (qa)

Enter the machine ID to use: 1
[INFO] License activated
Note
The password is encrypted and stored on the local file system.

Offline — Machines Without Internet Access

Step 1 — Generate a License Request Code

On the server, generate a request code for your account:

Terminal
bicatalog license offline -u john@organization.com

Copy the License Request Code.

Step 2 — Generate an Activation Code via the Portal

From a machine with internet access:

  1. Log on to app.rapidlens.com → License & Billing → Rapid BI Catalog, and click Activate for your machine.
  2. Select the Machines without Internet access tab, then click Activate using License Request Code.
  3. Paste the License Request Code and click Generate a License Activation Code.
  4. Copy the activation command (with the code) shown by the portal.
Generate a License Activation Code in the portal
In the portal, paste the License Request Code and generate a License Activation Code.

Step 3 — Activate on the Server

Terminal
bicatalog license activate -c "<activation_code>"

After activation, create your admin password when prompted to finish.

Next Steps