License management (IRPCLicenseManagement)
Reads and sets the server's license, its usage, and whether licensed features such as OCR or M-Files Web are available.
Use this interface to set or get license code and serial number.
| gRPC service | MFiles.IRPCLicenseManagement |
|---|---|
| Book and level | Administration API, specialized |
| Methods | 6 |
| Proto file | mfiles/IRPCLicenseManagement.proto |
Overview
M-Files Admin uses this service on its license page. Applications mostly need only DoesLicenseHaveFeature, which any session can call to find out whether an add-on feature is licensed before offering it.
Sessions and rights. A server-level session is enough (log in with login_data.vault_guid =
{00000000-0000-0000-0000-000000000000}). Reading or changing the license code and reading the
usage require the system administrator server role (server right manage_licenses in
ServerAccess); other callers get "Access denied. You do not
have the server-level access rights required by this operation.". On servers that license each
vault separately through M-Files Manage, a vault administrator can also read that vault's
license and usage from a vault session.
- Feature checks: DoesLicenseHaveFeature (session), DoesLicenseHaveFeatureByVaultDNS (no session).
- License code: GetLicenseCodeAndSerialNumber, SetLicenseCodeAndSerialNumber, RefreshLicenseCode.
- Usage: GetLicenseUsage.
Methods
| Method | Summary | Facts |
|---|---|---|
| DoesLicenseHaveFeature | Tells which of the requested add-on features (OCR, M-Files Web, AI search and so on) the license allows. | admin session idempotent |
| DoesLicenseHaveFeatureByVaultDNS | Tells whether a feature is licensed for the vault that a host name points to, without a session. | admin no session idempotent |
| GetLicenseCodeAndSerialNumber | Gets the server's serial number, license code and evaluation state. | admin session idempotent |
| GetLicenseUsage | Gets how many named, concurrent and read-only user licenses are in use. | admin session idempotent |
| RefreshLicenseCode | Asks the server to fetch its license again from M-Files Manage. | admin session idempotent |
| SetLicenseCodeAndSerialNumber | Installs a new license for the server. | admin session idempotent |