Administrators can manage licences via the License Management page. The License Management page also provides admins with an overview of license variables such as number of users, access to particular features and expiry dates. The following functions are available on the License Management page.
Section | Description |
---|---|
Current License | This function allows admins to view the current license parameters for a Yellowfin instance. The license displays the Yellowfin product subscription details. To learn more about the Yellowfin suite of products, click here. You can also contact the Yellowfin team to request a different license. |
Upload License | This function allows admins to update license files when required, as the license key received with the installer is generally active for a limited time. |
Reminder Schedule | This function allows admins to schedule reminder emails to nominated users or email addresses when license expiry approaches. |
There are 2 ways to access the License Management page:
To access the License Management page from the left-side navigation pane:
To access the License Management page from the Admin Console:
Admins can view license parameters on the System Information page from the Administration menu, or by adding the extension info.jsp to the Yellowfin instance URL. For example, yourinstance:yourport/info.jsp. |
Expand the Current License section on the License Management page to view the current license parameters for the Yellowfin instance.
Upon receiving a new or regenerated license key, admins can upload the new license to Yellowfin by following the steps below.
If the license is invalid, a license error message will be displayed. Confirm the license is valid (dates, hostname) by viewing the parameters in a text editor. If all parameters appear to be valid, contact Yellowfin for support.
New license files must be uploaded from the server on which Yellowfin is installed, otherwise an error message will be displayed.
Use the code provided below to query a license file from a central server and specify the time interval for updates. The system will automatically update the license if a new version is available.
Add a snippet in the web.xml to enable license auto provisioning servlet.
<servlet> <servlet-name>LicenceAutoProvision</servlet-name> <servlet-class>com.hof.servlet.LicenceAutoProvision</servlet-class> <init-param> <param-name>Enabled</param-name> <param-value>true</param-value> </init-param> <init-param> <param-name>TaskPeriodInterval</param-name> <param-value>360</param-value> </init-param> <init-param> <param-name>Protocol</param-name> <param-value>http</param-value> <!-- <param-value>https</param-value>--> <!-- <param-value>sftp</param-value>--> </init-param> <init-param> <param-name>Hostname</param-name> <param-value>localhost</param-value> </init-param> <init-param> <param-name>Port</param-name> <param-value>8100</param-value> </init-param> <init-param> <param-name>PathToLicenceFile</param-name> <param-value>/static/licence.lic</param-value> </init-param> <init-param> <param-name>Username</param-name> <param-value>demo</param-value> </init-param> <init-param> <param-name>Password</param-name> <param-value>demo</param-value> </init-param> <load-on-startup><!-- can use 9 or greater, as long as its one of the last servlet initialised --></load-on-startup> </servlet> |
Parameter | Description | Parameter Status |
Enabled | To enable if license automatic provisioning should start | Required, values are "true" or "false" |
TaskPeriodInterval | To configure how often periodic task should run again after | Required, any number |
Protocol | Required, supported values are "http"/"https"/"sftp" | |
Hostname | Central server hostname | Required |
Port | Central server open port for Yellowfin to connect to | Required |
PathToLicenceFile | String path to the license file | Required |
Username | Username for HTTP/HTTPS Basic Authentication and log in for SFTP | Optional |
Password | Password HTTP/HTTPS Basic Authentication and log in for SFTP | Optional |
Outgoing mail server settings must be configured for license reminder schedules to function. |
Admins can edit license reminder schedules by clicking the Schedule or Recipients links. |