action

Parent: region

Applies whentype = cards

Children: triggerActiontype = triggerAction

Direct Properties:

PropertyTypeRequiredDefault ValueDetails
typeenumYesbuttondata type=string; lov=STATIC
Valid values: button fullCard title subtitle media
labelstringYesdata type=string; maxLen=255
Applies whentype = button
Enter the text to be displayed on the button. If button display type is icon, this text becomes the ALT text for the icon image.

Property Groups:

  • layout
  • behavior
  • appearance
  • advanced
  • serverSideCondition
  • security
  • config
  • comments
layout
PropertyTypeRequiredDefault ValueDetails
positionenumYesprimarydata type=string; lov=STATIC
Valid values: primary secondary
Applies whentype = button
sequencenumberYesdata type=number; maxLen=22
Enter the display sequence for this action. This is used to evaluate the display condition and render in the order defined.
 
layout {
  position: primary
  sequence: 42
}
behavior
PropertyTypeRequiredDefault ValueDetails
typeenumYesredirectThisAppdata type=string; lov=STATIC
Valid values: redirectThisApp redirectOtherApp redirectUrl triggerAction
targetcomplexYesdata type=complex; maxLen=32767
Applies whentype = redirectThisApp
targetcomplexYesdata type=complex; maxLen=32767
Applies whentype = redirectOtherApp
targetUrlstringYesdata type=string; maxLen=4000
Applies whentype = redirectUrl
linkAttributesstringNodata type=string; maxLen=4000
Applies whentype in (redirectThisApp)type in (redirectOtherApp)type in (redirectUrl)
 
behavior {
  type: redirectThisApp
  target: {
    page: value
    items: [
      value
      value
    ]
    clearCache: value
    action: value
    request: value
    anchor: value
    session: "&SESSION."
    debug: "&DEBUG."
    printerFriendly: N
    otherArgs: value
  }
  targetUrl: value
  linkAttributes: value
}
appearance
PropertyTypeRequiredDefault ValueDetails
displayTypeenumYestextdata type=string; lov=STATIC
Valid values: text icon textWithIcon
Applies whentype = button
iconstringYesdata type=string; maxLen=255
Applies whentype = button and displayType in (icon)type = button and displayType in (textWithIcon)
hotbooleanYesfalsedata type=boolean
Applies whentype = button
Specify whether to use the Normal or Hot button when rendering this button.
cssClassesarray of stringsNodata type=string; maxLen=255
Applies whentype = button
Enter classes to add to this component. You may add multiple classes by separating them with spaces.
 
appearance {
  displayType: text
  icon: value
  hot: false
  cssClasses: [
    value
    value
  ]
}
advanced
PropertyTypeRequiredDefault ValueDetails
staticIdstringYesactiondata type=string; maxLen=255
 
