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

16.6 Managing Component Settings

Use Component Settings to set application level values for built-in APEX components and installed plug-ins.

Tip:

The Component Settings in your environment will vary based on the currently selected application.

Parent topic: Managing Shared Components

16.6.1 Configuring Component Settings

Configure Component Settings to set application-level values for built-in APEX components and installed plug-ins.

Tip:

To learn more about a specific component type, see the topics that follow.

To configure Component Settings:

  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.

    Tip:

    You can also access Shared Components from Page Designer by clicking Shared Components (Shared Components) on the Page Designer toolbar.
  2. Under Other Components, click Component Settings.
  3. On the Component Settings page, click the component name.
  4. On Component Settings, configure the appropriate settings.

    To learn more about a specific setting, see item Help.

  5. Subscription:
    • Subscribe From - Select a master component to subscribe from. When you select a master component and click on the Apply Changes, the component settings is automatically refreshed from the selected master.

      If the component setting is already subscribed, then click Refresh Component Settings to refresh the component settings from the master component.

  6. Click Apply Changes.

Parent topic: Managing Component Settings

16.6.2 Configuring Checkbox

Configure the default value stored in a page item for an enabled or disabled checkbox in Component Settings, Checkbox.

To configure the default value stored in a checkbox page item:

  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 Other Components, click Component Settings.
  3. On the Component Settings page, click Checkbox.
  4. Settings:
    1. Checked Value - Enter the value stored in the page item if the end user checks the checkbox. The value can be up to 255 characters long.
    2. Unchecked Value - Enter the value stored in the page item if the user deselects the checkbox. This attribute can also be left blank if you want to store NULL when checked. The value can be up to 255 characters long.
  5. Subscription:
    • Subscribe From - Select a master component to subscribe from. When you select a master component and click on the Apply Changes, the component settings is automatically refreshed from the selected master.

      If the component setting is already subscribed, then click Refresh Component Settings to refresh the component settings from the master component.

  6. Click Apply Changes.

Parent topic: Managing Component Settings

16.6.3 Configuring Color Picker Display

Configure the default display behavior for a Color Picker in Component Settings, Color Picker.

To configure the default display behavior for a Color Picker:

  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 Other Components, click Component Settings.
  3. On the Component Settings page, click Color Picker.
  4. Settings:
    1. Display As - Select how the color picker displays. Options include:

      • Popup - A color can be entered in the text field or chosen from the popup color picker.

      • Inline - A color picker is shown inline.

      • Color-only Popup - A button opens a popup color picker.

      • Native Color Picker - A native browser color input. The UI is dependent on the browser.

    2. Mode - Select the amount of information shown in the color picker. Options include:

      • Simple - Shows just the color spectrum controls and color presets if any are defined.

      • Full - Shows additional fields to view or enter colors as Hex, HSL, or RGB values with optional Alpha value depending on Return Value As. Also shows the Initial and Current colors.

  5. Subscription:
    • Subscribe From - Select a master component to subscribe from. When you select a master component and click on the Apply Changes, the component settings is automatically refreshed from the selected master.

      If the component setting is already subscribed, then click Refresh Component Settings to refresh the component settings from the master component.

  6. Click Apply Changes.

Parent topic: Managing Component Settings

16.6.4 Configuring Date Picker

Configure default Date Picker behavior in Shared Components, Component Settings.

