Controlling Config Settings with License Settings


License fields can be used to control the settings page to show or hide advanced settings. This technique does not need a new release and the settings page can be updated by a simple license sync.

To start add the custom license field on Vendor Web. The field will be visible to the customer unless it is marked as hidden. Set a default value to ensure existing licenses behave correctly as customers update their app version.

Update the application YAML with a hidden item that represents the license flag. Hidden items are very useful to bind template functions and command output to your settings. Here the item should be read only with a default field that uses the template LicenseFieldValue function that refers to the new license field. See the advanced_opt item shown below.

Find the config item to be controlled by the license field. The item may represent a single setting or a collection of settings. Set the when option check the value for the hidden field and on the next application publish you can control the settings page with license flags.

- name: authentication
  title: Authentication
  description: Service credentials.
  - name: advanced_opt
    title: Allow Advanced UI Settings
    type: text
    default: '{{repl LicenseFieldValue "advanced" }}'
    readonly: true
    hidden: true
  - name: password
    title: Password
    type: text
    default: password
- name: advanced
  title: Advanced
  description: Advanced settings to control the authentication endpoint.
  when: advanced_opt=1
  - name: endpoint
    title: Override API Endpoint
    type: text