APEXlang API Reference

app "example" (
  name: exampleName
  alias: value
  version: value
  type: standard
  group: value
  genAI {
    service: @component
    aiConsentMessage: ```
    Lorem ipsum dolor sit amet.
    ```
    requestHandlerProcedure: value
    responseHandlerProcedure: value
  }
  logo {
    type: image
    imageUrl: value
    text: text
    customHtml: ```
    Lorem ipsum dolor sit amet.
    ```
  }
  navigation {
    homeUrl: value
    loginUrl: value
  }
  navigationMenu {
    listTemplate: @component
    templateOptions: [
		value1
		value2
	]
    listPosition: top
    list: @component
  }
  navigationBar {
    implementation: classic
    list: value
    listTemplate: @component
    templateOptions: [
		value1
		value2
	]
  }
  userInterface {
    currentTheme: @component
    globalPage: 42
    usersCanChooseThemeStyle: false
    addBuiltWithApexToFooter: false
    autoDismissSuccessMessages: false
  }
  appFormatMasks {
    date: value
    dateTime: value
    timestamp: value
    timestampTimeZone: value
  }
  javaScript {
    fileUrls: [
		value1
		value2
	]
    includeLegacyJavascript: [
		pre18
		"18"
	]
    includeJqueryMigrate: false
  }
  css {
    fileUrls: [
		value1
		value2
	]
  }
  authentication {
    scheme: value
    configProcedureName: value
    publicUser: value
  }
  authorization {
    scheme: @component
    runOnPublicPages: false
    runOnBackgroundJob: false
    sourceForRoleOrGroupSchemes: accessControlUserRoleAssignments
  }
  security {
    deepLinking: true
    enableDictation: false
    browserCache: true
    embedInFrames: deny
    referrerPolicy: noReferrer
    htmlEscapingMode: basic
    httpResponseHeaders: ```
    Lorem ipsum dolor sit amet.
    ```
    runtimeApiUsage: [
		modifyThisApp
		modifyOtherApps
	]
  }
  sessionStateProtection {
    enabled: false
    allowUrlsCreatedAfter: value
    bookmarkHashFunction: sha1
    checksumSalt: value
    acceptPre202UrlChecksums: false
  }
  sessionManagement {
    rejoinSessions: false
    sessionStateCommits: immediate
    maxSessionLength: 5
    sessionTimeoutUrl: value
    maxSessionIdleTime: 5
    sessionIdleTimeoutUrl: value
    sessionTimeoutWarning: 42
  }
  databaseSession {
    parsingSchema: value
    mleEnvironment: value
    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'
    );
    ```
  }
  globalization {
    primaryLanguage: af
    documentDirection: leftToRight
    translationMethod: translationApps
    languageDerivedFrom: notTranslated
    autoTimeZone: false
    autoCsvEncoding: false
  }
  progressiveWebApp {
    enable: false
    installable: false
    display: fullscreen
    screenOrientation: any
    themeColor: value
    backgroundColor: value
    appDescription: ```
    Lorem ipsum dolor sit amet.
    ```
    appShortName: value
    customManifest: ```
    Lorem ipsum dolor sit amet.
    ```
    manifestIconUrl: value
    enablePushNotifications: false
    pushNotificationsCredentials: @component
    contactEmail: value
  }
  customServiceWorker {
    mode: default
    url: value
    functionVariableDeclarationMode: default
    functionVariableDeclaration: ```
    apex.message.alert( "Load complete." );
    ```
    installMode: default
    eventInstall: ```
    apex.message.alert( "Load complete." );
    ```
    eventInstallBefore: ```
    apex.message.alert( "Load complete." );
    ```
    eventInstallAfter: ```
    apex.message.alert( "Load complete." );
    ```
    activateMode: default
    eventActivate: ```
    apex.message.alert( "Load complete." );
    ```
    eventActivateBefore: ```
    apex.message.alert( "Load complete." );
    ```
    eventActivateAfter: ```
    apex.message.alert( "Load complete." );
    ```
    fetchMode: default
    eventFetch: ```
    apex.message.alert( "Load complete." );
    ```
    eventFetchBefore: ```
    apex.message.alert( "Load complete." );
    ```
    eventFetchCacheDefinition: ```
    apex.message.alert( "Load complete." );
    ```
    eventFetchCacheResponse: ```
    apex.message.alert( "Load complete." );
    ```
    eventFetchNetworkResponseSuccess: ```
    apex.message.alert( "Load complete." );
    ```
    eventFetchNetworkResponseError: ```
    apex.message.alert( "Load complete." );
    ```
    eventFetchOfflinePage: ```
    apex.message.alert( "Load complete." );
    ```
    eventFetchNetworkFallback: ```
    apex.message.alert( "Load complete." );
    ```
    syncMode: default
    eventSync: ```
    apex.message.alert( "Load complete." );
    ```
    pushMode: default
    eventPush: ```
    apex.message.alert( "Load complete." );
    ```
    eventPushBefore: ```
    apex.message.alert( "Load complete." );
    ```
    eventPushAfter: ```
    apex.message.alert( "Load complete." );
    ```
    notificationClickMode: default
    eventNotificationClick: ```
    apex.message.alert( "Load complete." );
    ```
    evenNotificationClickBefore: ```
    apex.message.alert( "Load complete." );
    ```
    evenNotificationClickAfter: ```
    apex.message.alert( "Load complete." );
    ```
    notificationCloseMode: default
    evenNotificationClose: ```
    apex.message.alert( "Load complete." );
    ```
    canMakePaymentMode: default
    evenCanMakePayment: ```
    apex.message.alert( "Load complete." );
    ```
    paymentRequestMode: default
    evenPaymentRequest: ```
    apex.message.alert( "Load complete." );
    ```
  }
  rowSearch {
    tokenize: false
    textQueryFunction: searchEngine
    customFunctionName: value
  }
  charValueComparison {
    mode: value
    behavior: binary
  }
  reportPrinting {
    type: native
    remotePrintServer: value
    credentials: @component
  }
  fileStorage {
    type: database
    fileServer: value
  }
  errorHandling {
    defaultDisplayLocation: inlineWithFieldAndInNotification
    errorHandlingFunctionName: value
  }
  runtime {
    friendlyUrls: false
    allowFeedback: false
    logging: false
    debugging: false
    compatibilityMode: "26.1"
    accessibleReadOnlyItems: false
  }
  staticFiles {
    appFilesPath: value
    apexFilesPath: value
  }
  proxy {
    proxyServer: value
    noProxyDomains: value
  }
  availability {
    status: available
    message: ```
    Lorem ipsum dolor sit amet.
    ```
    restrictUserList: [
		value1
		value2
	]
    globalNotificationMessage: ```
    Lorem ipsum dolor sit amet.
    ```
    buildStatus: runOnly
  }
  advanced {
    exactSubstitutions: false
    passEcid: false
    modernizeApp: false
    emailFromAddress: value
    copyrightBanner: ```
    Lorem ipsum dolor sit amet.
    ```
    faviconHtml: ```
    Lorem ipsum dolor sit amet.
    ```
    maxBackgroundPageProcessJobs: 5
    vacationRuleProcedureName: value
    mediaType: value
    opentelemetryProductFamily: value
    appBuilderIconName: value
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)

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.
    ```
  }
)

