Licensing

Licensing Errors

If the system detects a licensing error, then most functionality is disabled until the licensing problem is resolved. A licensing shutdown entails the following behavior:

  • an error banner is displayed across the top of all screens. List of possible banners can be found here.

  • all extensions are disabled

  • extension functions are not available

  • background processing of extensions is shutdown (connectors, jobs, etc)

  • most apps and view become unavailable.

Note: A restart is required to restore the system after a licensing error

Over Capacity

If you exceed the point limit of your license during runtime, then the system is put into licensing error mode. You will need to do one of the following actions to fix your capacity usage:

  1. Purchase more capacity on your current license (or add another license to the system). Once license is updated, a restart is required

  2. Disable one or more projects on the host. The simplest way to do this is to just rename the var/proj/{proj}/db directory to something like var/proj/{proj}/db-hold then restart your server

  3. Use scripts or tools to remove point records from your project(s). Once you bring your point usage under the licensed limit, you must restart your server to re-enable the disabled extensions

Removing Demo Project

First, we recommend to remove our FIN Demo project if not needed or have a small license capacity. If you have a larger license capacity and enough CAPs to spare, its ok to use it for demos or to check certain things on our demo.

To remove the demo project, the user would follow these steps:

  1. Stop the FIN service

  2. Go to the FIN directory, and navigate to the proj folder. The path should be something like this but with your version: C:\Program Files (x86)\FIN Framework\FIN Framework v5.0.2276\var\proj

  3. Remove the demo folder from the proj folder (it can be deleted or moved to recycle bin)

  4. Restart the FIN service

Now the user should only have their project(s) under the proj folder if they have any.

Added too much data

If the user added more data than allowed against their license, then they'll get the licensing error banner. To resolve this, this user has to either purchase additional CAPs to increase the license capacity or remove some data to lower the CAP count. 

To purchase more CAPs, the user would need to contact their distributor or OEM.

To remove some data, the user would follow these steps:

  1. User needs to go to DB Builder of project

  2. Select some equips and/or points to bring it under the limit. (deleting equip will remove the points underneath it as well)

  3. Once done, restart the FIN service

Once it's back under the CAP limit, then the licensing error banner would go away and the user can look into purchasing additional CAPs before continuing to add more data.

This is assuming the user doesn't have the demo project in the db folder consuming around 1.3K CAPs. If they do, they would need to look at the section above about "Removing Demo Project" to resolve this and gain back CAPs used by demo project.

Upgraded FIN

If the user upgraded FIN and is now getting the licensing error banner, then all they may need to do is remove the demo db that gets added when installing FIN. The user would look at the section above about "Removing Demo Project" to resolve this.

If the user already removed the demo project and still get the licensing error banner, then they need to look at the section above about "Added too much data".

New install with small license

If the user is installing FIN for the first time and they have a small license less than 1.3K CAPs, then they need to remove the demo project. They would look at the section above about "Removing Demo Project" to resolve this.

Orphan Records

At times there are cases where the user has removed the demo project and is certain that they aren't consuming x amount of CAPs, but is still getting the Licensing Error. In that case, we recommend to use Remove Orphan Records tool in the Folio app to check if they have orphan records that are consuming CAPs.

Restoring items from trash

If the user had to remove some points/auxPoints to get under the license limit, they can restore some points/auxPoints that were removed after upgrading license OR as a regular point if you have room in that license pool.