To configure default Date Picker behavior:

  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 Other Components, click Component Settings.
  3. On the Component Settings page, click Date Picker.
  4. Settings:
    1. Appearance & Behavior - Control the appearance and behavior of the calendar used to select dates. Only applies to Date Pickers when Display As is either Popup or Inline.

      Options include:

      • Show Week - Determines if the week of the year is shown.

      • Month Picker- Controls if the month is rendered as a button which allows selection instead of text.

      • Year Picker- Determines whether the year is rendered as a button which allow selection instead of text.

      • Paginate by Multiple Months - Determines whether the pagination size when displaying several months is only one month or the number of months.

      • Show Today Button - Controls whether the today button displays to select the current date.

      • Show Clear Button - Controls whether the clear button displays to clear the value of the date picker. Note: This is only used when Display As is Inline.

    2. Days Outside Month - Dictates the behavior of days outside the current viewing month. Only applies to Date Pickers when Display As is either Popup or Inline.

      Options include:

      • Hidden - Days outside the current viewing month will be hidden.

      • Selectable - Days outside the current viewing month will be visible and selectable.

      • Visible - Days outside the current viewing month will be visible.

    3. Time Increment - Time increment in minutes used by the time selection control. Use this attribute to select the time of increments that can still be manually entered and saved. Only applies to Date Pickers when Display As is either Popup or Inline.
    4. Show On - Controls when the calendar popup displays. Only applies to Date Pickers when Display As is Popup.

      Options include:

      • Item Focus - When the item receives focus or when the calendar icon is clicked.

      • Icon Click - Only when the calendar icon is clicked.

  5. Subscription:
    • Subscribe From - Select a master component to subscribe from. When you select a master component and click on the Apply Changes, the component settings is automatically refreshed from the selected master.

      If the component setting is already subscribed, then click Refresh Component Settings to refresh the component settings from the master component.

  6. Click Apply Changes.

Parent topic: Managing Component Settings

16.6.5 Configuring Geocoded Address

Configure Geocoded Address behavior in Component Settings, Geocoded Address.

A Geocoded Address item provides geocoding functionality that turns a postal address to a coordinate. To learn more, see Managing Page Items and Geocoded Address.

To configure default Geocoded Address behavior:

  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 Other Components, click Component Settings.
  3. On the Component Settings page, click Geocoded Address.
  4. Settings:
    1. Geocoder Match Mode - Determines how closely the attributes of an input address must match the data being used for geocoding. Options include:

      • Exact - All provided address parts must match. However, if the house number, street name, or street type do not all match, the first match in the following is returned: postal code, city or town, and state. For example, if the street name is incorrect but a valid postal code is specified, a location in the postal code is returned.

      • Relax Street Type - The provided street type can be different from the data used for geocoding. For example, Main Street or Main Blvd match Main St, if there is no other Main Blvd or Main Street in the relevant area.

      • Relax House Number - The house number and street type can be different from the data used for geocoding. For example, 123 Main St matches 123 Main Lane and 124 Main St, as long as there are no ambiguities or other matches.

      • Relax Street Name - The base name of the street, the house number, and the street type can be different from the data used for geocoding. For example, Pleasant Vale matches Pleasant Valley as long as there are no ambiguities or other matches in the data.

      • Relax Postal Code - The postal code (if provided), street name, street type and house number can be different from the data used for geocoding.

      • Relax All - The address can be outside the city specified as long as it is within the same county. Also includes the characteristics of Relax Postal Code.

    2. Display As - Select how the geocoding results display. Options include:

      • List View - The results display in a list view.

      • Grid View - The results display in a grid view.

    3. Map Preview - Determines whether to support previewing the geocoded address on a map. Options include:

      • Results Popup - Show the map in the Geocoding results popup, so that users can review the position before selecting a result. This is only supported when Display As, Grid View is enabled.

      • Item - Show a map visualizing the address location at the item position.

    4. Background - Select an out-of-the-box map background or choose a custom map background defined in Shared Components. Options include:
      • Default - Use the default map background. (either OpenStreetMap Bright or OpenStreetMap Dark for dark themes).
      • OpenStreetMap Bright - General purpose basemap based on OpenStreetMap data. This basemap style provides detailed location context for your data.
      • OpenStreetMap Dark - Non-obtrusive dark basemap based on OpenStreetMap data. This basemap style accentuates visualizations of your data.
      • OpenStreetMap Positron - Non-obtrusive light basemap based on OpenStreetMap data. This basemap style accentuates visualizations of your data.
      • Oracle World Map - General purpose basemap based on HERE Map data. This base map style provides location context for your data and accentuates visualization of your data.
      • Shared Component - Use custom map backgrounds defined in Shared Components.

      Note:

      To learn more about contributors and licensing for out-of-the-box map backgrounds, or to view them on Gitbub, see item Help.
    5. Custom Background - Only displays if Background is set to Shared Component. Select a background map to use.
    6. Height - Specify the height (in pixels) of the displayed map. Map's default height is calculated based on it's width with an 3:2 aspect ratio.
  5. Subscription:
    • Subscribe From - Select a master component to subscribe from. When you select a master component and click on the Apply Changes, the component settings is automatically refreshed from the selected master.

      If the component setting is already subscribed, then click Refresh Component Settings to refresh the component settings from the master component.

  6. Click Apply Changes.

