appSetting

Parent: app

Direct Properties:

PropertyTypeRequiredDefault ValueDetails
staticIdstringYesdata type=string; maxLen=255
Enter a unique Static ID for this application setting. Application settings enable developers to define application-level configuration options. The Static ID is used to identify this component in API calls or to refer to it in application export files. If you change the Static ID, dependent components will retain their references, but any existing API calls using the old ID must be updated manually.

Property Groups:

  • value
  • validation
  • config
  • subscription
  • comments
value
PropertyTypeRequiredDefault ValueDetails
staticValuemultiline stringNodata type=multiline string; maxLen=4000
Enter the default value for this application setting.
onUpgradeKeepValuebooleanYesfalsedata type=boolean
 
value {
  staticValue: ```
    value
  ```
  onUpgradeKeepValue: false
}
validation
PropertyTypeRequiredDefault ValueDetails
requiredbooleanYesfalsedata type=boolean
Specify whether this application setting is required and must always be set.
validValuesstringNodata type=string; maxLen=4000
 
validation {
  required: false
  validValues: value
}
config
PropertyTypeRequiredDefault ValueDetails
buildOptionreferenceNodata type=reference; lov=COMPONENT; references=buildOption
 
config {
  buildOption: @component
}
subscription
PropertyTypeRequiredDefault ValueDetails
masterreferenceNodata type=reference; lov=COMPONENT; references=appSetting
 
subscription {
  master: @component
}
comments
PropertyTypeRequiredDefault ValueDetails
commentsmultiline stringNodata type=multiline string; maxLen=4000
 
comments {
  comments: ```
    value
  ```
}

APEXlang Example

appSetting sample (
    staticId: value
    value {
        staticValue: ```
          value
        ```
        onUpgradeKeepValue: false
    }
    validation {
        required: false
        validValues: value
    }
    config {
        buildOption: @component
    }
    subscription {
        master: @component
    }
    comments {
        comments: ```
          value
        ```
    }
)