APEXlang API Reference

https://docs.oracle.com/en/database/oracle/apex/26.1/apxln/
Admin
APEXlang is a language used within Oracle APEX for defining application components, properties, and...
Tokens:275,358
Snippets:3,067
Trust Score:9.1
Update:3 months ago
Show doc for...
Tokens:
Raw
### Full Install Script Definition in APEXlang

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

A comprehensive example of an install script definition in APEXlang, including its name, execution sequence, script type and content, and detailed server-side conditions.

```apexlang
installScript "example" (
  name: exampleName
  execution {
    sequence: 42
  }
  script {
    type: packageSpec
    content: ```
    value
    ```
  }
  serverSideCondition {
    type: always
    sqlQuery: ```
    select empno, ename, job, sal
      from emp
     where deptno = :P1_DEPTNO
    ```
    language: sql
    sqlExpression: ```
    upper(:P1_SEARCH)
    ```
    plsqlExpression: ```
    :CARD_LINK is not null
    ```
    javaScriptExpression: ```
    apex.message.alert( "Load complete." );
    ```
    plsqlFunctionBody: ```
    return 'Generated text';
    ```
    javaScriptFunctionBody: ```
    return 'Generated text';
    ```
  }
)
```

--------------------------------

### Examples Configuration

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

Includes example usage or values for an attribute. Supports multiline strings up to 4000 characters.

```APEXlang
examples {
  examples: """
    Lorem ipsum dolor sit amet.
    """
}
```

--------------------------------

### Parameter Configuration Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

Defines a parameter with input direction and VARCHAR2 data type. This is a basic setup for an input parameter.

```json
parameter {
  direction: in
  dataType: varchar2
  dataTypeName: value
  hasDefault: false
  ignoreOutput: false
}
```

--------------------------------

### APEXlang Parameter Definition

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

Define a parameter named 'example' using APEXlang syntax, including its associated value configuration. This demonstrates a comprehensive parameter setup.

```apexlang
parameter "example" (
  name: @component
  parameter {
    ignoreOutput: false
  }
  value {
    type: staticValue
    staticValue: """
    Lorem ipsum dolor sit amet.
    """
    sqlQuery: """
    select empno, ename, job, sal
      from emp
     where deptno = :P1_DEPTNO
    """
    item: value
    language: sql
    sqlExpression: """
    upper(:P1_SEARCH)
    """
    plsqlExpression: """
    :CARD_LINK is not null
    """
    javaScriptExpression: """
    apex.message.alert( "Load complete." );
    """
    plsqlFunctionBody: """
    return 'Generated text';
    """
    javaScriptFunctionBody: """
    return 'Generated text';
    """
    formatMask: value
    trueValue: value
    falseValue: value
  }
)
```

--------------------------------

### Full APEXlang example for actionPosition

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

A complete APEXlang example demonstrating the structure and properties of an actionPosition component.

```apexlang
actionPosition "example" (
  name: exampleName
  apexlangName: value
  staticId: value
  sequence: 42
  position {
    type: link
    predefinedTemplate: value
  }
  help {
    helpText: ```
    Lorem ipsum dolor sit amet.
    ```
  }
  advanced {
    quickPick: false
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)
```

--------------------------------

### Full APEXlang Template Option Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

A comprehensive example demonstrating the structure of a template option in APEXlang, including all possible properties.

```apexlang
templateOption "example" (
  name: exampleName
  group: value
  sequence: 42
  appearance {
    cssClasses: [
		value1
		value2
	]
  }
  help {
    helpText: """
    Lorem ipsum dolor sit amet.
    """
  }
  advanced {
    isAdvancedOption: false
    staticId: value
    identifier: unique-id
  }
  subscription {
    master: value
  }
)
```

--------------------------------

### Configure installation substitution

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

Configure substitution settings for installation, including whether to prompt the user and the installation prompt text. This is applied when `substitution.promptSubstitution` is true.

```APEXlang
installation {
  promptSubstitution: false
  installationPrompt: value
}
```

```APEXlang
substitution "example" (
  name: exampleName
  installation {
    promptSubstitution: false
    installationPrompt: value
  }
)
```

--------------------------------

### Full APEXlang List Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

A comprehensive example demonstrating the structure and properties of an APEXlang list component.

```apexlang
list "example" (
  name: exampleName
  source {
    type: staticValues
    sqlQuery: ```
    select empno, ename, job, sal
      from emp
     where deptno = :P1_DEPTNO
    ```
    language: plsql
    plsqlFunctionBody: ```
    return 'Generated text';
    ```
    javaScriptFunctionBody: ```
    return 'Generated text';
    ```
  }
  advanced {
    staticId: value
  }
  config {
    buildOption: @component
  }
  subscription {
    master: value
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)
```

--------------------------------

### Define Examples for Plugin Attribute

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

The `examples` block is for providing example usage or values for an attribute. The `examples` property accepts a multiline string up to 4000 characters.

