process (autoRowFetch)
type = autoRowFetch| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
name | string | Yes | data type=string; maxLen=255Enter the name of the process for easy identification by developers. | |
type | enum | Yes | data type=string; lov=PLUGINSValid values: autoRowFetch | |
executionChain | reference | No | data type=reference; lov=COMPONENT; references=process | |
formRegion | reference | Yes | data type=reference; lov=COMPONENT; references=region | |
editableRegion | reference | No | data type=reference; lov=COMPONENT; references=regionApplies when executionChain does not support RUN_IN_BACKGROUND |
source
| 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 | data type=string; maxLen=128 | |
secondaryKeyItem | string | Yes | data type=string; maxLen=4000; textCase=UPPERApplies when secondary_key_column is set | |
secondaryKeyColumn | string | No | data type=string; maxLen=128 | |
rowVersionColumn | string | No | data type=string; maxLen=128 | |
runtimeWhereClause | string | No | data type=string; maxLen=4000 | |
fetchMode | enum | No | data type=string; maxLen=4000; lov=STATICValid values: setMemoryCacheOnDisplay |
source {
tableOwner: value
tableName: value
pkItem: value
pkColumn: value
secondaryKeyItem: value
secondaryKeyColumn: value
rowVersionColumn: value
runtimeWhereClause: value
fetchMode: setMemoryCacheOnDisplay
}genAI
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
enabled | boolean | Yes | false | data type=boolean |
agent | reference | No | data type=reference; lov=COMPONENT; references=aiAgentApplies when enabled = true | |
service | reference | No | data type=reference; lov=COMPONENT; references=genAIServiceApplies when enabled = true | |
systemPrompt | multiline string | No | data type=multiline string; maxLen=32767Applies when enabled = true |
genAI {
enabled: false
agent: @component
service: @component
systemPrompt: ```
value
```
}source
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
location | enum | Yes | localDatabase | data type=string; lov=STATICValid values: localDatabase restEnabledSql |
language | enum | Yes | plsql | data type=string; lov=STATICValid values: plsql javaScript-mleApplies when location = localDatabase |
plsqlCode | multiline string | Yes | data type=multiline string; maxLen=32767Applies when location = localDatabase and language = plsql | |
javaScriptCode | multiline string | Yes | data type=multiline string; maxLen=32767Applies when location = localDatabase and language = javaScript-mle | |
remoteServer | reference | Yes | data type=reference; lov=COMPONENT; references=restEnabledSqlDatabaseApplies when location = restEnabledSql | |
plsqlCode | multiline string | Yes | data type=multiline string; maxLen=32767Applies when location = restEnabledSqlEnter 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 |
|---|---|---|---|---|
sequence | number | Yes | data type=number; maxLen=22 | |
point | enum | Yes | processing | data type=string; lov=STATICValid values: newSession beforeHeader afterHeader beforeRegions afterRegions beforeFooter afterFooter afterSubmit processing ajaxCallback |
runProcess | enum | Yes | oncePerPageVisitDefault | data type=string; lov=STATICValid values: oncePerSessionOrWhenReset oncePerPageVisitDefault |
execution {
sequence: 42
point: newSession
runProcess: oncePerSessionOrWhenReset
}successMessage
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
successMessage | multiline string | No | data type=multiline string; maxLen=4000Enter 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:
For the Send E-Mail process type the substitution string 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=4000Enter the error message for this process. This message displays if an unhandled exception is raised. After any error processing stops, a rollback is issued and an error message displays. Note: the SQL error message sqlerrm displays by default if On Error Page is defined as the error display location, there is no need to add Error messages can include the following substitution strings:
| |
displayLocation | enum | Yes | inlineInNotification | data type=string; lov=STATICValid values: inlineInNotification onErrorPageApplies when point in (afterSubmit)point in (processing) |
error {
errorMessage: ```
value
```
displayLocation: inlineInNotification
}advanced
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
staticId | string | Yes | data type=string; maxLen=255 | |
executionMappingIdentifier | string | No | data type=string; maxLen=32767 |
advanced {
staticId: value
executionMappingIdentifier: value
}serverSideCondition
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
whenButtonPressed | reference | No | data type=reference; lov=COMPONENT; references=button | |
executionScope | enum | Yes | forCreatedAndModifiedRows | data type=string; lov=STATICValid values: forCreatedAndModifiedRows allSubmittedRowsApplies when executionChain does not support RUN_IN_BACKGROUND and editableRegion is set |
type | enum | No | data type=string; lov=STATICValid 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=4000Applies when type in (rowsReturned)type in (noRowsReturned) | |
language | enum | Yes | plsql | data type=string; lov=STATICValid values: sql plsql javaScript-mleApplies when type = expression |
sqlExpression | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = expression and language = sql | |
plsqlExpression | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = expression and language = plsql | |
javaScriptExpression | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = expression and language = javaScript-mle | |
language | enum | Yes | plsql | data type=string; lov=STATICValid values: plsql javaScript-mleApplies when type = functionBody |
plsqlFunctionBody | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = functionBody and language = plsql | |
javaScriptFunctionBody | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = functionBody and language = javaScript-mle | |
value | string | Yes | data type=string; maxLen=4000Applies 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=UPPERApplies 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=UPPERApplies when type in (userPreference=value)type in (userPreference!=value) | |
page | integer | Yes | data type=integer; maxLen=4000Applies when type in (currentPage=page)type in (currentPage!=page) | |
pages | array of integers | Yes | data type=integer; maxLen=4000Applies when type in (currentPageInList)type in (currentPageNotInList) | |
text | string | Yes | data type=string; maxLen=4000Applies 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=4000Applies 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=4000Applies when type in (itemIsInColonDelimitedList)type in (itemIsNotInColonDelimitedList) | |
item | string | Yes | data type=string; maxLen=4000; textCase=UPPERApplies when type = textIsContainedInItem | |
value | string | Yes | data type=string; maxLen=4000Applies when type in (textIsContainedInValue)type in (textIsNotContainedInValue)type in (text=value)type in (text!=value) | |
executeCondition | enum | Yes | forEachRow | data type=string; lov=STATICValid values: forEachRow onceApplies when executionChain does not support RUN_IN_BACKGROUND and editableRegion is set and type is set |
serverSideCondition {
whenButtonPressed: @component
executionScope: forCreatedAndModifiedRows
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=authorizationValid 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
process sample (
name: value
type: autoRowFetch
executionChain: @component
formRegion: @component
editableRegion: @component
source {
tableOwner: value
tableName: value
pkItem: value
pkColumn: value
secondaryKeyItem: value
secondaryKeyColumn: value
rowVersionColumn: value
runtimeWhereClause: value
fetchMode: setMemoryCacheOnDisplay
}
genAI {
enabled: false
agent: @component
service: @component
systemPrompt: ```
value
```
}
source {
location: localDatabase
language: plsql
plsqlCode: ```plsql
value
```
javaScriptCode: ```javascript-mle
value
```
remoteServer: @component
}
execution {
sequence: 42
point: newSession
runProcess: oncePerSessionOrWhenReset
}
successMessage {
successMessage: ```
value
```
}
error {
errorMessage: ```
value
```
displayLocation: inlineInNotification
}
advanced {
staticId: value
executionMappingIdentifier: value
}
serverSideCondition {
whenButtonPressed: @component
executionScope: forCreatedAndModifiedRows
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
```
}
)