triggerAction

Parent: action

Applies whentype = triggerAction

Plug-in Variants: addClasstype = addClass, alerttype = alert, cancelDialogtype = cancelDialog, cancelEventtype = cancelEvent, cleartype = clear, clearErrorstype = clearErrors, closeDialogtype = closeDialog, closeRegiontype = closeRegion, collapseTreetype = collapseTree, confirmtype = confirm, disabletype = disable, downloadtype = download, enabletype = enable, executeJsCodetype = executeJsCode, executeServerSideCodetype = executeServerSideCode, expandTreetype = expandTree, generateTextWithAitype = generateTextWithAi, getCurrentPositiontype = getCurrentPosition, hidetype = hide, invokeInteractiveReportDialogtype = invokeInteractiveReportDialog, openRegiontype = openRegion, printReporttype = printReport, refreshtype = refresh, removeClasstype = removeClass, setFocustype = setFocus, setStyletype = setStyle, setValuetype = setValue, sharetype = share, showtype = show, showAiAssistanttype = showAiAssistant, showErrorMessagetype = showErrorMessage, showSuccessMessagetype = showSuccessMessage, submitPagetype = submitPage, triggerGeocodingtype = triggerGeocoding

Direct Properties:

PropertyTypeRequiredDefault ValueDetails
namestringNodata type=string; maxLen=255
Enter the name of the action. This helps to identify what the action does in Page Designer.
actionenumYesdata type=string; lov=PLUGINS
Valid values: addClass alert cancelDialog cancelEvent clear clearErrors closeDialog closeRegion collapseTree confirm disable download enable executeJsCode executeServerSideCode expandTree generateTextWithAi getCurrentPosition hide invokeInteractiveReportDialog openRegion printReport refresh removeClass setFocus setStyle setValue share show showAiAssistant showErrorMessage showSuccessMessage submitPage triggerGeocoding

Property Groups:

  • genAI
  • affectedElements
  • execution
  • clientSideCondition
  • serverSideCondition
  • security
  • config
  • advanced
  • comments
genAI
PropertyTypeRequiredDefault ValueDetails
enabledbooleanYesfalsedata type=boolean
Applies whenaction supports AI_ENABLED
agentreferenceNodata type=reference; lov=COMPONENT; references=aiAgent
Applies whenaction supports AI_ENABLED_ALWAYS and action supports AI_ENABLED and enabled = trueaction supports AI_ENABLED and enabled = true
servicereferenceNodata type=reference; lov=COMPONENT; references=genAIService
Applies whenaction supports AI_ENABLED_ALWAYS and action supports AI_ENABLED and enabled = trueaction supports AI_ENABLED and enabled = true
systemPromptmultiline stringNodata type=multiline string; maxLen=32767
Applies whenaction supports AI_SYSTEM_PROMPT and action supports AI_ENABLED_ALWAYS and action supports AI_ENABLED and enabled = trueaction supports AI_SYSTEM_PROMPT and action supports AI_ENABLED and enabled = true
welcomeMessagemultiline stringNodata type=multiline string; maxLen=32767
Applies whenaction supports AI_UI and action supports AI_ENABLED_ALWAYS and action supports AI_ENABLED and enabled = trueaction supports AI_UI and action supports AI_ENABLED and enabled = true
itemsToSubmitarray of stringsNodata type=string; maxLen=4000; textCase=UPPER
Applies whenaction supports AI_ENABLED_ALWAYS and action supports AI_ENABLED and enabled = trueaction supports AI_ENABLED and enabled = true
 
