Vendor Platform
The vendor platform allows platform users (your staff members) to log in to their account and manage the organization's licenses. Depending on their permissions there are many tasks that can be accomplished, such as:
- Defining new products, configuring new entitlement options and license policies
- Issuing new licenses/orders
- Looking up license usage information
- Managing licenses (resetting devices/disabling licenses)
- Downloading invoices/setting up billing
The vendor platform is meant for your internal users.
For external users, please review our end-user portal documentation.
This section gives you a quick glance on summary aggregate statistics, as well as navigational elements to the rest of the platform.
Most data is aggregated within different sections to make it easily retrieve data. Here are the main summary views you can retrieve through the vendor platform using LicenseSpring:
This view allows you to look up all licenses that have been issued in your account. Clicking on any of the licenses will allow you to view the details for that given license.
The main actions that you can achieve on the license summary view include:
- Searching for and looking up a license
- Import licenses via CSV
- Download licenses via CSV
- Create new licenses (orders).
You can click on "tab columns" to add or remove columns to the table:
The columns you can add/Remove for the License Summary View are:
- Created on Date on which a license was created
- License Key/User The actual key or first email address assigned to a user-based license
- Product The product for which the license was issued on
- Expiration Date Time-limited and subscription-based licenses may have a value on when they are set to expire (or renew), if that field has been set for that license
- Is trial Will have an "x" symbol if the license is not of type trial, and a "checkmark" if the license is a trial license
- Status The status of the license (active/inactive/disabled)
- Times activated The number of devices that are currently node-locked to the license
- Max activations The maximum number of devices that the license allows to bind itself to
- Prevent Virtual Machine Boolean used to determine whether or not a license is allowed to run in a virtualized environment
- Customer email The email address specified for the customer associated to the order for which the license belongs to
- Customer name The name field of the customer associated with the order for which the license belongs to
- Customer company The company of the customer associated with the order for which the license belongs to
- Customer reference The reference (if specified) of a customer associated with the order for which a license belongs to
- Customer labels Labels (if any) added to a customer.
- Active Boolean displaying if there is at least one active device on the license
- Start Date Timestamp added to a license in case a start date was specified for the license
- Is bundle Boolean that shows whether the license is for a product bundle (True) or for a single product (False)
- Is air-gapped A green checkmark appears if this license is meant to activate an air-gapped license policy
- Is floating A green checkmark in this column if the license is meant to activate an on-prem floating license server.
- Is floating cloud Green checkmark in this column if the license is a cloud floating license.
- Max simultaneous license users Field used by both floating license types to determine max concurrent usage of the license. The Value will be N/A if the license is not of type floating
- Can borrow Green checkmark if the license is a floating license, and the default heartbeat can be overridden by a larger value
- Max borrow time Maximum time (in hours) that a floating license can be borrowed. N/A if the license is not a floating license or is a floating license and cannot be borrowed
- Max license users Maximum number of users that can be assigned to a license
- Enable maintenance period Boolean determining whether there is a maintenance window defined for the license
- Maintenance duration Duration of the maintenance period starting from the first activation of the license
- Maintenance End Date End date when the license maintenance window expires
- Max consumptions If the license is of type consumption, this is the maximum consumptions allowed for that license
- Total consumptions Total consumptions counted on the license to date. N/A if this is not a license of type consumption
- Product features Lists all feature codes that have are added to this license
- Disabled on If the license is disabled, this column will show the Date on which the license has been disabled on.
- Activated on This is the date that the license was last activated on. It is updated for every license activation
- Last updated Time stamp with the last modification to the licenses entitlements
- Last checked Time stamp with the last online license check
- Valid duration If the license is time-limited, the license's expiry date is counted on the time stamp of the first activation and this duration
- Order Order ID
- Active Devices Up to Dates Number of active devices using the latest product version
- Note Any note that is added to the license will appear in this column
This is summary view that displays a table with order information. Clicking on one of the orders will open the orders summary view.
Actions you can take on the orders summary view Include:
- Search for an order
- Download all orders and licenses for a given date range
- Start the order creator process
The columns you can specify for the orders table are:
- Created on Date/time at which an order was created
- Customer email If a customer is specified for this order, then the customer's email address will appear in this column
- Customer name Customer name if the order has a customer specified
- Customer company Company of the customer if the Order belongs to a customer with a company field
- Customer account Account of the customer if they belong to one, and if the order has a customer specified
- Customer reference Customer reference number if one is specified
- Customer Labels Customer label if one was specified
- Order ID Orders will always have this value
- Order reference Optionally specified reference number of the order
- Last updated Last time the order information was updated (order reference, campaign parameters, downloadID, is test, or is trial ).
- Type If created using a trial key License API endpoint it will be set as api_trial and in rest of the cases it will be set as normal. It can be overwritten using Management API when using the create order endpoint
- Campaign parameters Optional field, currently not used
- Is trial If the order was created when generating a trial license via the License API, there will be a green check mark in this field
This view will present a table with all of the customers that have been specified within LicenseSpring.
Common tasks you can accomplish on the customers summary view include:
- Looking up customers
- Defining customer labels
- Add a new customer to LicenseSpring
- Download a CSV file with all customers
LicenseSpring allows customers to be grouped by account. This is useful if you license software to an organization with different departments, or multiple locations, and can be found by expanding the "Customers" tab in the left-hand navigation
The columns in the accounts table include:
- Name Account name
- Code Account code
- Number of customers Number of customers that belong to a specific account
- Email Email address associated with the account
- Reference Optional value that can be useful when searching for an account
To retreive information on the account without moving from the summary page, click on the dropdown arrow next to the account Name:
The product configuration view allows platform users to define new products or product bundles, archive a product, or disable products, as well as add options to individual products.
Sections of the Product Configuration View
- Active Products List List of all products that are either active or disabled
- Archived Products List List of products that are no longer in use.
How to Search for a an Existing Product
You can search by product name or by the product code. If you have a lot of products in your account, you may also want to apply a filter to your results to narrow the results. Available filters include:
- Authorization method Drill down by key-based licenses, or user licenses
- Status Is the product active or disabled
- Allow trial Does the product allow trial licenses to be issued
We added separate articles to cover the functionality for the following sections of the vendor platform:
- License details
- Order details
- Customer details
- Customer account details
- Product configuration
- Analytics
- Settings