Assigns an alternate alphanumeric application identifier. You can use this identifier for the application ID.

When the Friendly URLs attribute is enabled, the Application Alias specified here displays in the URL when running the application. Applications created using Oracle APEX 20.1 or later default the Application Alias to the application Name.

• Understanding Friendly URL Syntax
• Customizing a Friendly URL

Version

Enter the application's version number. The value enter displays on the page. You can also automatically tie the version to the date of last modification using the following format masks:

• YYYY.MM.DD
• MM.DD.YYYY
• DD.MM.YYYY

If your application version uses YYYY.MM.DD, then App Builder replaces this format mask with the date of last modification of any application attribute.

Note: The friendly URL will include the workspace Path Prefix in the URL. To modify the Path Prefix, go to Workspace Administration, Manage Service, Set Workspace Preferences.

See:

• Understanding Friendly URL Syntax
• Customizing a Friendly URL
• Enabling RESTful Services and Defining a Path Prefix for a Workspace in Oracle APEX Administration Guide

Enables support for end user feedback for this application. Select Yes or No.

If you select Yes, you must create a feedback feature page to use this attribute. If you enable this option, a Feedback icon displays. Uses can click the Feedback icon to leave feedback. Disabling this option hides the Feedback icon. This enables you to turn on feedback for testing and turn it off for production

See Managing Feedback

Determines whether user activity is recorded in the Oracle APEX activity log. Select Yes to log every page view and enable an administrator to monitor user activity for each application.

Disabling logging may be advisable for high volume applications.

This attribute can only be modified if the Application Activity Logging attribute in APEX Administration Services is set to Use Application Setting.

See Enabling Application Activity Logging in Oracle APEX Administration Guide

Controls debug mode for the current application. Available options include:

• Yes - Enables the application to run in a debug mode from a browser at runtime.
• No - Disables the application from enabling in debug from a browser.

Running an application in debug mode is useful when an application is under development. For production applications, Oracle recommends disabling debugging and thus preventing users from viewing application logic.

Debug can be enabled programmatically regardless of this debug setting. If the application is run from the APEX development environment, debugging can always be enabled.

n/a

Controls the compatibility mode of the APEX runtime engine. Certain runtime behaviors change from release to release. To not break or change the behavior of existing applications, this attribute is automatically set during upgrade if necessary.

Use this attribute to obtain specific application behavior. To keep applications maintainable, set Compatibility Mode to the latest release after reviewing the changed behavior in the Release Notes and making the necessary changes.

Note: In order to refresh any theme in the current release, you must set Compatibility Mode to 21.2 to 24.1.

See:

• For more information see Changed Behavior, Compatibility Mode in Oracle APEX Release Notes.
• Updating App Compatibility Mode

Determines whether APEX renders the legacy SPAN-based elements for an item's read-only mode, or the more accessible readonly input or textarea elements. The more accessible input and textarea elements are focusable with the keyboard, and easier to perceive for screen reader users.

Determines the email address to use as the from address in the application.

Enter a valid email address to use as the from address when sending email from an email download or subscription. The value can be a literal string containing a valid email or a static substitution reference defined in the application using substitution syntax APP_EMAIL. Examples:

john.doe@abc.com
&MY_APP_EMAIL_FROM.

Oracle does not recommend using an item substitution at the application or page-level since it only works in email download, but not for subscriptions.

Tip: You can also specify the Email from Address by editing interactive report attributes. See About Emailing from an Interactive Report.

n/a

Specify a proxy server.

For example, App Builder may require a proxy server when using a region source type of URL. The URL region source embeds the results of the URL (that is, the page returned by navigating to the URL) as the region source. If you use a firewall and the target of a URL is outside the firewall relative to App Builder, you may need to specify a proxy server.

You can reference values entered into this field from PL/SQL using the PL/SQL package variable APEX_APPLICATION.G_PROXY_SERVER.

For example:

www-proxy.company.com

n/a

Select the Text Query Function type.

The Oracle Text query syntax is very complex and powerful and provides a rich set of query operators to deal with wildcards, stemming, fuzzy searches, and so forth. For end users, this syntax is often hard to understand. You can select a function to convert simple end user input to an Oracle Text query with the advanced search features automatically applied.Text Query Function options include:

• None - No query conversion function is used. The end user's input is passed directly to the Oracle Text search.

• Search Engine - This function performs a query relaxation search to retrieve relevant results beyond just exact matches. The goal is to get as many related results as possible, allowing users to easily find related information without needing to input precise queries. The search process begins with an exact match search and then progressively relaxes the query using techniques like stemming and fuzzy matching. While maximizing the number of results, the search engine function ensures that the most exact and relevant matches are always ranked at the top of the search results.

• Expert Search - This function supports more advanced search operators for precise queries. It allows exact matching, Boolean operators (AND, OR, NOT), precedence with parentheses and proximity search. Additional parameters allow customizing search behavior. This is best when requiring highly accurate results from very specific queries.

