Installation: Hub License Key: Set Up a Standard License Key

• About Standard License Keys
• Check Your License Key
• Setting Up

About Standard License Keys

A standard CodeSonar license key is locked to a specific machine.

• The CodeSonar hub (web server) must run on this machine.
• Analyses can run anywhere.

Most CodeSonar license keys are standard license keys. The alternative is a floating license key.

Check Your License Key

Before setting up, work through the following steps to make sure your license key is signed and of the expected type.

• Do you have a license key?
  • YES: Inspect the license key text now.
    Does the license key have a "signature" attribute?
    • YES: Does the license key have an attribute of the form "floating":true?
      • YES: You have a floating license key. Go to License Key Installation: Floating License Key to set up this license key.
      • NO: Your license key is ready to set up using the instructions on this page. Go on to Setting Up.
    • NO: The license key has not been signed. Go to Hub License Key: Obtaining a License Key and follow the instructions for obtaining a signed license key.
  • NO: Follow the instructions in Hub License Key: Obtaining a License Key.

Setting Up

For a hub located at <host>:<port>, set up the license key as follows.

1. If you haven't checked your license key, check it now.
2. If the CodeSonar Web GUI is not already open, open it now.
   http://<host>:<port>/
   If you don't see the hub home page, make sure you have specified the correct <host> and <port>. For example, if you specified hub interface ::1 and port 7340 when you set up the hub, the web GUI home page will be at http://[::1]:7340/.
3. If you are not already signed in as Administrator, sign in now.
   1. Click the Sign In link (at the top right of the page).
      CodeSonar will open a page for you to enter credentials.
   2. Enter Administrator in the Username field.
   3. Enter the Administrator password in the Password field.
      (If you have just started a new hub, you will have set a password for Administrator as part of that process.)
   4. Click Sign In.
   If this is the first time the Administrator account has been used, you will be asked to specify an email address for the account.
4. Click the see licensing details link in the GUI footer.
   The License Utilization page will open. Directly under the page heading will be a text field labeled Edit License(s).

   Note: alternative license key installation instructions are available for users who are not able to use the web GUI.

5. Paste the text of your signed license key into the Edit License(s) field, replacing any text that was previously present.
6. Click Save.
   CodeSonar will read and apply your new license key.
   • On success, CodeSonar will display a "License successfully updated" message above the text field and update the utilization summary to reflect the current license key terms.
   • Otherwise, CodeSonar will display a "License Error" message above the text field, with details of the problem experienced. See Hub License Key: Troubleshooting for resolution guidelines.
7. Your current Administrator session has reduced privileges because you signed in while the hub was in an unlicensed state. Sign out now to end the session so that you can start a new one that takes the license key into account:
   1. Click the Sign Out Administrator link (at the top right of the page).
      CodeSonar will display a page stating that you have signed out
   2. Click the Continue link.
      CodeSonar will display the hub home page.
   You are now in an anonymous session. If you want to sign in again (as Administrator or another user), you can do so by clicking the Sign In link at the top right of the page and entering credentials when prompted.
8. If you have not yet configured the hub, go on to Hub Setup: Hub Configuration.
   Otherwise, go on to Installation: Finishing Up.