End User Portal
What is the End User Portal?
The end user portal (EUP) is an option to help your end users manage their entitlements and do "offline" activations/de-activations.
A pre-built way for users to manage their entitlements saves support time and costs.
The end user portal can be customized to fit in with your branding. See below.
About the End User Portal configuration page
The End User Portal configuration page allows the vendor to easily upload a custom logo (via settings) and add a CSS stylesheet.
It also provides a convenient way to set the custom End User Portal URL.
NOTE: In order to have a custom URL, you will need to set up the appropriate CNAME records on your DNS information.
Customizing the End User Portal
The End User Portal (EUP) setup page is located under the "Administration" > "Configuration" > "End User Portal" on the top menu.
Change the URL and permissions.
Click the "edit" button in the top right of the first section to change the URL's name and allow a graph of activations to be displayed to the customer.
If you change the URL to your custom domain name, you will have to deploy a proxy to redirect traffic to your End User Portal. Please check sample proxy configuration on our github: https://github.com/Nalpeiron/eup-proxy
Upload custom CSS
To upload your CSS, click the "upload" button and select a CSS file from your desktop.
Here is an example of what you should customize.
Adding your logo
Go to the Administration in the left-hand navigation or click the button on the top right.
Accessing the End User Portal (EUP)
You will need to add "end-users" to Zentitle2 on a customer-by-customer basis for them to access the portal. Simply adding them will set off a process to invite them to set their own credentials and EUP access.
End User Portal User Access
Setting up End User Portal (EUP) access
To enable your end users to access the End User Portal (EUP), you will need to add them to your customers in the system.
When you add them, and you have access to the EUP functionality on your plan, you will see an option to set them up with EUP access. They will receive an email to access the EUP and self-serve offline activations, along with the opportunity to review the products on their account.
Granular permissions allow you to see who can view what on the EUP dashboard—the end user's admin level allows them to see more details.
To add an end user to the EUP, first add an end user under a customer per the docs on customers, etc
End user - Use of the portal
The End User Portal (EUP) facilitates the review of entitlements and any "offline" activation that may be required. The entitlement screens can be restricted so users can't see the usage graphs—see setup.
The URL for the EUP is unique to your company, and that is what you will issue to your end-users for access e.g., https://yourco.eup.zentitle.io/
Access to the EUP can be via either of our Account Based Licensing (ABL) methods - internal username/password or via an iDP, e.g., Auth0, etc
The portal can be customized using your logo and styled via CSS per the previous page. In our examples, we will use the fictitious company "Elevate Software."
Login page
Here is the login page the end user will see once you issue them the custom URL to the EUP mentioned above. The custom logo has been added.
You can see the two methods for logging in—the first is using the "internal" username and password from Zentitle2, and the second is using your iDP via single sign-on (SSO).
Using an iDP
Here is an example of an ISV like you setting up Auth0, which is the second option—you must set up this option in settings before it will function, obviously.
EUP Dashboard
When your end-users log in, the main page shows a list of their entitlements and the opportunity to perform an offline activation process. The end-user can filter their entitlements and download reports quickly and easily.
Permissions
The views below are for the "admin" role for your end-users.
Admin users can see all the entitlements in their account.
Standard users can only view the entitlements to which they are attached.
Note: you can add your custom logo like this example, it displays on the left hand navigation
Offline Activation
This is only used in cases where the end user is not connected to the Internet - more details here.
Reviewing Entitlements
Clicking on an entitlement will provide details on the features and capabilities they purchased.
End users cannot edit this information; they can only review it.
Using the internal tabs on the entitlements: "activations" and "activation log," will allow your user to review their usage and any attached activation codes.
The activations tab shows the end user who is in their organization, which is attached to the entitlement and the status of that user.
The activation log shows the end user the activity on the entitlement over time.
Logging out
In the top right-hand corner, the user can easily log out or reset their password.
End User Offline Activation
Zentitle2 fully supports offline activations, enabling your customers to activate a seat when the machine has no internet connection.
Note that an application that has been activated in an offline node lock manner cannot use the Advanced Features (usage count, element pools).
Applications using the Local License Server can make use of all Advanced Features.
The API calls to manage offline activations are in the Management API, and there are functions to manage offline activations within our client SDKs (for example, our .NET client).
Activate an offline machine.
Using the client SDK, generate an offline activation request token within your application and move it to a connected machine (such as using a USB key, copy/paste, or other technique). See Step (1) above.
In order to test this, you will need an activation code associated with the product and entitlement tested. This can be found in the "entitlement" section in the Zentitle2 UI.
Open the SDK.
Paste in the activation code previously sourced.
Click "Copy to clipboard" (or save to file).
Transfer activation request to the offline portal page
Now, you need to access the "end user portal" page related to your account.
Paste it (or upload it) to the End User Portal's offline activation page.
Click on 'Activate.
Copy the response token.
Use the offline token with the "offline" machine to activate
Go back to the offline machine (Step 2) and use the client SDK to ingest the response token in order to complete the offline activation sequence.
Open the SDK on the offline machine again.
Paste (or load from a file) the token from the portal page.
Click "activate offline."
The offline machine is now "activated" with the required entitlement.
Deactivate an offline activated machine.
Similarly, a user can de-activate an "offline activated device" by calling the DeactivateOffline API in the client SDK, which will immediately invalidate the locally cached license and simultaneously generate a Deactivation Credit token, which can be copied/moved to a connected machine using a USB key or other means and pasted into the End User Portal in the 'Deactivation' section.
Deactivate an offline machine.
Using the client SDK, generate an offline deactivation request token within your application and move it to a connected machine (such as using a USB key, copy/paste, or other technique). See Step (1) above.
Open the SDK
Click the "deactivate offline" button.
Click "Copy to clipboard" (or save to file)
Transfer deactivation request to the offline activation portal page
Paste it (or upload it) to the End User Portal's offline activation page.'
Click on 'Deactivate.
Now, the seat has been removed from the server side and can be re-activated again as required.