diff --git a/docs/vendor/licenses-adding-custom-fields.md b/docs/vendor/licenses-adding-custom-fields.md index 4a6ecb3c55..7baa11e30e 100644 --- a/docs/vendor/licenses-adding-custom-fields.md +++ b/docs/vendor/licenses-adding-custom-fields.md @@ -2,26 +2,56 @@ This topic describes how to manage customer license fields in the Replicated Vendor Portal, including how to add custom fields and set initial values for the built-in fields. -## Set Initial Values for Built-In License Fields (Beta) +## Manage Built-In License Fields -You can set initial values to populate the **Create Customer** form in the Vendor Portal when a new customer is created. This ensures that each new customer created from the Vendor Portal UI starts with the same set of built-in license field values. +This section describes how to manage the built-in license fields that are included in the licenses for all customer records by default. For a list of the built-in license fields, see [Built-In License Fields](/vendor/licenses-using-builtin-fields). + +### Set Initial Values for Built-In License Fields + +You can set initial values to populate the **Create Customer** form in the Vendor Portal when a new customer is created. This ensures that each new customer created from the Vendor Portal UI starts with the same set of built-in license field values. These _initial_ values differ from _default_ values in that setting initial values does not update the license field values for any existing customers. :::note Initial values are not applied to new customers created through the Vendor API v3. For more information, see [Create a customer](https://replicated-vendor-api.readme.io/reference/createcustomer-1) in the Vendor API v3 documentation. ::: -These _initial_ values differ from _default_ values in that setting initial values does not update the license field values for any existing customers. - To set initial values for built-in license fields: 1. In the Vendor Portal, go to **License Fields**. -1. Under **Built-in license options**, click **Edit** next to each license field where you want to set an initial value. +1. Under **Built-in license options**, open the menu for the license field where you want to set an initial value and click **Edit**. ![Edit Initial Value](/images/edit-initial-value.png) [View a larger version of this image](/images/edit-initial-value.png) +1. In the **Edit built-in license field** dialog, edit the **Initial value** field. + + ![Edit license field dialog](/images/edit-built-in-license-field-dialog.png) + + [View a larger version of this image](/images/edit-built-in-license-field-dialog.png) + + :::note + Click **Reset initial value** to reset the value for the field to its default. + ::: + +1. (Optional) Enable the **Locked** checkbox to lock the license field. + + When a license field is locked, a lock icon is displayed on both the **Create a new customer** and **Manage customer** pages. + +1. Click **Update** to save your changes. + +### Lock Built-In License Fields + +When a license field is locked, a lock icon is displayed on both the **Create a new customer** and **Manage customer** pages. To edit a locked field, click the lock icon to temporarily unlock it. Locking a license field makes it more difficult to accidentally change the field's value. + +To lock a built-in license field: + +1. Under **Built-in license options**, open the menu for the license field that you want to lock and click **Edit**. + +1. In the **Edit built-in license field** dialog, enable the **Locked** checkbox to lock the license field. + +1. Click **Update** to save your changes. + ## Manage Custom License Fields You can create custom license fields in the Vendor Portal. For example, you can create a custom license field to set the number of active users permitted. Or, you can create a field that sets the number of nodes a customer is permitted on their cluster. diff --git a/docs/vendor/releases-creating-customer.mdx b/docs/vendor/releases-creating-customer.mdx index 1338acdadf..bcd6b093ae 100644 --- a/docs/vendor/releases-creating-customer.mdx +++ b/docs/vendor/releases-creating-customer.mdx @@ -78,6 +78,18 @@ To edit license fields: * For applications installed with Helm that use the Replicated SDK, you can add logic to your application to enforce entitlements before installation or during runtime using the Replicated SDK API license endpoints. See [Check Entitlements in Helm Charts Before Deployment](licenses-reference-helm). * For applications installed with Replicated KOTS, update the license in the admin console. See [Update Online Licenses](/enterprise/updating-licenses#update-online-licenses) and [Update Air Gap Licenses](/enterprise/updating-licenses#update-air-gap-licenses) in _Updating Licenses in the Admin Console_. +## Edit a Locked License Field + +When a license field is locked, a lock icon is displayed on both the **Create a new customer** and **Manage customer** pages. For more information about how to lock and unlock license fields, see [Lock Built-In License Fields](licenses-adding-custom-fields#lock-built-in-license-fields) in _Manage Customer License Fields_. + +To edit a locked field: + +* On the **Create a new customer** page or the **Manage customer** page, click the lock icon to temporarily unlock the field. + + ![Lock icon on license field](/images/locked-license-field.png) + + [View a larger version of this image](/images/locked-license-field.png) + ## Archive a Customer When you archive a customer in the Vendor Portal, the customer is hidden from search by default and becomes read-only. Archival does not affect the utility of license files downloaded before the customer was archived. diff --git a/static/images/edit-built-in-license-field-dialog.png b/static/images/edit-built-in-license-field-dialog.png new file mode 100644 index 0000000000..9a6ef1761b Binary files /dev/null and b/static/images/edit-built-in-license-field-dialog.png differ diff --git a/static/images/edit-initial-value.png b/static/images/edit-initial-value.png index f290a18d98..f32eb12245 100644 Binary files a/static/images/edit-initial-value.png and b/static/images/edit-initial-value.png differ diff --git a/static/images/locked-license-field.png b/static/images/locked-license-field.png new file mode 100644 index 0000000000..e919d7448c Binary files /dev/null and b/static/images/locked-license-field.png differ