```apexlang
examples {
  examples: ```
    Lorem ipsum dolor sit amet.
    ```
}
```

--------------------------------

### Full APEXlang example for actionTemplate

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

A complete APEXlang example demonstrating the structure and properties of an actionTemplate component.

```apexlang
actionTemplate "example" (
  name: exampleName
  apexlangName: value
  type: button
  template {
    actionTemplate: ```
    Lorem ipsum dolor sit amet.
    ```
  }
  help {
    helpText: ```
    Lorem ipsum dolor sit amet.
    ```
  }
  advanced {
    translatable: false
    staticId: value
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)
```

--------------------------------

### Full APEXlang fileServer Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

A complete example demonstrating the configuration of a fileServer component with all its properties, including nested configurations for endpoint, authentication, advanced settings, and comments.

```apexlang
fileServer "example" (
  name: exampleName
  endpointUrl {
    url: value
  }
  authentication {
    credentials: @component
  }
  advanced {
    staticId: value
    promptOnInstall: false
    httpsHostName: value
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)
```

--------------------------------

### Full Build Option Example in APEXlang

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

A complete example of a build option definition in APEXlang, including status, advanced settings, subscription, and comments.

```apexlang
buildOption "example" (
  name: exampleName
  status {
    status: include
    defaultOnExport: exclude
    onUpgradeKeepStatus: false
  }
  advanced {
    staticId: value
    featureIdentifier: value
  }
  subscription {
    master: value
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)
```

--------------------------------

### Graph Search Configuration Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

Example of configuring a search on a graph. Includes `matchClause` and `columnsClause` for graph traversal and selection.

```sql
source {
  list: @component
  location: localDatabase
  type: GRAPH
  graphOwner: value
  graphName: value
  matchClause: ```
    Lorem ipsum dolor sit amet.
    ```
  columnsClause: ```
    Lorem ipsum dolor sit amet.
    ```
}
```

--------------------------------

### APEXlang Shortcut Full Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

A complete example of an APEXlang shortcut definition, demonstrating the integration of source, error, config, subscription, and comments properties.

```apexlang
shortcut "example" (
  staticId: value
  source {
    type: functionBody
    htmlCode: ```
    Lorem ipsum dolor sit amet.
    ```
    language: plsql
    plsqlFunctionBody: ```
    return 'Generated text';
    ```
    javaScriptFunctionBody: ```
    return 'Generated text';
    ```
    text: ```
    Lorem ipsum dolor sit amet.
    ```
    messageName: value
    imageUrl: value
  }
  error {
    errorMessage: ```
    Lorem ipsum dolor sit amet.
    ```
  }
  config {
    buildOption: @component
  }
  subscription {
    master: value
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)
```

--------------------------------

### Full aiAgent Configuration Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

A comprehensive example demonstrating the configuration of an aiAgent with all its property groups, including genAI, responseFormat, advanced, subscription, and comments.

```apex
aiAgent "example" (
  name: exampleName
  genAI {
    service: @component
    systemPrompt: ```
    Lorem ipsum dolor sit amet.
    ```
    welcomeMessage: ```
    Lorem ipsum dolor sit amet.
    ```
  }
  responseFormat {
    type: text
    jsonSchema: ```
    {
        "type": "object",
        "properties": {
            "status": { "type": "string" }
        }
    }
    ```
  }
  advanced {
    temperature: 42
    staticId: value
  }
  subscription {
    master: value
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)
```

--------------------------------

### Full APEXlang pwaShortcut Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

A complete example demonstrating the structure for defining a PWA shortcut in APEXlang. This includes direct properties and configuration blocks.

```apexlang
pwaShortcut "example" (
  name: exampleName
  sequence: 42
  shortcut {
    target: value
    iconUrl: fa-check
    description: ```
    Lorem ipsum dolor sit amet.
    ```
  }
  advanced {
    staticId: value
  }
  config {
    buildOption: @component
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)
```

--------------------------------

### Full APEXlang Region Template Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

A comprehensive example demonstrating the configuration of a region template in APEXlang, including all major property groups.

```apexlang
regionTemplate "example" (
  name: exampleName
  templateClass: borderlessRegion
  templateOptions {
    preset: [
		value1
		value2
	]
    default: [
		value1
		value2
	]
  }
  region {
    template: ```
    Lorem ipsum dolor sit amet.
    ```
    image: ```
    Lorem ipsum dolor sit amet.
    ```
    htmlTableAttributes: value
  }
  subRegions {
    template: ```
    Lorem ipsum dolor sit amet.
    ```
    header: ```
    Lorem ipsum dolor sit amet.
    ```
    headerEntry: ```
    Lorem ipsum dolor sit amet.
    ```
  }
  accessibility {
    landmarkType: banner
    regionTitleHtmlId: value
  }
  javaScript {
    fileUrls: [
		value1
		value2
	]
    executeWhenPageLoads: ```
    apex.message.alert( "Load complete." );
    ```
  }
  css {
    fileUrls: [
		value1
		value2
	]
  }
  advanced {
    staticId: value
    identifier: unique-id
    translatable: false
  }
  subscription {
    master: value
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)
```

