action formPagination - APEXlang Reference

`action (formPagination)`

Parent: action

Applies whentype = formPagination

Direct Properties:

Property	Type	Required	Default Value	Details
`name`	`string`	Yes		data type=`string`; maxLen=255 Enter a name for the task definition action.
`type`	`enum`	Yes		data type=`string`; lov=`PLUGINS` Valid values: `formPagination`

Property Groups:

target

Property	Type	Required	Default Value	Details
`tableOwner`	`string`	No		data type=`string`; maxLen=128
`tableName`	`string`	Yes		data type=`string`; maxLen=128
`pkItem`	`string`	Yes		data type=`string`; maxLen=4000; textCase=`UPPER`
`pkColumn`	`string`	Yes	`ROWID`	data type=`string`; maxLen=128
`secondaryKeyItem`	`string`	Yes		data type=`string`; maxLen=4000; textCase=`UPPER` Applies when`secondary_key_column is set`
`secondaryKeyColumn`	`string`	No		data type=`string`; maxLen=128
`navigationOrderColumn`	`string`	No		data type=`string`; maxLen=128
`secondaryNavigationOrderColumn`	`string`	No		data type=`string`; maxLen=128
`nextPkItem`	`string`	Yes		data type=`string`; maxLen=4000; textCase=`UPPER`
`prevPkItem`	`string`	Yes		data type=`string`; maxLen=4000; textCase=`UPPER`
`nextSecondaryKeyItem`	`string`	Yes		data type=`string`; maxLen=4000; textCase=`UPPER` Applies when`secondary_key_column is set`
`prevSecondaryKeyItem`	`string`	Yes		data type=`string`; maxLen=4000; textCase=`UPPER` Applies when`secondary_key_column is set`
`currentRowCountItem`	`string`	No		data type=`string`; maxLen=4000; textCase=`UPPER`
`runtimeWhereClause`	`string`	No		data type=`string`; maxLen=4000

target {
  tableOwner: value
  tableName: value
  pkItem: value
  pkColumn: value
  secondaryKeyItem: value
  secondaryKeyColumn: value
  navigationOrderColumn: value
  secondaryNavigationOrderColumn: value
  nextPkItem: value
  prevPkItem: value
  nextSecondaryKeyItem: value
  prevSecondaryKeyItem: value
  currentRowCountItem: value
  runtimeWhereClause: value
}

source

Property	Type	Required	Default Value	Details
`location`	`enum`	Yes	`localDatabase`	data type=`string`; lov=`STATIC` Valid values: `localDatabase` `restEnabledSql`
`language`	`enum`	Yes	`plsql`	data type=`string`; lov=`STATIC` Valid values: `plsql` `javaScript-mle` Applies when`location = localDatabase`
`plsqlCode`	`multiline string`	Yes		data type=`multiline string`; maxLen=32767 Applies when`location = localDatabase and language = plsql`
`javaScriptCode`	`multiline string`	Yes		data type=`multiline string`; maxLen=32767 Applies when`location = localDatabase and language = javaScript-mle`
`remoteServer`	`reference`	Yes		data type=`reference`; lov=`COMPONENT`; references=`restEnabledSqlDatabase` Applies when`location = restEnabledSql`
`plsqlCode`	`multiline string`	Yes		data type=`multiline string`; maxLen=32767 Applies when`location = restEnabledSql` Enter the PL/SQL code to be executed on the remote database.

source {
  location: localDatabase
  language: plsql
  plsqlCode: ```plsql
    value
  ```
  javaScriptCode: ```javascript-mle
    value
  ```
  remoteServer: @component
}

execution

Property	Type	Required	Default Value	Details
`onEvent`	`enum`	Yes	`claim`	data type=`string`; lov=`STATIC` Valid values: `claim` `complete` `setOutcome` `delegate` `updateComment` `updatePriority` `updateParameter` `release` `cancel` `create` `requestInformation` `submitInformation` `beforeExpire` `expire` `fail`
`outcome`	`enum`	No		data type=`string`; lov=`STATIC` Valid values: `approved` `rejected` Applies when`onEvent = complete and type = approval`
`outcome`	`string`	Yes		data type=`string`; maxLen=255 Applies when`onEvent = setOutcome`
`beforeExpirationInterval`	`string`	No		data type=`string`; maxLen=32767 Applies when`onEvent = beforeExpire`
`sequence`	`number`	Yes		data type=`number`; maxLen=22

