Cryptolens

General

Login to Cryptolens

Follow these steps to access your Umbraco licenses through Cryptolens

  • Log in

    • Click the Login button in the top-right corner of the page.

    • Enter your credentials and sign in.

    • Note: You may be required to complete user authentication before proceeding to the next step.

  • Navigate to Umbraco Licenses

    • Once logged in, locate the Umbraco link in the right-side panel and click it.

  • Access Your Licenses

    • Click List Current Products to view all the Umbraco licenses.

    • From here, you can manage your licenses as needed.

Products

If you click on Products in the navigation menu, or select List current products in the dashboard, you’ll see an overview of all available products.

  • Forms

  • Deploy

  • Workflow

  • Commerce

  • UI Builder

  • Engage

Customers

To find or edit existing customers, go to the Customers section by clicking Customers in the navigation menu.

In the Customer view, you can search for customers using the following criteria:

  • Name

  • Email

  • Company

  • ID

Note

You cannot search for license keys in the Customer view.

Important

Do not create customers in this view. 

Once you’ve found the customer you’re looking for, click on their name to open the Customer view.

In this view, you can:

  • Edit customer details

  • View the list of the customer’s licenses

Search

To search for a license in Cryptolens, you first need to open the specific product license you want to search within.

Available product licenses include:

  • Forms

  • Deploy

  • Workflow

  • Commerce

  • UI Builder

  • Engage

Once you know which product license you need to search in, open the corresponding Product view.

  • In this example, we’ll use Engage as the product license.

In the Engage view, click on the search bar located above the list of license keys.

To find a specific license, enter the license key in the search bar.

Note

You cannot search by Name, Email, or Company in this search bar—only license keys are supported.

Important

You can use Cmd + F (Mac) or Ctrl + F (Windows) to search the page, however, this will only search the licenses displayed on the current page. Licenses on other pages (e.g., page 3) will not appear in this search.

After entering the license key in the search bar, the license will be displayed below if it exists in the system.

Create a license in Cryptolens

How to handle the different license requests

There are two ways to request a license 

  1. Internally through the licensing-commercial-products channel on Slack with the workflow. 

    • Each workflow form includes all the necessary questions for creating or updating a license, and the requester is asked to specify whether it’s a paid, demo, trial, or free license.

    • If the license is paid and needs to be invoiced, Fishtank will automatically be notified.

    • Once a license has been requested internally, please reply in the original Slack thread with the license key after it has been created.

  2. Externally, customers make their own requests through our website https://umbraco.com/licenses.

    • When customers request through this link, they'll come through to the Product Licenses on Intercom, and everything has been paid for. 

    • Once a license has been requested externally, please reply in a side conversation on Intercom with the license key after it has been created, along with the documentation on how to install and configure it.

      • You can use the #License Information Client Response macro and edit it to match the correct product, version, and key.

How to create a license

This is a general instruction on how to create Workflow, Forms, UI Builder, Deploy, Commerce and Forms licenses for Umbraco v13+ projects.

Create a license key

This applies to all Umbraco subscription licenses. There are some specifics for Forms and Engage (see the bottom of this section).

  • From the product listing, choose the license type you want to create, and go to that page.

  • Then click on the "Create new key" button to start the process.

Enter details for the license

Then you need to fill in the BASIC license details:

  • Set time: usually 365 days, but check the license request to be sure.

  • Number of keys: ALWAYS "1".

  • Notes: add the main domain, if it is a free license, write it here as well.

In FEATURES, check:

  • Timelimit.

  • If the license is a trial, also check Trial.

  • Engage has additional possibilities in this one. Check HERE.

Fill in Customer Information:

  • Search the drop-down menu to see if the customer exists. If yes, add that customer. If not, you'll need to create one by clicking on the + sign.

Create a new customer

To create a new customer:

  • Click on the + sign in the create key -view. This will open new fields.

  • Fill in the Customer's name, email and company details. Make sure to avoid typos.

After filling out all the fields, you can click CREATE.

Add domains

After you've clicked create, you're directed to the license listing page. 

