customAttribute

Parent: plugin

Children: entry

Direct Properties:

PropertyTypeRequiredDefault ValueDetails
staticIdstringYesdata type=string; maxLen=255

Specify the Static ID for this attribute. For Template Components can be referenced in the template using the #STATIC_ID# syntax and for other Plug-in types can be referenced in the code via p_xxxx.attributes.get_varchar2( 'my_static_id' ).

apexlangNamestringYesdata type=string; maxLen=40
attributeintegerYesdata type=integer; maxLen=32767
namestringYesdata type=string; maxLen=255
Specify the label which is displayed for that attribute in the Oracle APEX Builder.
scopeenumYescomponentdata type=string; lov=STATIC
Valid values: app component report reportGroup regionColumn
typeenumYestextdata type=string; lov=STATIC
Valid values: authorizationGroup checkboxes codeLanguage color column component credential dataLoadDefinitionId dataLoadTableId emailTemplate html icon integer javaScript-mle javaScript-mleExpressionReturningBoolean javaScript-mleExpressionReturningVarchar2 javaScript-mleFunctionBodyReturningBoolean javaScript-mleFunctionBodyReturningVarchar2 javaScriptCode linkToTargetPageUrl mapBackground media number owner plsqlCode plsqlExpressionReturningBoolean plsqlExpressionReturningVarchar2 plsqlFunctionBodyReturningBoolean plsqlFunctionBodyReturningVarchar2 plsqlPackage plsqlProcedureOrFunction pageItem pageItems pageNumber pageNumbers regionSqlQueryColumn reportQuery sqlQuery selectList sessionStateValue table taskDefinition templatePlaceholders text textarea workflowDefinition xml yesNo restSource restOperation

Property Groups:

  • componentLov
  • validation
  • security
  • appearance
  • builder
  • templateSupport
  • accessibility
  • default
  • supports
  • dependingOn
  • help
  • examples
  • advanced
  • comments