advanced {
  staticId: value
}
serverSideCondition
PropertyTypeRequiredDefault ValueDetails
typeenumNodata type=string; lov=STATIC
Valid values: always rowsReturned noRowsReturned expression functionBody request=Value request!=Value requestIsContainedInValue requestIsNotContainedInValue item=value item!=value itemIsNull itemIsNotNull itemIsZero itemIsNotZero itemIsNullOrZero itemIsNotNullAndNotZero itemContainsNoSpaces itemIsNumeric itemIsNotNumeric itemIsAlphanumeric itemIsInColonDelimitedList itemIsNotInColonDelimitedList textIsContainedInItem text=value text!=value textIsContainedInValue textIsNotContainedInValue userPreference=value userPreference!=value currentPage=page currentPage!=page currentPageInList currentPageNotInList currentPage=pageSubmitted currentPage!=pageSubmitted currentPageIsInPrinterFriendlyMode currentPageIsNotInPrinterFriendlyMode pageRegionIsReadOnly pageRegionIsNotReadOnly userIsAuthenticated userIsPublicUser inlineValidationErrorsDisplayed inlineValidationErrorsNotDisplayed sqlReportsOkToShowForwardButton sqlReportsOkToShowBackButton currentLanguage=value currentLanguage!=value currentLanguageIsContainedInValue currentLanguageIsNotContainedInValue clientBrowserIsMozilla clientBrowserIsIE7higher clientBrowserIsXhtmlCssCapable clientBrowserIsOther cgiEnvDadName=value cgiEnvDadName!=value cgiEnvServerName=value cgiEnvServerName!=value cgiEnvHttpHost=value cgiEnvHttpHost!=value never
sqlQuerymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype in (rowsReturned)type in (noRowsReturned)
languageenumYesplsqldata type=string; lov=STATIC
Valid values: sql plsql javaScript-mle
Applies whentype = expression
sqlExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype = expression and language = sql
plsqlExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype = expression and language = plsql
javaScriptExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype = expression and language = javaScript-mle
languageenumYesplsqldata type=string; lov=STATIC
Valid values: plsql javaScript-mle
Applies whentype = functionBody
plsqlFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype = functionBody and language = plsql
javaScriptFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype = functionBody and language = javaScript-mle
valuestringYesdata type=string; maxLen=4000
Applies whentype in (request=Value)type in (request!=Value)type in (requestIsContainedInValue)type in (requestIsNotContainedInValue)type in (currentLanguageIsContainedInValue)type in (currentLanguageIsNotContainedInValue)type in (currentLanguage!=value)type in (currentLanguage=value)type in (cgiEnvDadName=value)type in (cgiEnvDadName!=value)type in (cgiEnvServerName=value)type in (cgiEnvServerName!=value)type in (cgiEnvHttpHost=value)type in (cgiEnvHttpHost!=value)
itemstringYesdata type=string; maxLen=4000; textCase=UPPER
Applies whentype in (item=value)type in (item!=value)type in (VALUE_OF_ITEM_IN_COND_1_EQ_COND_2)type in (VALUE_OF_ITEM_IN_COND_1_NOT_EQ_COND_2)type in (itemIsNull)type in (itemIsNotNull)type in (itemIsZero)type in (itemIsNotZero)type in (itemIsNullOrZero)type in (itemIsNotNullAndNotZero)type in (itemContainsNoSpaces)type in (itemIsNumeric)type in (itemIsNotNumeric)type in (itemIsAlphanumeric)type in (itemIsInColonDelimitedList)type in (itemIsNotInColonDelimitedList)
preferencestringYesdata type=string; maxLen=4000; textCase=UPPER
Applies whentype in (userPreference=value)type in (userPreference!=value)
pageintegerYesdata type=integer; maxLen=4000
Applies whentype in (currentPage=page)type in (currentPage!=page)
pagesarray of integersYesdata type=integer; maxLen=4000
Applies whentype in (currentPageInList)type in (currentPageNotInList)
textstringYesdata type=string; maxLen=4000
Applies whentype in (textIsContainedInItem)type in (textIsContainedInValue)type in (textIsNotContainedInValue)type in (text=value)type in (text!=value)
valuestringYesdata type=string; maxLen=4000
Applies whentype in (item=value)type in (item!=value)type in (VALUE_OF_ITEM_IN_COND_1_EQ_COND_2)type in (VALUE_OF_ITEM_IN_COND_1_NOT_EQ_COND_2)
listarray of stringsYesdata type=string; maxLen=4000
Applies whentype in (itemIsInColonDelimitedList)type in (itemIsNotInColonDelimitedList)
itemstringYesdata type=string; maxLen=4000; textCase=UPPER
Applies whentype = textIsContainedInItem
valuestringYesdata type=string; maxLen=4000
Applies whentype in (textIsContainedInValue)type in (textIsNotContainedInValue)type in (text=value)type in (text!=value)
executeConditionenumYesforEachRowdata type=string; lov=STATIC
Valid values: forEachRow once
Applies whentype is set
 
serverSideCondition {
  type: always
  sqlQuery: ```sql
    value
  ```
  language: sql
  sqlExpression: ```sql
    value
  ```
  plsqlExpression: ```plsql
    value
  ```
  javaScriptExpression: ```javascript-mle
    value
  ```
  plsqlFunctionBody: ```plsql
    value
  ```
  javaScriptFunctionBody: ```javascript-mle
    value
  ```
  value: value
  item: value
  preference: value
  page: 42
  pages: [
    42
    42
  ]
  text: value
  list: [
    value
    value
  ]
  executeCondition: forEachRow
}
security
PropertyTypeRequiredDefault ValueDetails
authorizationSchemeenumNodata type=reference; lov=COMPONENT; references=authorization
Valid values: mustNotBePublicUser
 
security {
  authorizationScheme: mustNotBePublicUser
}
config
PropertyTypeRequiredDefault ValueDetails
buildOptionreferenceNodata type=reference; lov=COMPONENT; references=buildOption
 
config {
  buildOption: @component
}
comments
PropertyTypeRequiredDefault ValueDetails
commentsmultiline stringNodata type=multiline string; maxLen=4000
 
comments {
  comments: ```
    value
  ```
}

APEXlang Example

action sample (
    type: button
    label: value
    layout {
        position: primary
        sequence: 42
    }
    behavior {
        type: redirectThisApp
        target: {
          page: value
          items: [
            value
            value
          ]
          clearCache: value
          action: value
          request: value
          anchor: value
          session: "&SESSION."
          debug: "&DEBUG."
          printerFriendly: N
          otherArgs: value
        }
        targetUrl: value
        linkAttributes: value
    }
    appearance {
        displayType: text
        icon: value
        hot: false
        cssClasses: [
          value
          value
        ]
    }
    advanced {
        staticId: value
    }
    serverSideCondition {
        type: always
        sqlQuery: ```sql
          value
        ```
        language: sql
        sqlExpression: ```sql
          value
        ```
        plsqlExpression: ```plsql
          value
        ```
        javaScriptExpression: ```javascript-mle
          value
        ```
        plsqlFunctionBody: ```plsql
          value
        ```
        javaScriptFunctionBody: ```javascript-mle
          value
        ```
        value: value
        item: value
        preference: value
        page: 42
        pages: [
          42
          42
        ]
        text: value
        list: [
          value
          value
        ]
        executeCondition: forEachRow
    }
    security {
        authorizationScheme: mustNotBePublicUser
    }
    config {
        buildOption: @component
    }
    comments {
        comments: ```
          value
        ```
    }
)