License Key - Prediction Engine

<div class="section-label">06 License Key</div> <div class="section-title">Activate after you install.</div> A **workstation** license is typically applied to laptop or desktop computer. Follow the three steps below. **Before you begin:** finish an [[Install/Get Started|Install]] path so rbp-license-info is available on your machine. If CSA assigned a **server**, **shared environment**, or **enterprise site** license instead, skip to [Servers, shared environments, and enterprise sites](#servers-shared-environments-and-enterprise-sites).   > [!warning] > The request code is only a request. It does not unlock the product by itself. CSA reviews it and sends back your signed license key. ## (1) Request a code On your approved computer, run: ```bash rbp-license-info ``` Copy the full code that starts with RBP-LRC-1: and send it to CSA the way your account team requested. > [!tip] > If the command is “not found,” open the same environment you installed into (for example your Python virtual environment). R users can call rbpengine::license_info() instead. Or jump to [Find the license tool](#find-the-license-tool). ## (2) Activate your key CSA returns a key that starts with RBP-LIC-1:. Activate it once: ```bash rbp-license-info --setlicense RBP-LIC-1:… ``` > [!warning] > Your license key is a secret. > > - Do not put it in public repositories or shared chat logs > - Store it in your organization’s secrets process when possible > - Tell CSA if it may have been exposed, or if you move to a different machine than the one that was licensed ## (3) Confirm your license ```bash rbp-license-info --viewlicense ``` You should see that a valid license is present. Then you are ready to run predictions. ## Troubleshooting | What you see | What to try | | --- | --- | | Command not found | [Find the license tool](#find-the-license-tool) | | License not found | Confirm step (2) completed | | Wrong machine / user | Request and activate again on the computer CSA approved | <div class="btn-row center"> <a class="btn-ghost" href="/Install/Get%20Started">← Get Started</a> <a class="btn-primary" href="/Install/Python">Python install</a> </div> *** # Servers, Virtual Machines, and Enterprise Deployments Use this section only if CSA told you that you have a **service-node** or **site** license. Individual workstation users can ignore it. ## Service node (one server or VM) Request the code **on that server**: ```bash rbp-license-info --sku service-node ``` Send the RBP-LRC-1: code to CSA. When you receive the key, set it for the processes that run predictions: ```bash export RBP_LICENSE=RBP-LIC-1:… ``` If the server is rebuilt and its machine identity changes, request a new code and ask CSA to reissue the key. ## Enterprise site (many servers or containers) CSA gives you a **site ID**. Set it before requesting the code: ```bash export RBP_SITE_ID=your-csa-assigned-site-id rbp-license-info --sku site ``` Send the RBP-LRC-1: code to CSA. On **every** machine in that environment, set both: ```bash export RBP_SITE_ID=your-csa-assigned-site-id export RBP_LICENSE=RBP-LIC-1:… ``` Use the exact site ID CSA sent you. A mismatch will block licensed use. ### Confirm (servers and sites) ```bash rbp-license-info --viewlicense ``` | What you see | What to try | | --- | --- | | Site ID mismatch | Exact RBP_SITE_ID from CSA on every instance | | Server was rebuilt | New request code + ask CSA to reissue | | License not found | Confirm RBP_LICENSE is set for the session that runs predictions | *** # Find the license tool Use this section only if your terminal says it cannot find rbp-license-info. The tool is installed with the product. Your terminal may not be looking in the right folder yet. ### Quick checks 1. Open a **new** terminal window after installing. 2. Use the same environment you installed into. 3. Confirm you finished an [[Install/Get Started|Install]] path. ### Python (`pip install rbp-engine`) The tool lives **inside the Python environment**, not in the native runtime prefix. Activate that environment, then try again. **Locate the files (works even when PATH is wrong):** ```bash python -m pip show -f rbp-engine | grep -i license-info ``` On Windows PowerShell: ```powershell python -m pip show -f rbp-engine | Select-String license-info ``` Or ask Python for the package `bin` folder: ```bash python -c "import rbp_engine, pathlib; print(pathlib.Path(rbp_engine.__file__).resolve().parent / 'bin')" ``` | System | Typical locations after `pip install` | | --- | --- | | **macOS / Linux** | Inside your environment: `<venv>/bin/rbp-license-info` · or user install: `~/.local/bin/rbp-license-info` · and the bundled binary under `…/site-packages/rbp_engine/bin/rbp-license-info` | | **Windows** | Inside your environment: `<venv>\Scripts\rbp-license-info.exe` · and the bundled binary under `…\site-packages\rbp_engine\bin\rbp-license-info.exe` | **Run by full path:** ```bash # macOS / Linux: virtual environment ./.venv/bin/rbp-license-info # macOS / Linux: bundled copy next to the package "$(python -c "import rbp_engine, pathlib; print(pathlib.Path(rbp_engine.__file__).resolve().parent / 'bin' / 'rbp-license-info')")" ``` ```powershell # Windows: virtual environment .\.venv\Scripts\rbp-license-info.exe # Windows: bundled copy next to the package python -c "import rbp_engine, pathlib; print(pathlib.Path(rbp_engine.__file__).resolve().parent / 'bin' / 'rbp-license-info.exe')" # then paste that path into PowerShell and run it ``` ### R (`install_engine()`) You do not need the tool on PATH. From the same R session: ```r rbpengine::license_info() rbpengine::license_info("--setlicense", "RBP-LIC-1:…") rbpengine::license_info("--viewlicense") ``` The binary is in the runtime tree install_engine() unpacked, the same layout as a native install. Prefixes: [[Install/Native Runtime#Where the runtime lives|Native Runtime]]. ### Native runtime Unpacked tarball, RBP_ENGINE_HOME, macOS .pkg, and the R install_engine() prefix are documented on [[Install/Native Runtime#Where the runtime lives|Native Runtime]]. The license tool is always <prefix>/bin/rbp-license-info (.exe on Windows). ### Still stuck? Email or message your CSA account team with your operating system (macOS, Linux, or Windows) and whether you installed via Python, R, or a native runtime. They can confirm the path for your build.