--------------------------------

### Full Map Background Configuration Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

A comprehensive example demonstrating the configuration of a map background with various properties including advanced, subscription, and comments. Suitable for defining map layers in APEX applications.

```APEXlang
mapBackground "example" (
  name: exampleName
  type: raster
  url: value
  attribution: ```
    Lorem ipsum dolor sit amet.
    ```
  apiKey: staticValue
  staticValue: value
  webCredential: @component
  httpHeaders: ```
    Lorem ipsum dolor sit amet.
    ```
  advanced {
    staticId: value
    minZoomLevel: 1
    maxZoomLevel: 5
  }
  subscription {
    master: value
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)
```

--------------------------------

### Full APEXlang Example for Saved Report

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

A comprehensive example demonstrating the structure and properties of a saved report in APEXlang.

```APEXlang
savedReport "example" (
  visibility: primaryDefault
  name: exampleName
  staticId: value
  chart {
    type: bar
    label: label
    value: value
    valueAggregation: sum
  }
  axisTitle {
    label: label
    value: value
  }
  description {
    description: """
    Lorem ipsum dolor sit amet.
    """
  }
  settings {
    appUser: value
  }
  sort {
    by: default
  }
  view {
    chart: false
    groupBy: false
    pivot: false
    default: value
    rowsPerPage: value
  }
  chartAppearance {
    orientation: vertical
  }
  flashback {
    minutesAgo: 1
    enabled: false
  }
)
```

--------------------------------

### Full APEXlang example for attributeGroup

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

A complete APEXlang example demonstrating the structure and properties of an attributeGroup component.

```apexlang
attributeGroup "example" (
  name: exampleName
  apexlangName: value
  sequence: 42
  advanced {
    staticId: value
  }
)
```

--------------------------------

### Full APEXlang vectorProvider Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

A comprehensive example demonstrating the configuration of a vectorProvider with all its properties, including local embedding, GenAI service, endpoint URL, authentication, additional data, advanced settings, and comments.

```apexlang
vectorProvider "example" (
  name: exampleName
  type: databaseOnnxModel
  localEmbedding {
    owner: value
    modelName: value
    function: value
  }
  genAIService {
    provider: ociGenAI
    modelName: value
  }
  endpointUrl {
    url: value
  }
  authentication {
    credentials: @component
  }
  additionalData {
    httpHeaders: ```
    Lorem ipsum dolor sit amet.
    ```
    attributes: ```
    Lorem ipsum dolor sit amet.
    ```
  }
  advanced {
    maxTokens: 5
    serverTimeout: 42
    staticId: value
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)
```

--------------------------------

### Configure Supporting Object Installation Object Names

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

Specify the names of objects to be installed as part of the supporting object.

```apex
installation {
  objectNames: [
		value1
		value2
	]
}
```

--------------------------------

### Full APEXlang Entry Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

A comprehensive example of an APEXlang entry, including server-side conditions, security, configuration, and comments.

```apexlang
entry "example" (
  name: exampleName
  pageNumber: 42
  execution {
    sequence: 42
  }
  appearance {
    parentEntry: @component
    longName: value
  }
  link {
    target: value
  }
  advanced {
    staticId: value
  }
  serverSideCondition {
    type: always
    sqlQuery: ```
    select empno, ename, job, sal
      from emp
     where deptno = :P1_DEPTNO
    ```
    language: sql
    sqlExpression: ```
    upper(:P1_SEARCH)
    ```
    plsqlExpression: ```
    :CARD_LINK is not null
    ```
    javaScriptExpression: ```
    apex.message.alert( "Load complete." );
    ```
    plsqlFunctionBody: ```
    return 'Generated text';
    ```
    javaScriptFunctionBody: ```
    return 'Generated text';
    ```
    value: value
    item: value
    preference: value
    page: 42
    pages: [1, 2]
    text: text
    list: [
		value1
		value2
	]
  }
  security {
    authorizationScheme: @component
  }
  config {
    buildOption: @component
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)
```

--------------------------------

### Table Search Configuration Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

Example of configuring a simple table search. The `whereClause` is a multiline SQL string.

```sql
source {
  list: @component
  location: localDatabase
  type: TABLE
  tableOwner: value
  tableName: value
  whereClause: ```
    status = 'ACTIVE'
    ```
}
```

--------------------------------

### APEXlang Example for Parameter Configuration

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

An APEXlang example demonstrating the structure for defining a parameter with various value configurations, including static text, SQL queries, and expressions.