genAI {
  enabled: false
  agent: @component
  service: @component
  systemPrompt: ```
    value
  ```
  welcomeMessage: ```html
    value
  ```
  itemsToSubmit: [
    value
    value
  ]
}
affectedElements
PropertyTypeRequiredDefault ValueDetails
selectionTypeenumNodata type=string; lov=STATIC
Valid values: items button region columns domObject jquerySelector javaScriptExpression triggeringElement eventSource
Applies whenaction supports ITEMaction supports BUTTONaction supports REGIONaction supports JQUERY_SELECTORaction supports JAVASCRIPT_EXPRESSIONaction supports TRIGGERING_ELEMENTaction supports EVENT_SOURCE
regionreferenceYesdata type=reference; lov=COMPONENT; references=region
Applies whenaction supports ITEM and selectionType = regionaction supports BUTTON and selectionType = regionaction supports REGION and selectionType = regionaction supports JQUERY_SELECTOR and selectionType = regionaction supports JAVASCRIPT_EXPRESSION and selectionType = regionaction supports TRIGGERING_ELEMENT and selectionType = regionaction supports EVENT_SOURCE and selectionType = region
buttonreferenceYesdata type=reference; lov=COMPONENT; references=button
Applies whenaction supports ITEM and selectionType = buttonaction supports BUTTON and selectionType = buttonaction supports REGION and selectionType = buttonaction supports JQUERY_SELECTOR and selectionType = buttonaction supports JAVASCRIPT_EXPRESSION and selectionType = buttonaction supports TRIGGERING_ELEMENT and selectionType = buttonaction supports EVENT_SOURCE and selectionType = button
itemsarray of stringsYesdata type=string; maxLen=4000; textCase=UPPER
Applies whenaction supports ITEM and selectionType = itemsaction supports BUTTON and selectionType = itemsaction supports REGION and selectionType = itemsaction supports JQUERY_SELECTOR and selectionType = itemsaction supports JAVASCRIPT_EXPRESSION and selectionType = itemsaction supports TRIGGERING_ELEMENT and selectionType = itemsaction supports EVENT_SOURCE and selectionType = items
jquerySelectorstringYesdata type=string; maxLen=4000
Applies whenaction supports ITEM and selectionType = jquerySelectoraction supports BUTTON and selectionType = jquerySelectoraction supports REGION and selectionType = jquerySelectoraction supports JQUERY_SELECTOR and selectionType = jquerySelectoraction supports JAVASCRIPT_EXPRESSION and selectionType = jquerySelectoraction supports TRIGGERING_ELEMENT and selectionType = jquerySelectoraction supports EVENT_SOURCE and selectionType = jquerySelector
javaScriptExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whenaction supports ITEM and selectionType = javaScriptExpressionaction supports BUTTON and selectionType = javaScriptExpressionaction supports REGION and selectionType = javaScriptExpressionaction supports JQUERY_SELECTOR and selectionType = javaScriptExpressionaction supports JAVASCRIPT_EXPRESSION and selectionType = javaScriptExpressionaction supports TRIGGERING_ELEMENT and selectionType = javaScriptExpressionaction supports EVENT_SOURCE and selectionType = javaScriptExpression
 
affectedElements {
  selectionType: items
  region: @component
  button: @component
  items: [
    value
    value
  ]
  jquerySelector: value
  javaScriptExpression: ```javascript-browser
    value
  ```
}
execution
PropertyTypeRequiredDefault ValueDetails
sequencenumberYesdata type=number; maxLen=22
stopExecutionOnErrorbooleanYestruedata type=boolean
Applies whenaction supports STOP_EXECUTION_ON_ERROR
waitForResultbooleanYestruedata type=boolean
Applies whenaction supports WAIT_FOR_RESULT
 
execution {
  sequence: 42
  stopExecutionOnError: false
  waitForResult: false
}
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
Specify a client-side condition, to control whether the action fires.
itemstringYesdata type=string; maxLen=4000; textCase=UPPER
Applies whentype in (item=value)type in (item!=value)type in (item>value)type in (item>=value)type in (item<value)type in (item<=value)type in (itemIsNull)type in (itemIsNotNull)type in (itemIsInList)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 whentype in (item=value)type in (item!=value)type in (item>value)type in (item>=value)type in (item<value)type in (item<=value)
listarray of stringsYesdata type=string; maxLen=4000
Applies whentype in (itemIsInList)type in (itemIsNotInList)
javaScriptExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype = jsExpression
 
clientSideCondition {
  type: "item=value"
  item: value
  value: value
  list: [
    value
    value
  ]
  javaScriptExpression: ```javascript-browser
    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 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
}
advanced
PropertyTypeRequiredDefault ValueDetails
staticIdstringYesdata type=string; maxLen=255
initJavaScriptFunctionmultiline stringNodata type=multiline string; maxLen=4000
Applies whenaction supports INIT_JAVASCRIPT_CODE
 
advanced {
  staticId: value
  initJavaScriptFunction: ```javascript-browser
    value
  ```
}
comments
PropertyTypeRequiredDefault ValueDetails
commentsmultiline stringNodata type=multiline string; maxLen=4000
 
comments {
  comments: ```
    value
  ```
}

APEXlang Example

triggerAction sample (
    name: value
    action: addClass
    genAI {
        enabled: false
        agent: @component
        service: @component
        systemPrompt: ```
          value
        ```
        welcomeMessage: ```html
          value
        ```
        itemsToSubmit: [
          value
          value
        ]
    }
    affectedElements {
        selectionType: items
        region: @component
        button: @component
        items: [
          value
          value
        ]
        jquerySelector: value
        javaScriptExpression: ```javascript-browser
          value
        ```
    }
    execution {
        sequence: 42
        stopExecutionOnError: false
        waitForResult: false
    }
    clientSideCondition {
        type: "item=value"
        item: value
        value: value
        list: [
          value
          value
        ]
        javaScriptExpression: ```javascript-browser
          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
    }
    advanced {
        staticId: value
        initJavaScriptFunction: ```javascript-browser
          value
        ```
    }
    comments {
        comments: ```
          value
        ```
    }
)