Now it is time to add domains. The license key you just created appears (usually) on the top of the list you see. To open it click on the license key on the left side. The license opens in a pop-up window.

Tip

In this window, you can still edit the license details if you forgot something before.

To add the domains, scroll down a little, and click on add/edit data objects. This will open a new window.

In this window you can add the requested domains to the license. One domain per row.

  • Name: integer from 1 upwards.

  • String value: a domain. Domains should be in apex form and include a wildcard (*.example.com). No wildcards in Engage licenses!

  • IntValue: "0" zero.

Important

Remember to create a line for local and localhost as well, with a wildcard (except no wildcards for Engage)

That's it! Your license is ready, and you can send the license key to the customer. 

Extend and unblock a license key

A license key can be extended after a confirmed payment of a subscription by a customer.

  • Find the license key under the requested product and click to edit it.

  • Type in the number of days the license should be extended for and click the + button.

To unblock a license: when the license has expired and been blocked, click the Unblock button to unblock it again.

Specifics for Engage, UI Builder, Forms and MVP licenses

Engage license

Engage license offers a couple more options for configuration. 

Has Analytics is always checked. In practice we only sell licenses for analytics only or all features - so you'll only ever tick just the first or all three feature checkboxes. Check the license request for which other options need to be checked.

If the product has been sold as an partner license, tick the "Is Partner" box.

If it is a trial license, make sure to tick the box 'Trial (F6)'.

The number of page views supported by the license is entered as a variable under "Data Objects".  The variable should have a name of #pageViews and a value of the appropriate number.

Caution

Very important!!!
Be aware that if it is a trial license, you must tick the box Trial (F6). If not, you are giving away free unlimited licenses.

When adding domains to an Engage license, DO NOT use wildcards.

UI Builder

Agency Licenses

Umbraco UI builder is the only license available on an agency license. Setting up the license follows almost the same process as all the other Cryptolens licenses, but with a couple of differences.

We create a single license per agency and add all of their customer site domains to that single license.

However, to avoid exposing customer A's domains to customer B, we need to do two things differently:

  • When creating the license, tick the third feature flag labelled "Agency License".

  • When adding the domains to the license via the "Data Objects" screen, the data object Name can be used to indicate a customer. We do this by providing a name with a prefix.  It's easiest to demonstrate with an example:

In this screenshot we have a single agency license, with two customer sites A & B, each with two domains.

  • Set a prefix prior to the "_" character in the name field.  So each customer should have the same prefix (e.g. "customerA_dev", "customerA_live").

  • With that in place we can make sure to only expose the domains relevant to each customer when a validation request is made.

Forms license

Forms subscription licenses work for Umbraco versions 13, and 16 upwards. (NOT for v14 or v15)!

From v17 onwards we offer only subscription licenses for Forms. Before this, customers can have a one-off license instead. We have a PP presentation for the details regarding the transition period: Umbraco Forms 

Important

Customers can be confused about the new license format or their access to the old shop. If you have an intercom ticket open with such a customer, add that ticket to the existing tracker ticket. We want to track these.

If a customer accidentally requests a Forms subscription license but wants an old one-off license instead, follow this workflow:

  1. Block the license key in Cryptolens and add a note explaining the reason.

  2. Inform Fishtank that the subscription license needs to be cancelled.

  3. Ask the client to order the correct license at umbraco.com/licenses

➡️Customers no longer have access to the old shop to see which licenses they have.

If a customer requests a list of their Forms licenses in the old shop, we can generate this:

  • Create a task to webdevelopment team's Airtable (Alban)

  • Use this link: https://airtable.com/appGsT7Q6pDXZnpKd/shrp0FiR2FCWKrXaa

  • Create it as a bugfix request.

  • Add shop account email to the request

  • And add which details the customer is requesting such as: license creation date, binding domain and additional domains.

  • Send the request.

MVP license

It’s also possible to request an MVP license.

Create this license the same way as a regular one, with two additional steps:

  • In the notes, write “MVP free license”.

  • When adding the company name, use the person’s name instead.