Parent topic: Managing Component Settings

16.6.6 Configuring Interactive Report Action Menu Structure

Configure if interactive reports use the new Action Menu or keep the legacy structure from earlier releases.

The structure of the interactive report Actions menu has changed to be consistent with interactive grids.

To configure how the Actions menu displays in interactive reports:

  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 Other Components, click Component Settings.
  3. On the Component Settings page, click Interactive Report.
  4. Settings, Actions Menu Structure - Specify how the Actions menu displays in interactive reports. Options include:

    Options include:

    • Interactive Grid - Select Interactive Grid to have the interactive report Actions menu match interactive grid.

    • Legacy - Select Legacy to have the interactive report Actions menu use the legacy structure.

  5. Subscription:
    • Subscribe From - Select a master component to subscribe from. When you select a master component and click on the Apply Changes, the component settings is automatically refreshed from the selected master.

      If the component setting is already subscribed, then click Refresh Component Settings to refresh the component settings from the master component.

  6. Click Apply Changes.

Parent topic: Managing Component Settings

16.6.7 Configuring Vector Tile Layers for Maps

Configure Map component settings to include Vector Tile Layers as the background map.

Some of the background maps are also available as Vector Tile Layers which include the layers: OpenStreetMap Position, OpenStreetMap Bright, and OpenStreetMap DarkMatter. Vector maps provide superior resolution over raster maps for all map zoom levels. Started with Oracle APEX release 22.2, all new applicationsVector Tile Layer usage is enabled by default. For aapplications created before release 22.2, you must enable Vector Tile Layers in Shared Components, Component Settings.

To enable Vector Tile Layers for maps:
  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 Other Components, click Component Settings.
  3. On the Component Settings page, click Maps.
  4. Settings, Use Vector Tile Layers - Select Yes to use Vector Tile Layers as the background map. If maps.oracle.com provides a Vector Tile Layer for the chosen background map and this attribute is enabled, the map region will use it.
  5. Subscription:
    • Subscribe From - Select a master component to subscribe from. When you select a master component and click on the Apply Changes, the component settings is automatically refreshed from the selected master.

      If the component setting is already subscribed, then click Refresh Component Settings to refresh the component settings from the master component.

  6. Click Apply Changes.

Parent topic: Managing Component Settings

16.6.8 Configuring Open AI Assistant

Configure Open AI Assistant component settings to set application-level values for the Open AI Assistant plug-in.

Configure the Open AI Assistant Settings to change the AI Avatar and User Avatar that display in Open AI Assistant.

To configure Open AI Assistant:
  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 Other Components, click Component Settings.
  3. On the Component Settings page, click Open AI Assistant.
  4. Settings, AI Avatar Type - Select the type of avatar for the AI assistant. Options include:

    Depending upon the option you select, additional settings appears.

    • Default
    • Icon Classes - If selected, enter the Icon Classes.
    • Image URL- If selected, enter the Image URL.
    • Initials - If selected, enter the Image URL.
  5. User Avatar Type - Select the type of avatar for the current application user. Options include:

    Depending upon the option you select, additional settings appears.

    • Default
    • Icon Classes - If selected, enter the Icon Classes.
    • Image URL- If selected, enter the Image URL.
    • Initials - If selected, enter the Image URL.
  6. Subscription:
    • Subscribe From - Select a master component to subscribe from. When you select a master component and click on the Apply Changes, the component settings is automatically refreshed from the selected master.

      If the component setting is already subscribed, then click Refresh Component Settings to refresh the component settings from the master component.

  7. Click Apply Changes.

Parent topic: Managing Component Settings

16.6.9 Configuring an Oracle Cloud Applications (SaaS) REST Service

Specify a sandbox name for use in App Builder and at runtime when using a Oracle Cloud Applications (SaaS) REST Service.

