### Full Install Script Definition in APEXlang Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln A comprehensive example of defining an install script with name, execution, script details, and 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'; ``` } ) ``` -------------------------------- ### Full standardAttributeConfig Example in APEXlang Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln A comprehensive example demonstrating the usage of standardAttributeConfig with all its property groups, including validation, sqlQuery, default, help, examples, dependingOn, and comments. ```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. """ } ) ``` -------------------------------- ### APEXlang Example Parameter Declaration Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln An example demonstrating how to declare a parameter named 'example' in APEXlang. This serves as a starting point for defining your own parameters. ```apexlang parameter "example" ( ``` -------------------------------- ### Full APEXlang connection example Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln A comprehensive example demonstrating the structure of a connection in APEXlang, including all possible property groups. ```apexlang connection "example" ( name: exampleName type: value execution { sequence: 42 } activity { from: @component to: @component } condition { operator: "=" value: value } config { buildOption: @component } advanced { diagram: value } comments { comments: ``` Lorem ipsum dolor sit amet. ``` } ) ``` -------------------------------- ### 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 in APEXlang, including all major property groups. ```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. ``` } ) ``` -------------------------------- ### Full APEXlang Version Example Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln A comprehensive example demonstrating the structure of an APEXlang workflow version with all its configurable sections. ```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 restEnabledSqlDatabase Example Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln A comprehensive example demonstrating the configuration of all properties for `restEnabledSqlDatabase` in APEXlang. ```apexlang restEnabledSqlDatabase "example" ( name: exampleName endpointUrl { url: value } authentication { credentials: @component } database { databaseType: oracle databaseInfo: ``` Lorem ipsum dolor sit amet. ``` } databaseSession { initPlsqlCode: ``` apex_debug.message('Processing APEXlang component'); apex_collection.create_or_truncate_collection( p_collection_name => 'EXAMPLE_ROWS' ); ``` cleanupPlsqlCode: ``` apex_debug.message('Processing APEXlang component'); apex_collection.create_or_truncate_collection( p_collection_name => 'EXAMPLE_ROWS' ); ``` } session { defaultSchema: value mysqlSqlModes: "select * from table_name" } dynamicConfig { plsqlCode: ``` apex_debug.message('Processing APEXlang component'); apex_collection.create_or_truncate_collection( p_collection_name => 'EXAMPLE_ROWS' ); ``` procedureName: value } advanced { staticId: value promptOnInstall: false httpsHostName: value ordsVersion: value serverTimeZone: value } comments { comments: ``` Lorem ipsum dolor sit amet. ``` } ) ``` -------------------------------- ### Define examples Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln Use the examples property to provide example usage or values for an attribute. Supports multiline strings. ```apexlang examples { examples: """ Lorem ipsum dolor sit amet. """ } ``` -------------------------------- ### APEXlang Process Example Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln A comprehensive example of an APEXlang process, demonstrating various configurations including source, execution, and conditions. ```apexlang process "example" ( name: exampleName type: staticContent executionChain: value formRegion: @component editableRegion: @component genAI { enabled: false agent: @component service: @component systemPrompt: ``` Lorem ipsum dolor sit amet. ``` } source { location: localDatabase language: plsql plsqlCode: ``` apex_debug.message('Processing APEXlang component'); apex_collection.create_or_truncate_collection( p_collection_name => 'EXAMPLE_ROWS' ); ``` javaScriptCode: ``` apex.message.alert( "Load complete." ); ``` remoteServer: @component } execution { sequence: 42 point: value runProcess: oncePerSessionOrWhenReset } successMessage { successMessage: ``` Lorem ipsum dolor sit amet. ``` } error { errorMessage: ``` Lorem ipsum dolor sit amet. ``` displayLocation: inlineInNotification } advanced { staticId: value executionMappingIdentifier: value } serverSideCondition { whenButtonPressed: @component executionScope: forCreatedAndModifiedRows 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. ``` } ) ``` -------------------------------- ### Full APEXlang List Example Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln A comprehensive example demonstrating the configuration of a list with all its properties, including source, advanced, config, subscription, and comments. ```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. ``` } ) ``` -------------------------------- ### Full APEXlang Build Option Example Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln An example demonstrating the complete structure of an APEXlang build option, including name, 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. ``` } ) ``` -------------------------------- ### Full APEXlang Entry Example Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln A comprehensive example demonstrating the structure 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. ``` } ) ``` -------------------------------- ### Full APEXlang Role Example Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln This example demonstrates a complete role definition in APEXlang, including name, description, advanced settings, and subscription. ```apexlang role "example" ( name: exampleName description { description: ``` Lorem ipsum dolor sit amet. ``` } advanced { staticId: value } subscription { master: value } ) ``` -------------------------------- ### Full APEXlang Menu Example Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln A comprehensive example demonstrating the structure of a menu component with various configurations including layout, behavior, appearance, server-side conditions, security, and comments. ```apexlang menu "example" ( type: menuEntry label: label parentMenu: @component layout { sequence: 42 } behavior { type: redirectThisApp target: value targetUrl: value linkAttributes: value } appearance { icon: fa-check } 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 ] } advanced { staticId: value } security { authorizationScheme: @component } config { buildOption: @component } comments { comments: ``` Lorem ipsum dolor sit amet. ``` } ) ``` -------------------------------- ### Full APEXlang aiAgent Example Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln A complete example demonstrating the configuration of an aiAgent in APEXlang, including all major sections. ```apexlang 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 tableLookup Example Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln A complete example demonstrating the usage of the tableLookup component with all its configurable properties. ```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 } ) ``` -------------------------------- ### APEXlang triggerAction Example Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln A comprehensive example of the APEXlang triggerAction, demonstrating its various configuration options. ```apexlang triggerAction "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 button: @component items: [ value1 value2 ] jquerySelector: "select * from table_name" javaScriptExpression: ``` apex.message.alert( "Load complete." ); ``` } execution { sequence: 42 stopExecutionOnError: false waitForResult: false } clientSideCondition { type: "item=value" item: value value: value list: [ value1 value2 ] javaScriptExpression: ``` apex.message.alert( "Load complete." ); ``` } 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 Email Template Example Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln A comprehensive example demonstrating the structure of an email template in APEXlang, including all major formatting and configuration sections. ```apexlang emailTemplate "example" ( name: exampleName emailSubject: value htmlFormat { header: ``` Lorem ipsum dolor sit amet. ``` body: ``` Lorem ipsum dolor sit amet. ``` footer: ``` Lorem ipsum dolor sit amet. ``` } plainTextFormat { content: ``` Lorem ipsum dolor sit amet. ``` } advanced { staticId: value versionNumber: "1" htmlTemplate: ``` Lorem ipsum dolor sit amet. ``` } subscription { master: value } comments { comments: ``` Lorem ipsum dolor sit amet. ``` } ) ``` -------------------------------- ### Full APEXlang entry example Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln An example demonstrating the structure of an entry in APEXlang, including its apexlangName and nested properties like entry, help, and advanced. ```apexlang entry "example" ( apexlangName: value entry { sequence: 42 display: value return: value } help { helpText: """ Lorem ipsum dolor sit amet. """ } advanced { quickPick: false deprecated: false } ) ``` -------------------------------- ### Configure Supporting Object Installation Names Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln Define the names of objects to be installed as part of the supporting object. Use multiline strings for clarity. ```apex installation { objectNames: [ value1 value2 ] } ``` -------------------------------- ### Full APEXlang Button Template Example Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln This example shows the complete APEXlang syntax for defining a `buttonTemplate`, including all its configurable property groups. ```apexlang buttonTemplate "example" ( name: exampleName templateClass: button templateOptions { preset: [ value1 value2 ] default: [ value1 value2 ] } button { normal: ``` Lorem ipsum dolor sit amet. ``` hot: ``` Lorem ipsum dolor sit amet. ``` } advanced { staticId: value identifier: unique-id translatable: false } subscription { master: value } comments { comments: ``` Lorem ipsum dolor sit amet. ``` } ) ``` -------------------------------- ### Advanced Property Group Example (actionPosition) Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln Example of the advanced property group for actionPosition, setting the quickPick option. ```apexlang advanced { quickPick: false } ``` -------------------------------- ### Full APEXlang Operation Example Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln A comprehensive example demonstrating the configuration of all properties for an APEXlang operation, including name, label, and nested configurations for request, data profile, caching, advanced settings, and comments. ```apexlang operation "example" ( name: exampleName label: label operation { urlPattern: value httpMethod: get databaseOperation: fetchRows } requestBody { template: ``` Lorem ipsum dolor sit amet. ``` versionNumber: "1" } dataProfile { nestedRows: @component } remoteCache { caching: allUsers timeout: ``` Lorem ipsum dolor sit amet. ``` } advanced { fixedPageSize: 42 allowFetchingAllRows: false fetchAllRowsTimeout: 42 forceRaiseHttp404Error: false staticId: value } comments { comments: ``` Lorem ipsum dolor sit amet. ``` } ) ``` -------------------------------- ### Full APEXlang activityVariable Example Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln A comprehensive example demonstrating the configuration of an activity variable with all its properties, including static ID, label, parameter type, value settings, 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. ``` } ) ``` -------------------------------- ### Full APEXlang Meta Tag Example Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln A comprehensive example demonstrating the metaTag component with various properties including server-side conditions, config, 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. ``` } ) ``` -------------------------------- ### Source Configuration Example Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln This snippet shows a comprehensive example of configuring the 'source' attribute for an automation, demonstrating various properties like location, language, and specific body content for PL/SQL and JavaScript. It also includes settings for sample data, table and graph details, SQL queries, REST sources, and optimizer hints. ```apex source { location: localDatabase remoteServer: @component language: plsql plsqlFunctionBody: ``` return 'Generated text'; ``` javaScriptFunctionBody: ``` return 'Generated text'; ``` sampleData: employees type: value tableOwner: value tableName: value includeRowidColumn: false whereClause: ``` status = 'ACTIVE' ``` graphOwner: value graphName: value matchClause: ``` Lorem ipsum dolor sit amet. ``` columnsClause: ``` Lorem ipsum dolor sit amet. ``` orderByClause: ``` created_on desc ``` sqlQuery: ``` select empno, ename, job, sal from emp where deptno = :P1_DEPTNO ``` restSource: @component jsonDualityView: @component jsonSource: @component optimizerHint: value } ``` -------------------------------- ### Full jsonDualityView APEXlang Example Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln A comprehensive example demonstrating the full configuration of a jsonDualityView in APEXlang, including all major property groups. ```apexlang jsonDualityView "example" ( name: exampleName dataProfile { name: exampleName format: csv rowSelector: value useRawSelectors: false comments: ``` Lorem ipsum dolor sit amet. ``` } source { location: localDatabase remoteServer: @component tableOwner: value tableName: value } advanced { xmlNamespaces: ``` Lorem ipsum dolor sit amet. ``` csvSeparator: value csvEnclosedBy: value staticId: value defaultXlsxSheetName: value skipRows: 42 firstLineContainsHeaders: false } remoteCache { caching: allUsers timeout: ``` Lorem ipsum dolor sit amet. ``` } 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 full structure of a jsonSource definition in APEXlang, including all nested blocks. ```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. ``` } ) ``` -------------------------------- ### Help Property Group Example Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln Example of the help property group, used to define help text for a component. ```apexlang help { helpText: """ Lorem ipsum dolor sit amet. """ } ``` -------------------------------- ### Full APEXlang textMessage Example Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln A comprehensive example demonstrating the complete structure of a textMessage component in APEXlang, including all property groups. ```APEXlang textMessage "example" ( staticId: value message { text: ``` Lorem ipsum dolor sit amet. ``` language: af usedInJavaScript: false } advanced { metadata: ``` Lorem ipsum dolor sit amet. ``` } subscription { master: 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 the structure of an APEXlang action, including genAI settings, affected elements, execution logic, client-side conditions, server-side conditions, security, configuration, 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. ``` } ) ``` -------------------------------- ### APEXlang component definition example Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln This APEXlang example demonstrates the structure for defining a component, including its type and associated properties. ```apexlang component "example" ( component { type: accessControlRole appItem: @component appProcess: @component appComputation: @component appSetting: @component buildOption: @component list: @component searchConfig: @component dataLoadDefinition: @component jsonDualityView: @component jsonSource: @component restDataSource: @component authenticationScheme: @component authorizationScheme: @component appAccessControlRole: @component emailTemplate: @component lov: @component plugIn: @component componentSettings: @component shortcut: @component mapBackground: @component reportLayout: @component textMessage: @component aiAgent: @component } ) ``` -------------------------------- ### APEXlang Example for Column Definition Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln An example demonstrating the APEXlang syntax for defining a column with its name, visibility, heading, layout, source, appearance, advanced settings, and comments. ```apexlang column "example" ( columnName: value show: false heading { heading: value } layout { sequence: 42 } source { dataType: varchar2 } appearance { formatMask: value } advanced { searchable: false } comments { comments: ``` Lorem ipsum dolor sit amet. ``` } ) ``` -------------------------------- ### Full APEXlang Entry Example Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln A comprehensive example of an APEXlang entry, demonstrating the integration of various sections including entry details, globalization, advanced settings, server-side conditions, configuration, and comments. ```apexlang entry "example" ( entry { sequence: 42 display: ``` Lorem ipsum dolor sit amet. ``` return: value quickPickRank: 42 } globalization { template: ``` 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. ``` } ) ``` -------------------------------- ### Value Configuration Examples Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln Illustrates different ways to configure the 'value' property for a participant, including static text, SQL queries, and expressions in SQL, PL/SQL, and JavaScript. ```apexlang value { type: staticValue staticValue: ``` Lorem ipsum dolor sit amet. ``` 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'; ``` } ``` -------------------------------- ### Full APEXlang Template Option Example Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln This example demonstrates the complete structure for defining a `templateOption` in APEXlang, including all possible property groups. ```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 } ) ``` -------------------------------- ### APEXlang actionPosition Example Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln Example of defining an actionPosition in APEXlang. This is used for components of type TEMPLATE 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 Report Layout Example Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln A comprehensive example demonstrating the structure and properties of a report layout in APEXlang, including file, dataLoop, templates, advanced, subscription, and comments configurations. ```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 legacyDataLoadDefinition Example in APEXlang Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln A complete example demonstrating the structure and properties of a legacyDataLoadDefinition in APEXlang, including all property groups. ```apexlang legacyDataLoadDefinition "example" ( name: exampleName target { tableOwner: value tableName: value } uniqueKeys { uniqueColumn1: value isUk1CaseSensitive: false uniqueColumn2: value isUk2CaseSensitive: false uniqueColumn3: value isUk3CaseSensitive: false } validation { skipValidation: false versionColumn: value } advanced { columnAliasesLov: @component wizardPageIds: value staticId: value } subscription { master: value } comments { comments: ``` Lorem ipsum dolor sit amet. ``` } ) ``` -------------------------------- ### Full APEXlang fileServer configuration Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln An example demonstrating the complete structure for configuring a fileServer component in APEXlang, including all property groups. ```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 APEXlang Component Example Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln A comprehensive example of an APEXlang plugin component, demonstrating various configurations including template settings, default slots, AI tool integration, source code, callbacks, and advanced properties. ```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. ``` } ) ``` -------------------------------- ### Full APEXlang customAttribute example Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln A comprehensive example demonstrating the structure of a customAttribute in APEXlang, including various nested properties. ```apexlang customAttribute "example" ( staticId: value apexlangName: value attribute: 42 name: exampleName scope: value type: value componentLov { type: static componentType: credential onDeleteBehavior: cascade nullText: value } validation { required: false maxLength: 5 minColumns: 1 maxColumns: 5 textCase: uppercase } security { escapeMode: html } appearance { attributeGroup: value sequence: 42 } builder { common: false showInWizard: false unit: value translatable: false includeColumnsInItemsPicker: false displayWidth: 42 } templateSupport { type: substitutions customSubstitutions: [ value1 value2 ] } accessibility { importantForAccessibility: false helpText: """ Lorem ipsum dolor sit amet. """ } default { value: false sampleDataValue: """ Lorem ipsum dolor sit amet. """ } supports { components: [ pageItems interactiveGridColumns ] dataTypes: [ value1 value2 ] } dependingOn { attribute: value conditionType: "=" value: value list: [ value1 value2 ] alwaysEvaluate: false parentAttribute: value } help { helpText: """ Lorem ipsum dolor sit amet. """ } examples { examples: """ Lorem ipsum dolor sit amet. """ } advanced { showDeprecatedAttributeForValues: [ value1 value2 ] } comments { comments: """ Lorem ipsum dolor sit amet. """ } ) ``` -------------------------------- ### Configure Supporting Object Installation Messages Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln Customize messages displayed during the installation process, including welcome, confirmation, success, and failure messages. Supports multiline strings. ```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. """ } ``` -------------------------------- ### APEXlang actionTemplate Example Source: https://docs.oracle.com/en/database/oracle/apex/26.1/apxln Example of defining an actionTemplate in APEXlang. This is used for components of type TEMPLATE 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. """ } ) ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.