```apexlang
parameter "example" (
  name: @component
  parameter {
    ignoreOutput: false
  }
  value {
    type: staticValue
    staticValue: "```
    Lorem ipsum dolor sit amet.
    ```"
    sqlQuery: "```
    select empno, ename, job, sal
      from emp
     where deptno = :P1_DEPTNO
    ```"
    item: value
    language: sql
    sqlExpression: "```
    upper(:P1_SEARCH)
    ```"
    plsqlExpression: "```
    :CARD_LINK is not null
    ```"
    javaScriptExpression: "```
    apex.message.alert( "Load complete." );
    ```"
    plsqlFunctionBody: "```
    return 'Generated text';
    ```"
    javaScriptFunctionBody: "```
    return 'Generated text';
    ```"
    preference: value
    name: exampleName
    formatMask: value
    trueValue: value
    falseValue: value
    column: @component
  }
)
```

--------------------------------

### Full APEXlang Workflow Version Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

A comprehensive example demonstrating the structure of a workflow version definition in APEXlang, including all major configuration blocks.

```APEXlang
version "example" (
  workflowVersion: value
  settings {
    state: inDevelopment
  }
  additionalData {
    type: tableView
    tableOwner: value
    tableName: value
    sqlQuery: ```
    select empno, ename, job, sal
      from emp
     where deptno = :P1_DEPTNO
    ```
  }
  columnMapping {
    primaryKeyColumn: value
  }
  advanced {
    debugLevel: info
    diagram: value
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)
```

--------------------------------

### Full APEXlang Action Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

A comprehensive example demonstrating an APEXlang action with various configurations including GenAI, affected elements, execution, conditions, security, config, advanced settings, and comments.

```apexlang
action "example" (
  name: exampleName
  action: staticContent
  genAI {
    enabled: false
    agent: @component
    service: @component
    systemPrompt: ```
    Lorem ipsum dolor sit amet.
    ```
    welcomeMessage: ```
    Lorem ipsum dolor sit amet.
    ```
    itemsToSubmit: [
		value1
		value2
	]
  }
  affectedElements {
    selectionType: value
    region: @component
    columns: [
		value1
		value2
	]
    button: @component
    items: [
		value1
		value2
	]
    domObject: value
    jquerySelector: "select * from table_name"
    javaScriptExpression: ```
    apex.message.alert( "Load complete." );
    ```
  }
  execution {
    sequence: 42
    event: @component
    fireWhenEventResultIs: value
    fireOnInit: false
    stopExecutionOnError: false
    waitForResult: false
  }
  clientSideCondition {
    type: "item=value"
    item: value
    value: value
    list: [
		value1
		value2
	]
    javaScriptExpression: ```
    apex.message.alert( "Load complete." );
    ```
    componentType: item
    column: value
  }
  serverSideCondition {
    type: always
    sqlQuery: ```
    select empno, ename, job, sal
      from emp
     where deptno = :P1_DEPTNO
    ```
    language: sql
    sqlExpression: ```
    upper(:P1_SEARCH)
    ```
    plsqlExpression: ```
    :CARD_LINK is not null
    ```
    javaScriptExpression: ```
    apex.message.alert( "Load complete." );
    ```
    plsqlFunctionBody: ```
    return 'Generated text';
    ```
    javaScriptFunctionBody: ```
    return 'Generated text';
    ```
    value: value
    item: value
    preference: value
    page: 42
    pages: [1, 2]
    text: text
    list: [
		value1
		value2
	]
  }
  security {
    authorizationScheme: @component
  }
  config {
    buildOption: @component
  }
  advanced {
    staticId: value
    initJavaScriptFunction: ```
    apex.message.alert( "Load complete." );
    ```
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)
```

--------------------------------

### Full APEXlang reportLayout example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

A comprehensive example demonstrating the configuration of a report layout in APEXlang, including all major property groups.

```apexlang
reportLayout "example" (
  name: exampleName
  type: xslGeneric
  file {
    fileName: value
    mimeType: value
    content: value
  }
  dataLoop {
    name: exampleName
  }
  templates {
    page: ```
    value
    ```
    columnHeading: ```
    Lorem ipsum dolor sit amet.
    ```
    column: ```
    Lorem ipsum dolor sit amet.
    ```
    columnWidth: ```
    Lorem ipsum dolor sit amet.
    ```
  }
  advanced {
    staticId: value
  }
  subscription {
    master: value
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)
```

--------------------------------

### Full Workflow Definition Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

This is a comprehensive example demonstrating the structure for defining a workflow in APEXlang, including its name, title, advanced properties, and comments.

```apexlang
workflow "example" (
  name: exampleName
  title: "Page title"
  advanced {
    staticId: value
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)
```

--------------------------------

### Full APEXlang tableLookup Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

A comprehensive example demonstrating the complete configuration of a `tableLookup` component with all its property groups.