componentLov
PropertyTypeRequiredDefault ValueDetails
typeenumYesstaticdata type=string; lov=STATIC
Valid values: static component
Applies whentype in (selectList)type in (checkboxes)
componentTypeenumNodata type=string; lov=STATIC
Valid values: credential remoteDatabase authenticationServer printServer restServer staticWorkspaceFile appGroup fileServer genAI vectorProvider app theme themeStyle themeFile templateOptionGroup globalTemplateOption pageTemplate pageTemplateOption pageTemplateDisplayPoint fieldTemplate fieldTemplateOption buttonTemplate buttonTemplateOption regionTemplate regionTemplateOption regionTemplateDisplayPoint listTemplate listTemplateOption breadcrumbTemplate breadcrumbTemplateOption calendarTemplate reportTemplate reportTemplateOption popupLovTemplate plugin pluginStdAttribute pluginAttributeGroup pluginCustomAttribute pluginAttributeLovEntry pluginActionTemplate pluginActionPosition pluginEvent pluginFile pluginSlot pluginSetting appItem appComputation appProcess buildOption authentication authorization aclRole webSrcModule webSrcOperation webSrcModuleParam webSrcModuleDataProfile webSrcModuleDataProfileColumn webSrcSyncStep webSrcSyncStepWsParam shortcut appSubstitution staticAppFile textMessage appSetting pwaShortcut pwaScreenshot dualityViewSource jsonDocumentSource dualityViewDataProfile dualityViewDataProfileColumn jsonCollectionDataProfile jsonCollectionDataProfileColumn aiAgent aiAgentTool aiAgentToolParam classicNavBar breadcrumb breadcrumbEntry list listEntry lov lovWsParam lovEntry lovColumn webServiceReference webServiceReferenceOperation webServiceRefOperParamI webServiceRefOperParamO webServiceRefOperParamA webServiceRefOperParamH dataLoadTable dataLoadRule dataLoadLookup tabSet reportLayout reportQuery reportQueryStatement reportQueryStmtWsParam automation automationWsParam automationAction emailTemplate dataLoadDefinition dataLoadDefDataProfile dataLoadDefDataProfileColumn taskDef taskDefParam taskDefAction taskDefParticipant languageMap dynamicTranslation concatenatedFile searchConfig searchConfigWsParam pageGroup tree developerComment supportObjects supportObjectsSubstitution supportObjectsBuildOption supportObjectsValidation supportObjectsInstall supportObjectsInstallObject supportObjectsUpgrade page region pageItem button dynamicActionEvent dynamicActionAction pageMetaTag validation pageComputation pageProcess pageProcessWsParam branch regionPluginAttributes irAttributes irColumnGroup irColumn irPrintAttr irSavedReport irSavedReportColumn irSavedReportCompute irSavedReportSort irSavedReportAggregate irSavedReportFilter irSavedReportCtrlBreak irSavedReportHighlight irSavedReportChart irSavedReportGroupBy irSavedReportGroupByCol irSavedReportGroupByAgg irSavedReportGroupBySort irSavedReportPivot irSavedReportPivotCol irSavedReportPivotRow irSavedReportPivotAgg irSavedReportPivotSort pageProcessWsParamIn pageProcessWsParamOut pageProcessWsParamAuth pageProcessInvokeApiParam classicReport classicReportColumn classicReportPrintAttr tabularForm tabularFormColumn tabularFormPrintAttr classicCalendar regionColumn regionTmplColumn jetChart jetChartSeries jetChartAxes jetChartWsParam igAttributes igColumnGroup igColumn igPrintAttr igSavedReport igSavedReportColumn igSavedReportFilter igSavedReportSort igSavedReportAggregate igSavedReportCtrlBreak igSavedReportHighlight igSavedReportChart regionWsParam facet facetGroup facetGroupItem sfilter sfilterGroup sfilterGroupItem card cardAction mapRegion mapLayer mapLayerWsParam mapBackground pageProcessTaskParam searchRegionSources regionAction irColumnAction regionActionMenuEntry irColumnActionMenuEntry buttonMenuEntry regionActionMenuEntryAction regionActionButtonAction pageButtonAction cardButtonAction buttonActionMenuEntryAction irActionButtonAction irActionMenuEntryAction workflow workflowParam workflowVersion workflowActivity workflowVariable workflowActivityVariable workflowParticipant workflowTransition workflowBranch workflowParallelBranch pageProcessWfParam wfActivityTaskParam wfActivityInvokeApiParam wfActivityWsParam wfActivityWfParam componentGroup compGrpComponent
Applies whentype = component
onDeleteBehaviorenumNodata type=string; lov=STATIC
Valid values: cascade setToNull
Applies whentype = component and componentType is set
nullTextstringNodata type=string; maxLen=255
Applies whentype in (selectList) and required = falsetype in (component) and required = false
 
componentLov {
  type: static
  componentType: credential
  onDeleteBehavior: cascade
  nullText: value
}
validation
PropertyTypeRequiredDefault ValueDetails
requiredbooleanYesfalsedata type=boolean
maxLengthnumberNodata type=number; maxLen=5
Applies whentype in (text)type in (textarea)type in (number)type in (integer)
minColumnsnumberNodata type=number; maxLen=3
Applies whentype = sqlQuery
maxColumnsnumberNodata type=number; maxLen=3
Applies whentype = sqlQuery
textCaseenumNodata type=string; lov=STATIC
Valid values: uppercase lowercase
Applies whentype in (text)type in (textarea)
 
validation {
  required: false
  maxLength: 42
  minColumns: 42
  maxColumns: 42
  textCase: uppercase
}
security
PropertyTypeRequiredDefault ValueDetails
escapeModeenumYeshtmldata type=string; lov=STATIC
Valid values: html htmlAttribute stripHtml raw
Applies whentype = templateComponent
 
security {
  escapeMode: html
}
appearance
PropertyTypeRequiredDefault ValueDetails
attributeGroupreferenceNodata type=reference; lov=COMPONENT; references=attributeGroup
Applies whentype in (templateComponent)type in (dynamicAction)type in (item)type in (region)type in (process)type in (genAITool)
sequencenumberYesdata type=number; maxLen=22

