column
type supports SOURCE_LOCATION and location is set| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
name | string | Yes | data type=string; maxLen=128; textCase=UPPER |
layout
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
sequence | number | Yes | data type=number; maxLen=22Enter the display sequence for this column. The sequence setting determines where this column is displayed in relation to other columns within the region. Note: If two columns, within the same region, have the same sequence value then they may be displayed in a different order when the application is exported and imported into another environment, such as a test or production environment. To ensure consistency, Oracle recommends you specify unique sequence numbers for every item, or at least for those within the same region. |
layout {
sequence: 42
}source
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
type | enum | Yes | databaseColumn | data type=string; lov=STATICValid values: databaseColumn sqlExpression none |
databaseColumn | string | Yes | data type=string; maxLen=128Applies when type = databaseColumn | |
sqlExpression | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = sqlExpression | |
dataType | enum | Yes | data type=string; maxLen=128; lov=STATICValid values: varchar2 number date timestamp timestampWithTimeZone timestampWithLocalTimeZone intervalYearToMonth intervalDayToSecond clob blob boolean rowid bfile sdoGeometry | |
primaryKey | boolean | Yes | false | data type=booleanApplies when type = databaseColumn |
availableOnClient | boolean | Yes | false | data type=booleanApplies when type = databaseColumn and primaryKey = false |
valueProtected | boolean | Yes | true | data type=booleanApplies when type = databaseColumn and primaryKey = false and availableOnClient = true |
source {
type: databaseColumn
databaseColumn: value
sqlExpression: ```sql
value
```
dataType: varchar2
primaryKey: false
availableOnClient: false
valueProtected: false
}lov
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
type | enum | No | data type=string; lov=STATICValid values: sharedComponent sqlQuery staticValues functionBody | |
lov | reference | Yes | data type=reference; lov=COMPONENT; references=lovApplies when type = sharedComponent | |
sqlQuery | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = sqlQueryEnter the SQL query definition to populate this list of values. Generally list of value queries are of the form:
select [displayValue],
[returnValue]
from ...
where ...
order by ...
Each column selected must have a unique name or alias. Oracle recommends using an alias on any column that includes an SQL expression. Note: When defining a Popup LOV item type, if you would like to display multiple columns in the popup, you must instead define your List of Values in Shared Components, with the required additional metadata. Inline list of values can only be used to display single columns for Popup LOVs. | |
staticValues | multiline string | Yes | STATIC:Display1;Return1,Display2;Return2 | data type=multiline string; maxLen=4000Applies when type = staticValues |
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=32767Applies when type = functionBody and language = plsql | |
javaScriptFunctionBody | multiline string | Yes | data type=multiline string; maxLen=32767Applies when type = functionBody and language = javaScript-mle | |
displayExtraValues | boolean | Yes | true | data type=booleanApplies when type is set |
lov {
type: sharedComponent
lov: @component
sqlQuery: ```sql
value
```
staticValues: ```
value
```
language: plsql
plsqlFunctionBody: ```plsql
value
```
javaScriptFunctionBody: ```javascript-mle
value
```
displayExtraValues: false
}accessibility
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
valueIdentifiesRow | boolean | Yes | false | data type=booleanApplies when display = report |
accessibility {
valueIdentifiesRow: false
}appearance
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
formatMask | string | No | data type=string; maxLen=255Applies when dataType in (date)dataType in (timestamp)dataType in (timestampWithTimeZone)dataType in (timestampWithLocalTimeZone) | |
formatMask | string | No | data type=string; maxLen=255Applies when dataType = number | |
group | boolean | Yes | false | data type=booleanApplies when type supports SUPPORTS_GROUPS and dataType in (varchar2) and type in (databaseColumn)type supports SUPPORTS_GROUPS and dataType in (varchar2) and type in (sqlExpression)type supports SUPPORTS_GROUPS and dataType in (number) and type in (databaseColumn)type supports SUPPORTS_GROUPS and dataType in (number) and type in (sqlExpression)type supports SUPPORTS_GROUPS and dataType in (date) and type in (databaseColumn)type supports SUPPORTS_GROUPS and dataType in (date) and type in (sqlExpression)type supports SUPPORTS_GROUPS and dataType in (timestamp) and type in (databaseColumn)type supports SUPPORTS_GROUPS and dataType in (timestamp) and type in (sqlExpression)type supports SUPPORTS_GROUPS and dataType in (timestampWithTimeZone) and type in (databaseColumn)type supports SUPPORTS_GROUPS and dataType in (timestampWithTimeZone) and type in (sqlExpression)type supports SUPPORTS_GROUPS and dataType in (timestampWithLocalTimeZone) and type in (databaseColumn)type supports SUPPORTS_GROUPS and dataType in (timestampWithLocalTimeZone) and type in (sqlExpression)type supports SUPPORTS_GROUPS and dataType in (intervalYearToMonth) and type in (databaseColumn)type supports SUPPORTS_GROUPS and dataType in (intervalYearToMonth) and type in (sqlExpression) |
appearance {
formatMask: value
group: false
}serverSideCondition
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
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) |
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=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
column sample (
name: value
layout {
sequence: 42
}
source {
type: databaseColumn
databaseColumn: value
sqlExpression: ```sql
value
```
dataType: varchar2
primaryKey: false
availableOnClient: false
valueProtected: false
}
lov {
type: sharedComponent
lov: @component
sqlQuery: ```sql
value
```
staticValues: ```
value
```
language: plsql
plsqlFunctionBody: ```plsql
value
```
javaScriptFunctionBody: ```javascript-mle
value
```
displayExtraValues: false
}
accessibility {
valueIdentifiesRow: false
}
appearance {
formatMask: value
group: false
}
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
}
comments {
comments: ```
value
```
}
)