dynamicAction

Parent: page

Children: action

Direct Properties:

PropertyTypeRequiredDefault ValueDetails
namestringYesdata type=string; maxLen=255
Enter the name of the dynamic action.

Property Groups:

  • execution
  • when
  • clientSideCondition
  • advanced
  • serverSideCondition
  • security
  • config
  • comments
execution
PropertyTypeRequiredDefault ValueDetails
sequencenumberYesdata type=number; maxLen=22
eventScopeenumYesstaticdata type=string; lov=STATIC
Valid values: static dynamic once
staticContainerstringNodata type=string; maxLen=255
Applies wheneventScope = dynamic
typeenumYesimmediatedata type=string; lov=STATIC
Valid values: immediate debounce throttle
Applies wheneventScope in (static)eventScope in (dynamic)
timeintegerYesdata type=integer; maxLen=32767
Applies wheneventScope in (static) and type in (debounce)eventScope in (static) and type in (throttle)eventScope in (dynamic) and type in (debounce)eventScope in (dynamic) and type in (throttle)
immediatebooleanYesfalsedata type=boolean
Applies wheneventScope in (static) and type in (debounce)eventScope in (static) and type in (throttle)eventScope in (dynamic) and type in (debounce)eventScope in (dynamic) and type in (throttle)
execution {
  sequence: 42
  eventScope: static
  staticContainer: value
  type: immediate
  time: 42
  immediate: false
}
when
PropertyTypeRequiredDefault ValueDetails
eventstringYeschangedata type=string; lov=EVENTS
customEventstringYesdata type=string; maxLen=130
Applies whenevent = custom
selectionTypeenumYesdata type=string; lov=STATIC
Valid values: items button region columns domObject jQuerySelector jsExpression
regionreferenceYesdata type=reference; lov=COMPONENT; references=region
Applies whenselectionType = region
interactiveGridreferenceYesdata type=reference; lov=COMPONENT; references=region
Applies whenselectionType = columns
columnsarray of stringsYesdata type=string; maxLen=4000; textCase=UPPER
Applies whenselectionType = columns
buttonreferenceYesdata type=reference; lov=COMPONENT; references=button
Applies whenselectionType = button
itemsarray of stringsYesdata type=string; maxLen=4000; textCase=UPPER
Applies whenselectionType = items
domObjectstringYesdata type=string; maxLen=4000
Applies whenselectionType = domObject
jquerySelectorstringYesdata type=string; maxLen=4000
Applies whenselectionType = jQuerySelector
javaScriptExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whenselectionType = jsExpression
when {
  event: value
  customEvent: value
  selectionType: items
  region: @component
  interactiveGrid: @component
  columns: [
    value
    value
  ]
  button: @component
  items: [
    value
    value
  ]
  domObject: value
  jquerySelector: value
  javaScriptExpression: ```javascript-browser
    value
  ```
}
clientSideCondition
PropertyTypeRequiredDefault ValueDetails
typeenumNodata type=string; lov=STATIC
Valid values: item=value item!=value item>value item>=value item<value item<=value itemIsNull itemIsNotNull itemIsInList itemIsNotInList jsExpression
Applies whenselectionType = columns and selectionType = region and region does not support IG_REGION
itemstringYesdata type=string; maxLen=4000; textCase=UPPER
Applies whenselectionType = columns and selectionType = region and region does not support IG_REGION and type in (item=value)selectionType = columns and selectionType = region and region does not support IG_REGION and type in (item!=value)selectionType = columns and selectionType = region and region does not support IG_REGION and type in (item>value)selectionType = columns and selectionType = region and region does not support IG_REGION and type in (item>=value)selectionType = columns and selectionType = region and region does not support IG_REGION and type in (item<value)selectionType = columns and selectionType = region and region does not support IG_REGION and type in (item<=value)selectionType = columns and selectionType = region and region does not support IG_REGION and type in (itemIsNull)selectionType = columns and selectionType = region and region does not support IG_REGION and type in (itemIsNotNull)selectionType = columns and selectionType = region and region does not support IG_REGION and type in (itemIsInList)selectionType = columns and selectionType = region and region does not support IG_REGION and type in (itemIsNotInList)

Enter the page item used in this condition. You can type in the name or pick from the list of available items.

