License Management
Users with an installation of Form.io within their own Self-Hosted private cloud or on-premise environment will manage the of the Projects within that environment through valid License Key(s). These keys are implemented within the environment variables for the associated deployment and managed by users. To access and manage the keys, License Managers will log into the SaaS portal at portal.form.io and navigate to the License Management page found in the left-hand navigation bar, or by clicking the username dropdown. You must be a Licensed Manager in order to access and manage the License Key.
Contact support@form.io to become a License Manager for your deployment
License Manager UI
The License Management page will display all licenses associated with the License Manager's account. The License line item will summarize information such as the License Key name, Start/End dates, and all the Managers associated with the License Key. Users will typically only have one license key they manage, but some users may have multiple keys associated with different environments.
Clicking the carrot icon next to the License Key Name will expand providing License details. The left-hand navigation tabs will guide the user through all of the utilization options for the License such as API and PDF Servers, Projects, Tenants, and Form Managers. The documentation below details the presented information and how to manage the utilization.
Not all of these utilizations will be available depending on what has been purchased for your specific License.
API / PDF Server
Clicking the API or PDF server tab will show all of the servers associated with the License, important information for the servers, and the ability to manage the utilization.
Environment ID: The Environment ID the Server is associated with. Use the status endpoint within your environment to view the ID associated with your deployment:
https://myenvironment.com/status
The URL will output the server version, the associated schema, and the Environment ID. The ID can then be matched up with the ID found on the License Management page. This can be helpful if you have multiple environments and need to know which environment ID is associated with what License.
The PDF server will have the same environment ID as the API Server if the two servers are associated with the same database string within the environment.
Host Name: Links an environment with the Enterprise server network host it was created on.
Mongo Hash: MD5 hash of the mongoDB configuration which is useful for server logging and is an additional way to tie the user's database to the associated environment
Status Toggle: Click the Toggle to disable the server utilization for the environment. Disabling will free up another server utilization for your environment.
Delete: Removes the server utilization from the License Management UI. This does not disable the functionality of the server within the self-hosted environment.
Projects
The Project tab lists all Projects associated with the given License Key. License Managers can manage the utilization of the Project, Stages, and connected Form Manager Applications.
To reinstall the Portal Base Project, delete the project within the Database, restart the environment container, and the Portal Base Project will be recreated.
Simply deleting the Portal Base Project and reinstalling it will inadvertently consume a Project allocation within the license scope.
Title: Title of the Project
Name: The live endpoint name of the Project
FM: When checked, indicates if the Form Manager application is enabled for the Project. Clicking the carrot icon next to the Project title will show which stage within that project has the Form Manager enabled.
Project ID: ID found within the environment URL of the Project
Environment ID: The Environment ID the project is associated with. This ID will match the associated server Environment ID within the same license.
Status / Delete: Click the Status to disable the project utilization and delete to remove the utilization from the License Management UI. Disabling or deleting the utilization will not remove the project from the environment. See Deleting a License Utilization for more information
Stages: Stage utilization associated with the Project. License Managers can modify the utilization of these Stages just like the Project utilization.
Each Project will have 7 utilization stages available.
Tenants
The Tenants tab lists all associated Tenants within the given License Key and Project. License Managers can manage the utilization of all Tenants within the License Key. Expanding the Tenant line item will display all Stages within that Tenant. The same Project and Stage utilization information is available here including IDs and the ability to disable the utilization.
Deleting a License Utilization
Deleting a License utilization like an API Server, Project, or Tenant from the License Management page does not delete this item from the database. The utilization of the License Key is simply removed from the License Key which is helpful when cleaning up the UI for unused utilizations.
Deleted Project, Stage, or Tenant utilizations will reactivate if the Project or Stage is opened again by a user within the self-hosted environment.
Deleting the actual Project or Stage from the database does not remove the associated utilization within the License Key and will need to be manually removed by deleting the utilization within License Management UI.
Last updated