```APEXlang
tableLookup "example" (
  columnName: value
  source {
    tableOwner: value
    tableName: value
    whereClause: ```
    status = 'ACTIVE'
    ```
  }
  compareUploadWith {
    column: value
    column2: value
    column3: value
  }
  lookup {
    returnColumn: value
  }
  error {
    errorMessage: ```
    Lorem ipsum dolor sit amet.
    ```
  }
  advanced {
    insertNewValue: false
  }
)
```

--------------------------------

### Full APEXlang Plugin Attribute Configuration Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

This example demonstrates the complete structure of `standardAttributeConfig` in APEXlang, including all property groups.

```apexlang
standardAttributeConfig "example" (
  name: exampleName
  validation {
    required: false
  }
  sqlQuery {
    minColumns: 1
    maxColumns: 5
  }
  default {
    value: ```
    Lorem ipsum dolor sit amet.
    ```
  }
  help {
    helpText: ```
    Lorem ipsum dolor sit amet.
    ```
  }
  examples {
    examples: ```
    Lorem ipsum dolor sit amet.
    ```
  }
  dependingOn {
    attribute: value
    conditionType: "="
    value: value
    list: [
		value1
		value2
	]
    alwaysEvaluate: false
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)
```

--------------------------------

### Full APEXlang pwaScreenshot Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

A complete example demonstrating the structure for defining a PWA screenshot in APEXlang. This includes all possible configuration blocks.

```apexlang
pwaScreenshot "example" (
  label {
    label: label
  }
  layout {
    sequence: 42
  }
  screenshot {
    url: value
    sizes: value
    formFactor: narrow
  }
  advanced {
    staticId: value
  }
  config {
    buildOption: @component
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)
```

--------------------------------

### Full APEXlang Activity Variable Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

A comprehensive example demonstrating the configuration of an activity variable in APEXlang, including static ID, label, parameter, value, display masks, and comments.

```apexlang
activityVariable "example" (
  staticId: value
  label {
    label: label
  }
  parameter {
    dataType: varchar2
  }
  value {
    type: staticValue
    staticValue: ```
    Lorem ipsum dolor sit amet.
    ```
    item: value
    sqlQuery: ```
    select empno, ename, job, sal
      from emp
     where deptno = :P1_DEPTNO
    ```
    language: sql
    sqlExpression: ```
    upper(:P1_SEARCH)
    ```
    plsqlExpression: ```
    :CARD_LINK is not null
    ```
    javaScriptExpression: ```
    apex.message.alert( "Load complete." );
    ```
    plsqlFunctionBody: ```
    return 'Generated text';
    ```
    javaScriptFunctionBody: ```
    return 'Generated text';
    ```
  }
  displayFormatMasks {
    sessionStateFormatMask: value
    trueValue: value
    falseValue: value
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)
```

--------------------------------

### Configure Supporting Object Installation Messages

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

Set custom messages for the installation process, including welcome, confirmation, success, and failure messages.

```apex
installationMessages {
  welcome: ```
    Lorem ipsum dolor sit amet.
    ```
  confirmation: ```
    Lorem ipsum dolor sit amet.
    ```
  installSuccess: ```
    Lorem ipsum dolor sit amet.
    ```
  installFailure: ```
    Lorem ipsum dolor sit amet.
    ```
}
```

--------------------------------

### Full Branch Definition Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

An example demonstrating the complete structure of a branch definition in APEXlang, including name, label, advanced, and comments.

```APEXlang
branch "example" (
  name: exampleName
  label {
    label: label
  }
  advanced {
    staticId: value
    diagram: value
  }
  comments {
    comments: """
    Lorem ipsum dolor sit amet.
    """
  }
)
```

--------------------------------

### APEXlang Substitution Full Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

A complete example of an APEXlang substitution definition, showing how to assign a static value to a named substitution.

```apexlang
substitution "example" (
  name: exampleName
  value {
    staticValue: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)
```

--------------------------------

### Sample Data Search Configuration Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

Example of configuring search using sample data. The `sampleData` property specifies the dataset.

```text
source {
  list: @component
  location: SAMPLE_DATA
  sampleData: employees
}
```

--------------------------------

### Full Data Load Definition Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

An example demonstrating the complete structure of a `dataLoadDefinition` in APEXlang, including all major property groups.

```apexlang
dataLoadDefinition "example" (
  name: exampleName
  dataProfile {
    name: exampleName
    format: csv
    rowSelector: value
    useRawSelectors: false
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
  target {
    type: table
    tableOwner: value
    tableName: value
    name: exampleName
    loadingMethod: append
  }
  advanced {
    encoding: iso-8859-6
    numericChars: value
    xmlNamespaces: ```
    Lorem ipsum dolor sit amet.
    ```
    csvSeparator: value
    csvEnclosedBy: value
    commitInterval: 42
    defaultXlsxSheetName: value
    skipRows: 42
    staticId: value
    firstLineContainsHeaders: false
  }
  errorHandling {
    whenOnError: value
    name: exampleName
    tableName: value
  }
  subscription {
    master: value
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)
```