tool "example" (
  name: exampleName
  type: staticContent
  executionPoint: value
  description: ```
    Lorem ipsum dolor sit amet.
    ```
  userApproval {
    requiresConfirmation: false
    title: "Page title"
    message: ```
    Lorem ipsum dolor sit amet.
    ```
    confirmLabel: value
    cancelLabel: value
  }
  notification {
    message: ```
    Lorem ipsum dolor sit amet.
    ```
    type: info
  }
  advanced {
    staticId: value
  }
  serverSideCondition {
    type: anyUserPromptContains
    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';
    ```
    list: [
		value1
		value2
	]
  }
  security {
    authorizationScheme: @component
  }
  config {
    buildOption: @component
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)

parameter "example" (
  name: exampleName
  description: ```
    Lorem ipsum dolor sit amet.
    ```
  value {
    dataType: varchar2
  }
  validation {
    required: false
    allowedValues: ```
    {
        "type": "object",
        "properties": {
            "status": { "type": "string" }
        }
    }
    ```
  }
)

appComputation "example" (
  itemName: value
  execution {
    sequence: 42
    point: newSession
  }
  computation {
    type: staticValue
    staticValue: value
    sqlQuery: ```
    select empno, ename, job, sal
      from emp
     where deptno = :P1_DEPTNO
    ```
    computationProcessed: newSession
    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';
    ```
    itemName: value
    preference: value
  }
  error {
    errorMessage: ```
    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
	]
  }
  security {
    authorizationScheme: @component
  }
  config {
    buildOption: @component
  }
  subscription {
    master: value
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)

appItem "example" (
  name: exampleName
  scope: app
  security {
    sessionStateDataType: number
    sessionStateProtection: unrestricted
    escapeSpecialChars: false
  }
  subscription {
    master: value
  }
  config {
    buildOption: @component
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)

appProcess "example" (
  name: exampleName
  type: staticContent
  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: afterAuthentication
  }
  error {
    errorMessage: ```
    Lorem ipsum dolor sit amet.
    ```
    displayLocation: inlineInNotification
  }
  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.
    ```
  }
  subscription {
    master: value
  }
)