execution {
  onEvent: claim
  outcome: value
  beforeExpirationInterval: value
  sequence: 42
}

successMessage

Property	Type	Required	Default Value	Details
`successMessage`	`multiline string`	No		data type=`multiline string`; maxLen=4000 Enter the success message for this process. If the process runs and does not generate an error, then this process success message displays in the notification section of the resulting page displayed. If you are branching to another page via a URL redirect, you may need to check the preserve success message attribute. For multi row processes, the following substitution string can be used to get the number of records processed: Insert: `#MRI_COUNT#` Update: `#MRU_COUNT#` Delete: `#MRD_COUNT#` For the Send E-Mail process type the substitution string `#TO#` can be used to get the addressees of the e-mail. Plug-ins can have other substitution strings as well. See Plug-in documentation for details.

successMessage {
  successMessage: ```
    value
  ```
}

error

Property	Type	Required	Default Value	Details
`errorMessage`	`multiline string`	No		data type=`multiline string`; maxLen=4000 Enter an error message to be written to the task history when the processing fails. Use #SQLERRM# as a placeholder for the actual ORA error message.
`logging`	`enum`	Yes	`none`	data type=`string`; lov=`STATIC` Valid values: `none` `success` `failure` `all`
`stopExecutionOnError`	`boolean`	Yes	`true`	data type=`boolean` Enable when processing for the current task should stop on error. Subsequent actions will not be processed in this case and the task will go the ERRORED state.

error {
  errorMessage: ```
    value
  ```
  logging: none
  stopExecutionOnError: false
}

advanced

Property	Type	Required	Default Value	Details
`staticId`	`string`	Yes		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: `rowsReturned` `noRowsReturned` `expression` `functionBody` `item=value` `item!=value` `itemIsNull` `itemIsNotNull` `itemIsZero` `itemIsNotZero` `itemIsNullOrZero` `itemIsNotNullAndNotZero` `itemContainsNoSpaces` `itemIsNumeric` `itemIsNotNumeric` `itemIsAlphanumeric` `itemIsInColonDelimitedList` `itemIsNotInColonDelimitedList` `textIsContainedInItem` `text=value` `text!=value` `textIsContainedInValue` `textIsNotContainedInValue` `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`
`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)`
`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: rowsReturned
  sqlQuery: ```sql
    value
  ```
  language: sql
  sqlExpression: ```sql
    value
  ```
  plsqlExpression: ```plsql
    value
  ```
  javaScriptExpression: ```javascript-mle
    value
  ```
  plsqlFunctionBody: ```plsql
    value
  ```
  javaScriptFunctionBody: ```javascript-mle
    value
  ```
  item: value
  text: value
  value: value
  list: [
    value
    value
  ]
}

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 (
    name: value
    type: formPagination
    target {
        tableOwner: value
        tableName: value
        pkItem: value
        pkColumn: value
        secondaryKeyItem: value
        secondaryKeyColumn: value
        navigationOrderColumn: value
        secondaryNavigationOrderColumn: value
        nextPkItem: value
        prevPkItem: value
        nextSecondaryKeyItem: value
        prevSecondaryKeyItem: value
        currentRowCountItem: value
        runtimeWhereClause: value
    }
    source {
        location: localDatabase
        language: plsql
        plsqlCode: ```plsql
          value
        ```
        javaScriptCode: ```javascript-mle
          value
        ```
        remoteServer: @component
    }
    execution {
        onEvent: claim
        outcome: value
        beforeExpirationInterval: value
        sequence: 42
    }
    successMessage {
        successMessage: ```
          value
        ```
    }
    error {
        errorMessage: ```
          value
        ```
        logging: none
        stopExecutionOnError: false
    }
    advanced {
        staticId: value
    }
    serverSideCondition {
        type: rowsReturned
        sqlQuery: ```sql
          value
        ```
        language: sql
        sqlExpression: ```sql
          value
        ```
        plsqlExpression: ```plsql
          value
        ```
        javaScriptExpression: ```javascript-mle
          value
        ```
        plsqlFunctionBody: ```plsql
          value
        ```
        javaScriptFunctionBody: ```javascript-mle
          value
        ```
        item: value
        text: value
        value: value
        list: [
          value
          value
        ]
    }
    config {
        buildOption: @component
    }
    comments {
        comments: ```
          value
        ```
    }
)