16.3 Using Shared Component Subscriptions

Use subscriptions to reuse shared components across several applications in a workspace.

• About Shared Component Subscriptions
  Learn about shared component subscriptions.
• About the Logic Resolving Dependencies
  Learn about logic resolving dependencies.
• Subscribing to a Shared Component
  Learn about subscribing to a shared component.
• About Subscribed Component Subscription Status
  Learn about viewing the Subscription Status of subscribed shared components.
• Refreshing a Subscribed Shared Component
  Access changes in a master shared component by refreshing the subscribed shared component.
• Publishing a Master Shared Component
  Publish a master shared component to push changes to all subscribing components.
• Unsubscribing to a Shared Component
  Unsubscribe to a shared component on the shared component edit page.

16.3.1 About Shared Component Subscriptions

Learn about shared component subscriptions.

Shared components can display or be applied on any page within an application and are accessible from the Shared Components page in App Builder. Shared component subscriptions enable developers to reuse shared components across several applications in a workspace.

This following shared components support subscriptions:

• Application Access Control (Roles)
• Application Computations
• Application Items
• Application Processes
• Application Settings
• Authentication Schemes
• Authorization Schemes
• Build Options
• Component Groups
• Data Load Definitions
• Email Templates
• Lists
• Lists of Values
• Map Backgrounds
• Plug-ins
• REST Data Source
• Report Layouts
• Search Configuration
• Shortcuts
• Text Messages

Subscribing to a shared component causes the following to happen:

• All the data from the master component and any dependent shared components are copied over to the subscribing shared component.
• The subscribing shared component becomes read-only.
• Only the master shared component can be edited.
• To make modifications, make changes to the master shared components. You can then push the changes to subscribed components by publishing them. Alternatively, you can also refresh individual subscribed shared components using the provided Refresh option.

16.3.2 About the Logic Resolving Dependencies

Learn about logic resolving dependencies.

Shared components that refer other shared components are called dependent shared components.

About the Logic Resolving Dependencies

Shared component dependencies are automatically resolved when:

• Copying a shared component from one application to another application.
• Subscribing to a shared component.
• Refreshing a subscribed shared component.
• Publishing a master shared component.

The logic used to resolve dependencies is as follows:

1. In the destination or subscribing application, APEX engine checks if the dependent shared component exists with the same Static ID. If no component with a matching Static ID is found, APEX attempts to find a component with the same name for component types where name is considered unique and safe to use for identification. If a match is found, then APEX re-uses the dependent shared component.
2. If the dependent shared component does not exist with the same Static ID or name (where applicable):
   • APEX copies the dependent shared component to the destination or subscribing application.
   • While copying, if the Subscribe flag is set to On then the subscription data is also copied.
   • While subscribing, refreshing, publishing, the dependent shared component subscription data is also copied."

16.3.3 Subscribing to a Shared Component

Learn about subscribing to a shared component.

You can subscribe to a shared component during the copy process or for selective shared components on the shared component edit page.

Tip:

To learn more about subscribing to a shared component during the copy process, see the copy discussion for the respective shared component.

To subscribe to a shared component:

1. Navigate to the shared component edit 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:

      Shared component pages can display either in icon or report view. If the page displays in icon view, Oracle recommends changing to report view so you can view the subscription status. Click View Table on the toolbar.
2. To subscribe to a shared component by copying:
   1. From the Tasks list, select Copy from another app.
   2. Copy From Application - Select an application from which to copy the shared component and click Next.
   3. Copy:
      • To Name - Optionally edit the name of the Data Load Definition.
      • Action - Select an Action:
        • Yes - Copy the shared component.
        • No - Do not copy the shared component.
        • Copy and Subscribe - Subscribing to a shared component copies it to your application and sets the master reference.
   4. Click Copy shared component.