appSetting "example" (
  staticId: value
  value {
    staticValue: ```
    Lorem ipsum dolor sit amet.
    ```
    onUpgradeKeepValue: false
  }
  validation {
    required: false
    validValues: unique-id
  }
  config {
    buildOption: @component
  }
  subscription {
    master: value
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)

authentication "example" (
  name: exampleName
  type: staticContent
  source {
    plsqlCode: ```
    apex_debug.message('Processing APEXlang component');
    apex_collection.create_or_truncate_collection(
        p_collection_name => 'EXAMPLE_ROWS'
    );
    ```
  }
  sessionNotValid {
    verifyFunctionName: value
    redirectTo: loginPage
    invalidSessionUrl: unique-id
  }
  loginProcessing {
    preAuthenticationProcedureName: value
    postAuthenticationProcedureName: value
    switchInSession: false
  }
  postLogout {
    redirectTo: homePage
    url: value
  }
  sessionSharing {
    type: app
    cookieName: value
    cookiePath: value
    cookieDomain: value
    secure: false
  }
  realAppSecurity {
    rasMode: disabled
    dynamicRoles: value
    namespaces: exampleName
  }
  advanced {
    staticId: value
  }
  help {
    helpText: ```
    Lorem ipsum dolor sit amet.
    ```
  }
  subscription {
    master: value
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)

authorization "example" (
  name: exampleName
  type: staticContent
  error {
    errorMessage: ```
    Lorem ipsum dolor sit amet.
    ```
  }
  advanced {
    evaluationType: perSession
    staticId: value
  }
  subscription {
    master: value
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)

automation "example" (
  name: exampleName
  execution {
    type: onDemand
    scheduleExpression: ```
    Lorem ipsum dolor sit amet.
    ```
    scheduleStatus: active
    actionsInitiatedOn: rowsReturned
  }
  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
  }
  dataProfile {
    nestedRows: @component
  }
  restSynchronization {
    useLocalTable: false
  }
  externalFilterAndOrderBy {
    enabled: false
    filter: ```
    Lorem ipsum dolor sit amet.
    ```
    orderBy: ```
    Lorem ipsum dolor sit amet.
    ```
  }
  localPostProcessing {
    type: whereOrderByClause
    whereClause: ```
    status = 'ACTIVE'
    ```
    orderByClause: ```
    created_on desc
    ```
    sqlQuery: ```
    select empno, ename, job, sal
      from emp
     where deptno = :P1_DEPTNO
    ```
    language: plsql
    plsqlFunctionBody: ```
    return 'Generated text';
    ```
    javaScriptFunctionBody: ```
    return 'Generated text';
    ```
  }
  columnMapping {
    primaryKeyColumn: value
  }
  actionExecution {
    commit: once
    maxRowsToProcess: 5
    actionErrorHandling: ignore
  }
  additionalCodeExecution {
    plsqlCode: ```
    apex_debug.message('Processing APEXlang component');
    apex_collection.create_or_truncate_collection(
        p_collection_name => 'EXAMPLE_ROWS'
    );
    ```
    initProcedureName: value
    beforeRowProcessingProcedureName: value
    cleanupProcedureName: value
  }
  advanced {
    staticId: value
  }
  serverSideCondition {
    type: rowsReturned
    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';
    ```
  }
  config {
    buildOption: @component
  }
  comments {
    comments: ```
    Lorem ipsum dolor sit amet.
    ```
  }
)