Skip Headers
Oracle® Application Express Application Builder User's Guide
Release 4.2 for Oracle Database 12c

E17961-10
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

16.10 Using Build Options to Control Configuration

Build options enable you to conditionally display specific functionality within an application.

Build options have two possible values: INCLUDE and EXCLUDE. If you specify an attribute as being included, then the Application Express engine considers it part of the application definition at runtime. Conversely, if you specify an attribute as being excluded, then the Application Express engine treats it as if it did not exist.

Topics:

See Also:

"Changing Build Status for Multiple Applications" in Oracle Application Express Administration Guide and discussions of the GET_BUILD_OPTION_STATUS and SET_BUILD_OPTION_STATUS procedures in "APEX_UTIL" in Oracle Application Express API Reference

16.10.1 Creating Build Options

You create a build option for an application on the Build Options page.

To create a build option:

  1. On the Workspace home page, click the Application Builder icon.

  2. Select an application.

  3. On the Application home page, click Shared Components.

  4. Under Logic, click Build Options.

  5. To create a new build option, click Create.

  6. Follow the on-screen instructions.

16.10.2 Managing Build Options

Build options have two possible values: INCLUDE and EXCLUDE. If you specify an attribute as being included, then the Application Express engine considers it part of the application definition at runtime. Conversely, if you specify an attribute as being excluded, then the Application Express engine treats it as if it did not exist.

To include or exclude a build option:

  1. On the Workspace home page, click the Application Builder icon.

  2. Select an application.

  3. On the Application home page, click Shared Components.

  4. Under Logic, click Build Options.

    The Build Options page appears.

  5. You can change the appearance of the page by using the Search bar at the top of the page. Available controls include:

    • Select columns to search - Resembles a magnifying glass. Click this icon to narrow your search. To search all columns, select All Columns.

    • Text area - Enter case insensitive search criteria (wildcard characters are implied) to search for build options by name and then click Go.

    • Go button - Executes a search or applies a filter.

    • View Icons - Displays each build option as a large icon. To edit a build option, click the appropriate icon.

    • View Report - Displays each build option as a line in a report. To edit a build option, click Name.

    • Actions menu - Use the Actions menu to customize the report view. See "About the Actions Menu".

  6. Select a build option name.

    The Create/Edit Build Option page appears.

  7. For Status, select either INCLUDE or EXCLUDE.

16.10.2.1 Selecting a Build Option

Once you create a build option, you can select it for a page, a component (report, chart, or form), a specific page control (button, item, list of value), and another shared component (breadcrumb, list, or tab). You apply build options to a page, component, page control, or shared component by navigating to the appropriate attributes page. Most attributes pages contain a Configuration section where you can select defined build options.

16.10.3 Exporting Build Options or Build Option Status

You can export build options or build option status on the Component Export page. Exporting build option status is an effective way to toggle build options on or off within another environment. For example, you can use this feature to deploy a production application with a hidden feature by associating the components of the hidden feature with a build option having the status of EXCLUDE. After deployment, you can enable the hidden feature by changing the status of the build option to INCLUDE and then exporting the Build Option Status.

Once you apply the Build Options Status to the production instance, the new feature appears.

To export build options or build option status:

  1. Navigate to the Component Export page:

    1. On the Workspace home page, click the Application Builder icon.

    2. Select an application.

    3. Click Shared Components.

    4. From the Tasks list, click Export Application Components.

      The Component Export page appears.

  2. Select the build options to export:

    1. Click the Components tab and select the build options to export.

    2. Click Add to Export.

  3. Select Build Option Status to be exported:

    1. Click the Build Options Status tab and select the build options to export.

    2. Click Add to Export.

  4. Click Next.

  5. On Components to Export:

    1. From File Format, select how rows in the export file are formatted:

      • Choose UNIX to have the resulting file contain rows delimited by line feeds.

      • Choose DOS to have the resulting file contain rows delimited by carriage returns and line feeds.

    2. Use the As of field to export a page as it was previously defined. Specify the number of minutes in the field provided.

      This utility uses the DBMS_FLASHBACK package. Because the timestamp to System Change Number (SCN) mapping is refreshed approximately every five minutes, you may have to wait that amount of time to locate the version for which you are looking. The time undo information is retained and influenced by the startup parameter UNDO_RETENTION (the default is three hours). However, this only influences the size of the undo tablespace. While two databases may have the same UNDO_RETENTION parameter, you are able to go back further in time on a database with fewer transactions because it is not filling the undo tablespace, forcing older data to be archived.

    3. Click Export Components.

16.10.4 Viewing the Build Option Utilization Report

Once you create a build option, a Utilization tab appears on the Build Options page. This report details build option utilization in the current application.

Note:

The Utilization tab only appears on the Build Options page after you create a build option.

To view the Build Option Utilization report:

  1. Navigate to the Build Options page:

    1. Navigate to the Workspace home page.

    2. Click the Application Builder icon.

    3. On the Application home page, click Shared Components.

    4. Under Application, click Build Options.

      The Build Options page appears.

  2. On the Build Options page, click Utilization.

    The Build Option Utilization report appears.

  3. Select a build option and click Go.