From a3b3cd511d2a0508a8725022fc0fe4331425c929 Mon Sep 17 00:00:00 2001 From: Chuck D'Antonio Date: Tue, 23 Sep 2025 15:34:12 -0700 Subject: [PATCH 1/3] Documents new custom field types TL;DR ----- Adds the new types of custom license fields Details ------- Updates the docs on custom license fields to include the "Password" and "Enum" types. Passwords are eseentially strings that are considered sufficiently sensitive to be masked in the UI, while enums allow you to specify a list of options for the users to choose from. Provides more description of each type by moving the list of types into its own section and putting the types in a table with the name, an explanation, and the type of widget used on the "Manage Customer" screen. --- docs/vendor/licenses-adding-custom-fields.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/docs/vendor/licenses-adding-custom-fields.md b/docs/vendor/licenses-adding-custom-fields.md index 7baa11e30e..f0f1ac12bc 100644 --- a/docs/vendor/licenses-adding-custom-fields.md +++ b/docs/vendor/licenses-adding-custom-fields.md @@ -80,11 +80,27 @@ To create a custom license field: |-----------------------|------------------------| | Field | The name used to reference the field. This value cannot be changed. | | Title| The display name for the field. This is how the field appears in the Vendor Portal and the Admin Console. You can change the title in the Vendor Portal. | - | Type| The field type. Supported formats include integer, string, text (multi-line string), and boolean values. This value cannot be changed. | + | Type| The field type. This value cannot be changed. See [Understanding + Custom License Field Types](#understanding-custom-license-field-types) for more information. | Default | The default value for the field for both existing and new customers. It is a best practice to provide a default value when possible. The maximum size for a license field value is 64KB. | | Required | If checked, this prevents the creation of customers unless this field is explicitly defined with a value. | | Hidden | If checked, the field is not visible to your customer in the Replicated Admin Console. The field is still visible to you in the Vendor Portal. **Note**: The Hidden field is displayed only for vendors with access to the Replicated installers (KOTS, kURL, Embedded Cluster). | +#### Understanding Custom License Field Types + +Each custom license field has a type that is used to validate its value. Some types change the widget used to edit the field when managing the customer. + +| Field | Description | Widget | +|-----------------------|------------------------|---------------------| +| Integer | A whole number numeric value | text field | +| String | Short form text that generally fits on a single line | text field | +| Text | Longer form text that may contain multiple lines | text area | +| Boolean | True or false | checkbox | +| Password | A short string of text that is masked on display | password || +| Enum | Provides a list of possible values | dropdown | + +String, Text, Password, and Enum types are all represented as strings in the license. + ### Update Custom License Fields To update a custom license field: @@ -138,4 +154,4 @@ To delete a custom license field: If you enable **Preserve License Values**, you can create a new field with the same name and `type` as the deleted field to reinstate the preserved values. ::: -1. Follow the instructions in the dialog and click **Delete**. \ No newline at end of file +1. Follow the instructions in the dialog and click **Delete**. From 949ae7061fd4f307b107cf71456f2ffc163a8c67 Mon Sep 17 00:00:00 2001 From: Chuck D'Antonio Date: Tue, 23 Sep 2025 15:41:01 -0700 Subject: [PATCH 2/3] Removes troublesome newline --- docs/vendor/licenses-adding-custom-fields.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/vendor/licenses-adding-custom-fields.md b/docs/vendor/licenses-adding-custom-fields.md index f0f1ac12bc..2abdae0942 100644 --- a/docs/vendor/licenses-adding-custom-fields.md +++ b/docs/vendor/licenses-adding-custom-fields.md @@ -80,8 +80,7 @@ To create a custom license field: |-----------------------|------------------------| | Field | The name used to reference the field. This value cannot be changed. | | Title| The display name for the field. This is how the field appears in the Vendor Portal and the Admin Console. You can change the title in the Vendor Portal. | - | Type| The field type. This value cannot be changed. See [Understanding - Custom License Field Types](#understanding-custom-license-field-types) for more information. + | Type| The field type. This value cannot be changed. See [Understanding Custom License Field Types](#understanding-custom-license-field-types) for more information. | Default | The default value for the field for both existing and new customers. It is a best practice to provide a default value when possible. The maximum size for a license field value is 64KB. | | Required | If checked, this prevents the creation of customers unless this field is explicitly defined with a value. | | Hidden | If checked, the field is not visible to your customer in the Replicated Admin Console. The field is still visible to you in the Vendor Portal. **Note**: The Hidden field is displayed only for vendors with access to the Replicated installers (KOTS, kURL, Embedded Cluster). | From d074a80e7892922e8600326b89a1482cd2992986 Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Tue, 23 Sep 2025 17:56:48 -0600 Subject: [PATCH 3/3] copy edits --- docs/vendor/licenses-adding-custom-fields.md | 64 ++++++++++---------- 1 file changed, 32 insertions(+), 32 deletions(-) diff --git a/docs/vendor/licenses-adding-custom-fields.md b/docs/vendor/licenses-adding-custom-fields.md index 2abdae0942..26f1e13ef3 100644 --- a/docs/vendor/licenses-adding-custom-fields.md +++ b/docs/vendor/licenses-adding-custom-fields.md @@ -85,21 +85,6 @@ To create a custom license field: | Required | If checked, this prevents the creation of customers unless this field is explicitly defined with a value. | | Hidden | If checked, the field is not visible to your customer in the Replicated Admin Console. The field is still visible to you in the Vendor Portal. **Note**: The Hidden field is displayed only for vendors with access to the Replicated installers (KOTS, kURL, Embedded Cluster). | -#### Understanding Custom License Field Types - -Each custom license field has a type that is used to validate its value. Some types change the widget used to edit the field when managing the customer. - -| Field | Description | Widget | -|-----------------------|------------------------|---------------------| -| Integer | A whole number numeric value | text field | -| String | Short form text that generally fits on a single line | text field | -| Text | Longer form text that may contain multiple lines | text area | -| Boolean | True or false | checkbox | -| Password | A short string of text that is masked on display | password || -| Enum | Provides a list of possible values | dropdown | - -String, Text, Password, and Enum types are all represented as strings in the license. - ### Update Custom License Fields To update a custom license field: @@ -110,23 +95,6 @@ To update a custom license field: :::important Enabling **Is this field is required?** updates the license field to be required on all new and existing customers. If you enable **Is this field is required?**, you must either set a default value for the field or manually update each existing customer to provide a value for the field. ::: - -### Set Customer-Specific Values for Custom License Fields - -To set a customer-specific value for a custom license field: - -1. Log in to the Vendor Portal and select the application. -1. Click **Customers**. -1. For the target customer, click the **Manage customer** button. -1. Under **Custom fields**, enter values for the target custom license fields for the customer. - - :::note - The maximum size for a license field value is 64KB. - ::: - - Custom license fields section in the manage customer page - - [View a larger version of this image](/images/customer-license-custom-fields.png) ### Delete Custom License Fields @@ -154,3 +122,35 @@ To delete a custom license field: ::: 1. Follow the instructions in the dialog and click **Delete**. + +### Custom License Field Types + +Each custom license field has a _type_ that is used to validate its value. The type also determines the widget that you use to set the license field's value on the **Manager customer** page. + +| Field | Description | Widget | +|-----------------------|------------------------|---------------------| +| Integer | A whole number numeric value | text field | +| String | Short form text that typically fits on a single line | text field | +| Text | Longer form text that can contain multiple lines | text area | +| Boolean | True or false | checkbox | +| Password | A short string of text that is masked on display | password | +| Enum | Provides a list of possible values | dropdown | + +String, Text, Password, and Enum types are all represented as strings in the license. + +## Set Customer-Specific Values for Custom License Fields + +To set a customer-specific value for a custom license field: + +1. Log in to the Vendor Portal and select the application. +1. Click **Customers**. +1. For the target customer, click the **Manage customer** button. +1. Under **Custom fields**, enter values for the target custom license fields for the customer. + + :::note + The maximum size for a license field value is 64KB. + ::: + + Custom license fields section in the manage customer page + + [View a larger version of this image](/images/customer-license-custom-fields.png) \ No newline at end of file