valuestringYesdata type=string; maxLen=4000
Applies whenselectionType = columns and selectionType = region and region does not support IG_REGION and type in (item=value)selectionType = columns and selectionType = region and region does not support IG_REGION and type in (item!=value)selectionType = columns and selectionType = region and region does not support IG_REGION and type in (item>value)selectionType = columns and selectionType = region and region does not support IG_REGION and type in (item>=value)selectionType = columns and selectionType = region and region does not support IG_REGION and type in (item<value)selectionType = columns and selectionType = region and region does not support IG_REGION and type in (item<=value)
listarray of stringsYesdata type=string; maxLen=4000
Applies whenselectionType = columns and selectionType = region and region does not support IG_REGION and type in (itemIsInList)selectionType = columns and selectionType = region and region does not support IG_REGION and type in (itemIsNotInList)
javaScriptExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whenselectionType = columns and selectionType = region and region does not support IG_REGION and type = jsExpression
typeenumNodata type=string; lov=STATIC
Valid values: itemColumn=value itemColumn!=value itemColumn>value itemColumn>=value itemColumn<value itemColumn<=value itemColumnIsNull itemColumnIsNotNull itemColumnIsInList itemColumnIsNotInList jsExpression
Applies whenselectionType = columns and interactiveGrid is setselectionType = region and region supports IG_REGION
componentTypeenumYescolumndata type=string; lov=STATIC
Valid values: item column
Applies whenselectionType = columns and interactiveGrid is set and type in (itemColumn=value)selectionType = columns and interactiveGrid is set and type in (itemColumn!=value)selectionType = columns and interactiveGrid is set and type in (itemColumn>value)selectionType = columns and interactiveGrid is set and type in (itemColumn>=value)selectionType = columns and interactiveGrid is set and type in (itemColumn<value)selectionType = columns and interactiveGrid is set and type in (itemColumn<=value)selectionType = columns and interactiveGrid is set and type in (itemColumnIsNull)selectionType = columns and interactiveGrid is set and type in (itemColumnIsNotNull)selectionType = columns and interactiveGrid is set and type in (itemColumnIsInList)selectionType = columns and interactiveGrid is set and type in (itemColumnIsNotInList)selectionType = region and region supports IG_REGION and type in (itemColumn=value)selectionType = region and region supports IG_REGION and type in (itemColumn!=value)selectionType = region and region supports IG_REGION and type in (itemColumn>value)selectionType = region and region supports IG_REGION and type in (itemColumn>=value)selectionType = region and region supports IG_REGION and type in (itemColumn<value)selectionType = region and region supports IG_REGION and type in (itemColumn<=value)selectionType = region and region supports IG_REGION and type in (itemColumnIsNull)selectionType = region and region supports IG_REGION and type in (itemColumnIsNotNull)selectionType = region and region supports IG_REGION and type in (itemColumnIsInList)selectionType = region and region supports IG_REGION and type in (itemColumnIsNotInList)
itemstringYesdata type=string; maxLen=4000; textCase=UPPER
Applies whenselectionType = columns and interactiveGrid is set and type in (itemColumn=value) and componentType = itemselectionType = columns and interactiveGrid is set and type in (itemColumn!=value) and componentType = itemselectionType = columns and interactiveGrid is set and type in (itemColumn>value) and componentType = itemselectionType = columns and interactiveGrid is set and type in (itemColumn>=value) and componentType = itemselectionType = columns and interactiveGrid is set and type in (itemColumn<value) and componentType = itemselectionType = columns and interactiveGrid is set and type in (itemColumn<=value) and componentType = itemselectionType = columns and interactiveGrid is set and type in (itemColumnIsNull) and componentType = itemselectionType = columns and interactiveGrid is set and type in (itemColumnIsNotNull) and componentType = itemselectionType = columns and interactiveGrid is set and type in (itemColumnIsInList) and componentType = itemselectionType = columns and interactiveGrid is set and type in (itemColumnIsNotInList) and componentType = itemselectionType = region and region supports IG_REGION and type in (itemColumn=value) and componentType = itemselectionType = region and region supports IG_REGION and type in (itemColumn!=value) and componentType = itemselectionType = region and region supports IG_REGION and type in (itemColumn>value) and componentType = itemselectionType = region and region supports IG_REGION and type in (itemColumn>=value) and componentType = itemselectionType = region and region supports IG_REGION and type in (itemColumn<value) and componentType = itemselectionType = region and region supports IG_REGION and type in (itemColumn<=value) and componentType = itemselectionType = region and region supports IG_REGION and type in (itemColumnIsNull) and componentType = itemselectionType = region and region supports IG_REGION and type in (itemColumnIsNotNull) and componentType = itemselectionType = region and region supports IG_REGION and type in (itemColumnIsInList) and componentType = itemselectionType = region and region supports IG_REGION and type in (itemColumnIsNotInList) and componentType = item
columnstringYesdata type=string; maxLen=4000
Applies whenselectionType = columns and interactiveGrid is set and type in (itemColumn=value) and componentType = columnselectionType = columns and interactiveGrid is set and type in (itemColumn!=value) and componentType = columnselectionType = columns and interactiveGrid is set and type in (itemColumn>value) and componentType = columnselectionType = columns and interactiveGrid is set and type in (itemColumn>=value) and componentType = columnselectionType = columns and interactiveGrid is set and type in (itemColumn<value) and componentType = columnselectionType = columns and interactiveGrid is set and type in (itemColumn<=value) and componentType = columnselectionType = columns and interactiveGrid is set and type in (itemColumnIsNull) and componentType = columnselectionType = columns and interactiveGrid is set and type in (itemColumnIsNotNull) and componentType = columnselectionType = columns and interactiveGrid is set and type in (itemColumnIsInList) and componentType = columnselectionType = columns and interactiveGrid is set and type in (itemColumnIsNotInList) and componentType = columnselectionType = region and region supports IG_REGION and type in (itemColumn=value) and componentType = columnselectionType = region and region supports IG_REGION and type in (itemColumn!=value) and componentType = columnselectionType = region and region supports IG_REGION and type in (itemColumn>value) and componentType = columnselectionType = region and region supports IG_REGION and type in (itemColumn>=value) and componentType = columnselectionType = region and region supports IG_REGION and type in (itemColumn<value) and componentType = columnselectionType = region and region supports IG_REGION and type in (itemColumn<=value) and componentType = columnselectionType = region and region supports IG_REGION and type in (itemColumnIsNull) and componentType = columnselectionType = region and region supports IG_REGION and type in (itemColumnIsNotNull) and componentType = columnselectionType = region and region supports IG_REGION and type in (itemColumnIsInList) and componentType = columnselectionType = region and region supports IG_REGION and type in (itemColumnIsNotInList) and componentType = column
valuestringYesdata type=string; maxLen=4000
Applies whenselectionType = columns and interactiveGrid is set and type in (itemColumn=value)selectionType = columns and interactiveGrid is set and type in (itemColumn!=value)selectionType = columns and interactiveGrid is set and type in (itemColumn>value)selectionType = columns and interactiveGrid is set and type in (itemColumn>=value)selectionType = columns and interactiveGrid is set and type in (itemColumn<value)selectionType = columns and interactiveGrid is set and type in (itemColumn<=value)selectionType = region and region supports IG_REGION and type in (itemColumn=value)selectionType = region and region supports IG_REGION and type in (itemColumn!=value)selectionType = region and region supports IG_REGION and type in (itemColumn>value)selectionType = region and region supports IG_REGION and type in (itemColumn>=value)selectionType = region and region supports IG_REGION and type in (itemColumn<value)selectionType = region and region supports IG_REGION and type in (itemColumn<=value)
listarray of stringsYesdata type=string; maxLen=4000
Applies whenselectionType = columns and interactiveGrid is set and type in (itemColumnIsInList)selectionType = columns and interactiveGrid is set and type in (itemColumnIsNotInList)selectionType = region and region supports IG_REGION and type in (itemColumnIsInList)selectionType = region and region supports IG_REGION and type in (itemColumnIsNotInList)
javaScriptExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whenselectionType = columns and interactiveGrid is set and type = jsExpressionselectionType = region and region supports IG_REGION and type = jsExpression
clientSideCondition {
  type: "item=value"
  item: value
  value: value
  list: [
    value
    value
  ]
  javaScriptExpression: ```javascript-browser
    value
  ```
  componentType: item
  column: value
}
advanced
PropertyTypeRequiredDefault ValueDetails
staticIdstringYesdata 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
Select a condition type to be met in order for this dynamic action to be active.
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)
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
  ]
}
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

dynamicAction sample (
    name: value
    execution {
        sequence: 42
        eventScope: static
        staticContainer: value
        type: immediate
        time: 42
        immediate: false
    }
    when {
        event: value
        customEvent: value
        selectionType: items
        region: @component
        interactiveGrid: @component
        columns: [
          value
          value
        ]
        button: @component
        items: [
          value
          value
        ]
        domObject: value
        jquerySelector: value
        javaScriptExpression: ```javascript-browser
          value
        ```
    }
    clientSideCondition {
        type: "item=value"
        item: value
        value: value
        list: [
          value
          value
        ]
        javaScriptExpression: ```javascript-browser
          value
        ```
        componentType: item
        column: 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
        ]
    }
    security {
        authorizationScheme: mustNotBePublicUser
    }
    config {
        buildOption: @component
    }
    comments {
        comments: ```
          value
        ```
    }
)