30.2 GET_BUILDER_LINK Function

Generate an action fragment or action data attributes to open the APEX Builder window or tab, redirect, and focus on a specific component.

Syntax

APEX_EXTENSION.GET_BUILDER_LINK (
    p_app_id          IN NUMBER,
    p_page_id         IN NUMBER   DEFAULT NULL,
    p_view_name       IN VARCHAR2 DEFAULT NULL,
    p_component_id    IN NUMBER   DEFAULT NULL,
    p_as_data_action  IN VARCHAR2 DEFAULT 'N' )
RETURN VARCHAR2;

Parameters

Parameter	Description
p_app_id	ID of application to open in the Builder
p_page_id	Optional ID of page in application to open. NULL if p_component_id references a shared component, but mandatory if referencing a component defined on a page, like page items, regions, or report columns.
p_view_name	APEX Dictionary view of component identified in p_component_id.
p_component_id	ID of component to focus on in the Designer or redirect to the corresponding edit page in Builder.
p_as_data_action	Default is N, which will generate an action fragment to be used in a href attribute of an anchor element. If set to Y, this function returns the corresponding data attributes for a button action. Note: When set to Y to generate the link as data attributes for a button and referencing the column value as a substitution string, the Escape Special Characters must be switched off for the column that uses the get_builder_link function.

Example

Generates a Builder Backlink url as action fragment for each List Entry of all Lists in the current workspace.

select workspace,
       application_name,
       list_name,
       display_sequence,
       entry_text,
       parent_entry_text,
       apex_extension.get_builder_link(p_app_id       => application_id,
                                       p_page_id      => null,
                                       p_view_name    => 'APEX_APPLICATION_LIST_ENTRIES',
                                       p_component_id => list_entry_id) as backlink
from apex_application_list_entries;