• Custom - Provide a custom function.

  In Custom Function Name, you can specify the name of a PL/SQL function which converts end user input to an Oracle Text query. The function takes the end user input as VARCHAR2 and returns the Oracle Text query as a result

  Example - Query Relaxation

  This example makes use of Oracle Text Query Relaxation and is transparent to the end user. This example first executes the exact query and then it performs increasing levels of fuzzy search, until the requested amount of rows is returned.

  create or replace function convert_end_user_search (
      p_search in varchar2 )
      return varchar2
  is
      c_xml constant varchar2(32767) :=
          '<query><textquery><progression>' ||
            '<seq> #SEARCH# </seq>' ||
            '<seq> FUZZY(#SEARCH#,80, 100,W) </seq>' ||
            '<seq> FUZZY(#SEARCH#,50,1000,W) </seq>' ||
            '<seq> FUZZY(#SEARCH#,20,3000,W) </seq>' ||
          '</progression></textquery></query>';
  
      l_search varchar2(32767) := p_search;
  begin
      --
      -- remove special characters;
      -- these are irrelevant for full text search
      --
      l_search := regexp_replace(
          srcstr => l_search,
          pattern => '[<>{}/()*%&!$?.:,;\+#]' );
  
      return replace(
          srcstr => c_xml,
          oldsub => '#SEARCH#',
          newsub => '{' || l_search || '}' );
  end;

See:

• If Text Query Function is Expert Search, see APEX_SEARCH, QUERY_EXPERT_SEARCH in Oracle APEX API Reference.

• If Text Query Function is Custom, see Understanding Oracle Text Application Development in Oracle Text Application Developer's Guide

Specify how the search terms are applied when a row search is performed within a component.

Selecting On treats each word of a search term separately and matches a record where the words are contained in any of the columns, together or independently. To search for an exact phrase, use a quotes (") around the search terms. For example, "ui developer". To escape a double quote in a search term, use a double quote ("").

Examples:

• Search for any record including the words "red" and "shoes"

  Search term: red shoes

• Search for any record including the word "developer" and the exact expression "ui designer"

  Search term: developer "ui designer"

• Search for any record including the word "author" and the exact expression "the sky is "blue" and nice"

  Search term: author "the sky is ""blue"" and nice"

Selecting Off treats the whole search term as an exact match.

n/a

Provide the maximum number of scheduler jobs being available for background execution of page processes for this application. Only the configured number of jobs will run at the same time, to execute page processes for this application in the background. If the configured maximum amount of scheduler jobs is active, new submitted executions will wait until a job becomes available.

Setting the attribute to zero disables background executions; new submitted executions will stay in enqueued state.

"Configuring Limits for Concurrently Running Scheduler Jobs" in About Background Page Processes

Status

Specifies whether the application is available or unavailable for use. Options include:

• Available - Application is available with no restrictions.

• Available with Developer Toolbar - Application is available for use. For developers, the Developer Toolbar displays on each page. Requires the developer to be logged in to App Builder in the same browser session.

• Available to Developers Only - Application is available to users having developer privileges.

• Restricted Access - Application is available to developers named in the Restrict to comma separated user list.

• Unavailable - Application cannot be run or edited. The message in Message for unavailable application displays when users attempt to access the application.

• Unavailable (Status Shown with PL/SQL) - Application cannot be run or edited.

• Unavailable (Redirect to URL) - Application cannot be run. The user is linked to the URL entered in Message for unavailable application.

Build Status

Identifies the build status of the current application. Options include:

• Run and Build Application - Developers and users can both run and develop the application.

• Run Application Only - Users can only run the application. This option is intended for applications in a production instance.

See Changing Application Build Status in Administration Services in Oracle APEX Administration Guide

Message for unavailable application

Use this attribute with Status. If you set Status to Unavailable, Unavailable (Status Shown with PL/SQL), or Unavailable (Redirect to URL) , the text you enter in this attribute displays. If you set Status to Available, the text you enter in this attribute does not display.

n/a

Restrict to comma separated user list (status must equal Restricted Access)

Use this attribute with the Status Restricted Access. If you set Status to Restricted Access, only the users listed in this attribute can run the application.

To use this attribute:

1. From the Status list, select a restricted status.

2. Enter a comma-delimited list of users who can run the application in the field provided.

3. Click Apply Changes.

n/a

Identifies where the validation error messages display for basic validations performed by Oracle APEX or by plug-ins. Validation error messages can display in a notification area (defined as part of the page template), or within the field label. Options include:

• Inline with Field and in Notification - Error messages display in a notification area defined as part of the page template.
• Inline with Field - Error messages display within the field label.
• Inline in Notification - Displays in the #NOTIFICATION_MESSAGE# template substitution string when an error occurs on the page.

Enter the name of a PL/SQL error function to be called to modify the existing error message and display a more user-friendly message or log the error if one occurs. This function can reference a package function or standalone function in the database. For example:

log_apex_error

When referencing a database PL/SQL package or standalone function, use the #OWNER# substitution string to reference the parsing schema of the current application. For example:

#OWNER#.log_apex_error

You must implement error handling functions using the syntax described in the apex_error package.

function <name of function> (
    p_error in apex_error.t_error )
    return apex_error.t_error_result

Note: Error handling specified at the page-level overwrites any error handling function specified here.