Product Custom Fields

starting with platform version v3 222 0 custom fields support an allowed values list product custom fields allow you to define key\ value pairs for any product for a given license, you can override the value of the product custom field with a license custom field value when you add a custom field to a product, all licenses for that given product will have that field added to them, and will show up on license checks and activations this field will appear on the server responses if you do not override the value for that given license example use cases for custom fields there are many ways you can use custom fields here are a few example use cases creating a product tier the key might be something like "edition" and the default value could be the lowest tier, such a "lite" for a given license you may change the default with "standard" or "pro" setting the number of cpu cores that a machine is allowed to run for your licensed application setting a grace period for requiring online license checks we call a "product custom field" the default key\ value pair that you set for a given product, and a "license custom field" the key\ value pair if you override the default value for the custom field for a given license add/remove/edit product custom fields open the product detail page, and click on the "custom fields" tab adding a new product custom field to add a new product custom field, click "add custom field", and specify a name (key) and value for your new custom field modify/delete product custom field click on the pencil to edit an existing product custom field, and it will allow you to modify the name and/or the value click on the red trash can to delete a product custom field once you issue a license, you can override the product custom field with a license custom field you can edit the value of the custom field for any license that was issued allowed custom field values to enhance data consistency and prevent accidental input errors, licensespring supports optional enumerated (enum) allowed values for custom fields defined at the product level when allowed values are specified, only predefined values can be assigned to the corresponding license custom field this introduces an additional validation layer while preserving backward compatibility and flexibility behavior and logic condition allowed license custom field values no allowed values defined any string allowed values defined values in the list or default product custom field value 1\ default behaviour (no allowed values defined) if a custom field on a product does not have an allowed values list defined the associated license custom field can accept any string as its value this allows full flexibility, including the ability to update or correct values without restriction 2\ allowed values defined on a product custom field if a custom field on a product has an allowed values list defined the associated license custom field can only accept one of the list values, or the product custom field’s default value this restriction helps ensure data integrity by limiting inputs to known, validated values if a default value is set, it is automatically added to the list of allowed values users can manually remove any allowed value , including the current default (prompting selection of a new default) the default value must always be one of the allowed values deletion of allowed values items if a value (e g , val3 ) is removed from the allowed values list on the product custom field existing license custom fields that already had val3 set will retain this value these values are not retroactively invalidated or overwritten however, val3 can no longer be set as a value in new license custom fields or updates this ensures stability and backward compatibility across issued licenses configuration via vendor platform allowed values for custom fields can be configured directly within the vendor platform or using the management api when creating or editing a product custom field, vendors can leave the allowed values list empty to allow free form values define a list of allowed values to enforce validation at the license level set a default value which remains valid even if not in the current allowed vlaues list product custom field allowed values “reset to allow any value” clears all allowed values with a confirmation prompt “reset all license custom fields" this action will reset all license custom fields for every license issued under this product