Specify the display sequence for this plug-in attribute in the Oracle APEX Builder.

 
appearance {
  attributeGroup: @component
  sequence: 42
}
builder
PropertyTypeRequiredDefault ValueDetails
commonbooleanYestruedata type=boolean
showInWizardbooleanYestruedata type=boolean
unitstringNodata type=string; maxLen=30
Applies whentype in (text)type in (number)type in (integer)
translatablebooleanYesfalsedata type=boolean
Applies whentype in (text)type in (textarea)type in (html)type in (xml)
includeColumnsInItemsPickerbooleanYesCOMPONENTdata type=boolean
Applies whentype in (region) and type in (text)type in (region) and type in (textarea)type in (region) and type in (html)type in (region) and type in (xml)type in (region) and type in (sqlQuery)type in (region) and type in (plsqlCode)type in (region) and type in (plsqlExpressionReturningVarchar2)type in (region) and type in (plsqlExpressionReturningBoolean)type in (region) and type in (plsqlFunctionBodyReturningVarchar2)type in (region) and type in (plsqlFunctionBodyReturningBoolean)type in (region) and type in (javaScriptCode)type in (region) and type in (pageItem)type in (region) and type in (pageItems)type in (region) and type in (linkToTargetPageUrl)type in (process) and type in (text)type in (process) and type in (textarea)type in (process) and type in (html)type in (process) and type in (xml)type in (process) and type in (sqlQuery)type in (process) and type in (plsqlCode)type in (process) and type in (plsqlExpressionReturningVarchar2)type in (process) and type in (plsqlExpressionReturningBoolean)type in (process) and type in (plsqlFunctionBodyReturningVarchar2)type in (process) and type in (plsqlFunctionBodyReturningBoolean)type in (process) and type in (javaScriptCode)type in (process) and type in (pageItem)type in (process) and type in (pageItems)type in (process) and type in (linkToTargetPageUrl)
displayWidthnumberNodata type=number; maxLen=4
Applies whentype in (text)type in (textarea)type in (number)type in (integer)
 
builder {
  common: false
  showInWizard: false
  unit: value
  translatable: false
  includeColumnsInItemsPicker: false
  displayWidth: 42
}
templateSupport
PropertyTypeRequiredDefault ValueDetails
typeenumNodata type=string; lov=STATIC
Valid values: substitutions templateDirectivesClient templateDirectivesServer
customSubstitutionsarray of stringsNodata type=string; maxLen=32767
Applies whentype in (templateDirectivesClient) and type in (html)type in (templateDirectivesClient) and type in (textarea)type in (templateDirectivesServer) and type in (html)type in (templateDirectivesServer) and type in (textarea)
 
templateSupport {
  type: substitutions
  customSubstitutions: [
    value
    value
  ]
}
accessibility
PropertyTypeRequiredDefault ValueDetails
importantForAccessibilitybooleanYesfalsedata type=boolean
helpTextmultiline stringNodata type=multiline string; maxLen=4000
Applies whenimportantForAccessibility = true
 
accessibility {
  importantForAccessibility: false
  helpText: ```
    value
  ```
}
default
PropertyTypeRequiredDefault ValueDetails
valuebooleanYesfalsedata type=boolean
Applies whentype = yesNo
valuemultiline stringNodata type=multiline string; maxLen=4000
sampleDataValuemultiline stringNodata type=multiline string; maxLen=4000
Applies whentype in (templateComponent)type in (region)
 
