The administration interface to the Licensing-as-a-Service is on the Heirloom PaaS instance you Powered On and acting as your licensing server. Access it with the URL you have chosen for your server
Click the Sign-On link to log in with the initial super user "firstname.lastname@example.org" and password "heirloom". Create a new superadmin user (e.g. email@example.com) and delete this one once you get the chance.
Once logged in you will have access to various features of the dashboard based on your user role. As a super user you have full access to dashboard features. As an admin you'll be able to work on users within your group and as a regular user you'll be able to view your own details and history.
Ability to alter records depends upon the roles assigned to that user. Roles are
- superadmin - ability to change any record and add new records
- admin - ability to change any record with the same group name and add licenses for customers within the group
- deploy - regular user allowed to read records owned by them and check their own licenses
- trial - regular user allowed to read records owned by them and check their own licenses, but for a trial period of time
When a superadmin or admin logs in they will initially be presented with the Users portal - the list of Customer records in the system. This portal shows the users within your system, and can be used to edit some of their properties. You can also load a single user or group of users by typing their email address or group name into the search field and clicking the appropriate toolbar icon (either of the 2 binocular icons to the left of the button group). To load all users you have access to, click the refresh button.
Double click a user to edit various properties of that user, clicking Update or cancel when finished as appropriate.
Right clicking a user will allow you to view their licenses by opening the Licenses portal.
The Licenses portal will show licenses for the user you selected (alternatively right clicking in the white space of the portal will allow you to load a License Portal that shows all users). Each license record shows the product and restriction the license is for, as well as a total transaction count, created date and an expiry date.
Double clicking the license will allow you to edit various parameters as well as reset the license checking parameters like MAC addresses and IP addresses. You can do this if a license is used on more machines or by more users than the restriction allows and you wish to reset it.
Clicking Add, if available to you will allow you to create a new license for that user. NOTE: This feature is only available from a users license portal, rather than the global portal you reach by right clicking the dashboard white space.
Right clicking a license allows you to view license history for that user and license via the License History portal.
The License History portal shows each transaction of a client with the license service and the outcome of that transaction. The 'Activity' columnshows that result and a 'good' transaction will show up as 'OK <email address>'. The transaction column shows the total transaction count sent during that license communication.
Clicking the 'save history' toolbar icon will generate a savable text version of the history list, while clicking the left of right arrow toolbar button will change the time period the history is shown for.
As a superadmin you will also have access to the Product and Restriction portals. Right click the dashboard whitespace to bring those up.
A product has a default restriction which can be overridden in a users license, but you will need to create a restriction before you can create a product.
Restrictions have various parameters that can be set to restrict how the license for that product can be run. Click 'Add' and fill in the required fields to create a restriction.
'Check Every' is the time in seconds a client will wait after a successful check before checking the license again.
Grace Period is the time in seconds a client will allow an invalid license to continue to be run.
MACs, Hosts, IPs and Cores are the count of those items a license may be used with. For example 2,2,2,1 in those fields means the license may be used with 2 mac addresses, 2 host names and 2 IP addresses (proxies can mean an IP address changes even though the host appears the same) and a single core machine.
Concurrency indicates how many of these license may be used at the same time.
A product can be created by clicking 'Add' and entering the required details. The 'Period' column indicates the number of days a license is create for by default (this can be changed by editing the license's expiry date) and is specified in the following format: ' <n> D' where <n> is the number of days.
There are help and support links at the top right of the dashboard which will give you access to the helpdesk and also the ability to search the forum or submit support incidents without leaving the dashboard.