triggerAction openRegion - APEXlang Reference

`triggerAction (openRegion)`

Parent: triggerAction

Applies whentype = openRegion

Direct Properties:

Property	Type	Required	Default Value	Details
`name`	`string`	No		data type=`string`; maxLen=255 Enter the name of the action. This helps to identify what the action does in Page Designer.
`action`	`enum`	Yes		data type=`string`; lov=`PLUGINS` Valid values: `openRegion`

Property Groups:

genAI

Property	Type	Required	Default Value	Details
`enabled`	`boolean`	Yes	`false`	data type=`boolean`
`agent`	`reference`	No		data type=`reference`; lov=`COMPONENT`; references=`aiAgent` Applies when`enabled = true`
`service`	`reference`	No		data type=`reference`; lov=`COMPONENT`; references=`genAIService` Applies when`enabled = true`
`systemPrompt`	`multiline string`	No		data type=`multiline string`; maxLen=32767 Applies when`enabled = true`
`welcomeMessage`	`multiline string`	No		data type=`multiline string`; maxLen=32767 Applies when`enabled = true`
`itemsToSubmit`	`array of strings`	No		data type=`string`; maxLen=4000; textCase=`UPPER` Applies when`enabled = true`

genAI {
  enabled: false
  agent: @component
  service: @component
  systemPrompt: ```
    value
  ```
  welcomeMessage: ```html
    value
  ```
  itemsToSubmit: [
    value
    value
  ]
}

affectedElements

Property	Type	Required	Details
`selectionType`	`enum`	No	data type=`string`; lov=`STATIC` Valid values: `items` `button` `region` `columns` `domObject` `jquerySelector` `javaScriptExpression` `triggeringElement` `eventSource`
`region`	`reference`	Yes	data type=`reference`; lov=`COMPONENT`; references=`region` Applies when`selectionType = region`
`button`	`reference`	Yes	data type=`reference`; lov=`COMPONENT`; references=`button` Applies when`selectionType = button`
`items`	`array of strings`	Yes	data type=`string`; maxLen=4000; textCase=`UPPER` Applies when`selectionType = items`
`jquerySelector`	`string`	Yes	data type=`string`; maxLen=4000 Applies when`selectionType = jquerySelector`
`javaScriptExpression`	`multiline string`	Yes	data type=`multiline string`; maxLen=4000 Applies when`selectionType = javaScriptExpression`

affectedElements {
  selectionType: items
  region: @component
  button: @component
  items: [
    value
    value
  ]
  jquerySelector: value
  javaScriptExpression: ```javascript-browser
    value
  ```
}

execution

Property	Type	Required	Default Value	Details
`sequence`	`number`	Yes		data type=`number`; maxLen=22
`stopExecutionOnError`	`boolean`	Yes	`true`	data type=`boolean`
`waitForResult`	`boolean`	Yes	`true`	data type=`boolean`

execution {
  sequence: 42
  stopExecutionOnError: false
  waitForResult: false
}

clientSideCondition

Property	Type	Required	Details
`type`	`enum`	No	data 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.
`item`	`string`	Yes	data type=`string`; maxLen=4000; textCase=`UPPER` Applies when`type 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.
`value`	`string`	Yes	data type=`string`; maxLen=4000 Applies when`type in (item=value)type in (item!=value)type in (item>value)type in (item>=value)type in (item<value)type in (item<=value)`
`list`	`array of strings`	Yes	data type=`string`; maxLen=4000 Applies when`type in (itemIsInList)type in (itemIsNotInList)`
`javaScriptExpression`	`multiline string`	Yes	data type=`multiline string`; maxLen=4000 Applies when`type = jsExpression`

clientSideCondition {
  type: "item=value"
  item: value
  value: value
  list: [
    value
    value
  ]
  javaScriptExpression: ```javascript-browser
    value
  ```
}

serverSideCondition

Property	Type	Required	Default Value	Details
`type`	`enum`	No		data 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.
`sqlQuery`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`type in (rowsReturned)type in (noRowsReturned)`
`language`	`enum`	Yes	`plsql`	data type=`string`; lov=`STATIC` Valid values: `sql` `plsql` `javaScript-mle` Applies when`type = expression`
`sqlExpression`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`type = expression and language = sql`
`plsqlExpression`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`type = expression and language = plsql`
`javaScriptExpression`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`type = expression and language = javaScript-mle`
`language`	`enum`	Yes	`plsql`	data type=`string`; lov=`STATIC` Valid values: `plsql` `javaScript-mle` Applies when`type = functionBody`
`plsqlFunctionBody`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`type = functionBody and language = plsql`
`javaScriptFunctionBody`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`type = functionBody and language = javaScript-mle`
`value`	`string`	Yes		data type=`string`; maxLen=4000 Applies when`type 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)`
`item`	`string`	Yes		data type=`string`; maxLen=4000; textCase=`UPPER` Applies when`type 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)`
`preference`	`string`	Yes		data type=`string`; maxLen=4000; textCase=`UPPER` Applies when`type in (userPreference=value)type in (userPreference!=value)`
`page`	`integer`	Yes		data type=`integer`; maxLen=4000 Applies when`type in (currentPage=page)type in (currentPage!=page)`
`pages`	`array of integers`	Yes		data type=`integer`; maxLen=4000 Applies when`type in (currentPageInList)type in (currentPageNotInList)`
`text`	`string`	Yes		data type=`string`; maxLen=4000 Applies when`type in (textIsContainedInItem)type in (textIsContainedInValue)type in (textIsNotContainedInValue)type in (text=value)type in (text!=value)`
`value`	`string`	Yes		data type=`string`; maxLen=4000 Applies when`type 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)`
`list`	`array of strings`	Yes		data type=`string`; maxLen=4000 Applies when`type in (itemIsInColonDelimitedList)type in (itemIsNotInColonDelimitedList)`
`item`	`string`	Yes		data type=`string`; maxLen=4000; textCase=`UPPER` Applies when`type = textIsContainedInItem`
`value`	`string`	Yes		data type=`string`; maxLen=4000 Applies when`type 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

Property	Type	Required	Default Value	Details
`authorizationScheme`	`enum`	No		data type=`reference`; lov=`COMPONENT`; references=`authorization` Valid values: `mustNotBePublicUser`

security {
  authorizationScheme: mustNotBePublicUser
}

config

Property	Type	Required	Default Value	Details
`buildOption`	`reference`	No		data type=`reference`; lov=`COMPONENT`; references=`buildOption`

config {
  buildOption: @component
}

advanced

Property	Type	Required	Default Value	Details
`staticId`	`string`	Yes		data type=`string`; maxLen=255
`initJavaScriptFunction`	`multiline string`	No		data type=`multiline string`; maxLen=4000

advanced {
  staticId: value
  initJavaScriptFunction: ```javascript-browser
    value
  ```
}

comments

Property	Type	Required	Default Value	Details
`comments`	`multiline string`	No		data type=`multiline string`; maxLen=4000

comments {
  comments: ```
    value
  ```
}

APEXlang Example

triggerAction sample (
    name: value
    action: openRegion
    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
        ```
    }
)