supportingObject

Parent: app

Children: buildOption, installScript, substitution, upgradeScript, validation

Property Groups:

  • prerequisites
  • installation
  • installationMessages
  • upgrade
  • upgradeMessages
  • deinstall
  • deinstallationMessages
  • messages
  • advanced
prerequisites
PropertyTypeRequiredDefault ValueDetails
freeSpaceintegerNodata type=integer; maxLen=32767
systemPrivilegesarray of enumsNodata type=string; lov=STATIC
Valid values: createDatabaseLink createMaterializedView createProcedure createSequence createSynonym createTable createTrigger createType createView
 
prerequisites {
  freeSpace: 42
  systemPrivileges: [
    createDatabaseLink
    createMaterializedView
  ]
}
installation
PropertyTypeRequiredDefault ValueDetails
objectNamesarray of multiline stringsNodata type=multiline string; maxLen=32767
 
installation {
  objectNames: [
    value
    value
  ]
}
installationMessages
PropertyTypeRequiredDefault ValueDetails
welcomemultiline stringNodata type=multiline string; maxLen=4000
confirmationmultiline stringNodata type=multiline string; maxLen=4000
installSuccessmultiline stringNodata type=multiline string; maxLen=4000
installFailuremultiline stringNodata type=multiline string; maxLen=4000
 
installationMessages {
  welcome: ```
    value
  ```
  confirmation: ```
    value
  ```
  installSuccess: ```
    value
  ```
  installFailure: ```
    value
  ```
}
upgrade
PropertyTypeRequiredDefault ValueDetails
upgradeWhenSqlQuerymultiline stringNodata type=multiline string; maxLen=32767
 
upgrade {
  upgradeWhenSqlQuery: ```sql
    value
  ```
}
upgradeMessages
PropertyTypeRequiredDefault ValueDetails
welcomemultiline stringNodata type=multiline string; maxLen=4000
confirmationmultiline stringNodata type=multiline string; maxLen=4000
successmultiline stringNodata type=multiline string; maxLen=4000
failuremultiline stringNodata type=multiline string; maxLen=4000
 
upgradeMessages {
  welcome: ```
    value
  ```
  confirmation: ```
    value
  ```
  success: ```
    value
  ```
  failure: ```
    value
  ```
}
deinstall
PropertyTypeRequiredDefault ValueDetails
scriptmultiline stringNodata type=multiline string; maxLen=32767
 
deinstall {
  script: ```
    value
  ```
}
deinstallationMessages
PropertyTypeRequiredDefault ValueDetails
confirmationmultiline stringNodata type=multiline string; maxLen=4000
postDeinstallmultiline stringNodata type=multiline string; maxLen=4000
 
deinstallationMessages {
  confirmation: ```
    value
  ```
  postDeinstall: ```
    value
  ```
}
messages
PropertyTypeRequiredDefault ValueDetails
licensemultiline stringNodata type=multiline string; maxLen=4000
validationsmultiline stringNodata type=multiline string; maxLen=4000
appSubstitutionsmultiline stringNodata type=multiline string; maxLen=4000
buildOptionsmultiline stringNodata type=multiline string; maxLen=4000
 
messages {
  license: ```
    value
  ```
  validations: ```
    value
  ```
  appSubstitutions: ```
    value
  ```
  buildOptions: ```
    value
  ```
}
advanced
PropertyTypeRequiredDefault ValueDetails
includeInAppExportenumYestruedata type=string; lov=STATIC
Valid values: true false autoInstall
 
advanced {
  includeInAppExport: true
}

APEXlang Example

supportingObject sample (
    prerequisites {
        freeSpace: 42
        systemPrivileges: [
          createDatabaseLink
          createMaterializedView
        ]
    }
    installation {
        objectNames: [
          value
          value
        ]
    }
    installationMessages {
        welcome: ```
          value
        ```
        confirmation: ```
          value
        ```
        installSuccess: ```
          value
        ```
        installFailure: ```
          value
        ```
    }
    upgrade {
        upgradeWhenSqlQuery: ```sql
          value
        ```
    }
    upgradeMessages {
        welcome: ```
          value
        ```
        confirmation: ```
          value
        ```
        success: ```
          value
        ```
        failure: ```
          value
        ```
    }
    deinstall {
        script: ```
          value
        ```
    }
    deinstallationMessages {
        confirmation: ```
          value
        ```
        postDeinstall: ```
          value
        ```
    }
    messages {
        license: ```
          value
        ```
        validations: ```
          value
        ```
        appSubstitutions: ```
          value
        ```
        buildOptions: ```
          value
        ```
    }
    advanced {
        includeInAppExport: true
    }
)