To configure a sandbox for use in the App Builder and at runtime when using this Oracle SaaS REST service.:

  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 Other Components, click Component Settings.
  3. On the Component Settings page, click Oracle Cloud Applications (SaaS) REST Service.
  4. Settings, Sandbox Name - Provides the name of a metadata sandbox (if any) to use in the App Builder and at runtime when using this Oracle SaaS REST service. .

    Oracle SaaS REST endpoints automatically reflect application customizations made to the system. If you need to develop an APEX application against in progress customizations being made in a named metadata sandbox, enter a case sensitive name of the sandbox that APEX should use. If the value is null, then APEX works with the version of the REST service that only reflects published customizations

  5. Subscription:
    • Subscribe From - Select a master component to subscribe from. When you select a master component and click on the Apply Changes, the component settings is automatically refreshed from the selected master.

      If the component setting is already subscribed, then click Refresh Component Settings to refresh the component settings from the master component.

  6. Click Apply Changes.

See Also:

Working Against a Sandbox

Parent topic: Managing Component Settings

16.6.10 Dynamically Adding Sliders to Regions

Dynamically add a slider to regions if the displayed region name exceeds the width of the region by configuring the Component Settings, Region Display Selector.

To dynamically add a slider to a region if the displayed region name exceeds the width of the region:

  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 Other Components, click Component Settings.
  3. On the Component Settings page, click Region Display Selector.
  4. Settings, Include Slider - Select Yes to dynamically add a slider to the region if the displayed region name exceeds the width of the region.
  5. Subscription:
    • Subscribe From - Select a master component to subscribe from. When you select a master component and click on the Apply Changes, the component settings is automatically refreshed from the selected master.

      If the component setting is already subscribed, then click Refresh Component Settings to refresh the component settings from the master component.

  6. Click Apply Changes.

Parent topic: Managing Component Settings

16.6.11 Configuring Star Rating

Configure default Star Rating behavior in Component Setting, Star Rating.

To configure default Star Rating behavior:

  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 Other Components, click Component Settings.
  3. On the Component Settings page, click Star Rating.
  4. Settings:
    1. Default Icon - Choose the default icon to use (such as fa-star, fa,-thumbs-up, or fa-database).
    2. Active Color - Choose the default color for active stars.
    3. Inactive Color - Choose the default color for inactive stars.
    4. Tooltip - Specify the template for the tooltip when end users hover the mouse over the item. This rating value replaces the #VALUE# substitution (for example, the movie rating is #VALUE#).
  5. Subscription:
    • Subscribe From - Select a master component to subscribe from. When you select a master component and click on the Apply Changes, the component settings is automatically refreshed from the selected master.

      If the component setting is already subscribed, then click Refresh Component Settings to refresh the component settings from the master component.

  6. Click Apply Changes.

Parent topic: Managing Component Settings

16.6.12 Configuring Switch Defaults

Configure default Switch item type behavior Component Settings, Switch.

Display options include On/Off switch toggle, pill button, or select list.

To configure default Switch item type behavior:

  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 Other Components, click Component Settings
  3. On the Component Settings page, click Switch.
  4. Settings:
    1. Display Style - Options include:

      • Switch

      • Pill Button

      • Select List

    2. On Value - Enter the value stored in the page item if the end user picks the On option. The value can be up to 255 characters long.
    3. On Label - Enter the text displayed for the On option. If no text is entered, the system default label is used.
    4. Off Value - Enter the value stored in the page item if the user picks the Off option. The value can be up to 255 characters long. This value is used if the page item is populated with a value which does not match either the On Value or Off Value.
    5. Off Label - Enter the text displayed for the Off option. If no text is entered, the system default label is used.
  5. Subscription:
    • Subscribe From - Select a master component to subscribe from. When you select a master component and click on the Apply Changes, the component settings is automatically refreshed from the selected master.

      If the component setting is already subscribed, then click Refresh Component Settings to refresh the component settings from the master component.

  6. Click Apply Changes.

Parent topic: Managing Component Settings

16.6.13 Viewing the Component Settings History Report

View a report of recent modifications made to Component Settings in the current application.

To view the Component Settings History report:

  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 Other Components, click Component Settings.
  3. Click the History tab.

    The History page displays as an interactive report. To customize the report, use the Search bar at the top of the page.

Parent topic: Managing Component Settings