action - APEXlang Reference

`action`

Parent: column

Children: menuposition supports MENU; position supports TEMPLATE and template supports MENU, triggerActionposition supports TEMPLATE and template supports LINK_URL and type = triggerAction; position supports LINK and type = triggerAction; position supports TMPL_LINK_URL and type = triggerAction

Direct Properties:

Property	Type	Required	Details
`position`	`string`	Yes	data type=`string`; lov=`PLUGIN_ACTION_POSITIONS`
`template`	`string`	Yes	data type=`string`; lov=`PLUGIN_ACTION_TEMPLATES` Applies when`position supports TEMPLATE`
`label`	`string`	Yes	data type=`string`; maxLen=255 Applies when`position supports TEMPLATE and template supports LABELposition supports TMPL_LABEL`

Property Groups:

layout

Property	Type	Required	Default Value	Details
`sequence`	`number`	Yes		data 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 {
  sequence: 42
}

behavior

Property	Type	Required	Default Value	Details
`type`	`enum`	Yes	`redirectThisApp`	data type=`string`; lov=`STATIC` Valid values: `redirectThisApp` `redirectOtherApp` `redirectUrl` `triggerAction` Applies when`position supports TEMPLATE and template supports LINK_URLposition supports LINKposition supports TMPL_LINK_URL`
`target`	`complex`	Yes		data type=`complex`; maxLen=32767 Applies when`position supports TEMPLATE and template supports LINK_URL and type = redirectThisAppposition supports LINK and type = redirectThisAppposition supports TMPL_LINK_URL and type = redirectThisApp`
`target`	`complex`	Yes		data type=`complex`; maxLen=32767 Applies when`position supports TEMPLATE and template supports LINK_URL and type = redirectOtherAppposition supports LINK and type = redirectOtherAppposition supports TMPL_LINK_URL and type = redirectOtherApp`
`targetUrl`	`string`	Yes		data type=`string`; maxLen=4000 Applies when`position supports TEMPLATE and template supports LINK_URL and type = redirectUrlposition supports LINK and type = redirectUrlposition supports TMPL_LINK_URL and type = redirectUrl`
`linkAttributes`	`string`	No		data type=`string`; maxLen=4000 Applies when`position supports TEMPLATE and template supports LINK_URL and type in (redirectThisApp) and template supports LINK_ATTRposition supports TEMPLATE and template supports LINK_URL and type in (redirectThisApp) and position supports LINKposition supports TEMPLATE and template supports LINK_URL and type in (redirectThisApp) and position supports TMPL_LINK_ATTRposition supports TEMPLATE and template supports LINK_URL and type in (redirectOtherApp) and template supports LINK_ATTRposition supports TEMPLATE and template supports LINK_URL and type in (redirectOtherApp) and position supports LINKposition supports TEMPLATE and template supports LINK_URL and type in (redirectOtherApp) and position supports TMPL_LINK_ATTRposition supports TEMPLATE and template supports LINK_URL and type in (redirectUrl) and template supports LINK_ATTRposition supports TEMPLATE and template supports LINK_URL and type in (redirectUrl) and position supports LINKposition supports TEMPLATE and template supports LINK_URL and type in (redirectUrl) and position supports TMPL_LINK_ATTRposition supports LINK and type in (redirectThisApp) and position supports TEMPLATE and template supports LINK_ATTRposition supports LINK and type in (redirectThisApp)position supports LINK and type in (redirectThisApp) and position supports TMPL_LINK_ATTRposition supports LINK and type in (redirectOtherApp) and position supports TEMPLATE and template supports LINK_ATTRposition supports LINK and type in (redirectOtherApp)position supports LINK and type in (redirectOtherApp) and position supports TMPL_LINK_ATTRposition supports LINK and type in (redirectUrl) and position supports TEMPLATE and template supports LINK_ATTRposition supports LINK and type in (redirectUrl)position supports LINK and type in (redirectUrl) and position supports TMPL_LINK_ATTRposition supports TMPL_LINK_URL and type in (redirectThisApp) and position supports TEMPLATE and template supports LINK_ATTRposition supports TMPL_LINK_URL and type in (redirectThisApp) and position supports LINKposition supports TMPL_LINK_URL and type in (redirectThisApp) and position supports TMPL_LINK_ATTRposition supports TMPL_LINK_URL and type in (redirectOtherApp) and position supports TEMPLATE and template supports LINK_ATTRposition supports TMPL_LINK_URL and type in (redirectOtherApp) and position supports LINKposition supports TMPL_LINK_URL and type in (redirectOtherApp) and position supports TMPL_LINK_ATTRposition supports TMPL_LINK_URL and type in (redirectUrl) and position supports TEMPLATE and template supports LINK_ATTRposition supports TMPL_LINK_URL and type in (redirectUrl) and position supports LINKposition supports TMPL_LINK_URL and type in (redirectUrl) and position supports TMPL_LINK_ATTR`

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

Property	Type	Required	Default Value	Details
`displayType`	`enum`	Yes	`text`	data type=`string`; lov=`STATIC` Valid values: `text` `icon` `textWithIcon` Applies when`position supports TEMPLATE and template supports ICON_CLASSESposition supports TMPL_ICON_CLASSES`
`icon`	`string`	Yes		data type=`string`; maxLen=255 Applies when`position supports TEMPLATE and template supports ICON_CLASSES and displayType in (icon)position supports TEMPLATE and template supports ICON_CLASSES and displayType in (textWithIcon)position supports TMPL_ICON_CLASSES and displayType in (icon)position supports TMPL_ICON_CLASSES and displayType in (textWithIcon)`
`hot`	`boolean`	Yes	`false`	data type=`boolean` Applies when`position supports TEMPLATE and template supports IS_HOTposition supports TMPL_IS_HOT` Specify whether to use the Normal or Hot button when rendering this button.
`showAsDisabled`	`boolean`	Yes	`false`	data type=`boolean` Applies when`position supports TEMPLATE and template supports IS_DISABLEDposition supports TMPL_IS_DISABLED`
`cssClasses`	`array of strings`	No		data type=`string`; maxLen=255 Applies when`position supports TEMPLATE and template supports CSS_CLASSESposition supports TMPL_CSS_CLASSES` Enter classes to add to this action. You may add multiple classes by separating them with spaces.

appearance {
  displayType: text
  icon: value
  hot: false
  showAsDisabled: false
  cssClasses: [
    value
    value
  ]
}

advanced

Property	Type	Required	Default Value	Details
`staticId`	`string`	Yes	`action`	data type=`string`; maxLen=255

advanced {
  staticId: 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`
`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)`
`executeCondition`	`enum`	Yes	`forEachRow`	data type=`string`; lov=`STATIC` Valid values: `forEachRow` `once` Applies when`type 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

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
}

comments

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

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

APEXlang Example

action sample (
    position: value
    template: value
    label: value
    layout {
        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
        showAsDisabled: 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
        ```
    }
)