--------------------------------

### Full APEXlang languageMapping Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

This is a complete example demonstrating the `languageMapping` configuration in APEXlang, including translation, advanced, and comments settings.

```apexlang
languageMapping "example" (
  translation {
    appId: 42
    language: af
    documentDirection: true
  }
  advanced {
    imageDirectory: value
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)
```

--------------------------------

### Full APEXlang reportQuery example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

An example of configuring a report query in APEXlang, covering output, session state, and advanced settings.

```apexlang
reportQuery "example" (
  name: exampleName
  output {
    fileName: value
    format: pdf
    formatItem: value
    layout: @component
    viewFileAs: attachment
  }
  sessionState {
    include: false
    items: [
		value1
		value2
	]
  }
  advanced {
    staticId: value
  }
)
```

--------------------------------

### APEXlang Full Parameter Definition Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

An example demonstrating a complete APEXlang parameter definition, including nested parameter configurations and various value settings. This shows how to structure a parameter with its associated properties and values.

```apexlang
parameter "example" (
  name: @component
  parameter {
    ignoreOutput: false
  }
  value {
    type: value
    staticValue: ```
    Lorem ipsum dolor sit amet.
    ```
    sqlQuery: ```
    select empno, ename, job, sal
      from emp
     where deptno = :P1_DEPTNO
    ```
    item: value
    language: sql
    sqlExpression: ```
    upper(:P1_SEARCH)
    ```
    plsqlExpression: ```
    :CARD_LINK is not null
    ```
    javaScriptExpression: ```
    apex.message.alert( "Load complete." );
    ```
    plsqlFunctionBody: ```
    return 'Generated text';
    ```
    javaScriptFunctionBody: ```
    return 'Generated text';
    ```
    preference: value
    name: exampleName
    formatMask: value
    trueValue: value
    falseValue: value
    column: @component
  }
)
```

--------------------------------

### Full APEXlang Component Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

A comprehensive example demonstrating the structure and various properties of an APEXlang component, including template settings, slots, AI tool configuration, and source code.

```apexlang
plugin "example" (
  name: exampleName
  apexlangName: value
  staticId: value
  type: templateComponent
  theme: @component
  templateComponent {
    availableAs: [
		partial
		report
	]
    partial: ```
    Lorem ipsum dolor sit amet.
    ```
    reportBody: ```
    Lorem ipsum dolor sit amet.
    ```
    reportGroup: ```
    Lorem ipsum dolor sit amet.
    ```
    reportRow: ```
    Lorem ipsum dolor sit amet.
    ```
    reportContainer: ```
    Lorem ipsum dolor sit amet.
    ```
    translateTemplates: false
    defaultEscapeMode: html
    numberOfLazyLoadingSkeletons: 42
  }
  defaultSlots {
    regions: value
    items: value
    buttons: value
  }
  aiTool {
    executionLocation: clientSide
    supportedExecutionPoints: [
		augmentSystemPrompt
		onDemand
	]
  }
  onDemand {
    description: ```
    Lorem ipsum dolor sit amet.
    ```
    parameters: noParameters
    parametersJsonSchema: ```
    {
        "type": "object",
        "properties": {
            "status": { "type": "string" }
        }
    }
    ```
  }
  component {
    supports: [
		pageItems
		interactiveGridColumns
	]
    supportsSessionStateDataTypes: [
		varchar2
		clob
	]
    standardAttributes: [
		visibleWidget
		standardFormElement
	]
  }
  source {
    plsqlCode: ```
    apex_debug.message('Processing APEXlang component');
    apex_collection.create_or_truncate_collection(
        p_collection_name => 'EXAMPLE_ROWS'
    );
    ```
    sampleData: employees
  }
  callbacks {
    apiInterface: value
    renderProcedureName: value
    metaDataProcedureName: value
    sessionSentryProcedureName: value
    invalidSessionProcedureName: unique-id
    authenticationProcedureName: value
    postLogoutProcedureName: value
    ajaxProcedureName: value
    validationProcedureName: unique-id
    executionFunctionProcedureName: value
    completionFunctionProcedureName: value
    terminationFunctionProcedureName: value
    restSourceCapabilitiesProcedure: value
    restSourceFetchProcedure: value
    restSourceDmlProcedure: value
    restSourceExecuteProcedure: value
    aiRequestHandlerProcedure: value
    aiResponseHandlerProcedure: value
    restSourceDiscoverProcedure: value
  }
  advanced {
    filePrefix: value
    category: component
    quickPick: false
    substituteAttributeValues: false
    deprecated: false
    legacy: false
  }
  css {
    fileUrls: [
		value1
		value2
	]
  }
  javaScript {
    fileUrls: [
		value1
		value2
	]
  }
  information {
    version: value
    aboutUrl: value
    helpText: ```
    Lorem ipsum dolor sit amet.
    ```
  }
  subscription {
    master: value
    subscribeComponentSettings: false
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)
```

