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 Automatic Dependency Resolution
  Learn about the automatic copy of dependent shared components.
• Subscribing to a Shared Component
  Learn about subscribing to a shared component
• About Subscribed Component Subscription Status
  Learn about the Subscription Status of subscribed shared components.
• Unsubscribing to a Shared Component
  Unsubscribe to a shared component on the shared component edit page.
• 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.

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.

The functionality explained in this section is applicable to following shared components:

• Application Items
• Application Processes
• Application Computations
• Application Settings
• Build Options
• Application Access Control (Roles)
• Email Templates
• Report Layouts
• 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 or deleted.
• To make modifications, make changes to the master shared components. You can then push the changes to subscribed components by publishing it. Alternatively you can also refresh individual subscribed shared components using the provided Refresh option.

16.3.2 About Automatic Dependency Resolution

Learn about the automatic copy of dependent shared components.

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

The following table describes shared components that have dependents.

Shared Component Type	Dependent Shared Components
Application Computation	Build Option
Application Item	Build Option
Application Process	Build Option Authorization Scheme Application Item (if the computation is based on an Application Item)
Application Settings	Build Option

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 name. If it exists, then APEX re-uses the dependent shared component.
2. If the dependent shared component does not exist with the same name:
   • 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 on the shared component edit page, or while copying the shared component from another application.

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.

   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. To subscribe to a shared component from the shared component edit page:
   1. On the shared component edit page, find the Subscription region.
   2. Subscription, Subscribe From - Select a master shared component to subscribe to and click Apply Changes.

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

   3. Subscription, Refresh shared component - If the shared component is already subscribed, click Refresh shared component.
   4. Click Apply Changes.

   Tip:

   You can also subscribe to a shared component during the copy process. To learn more, see the copy discussion for the respective shared component.

16.3.4 About Subscribed Component Subscription Status

Learn about 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.

The Subscription Status displays in the Subscription Status column on the shared component page as showing in the example that follows.

Description of the illustration subscription_status.png

In the previous example, the subscribed shared component My Build Option has a Subscription Status of Needs refresh.

The Subscription Status also appears on the shared component edit page in the Subscription region.

See Also:

Refreshing a Subscribed Shared Component

16.3.5 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.

16.3.6 Refreshing a Subscribed Shared Component

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

If a master shared component has changes, 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 page.

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 refresh all shared components subscriptions:
   1. On the Shared Components page, find the Tasks region on the side bar.
   2. Under Tasks, click Refresh Subscriptions.
   3. On the Refresh Subscriptions page, click 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.

16.3.7 Publishing a Master Shared Component

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

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.

6. Click Apply Changes.