Skip to content

Commit a86ea15

Browse files
crdantpaigecalvert
andauthored
Documents new custom field types (#3545)
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. Co-authored-by: Paige Calvert <[email protected]>
1 parent 53c85c9 commit a86ea15

File tree

1 file changed

+34
-19
lines changed

1 file changed

+34
-19
lines changed

docs/vendor/licenses-adding-custom-fields.md

Lines changed: 34 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ To create a custom license field:
8080
|-----------------------|------------------------|
8181
| Field | The name used to reference the field. This value cannot be changed. |
8282
| 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. |
83-
| Type| The field type. Supported formats include integer, string, text (multi-line string), and boolean values. This value cannot be changed. |
83+
| Type| The field type. This value cannot be changed. See [Understanding Custom License Field Types](#understanding-custom-license-field-types) for more information.
8484
| 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. |
8585
| Required | If checked, this prevents the creation of customers unless this field is explicitly defined with a value. |
8686
| 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). |
@@ -95,23 +95,6 @@ To update a custom license field:
9595
:::important
9696
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.
9797
:::
98-
99-
### Set Customer-Specific Values for Custom License Fields
100-
101-
To set a customer-specific value for a custom license field:
102-
103-
1. Log in to the Vendor Portal and select the application.
104-
1. Click **Customers**.
105-
1. For the target customer, click the **Manage customer** button.
106-
1. Under **Custom fields**, enter values for the target custom license fields for the customer.
107-
108-
:::note
109-
The maximum size for a license field value is 64KB.
110-
:::
111-
112-
<img width="600" alt="Custom license fields section in the manage customer page" src="/images/customer-license-custom-fields.png"/>
113-
114-
[View a larger version of this image](/images/customer-license-custom-fields.png)
11598

11699
### Delete Custom License Fields
117100

@@ -138,4 +121,36 @@ To delete a custom license field:
138121
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.
139122
:::
140123

141-
1. Follow the instructions in the dialog and click **Delete**.
124+
1. Follow the instructions in the dialog and click **Delete**.
125+
126+
### Custom License Field Types
127+
128+
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.
129+
130+
| Field | Description | Widget |
131+
|-----------------------|------------------------|---------------------|
132+
| Integer | A whole number numeric value | text field |
133+
| String | Short form text that typically fits on a single line | text field |
134+
| Text | Longer form text that can contain multiple lines | text area |
135+
| Boolean | True or false | checkbox |
136+
| Password | A short string of text that is masked on display | password |
137+
| Enum | Provides a list of possible values | dropdown |
138+
139+
String, Text, Password, and Enum types are all represented as strings in the license.
140+
141+
## Set Customer-Specific Values for Custom License Fields
142+
143+
To set a customer-specific value for a custom license field:
144+
145+
1. Log in to the Vendor Portal and select the application.
146+
1. Click **Customers**.
147+
1. For the target customer, click the **Manage customer** button.
148+
1. Under **Custom fields**, enter values for the target custom license fields for the customer.
149+
150+
:::note
151+
The maximum size for a license field value is 64KB.
152+
:::
153+
154+
<img width="600" alt="Custom license fields section in the manage customer page" src="/images/customer-license-custom-fields.png"/>
155+
156+
[View a larger version of this image](/images/customer-license-custom-fields.png)

0 commit comments

Comments
 (0)