--------------------------------

### APEXlang Column Group Example (Interactive Grid)

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

An example demonstrating the structure of a column group definition in APEXlang for Interactive Grids.

```apexlang
columnGroup "example" (
  heading {
    heading: value
    alternativeLabel: value
  }
  advanced {
    staticId: value
  }
)
```

--------------------------------

### APEXlang Action Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

A comprehensive example demonstrating an APEXlang action with various configurations including position, template, label, layout, behavior, appearance, advanced settings, and server-side conditions.

```apexlang
action "example" (
  position: value
  template: value
  label: label
  layout {
    sequence: 42
  }
  behavior {
    type: redirectThisApp
    target: value
    targetUrl: value
    linkAttributes: value
  }
  appearance {
    displayType: text
    icon: fa-check
    hot: false
    showAsDisabled: false
    cssClasses: [
		value1
		value2
	]
  }
  advanced {
    staticId: value
  }
  serverSideCondition {
    type: always
    sqlQuery: ```
    select empno, ename, job, sal
      from emp
     where deptno = :P1_DEPTNO
    ```
    language: sql
    sqlExpression: ```
    upper(:P1_SEARCH)
    ```
    plsqlExpression: ```
    :CARD_LINK is not null
    ```
    javaScriptExpression: ```
    apex.message.alert( "Load complete." );
    ```
  }
)
```

--------------------------------

### Full APEXlang Meta Tag Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

A comprehensive example of a metaTag with various properties including server-side conditions, configuration, and comments.

```apexlang
metaTag "example" (
  name: exampleName
  value: ```
    Lorem ipsum dolor sit amet.
    ```
  advanced {
    staticId: value
  }
  serverSideCondition {
    type: always
    sqlQuery: ```
    select empno, ename, job, sal
      from emp
     where deptno = :P1_DEPTNO
    ```
    language: sql
    sqlExpression: ```
    upper(:P1_SEARCH)
    ```
    plsqlExpression: ```
    :CARD_LINK is not null
    ```
    javaScriptExpression: ```
    apex.message.alert( "Load complete." );
    ```
    plsqlFunctionBody: ```
    return 'Generated text';
    ```
    javaScriptFunctionBody: ```
    return 'Generated text';
    ```
    value: value
    item: value
    preference: value
    page: 42
    pages: [1, 2]
    text: text
    list: [
		value1
		value2
	]
  }
  config {
    buildOption: @component
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)
```

--------------------------------

### APEXlang Region Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

A comprehensive example demonstrating the configuration of a 'staticContent' region using APEXlang, including chart, component appearance, link, map, output, title, chart appearance, page, card, and source settings.

```APEXlang
region "example" (
  name: exampleName
  title: "Page title"
  type: staticContent
  chart {
    type: area
  }
  componentAppearance {
    display: value
    layout: grid
    gridColumns: "2"
    listTemplate: @component
    breadcrumbTemplate: @component
    templateOptions: [
		value1
		value2
	]
    templateType: theme
    cssClasses: [
		value1
		value2
	]
    template: @component
    customAttributes: value
    selectFirstRow: false
    fixedRowHeight: false
    showNullValuesAs: value
  }
  link {
    linkColumn: singleRowView
    uniquelyIdentifyRowsBy: rowid
    uniqueColumn: value
    target: value
    linkIcon: ```
    Lorem ipsum dolor sit amet.
    ```
    linkAttributes: value
    authorizationScheme: @component
    conditionType: always
    sqlQuery: ```
    select empno, ename, job, sal
      from emp
     where deptno = :P1_DEPTNO
    ```
    language: sql
    sqlExpression: ```
    upper(:P1_SEARCH)
    ```
    plsqlExpression: ```
    :CARD_LINK is not null
    ```
    javaScriptExpression: ```
    apex.message.alert( "Load complete." );
    ```
    plsqlFunctionBody: ```
    return 'Generated text';
    ```
    javaScriptFunctionBody: ```
    return 'Generated text';
    ```
    value: value
    item: value
    preference: value
    page: 42
    pages: [1, 2]
    text: text
    list: [
		value1
		value2
	]
  }
  map {
    background: default
    standard: openstreetmapPositron
    darkMode: openstreetmapDark
    height: 300
  }
  output {
    layout: @component
    linkText: value
    format: pdf
    viewFileAs: attachment
    formatItem: value
    fileName: value
  }
  title {
    title: "Page title"
    advancedFormatting: false
    column: value
    htmlExpression: ```
    Lorem ipsum dolor sit amet.
    ```
    cssClasses: [
		value1
		value2
	]
  }
  chartAppearance {
    orientation: vertical
    stack: false
    stackLabel: false
    fontFamily: arial
    fontStyle: normal
    fontSize: "8"
    fontColor: value
  }
  page {
    size: letter
    orientation: portrait
    units: inches
    width: 400
    height: 300
    borderWidth: 1
    borderColor: value
  }
  card {
    cssClasses: [
		value1
		value2
	]
    primaryKeyColumn2: value
    primaryKeyColumn1: value
  }
  source {
    sqlQuery: ```
    select empno, ename, job, sal
      from emp
     where deptno = :P1_DEPTNO
    ```
    plsqlCode: ```
    apex_debug.message('Processing APEXlang component');
    apex_collection.create_or_truncate_collection(
        p_collection_name => 'EXAMPLE_ROWS'
    );
    ```
    plsqlFunctionBody: ```
    return 'Generated text';
    ```
    htmlCode: ```
    Lorem ipsum dolor sit amet.
    ```
    text: ```
    Lorem ipsum dolor sit amet.
    ```
    language: plsql
    javaScriptFunctionBody: ```
    return 'Generated text';
    ```
    location: localDatabase
    remoteServer: @component
    sampleData: employees
    type: value
    tableOwner: value
    tableName: value
    includeRowidColumn: false
    whereClause: ```
    status = 'ACTIVE'
    ```
    graphOwner: value
    graphName: value
    matchClause: ```
    Lorem ipsum dolor sit amet.
    ```
    columnsClause: ```