If you want to bring back some of the points/auxPoints that had been removed from the database, into the trash, you can do the following:

  1. Open Folio app

  2. Click on the trash icon top right corner and select "show trash"

  3. The deleted point/auxPoint points will still exist in the trash (unless you've emptied the trash or deleted them forever)

  4. At this point you can remove the aux tag and add them back in as points or keep the aux tag and add them back in as auxPoints (removing the 'trash' marker tag will restore the point back into the database). 

Possible Errors

Below are the different types of errors and how to resolve them.

Error 1: Duplicate license file ids

This means the user uploaded multiple duplicate license files in their var/lic/ directory. To resolve this, the user would follow the below steps.

Option 1:

  1. In the Host, go to the Licenses tab and delete the license (need to do this with SU user)

  2. Then restart the FIN service and that should do it if the licenses are valid, if not look below

Option 2:

  1. Go to the "lic" folder in the FIN directory. The path should look something like this but with your version and location FIN is installed in: C:\Program Files (x86)\FIN Framework\FIN Framework v5.0.2276\var\lic

  2. Stop the FIN service and remove all the licenses

  3. Add the correct license in that folder OR start the FIN service

  4. Then upload the correct license via the Host > Licenses tab (need SU for this)

This should resolve the duplicate license error.

Error 2: License error - over auxPoint capacity limit: used x of x points; x of x auxPoints

The "License error - over auxPoint capacity limit" error indicates that the projects within the server contain more auxPoints (points tagged with the 'aux' marker tag) than the license is set to allow. To resolve this error, there are few options. First is to remove our demo project if it exists. The second option is to delete some auxPoints to get under the limit. The third option is to remove aux marker tag to make them non auxPoints if points limit is available. Our demo contains 30 if you decide to keep it. Depending on your license, it may be enough or you would have to remove more from your project(s). The user can follow the below steps for either option they want to go with.

Option 1:

  1. Remove the demo project that comes with the installation if not yet removed. Read the "Removing Demo Project" section on how to do this.

Option 2:

  1. Go to DB Builder of project

  2. Select the "points" tab

  3. In the "marker" tag column open the filter menu and select 'aux' from the list. Press "ok" to filter the results.

  4. Adjust the amount of results shown on the page based on how many auxPoints you need to view/edit at once.

  5. Click on the trash icon and move them to the trash

  6. Restart the FIN service and you should be good
    NOTE: If the user wants to restore some auxPoints if they deleted too many or have upgraded their license, they can look at the "Restoring items from trash" section.

Option 3:

  1. The user would follow option 2

  2. Then convert some to non aux points by removing the 'aux' marker tag from the selected points

  3. Go to folio and click on the trash icon top right corner to view trash

  4. Select points to convert to non aux points

  5. Edit them to remove the 'aux' marker tag and apply

  6. Now the user has moved some points from the auxPoints pool to the points pool if available.

Error 3: License error - over point capacity limit: used x of x points; x of x auxPoints

The "License error - over point capacity limit" error indicates that the projects within the server contain more points (points without the 'aux' marker tag) than the license is set to allow. To resolve this error, there are few options. First is to remove our demo project if it exists. The second option is to delete points to get under the limit. The third option is to make some of the non aux points as auxPoints if auxPoint limit available. Our demo contains about 1,190 points. Depending on your license, it may be enough or you would have to remove more from your project(s). The user can follow the below steps for either option they want to go with.

Option 1:

  1. Remove the demo project that comes with the installation if not yet removed. Read the "Removing Demo Project" section on how to do this.

Option 2:

  1. Go to DB Builder of project

  2. Select the "points" tab

  3. Filter for the points you wish to remove

  4. Once selected, click on the trash icon and move them to the trash

  5. Restart the FIN service
    NOTE: If the user wants to restore some points if they deleted too many, or have upgraded their license, or they want to convert some to auxPoints, they can look at the "Restoring items from trash" section.

Option 3:

  1. Go to DB Builder of project

  2. Select the "points" tab

  3. In the "marker" tag column open the filter menu and select 'aux' from the list. Press "ok" to filter the results.

  4. Then select points that are not aux points

  5. Once selected, the user can select the trend icon top right corner to convert them to aux points

  6. Thats it, now the user has moved some points from the points pool to the auxPoints pool if available.

  7. Restart the FIN service

Error 4: License is not compatible with 3.0

This means that the user uploaded a FIN 4.5 or older license file in their FIN 5.0 var/lic/ directory by new install or accidentally choosing wrong license file. FIN 4.5 or older licenses are not compatible with FIN 5 or newer, they will need to be upgraded to the new format. Contact your distributor/OEM to see what it would take to upgrade your license to a FIN 5.0 license if you don't have a FIN 5.0 license. To resolve this with a FIN 5.0 license, the user would follow the below steps.

  1. Go to the "lic" folder in the FIN directory. The path should look something like this but with your version and location FIN is installed in: C:\Program Files (x86)\FIN Framework\FIN Framework v5.0.2276\var\lic

  2. Stop the FIN service and remove all the licenses

  3. Add the correct license in that folder OR start the FIN service

  4. Then upload the correct license via the Host > Licenses tab (need SU for this)

This should resolve the license compatibility error.

Error 5: No license installed

This means that the user hasn't installed in FIN 5.0 license yet during installation. To resolve this, the user can follow the below steps. Note: When migrating, a FIN 4.5 will not work with FIN 5.0. You'll need a new license to be compatible with FIN 5.0.

  1. While in the Host window, go to Licenses tab on the left side

  2. Then click on Install button on the bottom left corner of that window

  3. Pick a FIN 5.0 license to install

  4. Then open it and restart the FIN service

Error 6: Release date is past the maintenance date.

This means that the maintenance date on the license expires prior to the latest software release date. To continue to take advantage of the latest features and software updates, the user would need to catch up on their maintenance. Once done, the new license will have an updated maintenance date that will be compatible with the latest version at that moment. If not, they would have to revert back to the previous software version that the current maintenance is compatible with.

Error 7: Disk full emergency shutdown [xMB < xMB]

This means that the machine hosting FIN doesn’t have enough disk space available and because of that will shutdown. This user would either have to delete some files such as backups if there are a lot, empty the Recycle Bin on the desktop to create some space, or expand the disk space to a larger capacity.

Warn 1: Invalid FIN license

This typically means that the service wasn’t fully restarted. A restart of the service should resolve this issue.