default {
  value: false
  sampleDataValue: ```
    value
  ```
}
supports
PropertyTypeRequiredDefault ValueDetails
componentsarray of enumsNodata type=string; lov=STATIC
Valid values: pageItems interactiveGridColumns facets facetGroupItems filters filterGroupItems
Applies whentype = item
componentsarray of enumsNodata type=string; lov=STATIC
Valid values: pageProcesses automationActions taskDefinitionActions workflowActivities
Applies whentype = process
dataTypesarray of enumsYesvarchar2data type=string; lov=STATIC
Valid values: varchar2 number date timestamp timestampWithTimeZone timestampWithLocalTimeZone intervalYearToMonth intervalDayToSecond blob clob bfile rowid
Applies whentype in (regionSqlQueryColumn)type in (column)type in (sessionStateValue)
 
supports {
  components: [
    pageItems
    interactiveGridColumns
  ]
  dataTypes: [
    varchar2
    number
  ]
}
dependingOn
PropertyTypeRequiredDefault ValueDetails
attributereferenceNodata type=reference; lov=COMPONENT; references=customAttribute
conditionTypeenumYesdata type=string; lov=STATIC
Valid values: = != inList notInList isNull isNotNull
Applies whenattribute is set
valuestringYesdata type=string; maxLen=4000
Applies whenattribute is set and conditionType in (=)attribute is set and conditionType in (!=)
listarray of stringsYesdata type=string; maxLen=4000
Applies whenattribute is set and conditionType in (inList)attribute is set and conditionType in (notInList)
alwaysEvaluatebooleanYestruedata type=boolean
Applies whenattribute is set
parentAttributereferenceNodata type=reference; lov=COMPONENT; references=customAttribute
Applies whentype in (table)type in (column)type in (plsqlPackage)type in (plsqlProcedureOrFunction)type in (restOperation)
 
dependingOn {
  attribute: @component
  conditionType: "="
  value: value
  list: [
    value
    value
  ]
  alwaysEvaluate: false
  parentAttribute: @component
}
help
PropertyTypeRequiredDefault ValueDetails
helpTextmultiline stringNodata type=multiline string; maxLen=4000
 
help {
  helpText: ```
    value
  ```
}
examples
PropertyTypeRequiredDefault ValueDetails
examplesmultiline stringNodata type=multiline string; maxLen=4000
 
examples {
  examples: ```
    value
  ```
}
advanced
PropertyTypeRequiredDefault ValueDetails
showDeprecatedAttributeForValuesarray of stringsNodata type=string; maxLen=30
 
advanced {
  showDeprecatedAttributeForValues: [
    value
    value
  ]
}
comments
PropertyTypeRequiredDefault ValueDetails
commentsmultiline stringNodata type=multiline string; maxLen=4000
 
comments {
  comments: ```
    value
  ```
}

APEXlang Example

customAttribute sample (
    staticId: value
    apexlangName: value
    attribute: 42
    name: value
    scope: app
    type: authorizationGroup
    componentLov {
        type: static
        componentType: credential
        onDeleteBehavior: cascade
        nullText: value
    }
    validation {
        required: false
        maxLength: 42
        minColumns: 42
        maxColumns: 42
        textCase: uppercase
    }
    security {
        escapeMode: html
    }
    appearance {
        attributeGroup: @component
        sequence: 42
    }
    builder {
        common: false
        showInWizard: false
        unit: value
        translatable: false
        includeColumnsInItemsPicker: false
        displayWidth: 42
    }
    templateSupport {
        type: substitutions
        customSubstitutions: [
          value
          value
        ]
    }
    accessibility {
        importantForAccessibility: false
        helpText: ```
          value
        ```
    }
    default {
        value: false
        sampleDataValue: ```
          value
        ```
    }
    supports {
        components: [
          pageItems
          interactiveGridColumns
        ]
        dataTypes: [
          varchar2
          number
        ]
    }
    dependingOn {
        attribute: @component
        conditionType: "="
        value: value
        list: [
          value
          value
        ]
        alwaysEvaluate: false
        parentAttribute: @component
    }
    help {
        helpText: ```
          value
        ```
    }
    examples {
        examples: ```
          value
        ```
    }
    advanced {
        showDeprecatedAttributeForValues: [
          value
          value
        ]
    }
    comments {
        comments: ```
          value
        ```
    }
)