```

--------------------------------

### Full Breadcrumb Template Example in APEXlang

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

A comprehensive example demonstrating the complete structure of a breadcrumb template definition in APEXlang, including all configurable sections.

```apexlang
breadcrumbTemplate "example" (
  name: exampleName
  templateClass: breadcrumb
  templateOptions {
    preset: [
		value1
		value2
	]
    default: [
		value1
		value2
	]
  }
  breadcrumb {
    startWith: childBreadcrumbEntries
    beforeEntries: ```
    Lorem ipsum dolor sit amet.
    ```
    betweenEntries: ```
    Lorem ipsum dolor sit amet.
    ```
    maxEntries: 5
    afterEntries: ```
    Lorem ipsum dolor sit amet.
    ```
  }
  entry {
    currentPage: ```
    Lorem ipsum dolor sit amet.
    ```
    nonCurrentPage: ```
    Lorem ipsum dolor sit amet.
    ```
    linkAttributes: value
  }
  advanced {
    staticId: value
    identifier: unique-id
    translatable: false
  }
  subscription {
    master: value
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)
```

--------------------------------

### Full APEXlang jsonSource Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

A comprehensive example demonstrating the complete configuration of a jsonSource in APEXlang, including data profile, source, advanced, remote cache, subscription, and comments settings.

```apexlang
jsonSource "example" (
  name: exampleName
  type: tableWithJsonColumn
  dataProfile {
    name: exampleName
    format: csv
    rowSelector: value
    useRawSelectors: false
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
  source {
    location: localDatabase
    remoteServer: @component
    tableOwner: value
    tableName: value
    whereClause: ```
    status = 'ACTIVE'
    ```
  }
  advanced {
    xmlNamespaces: ```
    Lorem ipsum dolor sit amet.
    ```
    csvSeparator: value
    csvEnclosedBy: value
    defaultXlsxSheetName: value
    skipRows: 42
    staticId: value
    firstLineContainsHeaders: false
  }
  remoteCache {
    caching: allUsers
    timeout: ```
    Lorem ipsum dolor sit amet.
    ```
  }
  subscription {
    master: value
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)
```

--------------------------------

### APEXlang Action Example

Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln

A comprehensive example of an APEXlang action, demonstrating button configuration, layout, behavior, appearance, advanced settings, server-side conditions, security, build options, and comments.

```APEXlang
action "example" (
  type: button
  label: label
  layout {
    position: primary
    sequence: 42
  }
  behavior {
    type: redirectThisApp
    target: value
    targetUrl: value
    linkAttributes: value
  }
  appearance {
    displayType: text
    icon: fa-check
    hot: false
    cssClasses: [
		value1
		value2
	]
  }
  advanced {
    staticId: value
  }
  serverSideCondition {
    type: always
    sqlQuery: ```
    select empno, ename, job, sal
      from emp
     where deptno = :P1_DEPTNO
    ```
    language: sql
    sqlExpression: ```
    upper(:P1_SEARCH)
    ```
    plsqlExpression: ```
    :CARD_LINK is not null
    ```
    javaScriptExpression: ```
    apex.message.alert( "Load complete." );
    ```
    plsqlFunctionBody: ```
    return 'Generated text';
    ```
    javaScriptFunctionBody: ```
    return 'Generated text';
    ```
    value: value
    item: value
    preference: value
    page: 42
    pages: [1, 2]
    text: text
    list: [
		value1
		value2
	]
    executeCondition: forEachRow
  }
  security {
    authorizationScheme: @component
  }
  config {
    buildOption: @component
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)
```
Tokens:
Raw