1. App Builder User's Guide
  2. Managing Shared Components
  3. Managing Application Settings

16.4 Managing Application Settings

Create Application Settings to define application-level configuration options.

Tip:

You also use the APEX_APP_SETTING API to access application settings. See APEX_APP_SETTING in Oracle APEX API Reference.

Parent topic: Managing Shared Components

16.4.1 Creating an Application Setting

Create an Application Settings to enable developers to define application-level configuration options.

To create an Application Setting:

  1. Navigate to the Shared Components page:
    1. On the Workspace home page, click App Builder.
    2. Select an application.
    3. On the Application home page, click Shared Components.

      The Shared Components page appears.

  2. Under Application Logic, select Application Settings.
  3. Click Create Setting.
  4. On Application Setting:
    1. Name - Enter a descriptive name for this application setting.
    2. Value - Enter the default value for this application setting.
    3. Value Required - Select whether this Application Setting requires a value. Select On or Off.
    4. Valid Values - Enter comma separated valid values. If defined, APEX only accepts valid values when the settings change.
    5. On Upgrade Keep Value - Select whether the application setting value in the deployed application should be kept, or overwritten with the specified value when the application is upgraded. Selecting On to keep the deployed value is useful if the application supports application setting configuration (using the APEX_APP_SETTING.SET_VALUE API) to change the application setting value in the deployed application, and where you want to respect those values upon upgrade.
    6. Comments - Enter comments that describe this setting.
  5. Click Create Application Setting.

    The new Application Setting displays on the Application Settings page.

Parent topic: Managing Application Settings

16.4.2 Editing or Deleting Application Setting

Edit or delete an existing setting on the Application Settings page.

To edit or delete an Application Setting:

  1. Navigate to the Shared Components page:
    1. On the Workspace home page, click App Builder.
    2. Select an application.
    3. On the Application home page, click Shared Components.

      The Shared Components page appears.

  2. Under Application Logic, select Application Settings.
    The Application Settings page appears.
  3. To edit an existing setting:
    1. Select the setting.
      The Application Setting dialog appears.
    2. Edit the appropriate attributes.
      To learn more about an attribute, see field-level Help.
    3. Click Apply Changes.
  4. To delete an existing setting:
    1. Select the setting.
      The Application Setting dialog appears.
    2. Click Delete.

Parent topic: Managing Application Settings

16.4.3 Copying or Subscribing to Application Settings

Copy an application setting from the current application or from another application. When copying an application setting from another application, you can also subscribe to it.

To copy an application setting:

  1. Navigate to the Shared Components, Application Settings page:
    1. On the Workspace home page, click App Builder.
    2. Select an application.
    3. On the Application home page, click Shared Components.

      The Shared Components page appears.

    4. Under Application Logic, select Application Settings.

      The Application Settings page appears. Note that the report includes the following columns: Subscribed From, Subscription Status, and Subscribers.

  2. To copy an application setting within the current application:
    1. Search for the application setting and click Copy in the Copy column.
      The Copy Application Setting Wizard appears.
    2. New Application Setting Name - Enter the name of the application setting. Application setting name must be unique within the application.
    3. Click Copy Application Setting.
  3. To copy an application setting from another application:
    1. From the Tasks region on the Application Settings page, click Copy from another app.
      Copy Application Setting Wizard appears.
    2. Application - Select the application from which you want to copy.
    3. Copy Application Setting - Select the application setting to copy.
    4. Subscribe - Enable this flag to subscribe to the application setting.
    5. Click Copy Application Setting.

    Note:

    While copying an application setting from another application, build option dependency is automatically resolved during the copy process. To learn more see About Automatic Dependency Resolution.

See Also:

Using Shared Component Subscriptions

Parent topic: Managing Application Settings

16.4.4 Subscribing to a Application Settings

Subscribe to application settings on the Application Settings page.

Subscriptions enable developers to reuse shared components across several applications in a workspace. To learn more about shared component subscriptions, see Using Shared Component Subscriptions.

Tip:

You can also subscribe to an application setting by copying it and enabling the Subscribe option. See Copying or Subscribing to Application Settings.

To subscribe to application settings in the current application:

  1. Navigate to the Application Settings page:
    1. Navigate to the Workspace home page.
    2. Click the App Builder icon.
    3. Select an application.
    4. On the Application home page, click Shared Components.
    5. Under Application Logic, click Application Settings.

      The Application Settings page appears. Note that the report includes the following columns: Subscribed From, Subscription Status, and Subscribers.

  2. Select an application setting.
    The Application Settings page appears.
  3. To subscribe to an application setting:
    1. Find the Subscription region.
    2. Subscription, Subscribe From - Select a master application setting to subscribe to and click Apply Changes.
    3. Confirm your selection and click Subscribe.

      The subscribed component is automatically refreshed from the selected master.

  4. To refresh a subscription:
    1. Find the Subscription region.
    2. Click Apply Changes.
    3. Subscription, Refresh Application Settings - If the application setting is already subscribed, click Refresh Application Settings.
  5. To unsubscribe from an application setting:
    1. Find the Subscription region.
    2. Subscription, Unsubscribe - Click Unsubscribe.

Parent topic: Managing Application Settings