app
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
name | string | Yes | data type=string; maxLen=255
Provides a short descriptive name for the application to distinguish it from other applications in your development environment. | |
alias | string | Yes | data type=string; maxLen=80; textCase=UPPERAssigns an alternate alphanumeric application identifier. You can use this identifier in place of the application ID. When the Friendly URLs setting is enabled, the alias must be unique within the same workspace. When the Friendly URLs setting is disabled, the alias must be unique across all workspaces. | |
version | string | Yes | Release 1.0 | data type=string; maxLen=255 |
type | enum | Yes | standard | data type=string; lov=STATICValid values: standard library boilerplate theme |
group | reference | No | data type=reference; lov=COMPONENT; references=appGroup |
genAI
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
service | reference | No | data type=reference; lov=COMPONENT; references=genAIService | |
aiConsentMessage | multiline string | No | data type=multiline string; maxLen=4000Applies when service is set | |
requestHandlerProcedure | string | No | data type=string; maxLen=255 | |
responseHandlerProcedure | string | No | data type=string; maxLen=255 |
genAI {
service: @component
aiConsentMessage: ```
value
```
requestHandlerProcedure: value
responseHandlerProcedure: value
}logo
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
type | enum | No | data type=string; lov=STATICValid values: image text imageAndText custom | |
imageUrl | string | Yes | data type=string; maxLen=4000Applies when type in (image)type in (imageAndText) | |
text | string | Yes | data type=string; maxLen=4000Applies when type in (text)type in (imageAndText) | |
customHtml | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = custom |
logo {
type: image
imageUrl: value
text: value
customHtml: ```
value
```
}navigation
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
homeUrl | complex | Yes | data type=complex; maxLen=2000 | |
loginUrl | complex | No | data type=complex; maxLen=2000 |
navigation {
homeUrl: {
type: in_app
url: value
app: value
page: value
items: [
value
value
]
clearCache: value
action: value
request: value
anchor: value
session: "&SESSION."
debug: "&DEBUG."
printerFriendly: N
otherArgs: value
}
loginUrl: {
type: in_app
url: value
app: value
page: value
items: [
value
value
]
clearCache: value
action: value
request: value
anchor: value
session: "&SESSION."
debug: "&DEBUG."
printerFriendly: N
otherArgs: value
}
}navigationMenu
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
listTemplate | reference | No | data type=reference; lov=COMPONENT; references=listTemplate | |
templateOptions | array of strings | No | data type=string; lov=TEMPLATE_OPTIONSApplies when listTemplate is set | |
listPosition | enum | Yes | side | data type=string; lov=STATICValid values: top sideApplies when listTemplate is set |
list | reference | No | data type=reference; lov=COMPONENT; references=listApplies when listTemplate is set |
navigationMenu {
listTemplate: @component
templateOptions: [
value
value
]
listPosition: top
list: @component
}navigationBar
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
implementation | enum | Yes | list | data type=string; lov=STATICValid values: classic list |
list | reference | Yes | data type=reference; lov=COMPONENT; references=listApplies when implementation = list | |
listTemplate | reference | Yes | data type=reference; lov=COMPONENT; references=listTemplateApplies when implementation = list | |
templateOptions | array of strings | No | data type=string; lov=TEMPLATE_OPTIONSApplies when implementation = list and listTemplate is set |
navigationBar {
implementation: classic
list: @component
listTemplate: @component
templateOptions: [
value
value
]
}userInterface
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
currentTheme | reference | Yes | data type=reference; lov=COMPONENT; references=theme | |
globalPage | integer | No | data type=integer; maxLen=32767 | |
usersCanChooseThemeStyle | boolean | Yes | false | data type=boolean |
addBuiltWithApexToFooter | boolean | Yes | true | data type=boolean |
autoDismissSuccessMessages | boolean | Yes | false | data type=boolean |
userInterface {
currentTheme: @component
globalPage: 42
usersCanChooseThemeStyle: false
addBuiltWithApexToFooter: false
autoDismissSuccessMessages: false
}appFormatMasks
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
date | string | No | data type=string; maxLen=255 | |
dateTime | string | No | data type=string; maxLen=255 | |
timestamp | string | No | data type=string; maxLen=255 | |
timestampTimeZone | string | No | data type=string; maxLen=255 |
appFormatMasks {
date: value
dateTime: value
timestamp: value
timestampTimeZone: value
}javaScript
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
fileUrls | array of strings | No | data type=string; maxLen=4000Enter JavaScript file URLs for code to be loaded on every page. Each URL has to be written into a new line.
If you provide a minified version of your file, you can use the substitution string JavaScript file URLs you enter here replaces the | |
includeLegacyJavascript | array of enums | No | data type=string; lov=STATICValid values: pre18 18 | |
includeJqueryMigrate | boolean | Yes | false | data type=boolean |
javaScript {
fileUrls: [
value
value
]
includeLegacyJavascript: [
pre18
"18"
]
includeJqueryMigrate: false
}css
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
fileUrls | array of strings | No | data type=string; maxLen=4000Enter CSS file URLs to be loaded on every page. Each URL has to be written into a new line. If you provide
a minified version of your file you can use the substitution string File URLs you enter here will replace the |
css {
fileUrls: [
value
value
]
}authentication
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
scheme | reference | No | data type=reference; lov=COMPONENT; references=authentication | |
configProcedureName | string | No | data type=string; maxLen=255 | |
publicUser | string | No | data type=string; maxLen=255 | |
enableDeepDataSecurity | boolean | Yes | false | data type=booleanApplies when scheme supports SUPPORTS_DEEPSEC |
databaseResourceScope | string | Yes | data type=string; maxLen=4000Applies when scheme supports SUPPORTS_DEEPSEC and enableDeepDataSecurity = true | |
appScope | string | Yes | data type=string; maxLen=4000Applies when scheme supports SUPPORTS_DEEPSEC and enableDeepDataSecurity = true |
authentication {
scheme: @component
configProcedureName: value
publicUser: value
enableDeepDataSecurity: false
databaseResourceScope: value
appScope: value
}authorization
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
scheme | enum | No | data type=reference; lov=COMPONENT; references=authorizationValid values: mustNotBePublicUser | |
runOnPublicPages | boolean | Yes | false | data type=boolean |
runOnBackgroundJob | boolean | Yes | true | data type=booleanApplies when scheme is set |
sourceForRoleOrGroupSchemes | enum | Yes | accessControlUserRoleAssignments | data type=string; lov=STATICValid values: accessControlUserRoleAssignments authenticationScheme customCode |
authorization {
scheme: mustNotBePublicUser
runOnPublicPages: false
runOnBackgroundJob: false
sourceForRoleOrGroupSchemes: accessControlUserRoleAssignments
}security
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
deepLinking | enum | Yes | false | data type=string; lov=STATICValid values: true false |
enableDictation | boolean | Yes | false | data type=boolean |
browserCache | enum | Yes | false | data type=string; lov=STATICValid values: true false |
embedInFrames | enum | Yes | deny | data type=string; lov=STATICValid values: deny allowSameOrigin allow |
referrerPolicy | enum | Yes | strictOrigin | data type=string; lov=STATICValid values: noReferrer noReferrerWhenDowngrade origin originWhenCrossOrigin sameOrigin strictOrigin strictOriginWhenCrossOrigin unsafeUrl |
allowBotAccess | boolean | Yes | false | data type=boolean |
htmlEscapingMode | enum | Yes | extended | data type=string; lov=STATICValid values: basic extended |
httpResponseHeaders | multiline string | No | data type=multiline string; maxLen=4000 | |
runtimeApiUsage | array of enums | No | data type=string; lov=STATICValid values: modifyThisApp modifyOtherApps modifyWorkspaceRepository |
security {
deepLinking: true
enableDictation: false
browserCache: true
embedInFrames: deny
referrerPolicy: noReferrer
allowBotAccess: false
htmlEscapingMode: basic
httpResponseHeaders: ```
value
```
runtimeApiUsage: [
modifyThisApp
modifyOtherApps
]
}sessionStateProtection
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
enabled | boolean | Yes | true | data type=boolean |
allowUrlsCreatedAfter | datetime | No | data type=datetime; maxLen=32767 | |
bookmarkHashFunction | enum | Yes | sha2-512bit | data type=string; lov=STATICValid values: sha1 sha2-256bit sha2-384bit sha2-512bit md5 |
checksumSalt | string | No | data type=string; maxLen=32767 | |
acceptPre202UrlChecksums | boolean | No | false | data type=boolean |
sessionStateProtection {
enabled: false
allowUrlsCreatedAfter: value
bookmarkHashFunction: sha1
checksumSalt: value
acceptPre202UrlChecksums: false
}sessionManagement
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
rejoinSessions | enum | Yes | false | data type=string; lov=STATICValid values: false publicSessions allSessions |
sessionStateCommits | enum | Yes | endOfRequest | data type=string; lov=STATICValid values: immediate endOfRequest |
maxSessionLength | integer | No | data type=integer; maxLen=32767 | |
sessionTimeoutUrl | string | No | data type=string; maxLen=4000 | |
maxSessionIdleTime | integer | No | data type=integer; maxLen=32767 | |
sessionIdleTimeoutUrl | string | No | data type=string; maxLen=4000 | |
sessionTimeoutWarning | integer | No | data type=integer; maxLen=32767 |
sessionManagement {
rejoinSessions: false
sessionStateCommits: immediate
maxSessionLength: 42
sessionTimeoutUrl: value
maxSessionIdleTime: 42
sessionIdleTimeoutUrl: value
sessionTimeoutWarning: 42
}databaseSession
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
parsingSchema | string | No | data type=string; maxLen=128 | |
mleEnvironment | string | No | data type=string; maxLen=255 | |
initPlsqlCode | multiline string | No | data type=multiline string; maxLen=4000 | |
cleanupPlsqlCode | multiline string | No | data type=multiline string; maxLen=4000 |
databaseSession {
parsingSchema: value
mleEnvironment: value
initPlsqlCode: ```plsql
value
```
cleanupPlsqlCode: ```plsql
value
```
}globalization
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
primaryLanguage | enum | Yes | en | data type=string; lov=STATICValid values: af sq ar-dz ar-bh ar-eg ar-iq ar-jo ar-kw ar-lb ar-ly ar-ma ar-om ar-qa ar-sa ar-sy ar-tn ar-ae ar-ye ar hy as az eu be bn ba bg km ca zh-cn zh-hk zh-mo zh-sg zh-tw zh hr cs da nl-be nl en-au en-bz en-ca en-ie en-jm en-nz en-ph en-za en-tt en-gb en-us en-zw en et mk fo fa fi fr-be fr-ca fr fr-lu fr-mc fr-ch gd gl de-at de de-li de-lu de-ch el gu he hi hu is id ga it it-ch ja kn kk kok ko kz lv lt ms ml mt mr me ne nb-no no nn-no or pl pt-br pt pa ro ru-md ru sr-cyrl sr-latn sr sk sl es-ar es-bo es-cl es-co es-cr es-do es-ec es-sv es-gt es-hn es-mx es-ni es-pa es-py es-pe es-pr es es-us es-uy es-ve sw sv-fi sv ta te th tr uk ur uz vi cy |
documentDirection | enum | No | data type=string; lov=STATICValid values: leftToRight rightToLeft | |
translationMethod | enum | No | data type=string; lov=STATICValid values: translationApps textMessages | |
languageDerivedFrom | enum | Yes | appPrimaryLanguage | data type=string; lov=STATICValid values: notTranslated appPrimaryLanguage browserPreference appPreference itemPreference session |
autoTimeZone | boolean | Yes | false | data type=boolean |
autoCsvEncoding | boolean | Yes | true | data type=boolean |
globalization {
primaryLanguage: af
documentDirection: leftToRight
translationMethod: translationApps
languageDerivedFrom: notTranslated
autoTimeZone: false
autoCsvEncoding: false
}progressiveWebApp
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
enable | boolean | Yes | true | data type=boolean |
installable | boolean | Yes | false | data type=booleanApplies when enable = true |
display | enum | Yes | standalone | data type=string; lov=STATICValid values: fullscreen standalone minimalUI browserApplies when enable = true and installable = true |
screenOrientation | enum | Yes | any | data type=string; lov=STATICValid values: any natural landscape landscapePrimary landscapeSecondary portrait portraitPrimary portraitSecondaryApplies when enable = true and installable = true |
themeColor | string | No | data type=string; maxLen=128Applies when enable = true and installable = true | |
backgroundColor | string | No | data type=string; maxLen=128Applies when enable = true and installable = true | |
appDescription | multiline string | No | data type=multiline string; maxLen=4000Applies when enable = true and installable = true | |
appShortName | string | No | data type=string; maxLen=18Applies when enable = true | |
customManifest | multiline string | No | data type=multiline string; maxLen=4000Applies when enable = true and installable = true | |
manifestIconUrl | string | No | data type=string; maxLen=255Applies when enable = true | |
enablePushNotifications | boolean | Yes | false | data type=booleanApplies when enable = true |
pushNotificationsCredentials | reference | Yes | data type=reference; lov=COMPONENT; references=webCredentialApplies when enable = true and enablePushNotifications = true | |
contactEmail | string | No | data type=string; maxLen=255Applies when enable = true and enablePushNotifications = true |
progressiveWebApp {
enable: false
installable: false
display: fullscreen
screenOrientation: any
themeColor: value
backgroundColor: value
appDescription: ```
value
```
appShortName: value
customManifest: ```
value
```
manifestIconUrl: value
enablePushNotifications: false
pushNotificationsCredentials: @component
contactEmail: value
}customServiceWorker
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
mode | enum | Yes | default | data type=string; lov=STATICValid values: default custom urlApplies when enable = true |
url | string | Yes | data type=string; maxLen=32767Applies when enable = true and mode = url | |
functionVariableDeclarationMode | enum | Yes | default | data type=string; lov=STATICValid values: default hookApplies when enable = true and mode = custom |
functionVariableDeclaration | multiline string | No | data type=multiline string; maxLen=32767Applies when enable = true and mode = custom and functionVariableDeclarationMode = hook | |
installMode | enum | Yes | default | data type=string; lov=STATICValid values: default custom hookApplies when enable = true and mode = custom |
eventInstall | multiline string | No | data type=multiline string; maxLen=32767Applies when enable = true and mode = custom and installMode = custom | |
eventInstallBefore | multiline string | No | data type=multiline string; maxLen=32767Applies when enable = true and mode = custom and installMode = hook | |
eventInstallAfter | multiline string | No | data type=multiline string; maxLen=32767Applies when enable = true and mode = custom and installMode = hook | |
activateMode | enum | Yes | default | data type=string; lov=STATICValid values: default custom hookApplies when enable = true and mode = custom |
eventActivate | multiline string | No | data type=multiline string; maxLen=32767Applies when enable = true and mode = custom and activateMode = custom | |
eventActivateBefore | multiline string | No | data type=multiline string; maxLen=32767Applies when enable = true and mode = custom and activateMode = hook | |
eventActivateAfter | multiline string | No | data type=multiline string; maxLen=32767Applies when enable = true and mode = custom and activateMode = hook | |
fetchMode | enum | Yes | default | data type=string; lov=STATICValid values: default custom hookApplies when enable = true and mode = custom |
eventFetch | multiline string | No | data type=multiline string; maxLen=32767Applies when enable = true and mode = custom and fetchMode = custom | |
eventFetchBefore | multiline string | No | data type=multiline string; maxLen=32767Applies when enable = true and mode = custom and fetchMode = hook | |
eventFetchCacheDefinition | multiline string | No | data type=multiline string; maxLen=32767Applies when enable = true and mode = custom and fetchMode = hook | |
eventFetchCacheResponse | multiline string | No | data type=multiline string; maxLen=32767Applies when enable = true and mode = custom and fetchMode = hook | |
eventFetchNetworkResponseSuccess | multiline string | No | data type=multiline string; maxLen=32767Applies when enable = true and mode = custom and fetchMode = hook | |
eventFetchNetworkResponseError | multiline string | No | data type=multiline string; maxLen=32767Applies when enable = true and mode = custom and fetchMode = hook | |
eventFetchOfflinePage | multiline string | No | data type=multiline string; maxLen=32767Applies when enable = true and mode = custom and fetchMode = hook | |
eventFetchNetworkFallback | multiline string | No | data type=multiline string; maxLen=32767Applies when enable = true and mode = custom and fetchMode = hook | |
syncMode | enum | Yes | default | data type=string; lov=STATICValid values: default customApplies when enable = true and mode = custom |
eventSync | multiline string | No | data type=multiline string; maxLen=32767Applies when enable = true and mode = custom and syncMode = custom | |
pushMode | enum | Yes | default | data type=string; lov=STATICValid values: default custom hookApplies when enable = true and mode = custom |
eventPush | multiline string | No | data type=multiline string; maxLen=32767Applies when enable = true and mode = custom and pushMode = custom | |
eventPushBefore | multiline string | No | data type=multiline string; maxLen=32767Applies when enable = true and mode = custom and pushMode = hook | |
eventPushAfter | multiline string | No | data type=multiline string; maxLen=32767Applies when enable = true and mode = custom and pushMode = hook | |
notificationClickMode | enum | Yes | default | data type=string; lov=STATICValid values: default custom hookApplies when enable = true and mode = custom |
eventNotificationClick | multiline string | No | data type=multiline string; maxLen=32767Applies when enable = true and mode = custom and notificationClickMode = custom | |
evenNotificationClickBefore | multiline string | No | data type=multiline string; maxLen=32767Applies when enable = true and mode = custom and notificationClickMode = hook | |
evenNotificationClickAfter | multiline string | No | data type=multiline string; maxLen=32767Applies when enable = true and mode = custom and notificationClickMode = hook | |
notificationCloseMode | enum | Yes | default | data type=string; lov=STATICValid values: default custom hookApplies when enable = true and mode = custom |
evenNotificationClose | multiline string | No | data type=multiline string; maxLen=32767Applies when enable = true and mode = custom and notificationCloseMode = custom | |
canMakePaymentMode | enum | Yes | default | data type=string; lov=STATICValid values: default customApplies when enable = true and mode = custom |
evenCanMakePayment | multiline string | No | data type=multiline string; maxLen=32767Applies when enable = true and mode = custom and canMakePaymentMode = custom | |
paymentRequestMode | enum | Yes | default | data type=string; lov=STATICValid values: default customApplies when enable = true and mode = custom |
evenPaymentRequest | multiline string | No | data type=multiline string; maxLen=32767Applies when enable = true and mode = custom and paymentRequestMode = custom |
customServiceWorker {
mode: default
url: value
functionVariableDeclarationMode: default
functionVariableDeclaration: ```javascript-browser
value
```
installMode: default
eventInstall: ```javascript-browser
value
```
eventInstallBefore: ```javascript-browser
value
```
eventInstallAfter: ```javascript-browser
value
```
activateMode: default
eventActivate: ```javascript-browser
value
```
eventActivateBefore: ```javascript-browser
value
```
eventActivateAfter: ```javascript-browser
value
```
fetchMode: default
eventFetch: ```javascript-browser
value
```
eventFetchBefore: ```javascript-browser
value
```
eventFetchCacheDefinition: ```javascript-browser
value
```
eventFetchCacheResponse: ```javascript-browser
value
```
eventFetchNetworkResponseSuccess: ```javascript-browser
value
```
eventFetchNetworkResponseError: ```javascript-browser
value
```
eventFetchOfflinePage: ```javascript-browser
value
```
eventFetchNetworkFallback: ```javascript-browser
value
```
syncMode: default
eventSync: ```javascript-browser
value
```
pushMode: default
eventPush: ```javascript-browser
value
```
eventPushBefore: ```javascript-browser
value
```
eventPushAfter: ```javascript-browser
value
```
notificationClickMode: default
eventNotificationClick: ```javascript-browser
value
```
evenNotificationClickBefore: ```javascript-browser
value
```
evenNotificationClickAfter: ```javascript-browser
value
```
notificationCloseMode: default
evenNotificationClose: ```javascript-browser
value
```
canMakePaymentMode: default
evenCanMakePayment: ```javascript-browser
value
```
paymentRequestMode: default
evenPaymentRequest: ```javascript-browser
value
```
}rowSearch
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
tokenize | boolean | Yes | true | data type=boolean |
textQueryFunction | enum | No | data type=string; lov=STATICValid values: searchEngine expertSearch custom | |
customFunctionName | string | Yes | data type=string; maxLen=500Applies when textQueryFunction = custom |
rowSearch {
tokenize: false
textQueryFunction: searchEngine
customFunctionName: value
}charValueComparison
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
mode | string | No | data type=string; maxLen=255 | |
behavior | enum | No | data type=string; lov=STATICValid values: binary linguistic |
charValueComparison {
mode: value
behavior: binary
}reportPrinting
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
type | enum | Yes | native | data type=string; lov=STATICValid values: native remote useInstanceSettings |
remotePrintServer | reference | Yes | data type=reference; lov=COMPONENT; references=printServerApplies when type = remote | |
credentials | reference | No | data type=reference; lov=COMPONENT; references=webCredentialApplies when type = remote |
reportPrinting {
type: native
remotePrintServer: @component
credentials: @component
}fileStorage
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
type | enum | Yes | database | data type=string; lov=STATICValid values: database objectStorage |
fileServer | reference | No | data type=reference; lov=COMPONENT; references=fileServerApplies when type = objectStorage |
fileStorage {
type: database
fileServer: @component
}errorHandling
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
defaultDisplayLocation | enum | Yes | inlineWithFieldAndInNotification | data type=string; lov=STATICValid values: inlineWithFieldAndInNotification inlineWithField inlineInNotification |
errorHandlingFunctionName | string | No | data type=string; maxLen=255 |
errorHandling {
defaultDisplayLocation: inlineWithFieldAndInNotification
errorHandlingFunctionName: value
}runtime
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
friendlyUrls | boolean | Yes | true | data type=boolean |
allowFeedback | boolean | Yes | false | data type=boolean |
logging | boolean | Yes | YES | data type=boolean |
debugging | boolean | Yes | 0 | data type=boolean |
compatibilityMode | enum | Yes | 26.1 | data type=string; lov=STATICValid values: 26.1 24.2 21.2 19.2-20.1-20.2-21.1 19.1 5.1-18.1-18.2 5.0 4.2 4.1 4.0 |
accessibleReadOnlyItems | boolean | Yes | true | data type=boolean |
runtime {
friendlyUrls: false
allowFeedback: false
logging: false
debugging: false
compatibilityMode: "26.1"
accessibleReadOnlyItems: false
}staticFiles
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
appFilesPath | string | No | data type=string; maxLen=255 | |
apexFilesPath | string | No | data type=string; maxLen=255 |
staticFiles {
appFilesPath: value
apexFilesPath: value
}proxy
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
proxyServer | string | No | data type=string; maxLen=255 | |
noProxyDomains | string | No | data type=string; maxLen=500Applies when proxyServer is set |
proxy {
proxyServer: value
noProxyDomains: value
}availability
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
status | enum | Yes | availableWithDevToolbar | data type=string; lov=STATICValid values: available availableWithDevToolbar availableDevsOnly restricted unavailable unavailableStatusShownWithPlsql unavailableRedirectToUrl |
message | multiline string | Yes | data type=multiline string; maxLen=4000Applies when status in (unavailable)status in (unavailableStatusShownWithPlsql)status in (unavailableRedirectToUrl) | |
restrictUserList | array of multiline strings | Yes | data type=multiline string; maxLen=4000Applies when status = restricted | |
globalNotificationMessage | multiline string | No | data type=multiline string; maxLen=4000 | |
buildStatus | enum | Yes | runAndBuild | data type=string; lov=STATICValid values: runOnly runAndBuildApplies when type in (standard)type in (boilerplate) |
availability {
status: available
message: ```
value
```
restrictUserList: [
value
value
]
globalNotificationMessage: ```
value
```
buildStatus: runOnly
}advanced
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
exactSubstitutions | boolean | No | true | data type=boolean |
passEcid | boolean | Yes | true | data type=boolean |
modernizeApp | boolean | Yes | false | data type=boolean |
emailFromAddress | string | No | data type=string; maxLen=255 | |
copyrightBanner | multiline string | No | data type=multiline string; maxLen=4000 | |
faviconHtml | multiline string | No | data type=multiline string; maxLen=4000 | |
maxBackgroundPageProcessJobs | integer | No | data type=integer; maxLen=32767 | |
vacationRuleProcedureName | string | No | data type=string; maxLen=500Specify the name of a PL/SQL procedure in the format schemaName.packageName.procedureName. The procedure is expected to return alternate participants for task definitions in this application. The vacation rule procedure should implement the following interface.
procedure my_vacation_rule (
p_param in apex_human_task.t_vacation_rule_input,
p_result out apex_human_task.t_vacation_rule_result );
The procedure input is of type apex_human_task.t_vacation_rule_input and the result output is of type apex_human_task.t_vacation_rule_result | |
mediaType | string | No | data type=string; maxLen=255 | |
opentelemetryProductFamily | string | No | data type=string; maxLen=255 | |
appBuilderIconName | string | No | data type=string; maxLen=255 |
advanced {
exactSubstitutions: false
passEcid: false
modernizeApp: false
emailFromAddress: value
copyrightBanner: ```
value
```
faviconHtml: ```
value
```
maxBackgroundPageProcessJobs: 42
vacationRuleProcedureName: value
mediaType: value
opentelemetryProductFamily: value
appBuilderIconName: value
}comments
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
comments | multiline string | No | data type=multiline string; maxLen=4000 |
comments {
comments: ```
value
```
}APEXlang Example
app sample (
name: value
alias: value
version: value
type: standard
group: @component
genAI {
service: @component
aiConsentMessage: ```
value
```
requestHandlerProcedure: value
responseHandlerProcedure: value
}
logo {
type: image
imageUrl: value
text: value
customHtml: ```
value
```
}
navigation {
homeUrl: {
type: in_app
url: value
app: value
page: value
items: [
value
value
]
clearCache: value
action: value
request: value
anchor: value
session: "&SESSION."
debug: "&DEBUG."
printerFriendly: N
otherArgs: value
}
loginUrl: {
type: in_app
url: value
app: value
page: value
items: [
value
value
]
clearCache: value
action: value
request: value
anchor: value
session: "&SESSION."
debug: "&DEBUG."
printerFriendly: N
otherArgs: value
}
}
navigationMenu {
listTemplate: @component
templateOptions: [
value
value
]
listPosition: top
list: @component
}
navigationBar {
implementation: classic
list: @component
listTemplate: @component
templateOptions: [
value
value
]
}
userInterface {
currentTheme: @component
globalPage: 42
usersCanChooseThemeStyle: false
addBuiltWithApexToFooter: false
autoDismissSuccessMessages: false
}
appFormatMasks {
date: value
dateTime: value
timestamp: value
timestampTimeZone: value
}
javaScript {
fileUrls: [
value
value
]
includeLegacyJavascript: [
pre18
"18"
]
includeJqueryMigrate: false
}
css {
fileUrls: [
value
value
]
}
authentication {
scheme: @component
configProcedureName: value
publicUser: value
enableDeepDataSecurity: false
databaseResourceScope: value
appScope: value
}
authorization {
scheme: mustNotBePublicUser
runOnPublicPages: false
runOnBackgroundJob: false
sourceForRoleOrGroupSchemes: accessControlUserRoleAssignments
}
security {
deepLinking: true
enableDictation: false
browserCache: true
embedInFrames: deny
referrerPolicy: noReferrer
allowBotAccess: false
htmlEscapingMode: basic
httpResponseHeaders: ```
value
```
runtimeApiUsage: [
modifyThisApp
modifyOtherApps
]
}
sessionStateProtection {
enabled: false
allowUrlsCreatedAfter: value
bookmarkHashFunction: sha1
checksumSalt: value
acceptPre202UrlChecksums: false
}
sessionManagement {
rejoinSessions: false
sessionStateCommits: immediate
maxSessionLength: 42
sessionTimeoutUrl: value
maxSessionIdleTime: 42
sessionIdleTimeoutUrl: value
sessionTimeoutWarning: 42
}
databaseSession {
parsingSchema: value
mleEnvironment: value
initPlsqlCode: ```plsql
value
```
cleanupPlsqlCode: ```plsql
value
```
}
globalization {
primaryLanguage: af
documentDirection: leftToRight
translationMethod: translationApps
languageDerivedFrom: notTranslated
autoTimeZone: false
autoCsvEncoding: false
}
progressiveWebApp {
enable: false
installable: false
display: fullscreen
screenOrientation: any
themeColor: value
backgroundColor: value
appDescription: ```
value
```
appShortName: value
customManifest: ```
value
```
manifestIconUrl: value
enablePushNotifications: false
pushNotificationsCredentials: @component
contactEmail: value
}
customServiceWorker {
mode: default
url: value
functionVariableDeclarationMode: default
functionVariableDeclaration: ```javascript-browser
value
```
installMode: default
eventInstall: ```javascript-browser
value
```
eventInstallBefore: ```javascript-browser
value
```
eventInstallAfter: ```javascript-browser
value
```
activateMode: default
eventActivate: ```javascript-browser
value
```
eventActivateBefore: ```javascript-browser
value
```
eventActivateAfter: ```javascript-browser
value
```
fetchMode: default
eventFetch: ```javascript-browser
value
```
eventFetchBefore: ```javascript-browser
value
```
eventFetchCacheDefinition: ```javascript-browser
value
```
eventFetchCacheResponse: ```javascript-browser
value
```
eventFetchNetworkResponseSuccess: ```javascript-browser
value
```
eventFetchNetworkResponseError: ```javascript-browser
value
```
eventFetchOfflinePage: ```javascript-browser
value
```
eventFetchNetworkFallback: ```javascript-browser
value
```
syncMode: default
eventSync: ```javascript-browser
value
```
pushMode: default
eventPush: ```javascript-browser
value
```
eventPushBefore: ```javascript-browser
value
```
eventPushAfter: ```javascript-browser
value
```
notificationClickMode: default
eventNotificationClick: ```javascript-browser
value
```
evenNotificationClickBefore: ```javascript-browser
value
```
evenNotificationClickAfter: ```javascript-browser
value
```
notificationCloseMode: default
evenNotificationClose: ```javascript-browser
value
```
canMakePaymentMode: default
evenCanMakePayment: ```javascript-browser
value
```
paymentRequestMode: default
evenPaymentRequest: ```javascript-browser
value
```
}
rowSearch {
tokenize: false
textQueryFunction: searchEngine
customFunctionName: value
}
charValueComparison {
mode: value
behavior: binary
}
reportPrinting {
type: native
remotePrintServer: @component
credentials: @component
}
fileStorage {
type: database
fileServer: @component
}
errorHandling {
defaultDisplayLocation: inlineWithFieldAndInNotification
errorHandlingFunctionName: value
}
runtime {
friendlyUrls: false
allowFeedback: false
logging: false
debugging: false
compatibilityMode: "26.1"
accessibleReadOnlyItems: false
}
staticFiles {
appFilesPath: value
apexFilesPath: value
}
proxy {
proxyServer: value
noProxyDomains: value
}
availability {
status: available
message: ```
value
```
restrictUserList: [
value
value
]
globalNotificationMessage: ```
value
```
buildStatus: runOnly
}
advanced {
exactSubstitutions: false
passEcid: false
modernizeApp: false
emailFromAddress: value
copyrightBanner: ```
value
```
faviconHtml: ```
value
```
maxBackgroundPageProcessJobs: 42
vacationRuleProcedureName: value
mediaType: value
opentelemetryProductFamily: value
appBuilderIconName: value
}
comments {
comments: ```
value
```
}
)