column
Applies when
type = classicReport| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
columnName | string | Yes | data type=string; maxLen=128 | |
reportColumnQueryId | string | No | data type=string; maxLen=4 | |
derivedColumn | string | No | data type=string; maxLen=4 | |
type | enum | Yes | plainText | data type=string; lov=STATICValid values: plainText plainTextBasedOnLov richText link displayImage downloadBlob percentGraph hidden displayAsTextSavesState datePickerClassic datePicker textField textArea selectList radioGroup hiddenField popupLov popupKeyLov simpleCheckbox rowSelector |
heading
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
heading | string | No | data type=string; maxLen=4000 | |
alignment | enum | Yes | start | data type=string; lov=STATICValid values: start center end |
heading {
heading: value
alignment: start
}lov
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
type | enum | Yes | data type=string; lov=STATICValid values: sharedComponent sqlQuery staticValues functionBodyApplies when type in (plainTextBasedOnLov)type in (selectList)type in (radioGroup)type in (popupLov)type in (popupKeyLov) | |
lov | reference | Yes | data type=reference; lov=COMPONENT; references=lovApplies when type in (plainTextBasedOnLov) and type = sharedComponenttype in (selectList) and type = sharedComponenttype in (radioGroup) and type = sharedComponenttype in (popupLov) and type = sharedComponenttype in (popupKeyLov) and type = sharedComponent | |
sqlQuery | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type in (plainTextBasedOnLov) and type = sqlQuerytype in (selectList) and type = sqlQuerytype in (radioGroup) and type = sqlQuerytype in (popupLov) and type = sqlQuerytype in (popupKeyLov) and type = sqlQuery | |
staticValues | multiline string | Yes | STATIC:Display1;Return1,Display2;Return2 | data type=multiline string; maxLen=4000Applies when type in (plainTextBasedOnLov) and type = staticValuestype in (selectList) and type = staticValuestype in (radioGroup) and type = staticValuestype in (popupLov) and type = staticValuestype in (popupKeyLov) and type = staticValues |
language | enum | Yes | plsql | data type=string; lov=STATICValid values: plsql javaScript-mleApplies when type in (plainTextBasedOnLov) and type = functionBodytype in (selectList) and type = functionBodytype in (radioGroup) and type = functionBodytype in (popupLov) and type = functionBodytype in (popupKeyLov) and type = functionBody |
plsqlFunctionBody | multiline string | Yes | data type=multiline string; maxLen=32767Applies when type in (plainTextBasedOnLov) and type = functionBody and language = plsqltype in (selectList) and type = functionBody and language = plsqltype in (radioGroup) and type = functionBody and language = plsqltype in (popupLov) and type = functionBody and language = plsqltype in (popupKeyLov) and type = functionBody and language = plsql | |
javaScriptFunctionBody | multiline string | Yes | data type=multiline string; maxLen=32767Applies when type in (plainTextBasedOnLov) and type = functionBody and language = javaScript-mletype in (selectList) and type = functionBody and language = javaScript-mletype in (radioGroup) and type = functionBody and language = javaScript-mletype in (popupLov) and type = functionBody and language = javaScript-mletype in (popupKeyLov) and type = functionBody and language = javaScript-mle | |
checkboxValues | string | Yes | data type=string; maxLen=32767Applies when type = simpleCheckbox | |
displayExtraValues | boolean | Yes | true | data type=booleanApplies when type in (selectList)type in (radioGroup) |
displayNullValue | boolean | Yes | true | data type=booleanApplies when type in (selectList)type in (radioGroup)type in (popupLov)type in (popupKeyLov) |
nullDisplayValue | string | No | data type=string; maxLen=255Applies when type in (selectList) and displayNullValue = truetype in (radioGroup) and displayNullValue = truetype in (popupLov) and displayNullValue = truetype in (popupKeyLov) and displayNullValue = true | |
nullReturnValue | string | No | data type=string; maxLen=255Applies when type in (selectList) and displayNullValue = truetype in (radioGroup) and displayNullValue = truetype in (popupLov) and displayNullValue = truetype in (popupKeyLov) and displayNullValue = true |
lov {
type: sharedComponent
lov: @component
sqlQuery: ```sql
value
```
staticValues: ```
value
```
language: plsql
plsqlFunctionBody: ```plsql
value
```
javaScriptFunctionBody: ```javascript-mle
value
```
checkboxValues: value
displayExtraValues: false
displayNullValue: false
nullDisplayValue: value
nullReturnValue: value
}layout
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
sequence | number | Yes | data type=number; maxLen=22 | |
columnAlignment | enum | Yes | start | data type=string; lov=STATICValid values: start center end |
layout {
sequence: 42
columnAlignment: start
}accessibility
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
valueIdentifiesRow | boolean | Yes | false | data type=boolean |
imageDescription | string | No | data type=string; maxLen=255Applies when type = displayImage |
accessibility {
valueIdentifiesRow: false
imageDescription: value
}appearance
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
formatMask | string | No | data type=string; maxLen=255Applies when type in (plainText)type in (link)type in (displayAsTextSavesState)type in (textField)type in (datePicker)Enter the format mask to apply to this column. You can type in the format mask or pick from the predefined list, based on a sample representation of how that format mask is displayed. It is important that number format masks are only applied to columns that contain numbers and date format masks are only applied to columns that contain dates. Otherwise, a runtime error is raised when any record contains a value that can not be converted using the specified format mask. | |
formatMask | enum | Yes | data type=string; lov=STATICValid values: useAppDateFormat useAppFormatMask useItemFormatMask ddMmYyyy ddMmYyyyHhMi ddMmYyyyHh24Mi ddMonRr ddMonRrHhMi ddMonRrHh24Mi ddMonYyyy ddMonYyyyHhMi ddMonYyyyHh24Mi mmDdYyyy mmDdYyyyHhMi mmDdYyyyHh24Mi rrMonDd rrMonDdHhMi rrMonDdHh24Mi yyyyDdMm yyyyDdMmHhMi yyyyDdMmHh24Mi yyyyMmDd yyyyMmDdHhMi yyyyMmDdHh24MiApplies when type = datePickerClassic | |
backgroundColor | string | No | data type=string; maxLen=255Applies when type = percentGraph | |
foregroundColor | string | No | data type=string; maxLen=255Applies when type = percentGraph | |
barWidth | integer | No | data type=integer; maxLen=32767Applies when type = percentGraph | |
width | number | No | data type=number; maxLen=22Applies when type in (textField)type in (textArea)type in (datePickerClassic)type in (datePicker)type in (popupLov)type in (popupKeyLov) | |
height | number | No | data type=number; maxLen=22Applies when type = textArea | |
viewFileAs | enum | Yes | attachment | data type=string; lov=STATICValid values: attachment inlineApplies when type = downloadBlob |
template | reference | No | data type=reference; lov=COMPONENT; references=fieldTemplateApplies when type in (displayAsTextSavesState)type in (textField)type in (textArea)type in (datePickerClassic)type in (datePicker)type in (hiddenField)type in (selectList)type in (radioGroup)type in (popupLov)type in (popupKeyLov)type in (simpleCheckbox)Choose the field template to be used when rendering the tabular form field. When no template is selected, the field is rendered using the default accessibility compliant label. | |
downloadText | string | No | data type=string; maxLen=255Applies when type = downloadBlob |
appearance {
formatMask: useAppDateFormat
backgroundColor: value
foregroundColor: value
barWidth: 42
width: 42
height: 42
viewFileAs: attachment
template: @component
downloadText: value
}settings
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
format | enum | Yes | markdown | data type=string; lov=STATICValid values: html markdownApplies when type = richText |
settings {
format: html
}blobAttributes
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
tableOwner | string | No | data type=string; maxLen=32767Applies when type in (displayImage)type in (downloadBlob) | |
tableName | string | Yes | data type=string; maxLen=32767Applies when type in (displayImage)type in (downloadBlob) | |
blobColumn | string | Yes | data type=string; maxLen=32767Applies when type in (displayImage)type in (downloadBlob) | |
primaryKeyColumn1 | string | Yes | data type=string; maxLen=32767Applies when type in (displayImage)type in (downloadBlob) | |
primaryKeyColumn2 | string | No | data type=string; maxLen=32767Applies when type in (displayImage)type in (downloadBlob) | |
mimeTypeColumn | string | No | data type=string; maxLen=32767Applies when type in (displayImage)type in (downloadBlob) | |
filenameColumn | string | No | data type=string; maxLen=32767Applies when type in (displayImage)type in (downloadBlob) | |
lastUpdatedColumn | string | No | data type=string; maxLen=32767Applies when type in (displayImage)type in (downloadBlob) | |
charSetColumn | string | No | data type=string; maxLen=32767Applies when type = downloadBlob |
blobAttributes {
tableOwner: value
tableName: value
blobColumn: value
primaryKeyColumn1: value
primaryKeyColumn2: value
mimeTypeColumn: value
filenameColumn: value
lastUpdatedColumn: value
charSetColumn: value
}link
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
target | complex | No | data type=complex; maxLen=32767Applies when type in (link)type in (percentGraph) | |
linkText | string | Yes | data type=string; maxLen=4000Applies when type in (link) and target is settype in (percentGraph) and target is set | |
linkAttributes | string | No | data type=string; maxLen=4000Applies when type in (link) and target is settype in (percentGraph) and target is set |
link {
target: {
type: in_app
url: value
app: value
page: value
items: [
value
value
]
clearCache: value
action: value
request: value
anchor: value
session: "&SESSION."
debug: "&DEBUG."
printerFriendly: N
otherArgs: value
}
linkText: value
linkAttributes: value
}element
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
numberOfColumns | integer | No | data type=integer; maxLen=32767Applies when type = radioGroup |
element {
numberOfColumns: 42
}columnFormatting
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
htmlExpression | multiline string | No | data type=multiline string; maxLen=4000Applies when type = plainText | |
cssClasses | array of strings | No | data type=string; maxLen=255Applies when type in (plainText)type in (link)type in (percentGraph) | |
cssStyle | array of strings | No | data type=string; maxLen=255Applies when type in (plainText)type in (link)type in (percentGraph) | |
highlightWords | string | No | data type=string; maxLen=255Applies when type = plainText |
columnFormatting {
htmlExpression: ```html
value
```
cssClasses: [
value
value
]
cssStyle: [
value
value
]
highlightWords: value
}sorting
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
defaultSequence | enum | No | data type=string; lov=STATICValid values: 1 2 3 4 5 6 7 8 | |
direction | enum | No | data type=string; lov=STATICValid values: descApplies when defaultSequence is set | |
sortable | boolean | Yes | false | data type=boolean |
sorting {
defaultSequence: "1"
direction: desc
sortable: false
}exportPrinting
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
includeInExportPrint | boolean | Yes | true | data type=boolean |
printWidth | string | No | data type=string; maxLen=4000Applies when includeInExportPrint = true |
exportPrinting {
includeInExportPrint: false
printWidth: value
}advanced
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
cssClasses | array of strings | No | data type=string; maxLen=255Applies when type in (textField)type in (textArea)type in (datePickerClassic)type in (datePicker)type in (hiddenField)type in (selectList)type in (radioGroup)type in (popupLov)type in (popupKeyLov)type in (simpleCheckbox) | |
customAttributes | string | No | data type=string; maxLen=2000Applies when type in (textField)type in (textArea)type in (datePickerClassic)type in (datePicker)type in (hiddenField)type in (selectList)type in (radioGroup)type in (popupLov)type in (popupKeyLov)type in (simpleCheckbox) | |
cellWidth | integer | No | data type=integer; maxLen=32767 | |
computeSum | boolean | Yes | false | data type=boolean |
advanced {
cssClasses: [
value
value
]
customAttributes: value
cellWidth: 42
computeSum: 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 | |
escapeSpecialChars | boolean | Yes | true | data type=booleanApplies when type in (plainText)type in (link)type in (hidden)type in (plainTextBasedOnLov) |
security {
authorizationScheme: mustNotBePublicUser
escapeSpecialChars: false
}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 (
columnName: value
reportColumnQueryId: value
derivedColumn: value
type: plainText
heading {
heading: value
alignment: start
}
lov {
type: sharedComponent
lov: @component
sqlQuery: ```sql
value
```
staticValues: ```
value
```
language: plsql
plsqlFunctionBody: ```plsql
value
```
javaScriptFunctionBody: ```javascript-mle
value
```
checkboxValues: value
displayExtraValues: false
displayNullValue: false
nullDisplayValue: value
nullReturnValue: value
}
layout {
sequence: 42
columnAlignment: start
}
accessibility {
valueIdentifiesRow: false
imageDescription: value
}
appearance {
formatMask: useAppDateFormat
backgroundColor: value
foregroundColor: value
barWidth: 42
width: 42
height: 42
viewFileAs: attachment
template: @component
downloadText: value
}
settings {
format: html
}
blobAttributes {
tableOwner: value
tableName: value
blobColumn: value
primaryKeyColumn1: value
primaryKeyColumn2: value
mimeTypeColumn: value
filenameColumn: value
lastUpdatedColumn: value
charSetColumn: value
}
link {
target: {
type: in_app
url: value
app: value
page: value
items: [
value
value
]
clearCache: value
action: value
request: value
anchor: value
session: "&SESSION."
debug: "&DEBUG."
printerFriendly: N
otherArgs: value
}
linkText: value
linkAttributes: value
}
element {
numberOfColumns: 42
}
columnFormatting {
htmlExpression: ```html
value
```
cssClasses: [
value
value
]
cssStyle: [
value
value
]
highlightWords: value
}
sorting {
defaultSequence: "1"
direction: desc
sortable: false
}
exportPrinting {
includeInExportPrint: false
printWidth: value
}
advanced {
cssClasses: [
value
value
]
customAttributes: value
cellWidth: 42
computeSum: 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
escapeSpecialChars: false
}
config {
buildOption: @component
}
comments {
comments: ```
value
```
}
)