3. For some shared components, you can subscribe on the shared component edit page:

   Note:

   This procedure does not apply to REST Data Sources or Data Load Definitions.
   1. Find and access the edit page of the shared component.
   2. Find the Subscription region.
   3. Subscription, Subscribe From - Select a master shared component to subscribe to and click Apply Changes.

      When you select a master shared component and click Apply Changes, the subscribed shared component are be automatically refreshed from the selected master

See Also:

Refreshing a Subscribed Shared Component

16.3.4 About Subscribed Component Subscription Status

Learn about viewing the Subscription Status of subscribed shared components.

Each subscribed shared component has a Subscription Status of either:

• Up to date - Indicates the subscribed shared component is the same as master shared component.

• Needs refresh - Indicates the subscribed component is not same as master and needs to be refreshed.

Tip:

Shared component pages can display either in icon or report view. To view a Subscription Status for all shared components, access table view. On the toolbar, click View Table.

In report view, each shared component page includes the following columns: Subscribed From, Subscription Status, and Subscribers.

Description of the illustration subscription_status.png

In the previous example, the Administration list is subscribed from application 102 and has a Subscription Status of Up to date. The Navigation Bar is also subscribed from application 102 but has a Subscription Status of Needs Refresh.

Tip:

The subscription status also displays on the shared component edit page in the Subscription region.

See Also:

Refreshing a Subscribed Shared Component

16.3.5 Refreshing a Subscribed Shared Component

Access changes in a master shared component by refreshing the subscribed shared component.

If a master shared component has changed, the subscribed shared component has a Subscription Status of Needs refresh and a Refresh button appears on the shared component edit page. The Refresh button does not appear if the subscription status is Up to date.

You can refresh a subscribed shared component on the shared component, edit page, or perform a bulk refresh of all subscriptions by clicking Refresh Subscriptions on the Shared Components, component page.

Note:

The static_id logic has been harmonized across all shared components, including Search Configs, Email Templates, REST Data Sources, and Data Load Definitions. When the static_id changes in the master component, this change will be reflected in the subscribing component after refresh.

To refresh a subscribed shared component:

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

      The Shared Components page appears.

2. To perform a bulk subscription refresh for a specific shared components:
   1. Select the shared component type to be refreshed (or example Lists).
   2. On the components page, find the Tasks region on the side bar.
   3. Under Tasks, click Refresh Subscriptions.
   4. On Refresh Subscriptions, select Refresh All to perform a bulk refresh of all shared components
3. To refresh a specific shared component subscription:
   1. Find and access the edit page of the shared component.

      By default, each shared component page displays as a report. If there are new changes in the master shared component, the Subscription Status changes to Needs refresh.

      To access the edit page, click the shared component name.

   2. On the shared component edit page, find the Subscription region and click the Refresh shared component button.

      The following confirmation message appears:

      shared component refreshed from the master shared component.

16.3.6 Publishing a Master Shared Component

Publish a master shared component to push changes to all subscribing components.

Note:

The Static ID logic has been harmonized for all shared components. When a master component is published, the static_id is updated for Email Templates, REST Data Sources, Data Load Definitions, and Search Configurations.

To publish a master shared component:

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

      The Shared Components page appears.

2. Find and access the edit page of the master shared component.

   By default, each shared component page displays as a report. To access the edit page, click the shared component name.

3. Edit the master shared component.
4. To push the changes to subscribed shared components, under Subscription, click Publish.
5. In the Confirm Publish dialog, click Publish again.
   The following confirmation message appears:

   All subscribing shared components are refreshed.

   Note:

   Applications locked by other developers will not be refreshed.

16.3.7 Unsubscribing to a Shared Component

Unsubscribe to a shared component on the shared component edit page.

To unsubscribe to a shared component:

1. Navigate to the shared component edit 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. Find and access the edit page of the shared component.

      By default, each shared component page displays as a report. To access the edit page, click the shared component name.

2. On the shared component edit page, find the Subscription region and click Unsubscribe.