Oracle Portal Development Kit

Moving a provider within a distributed Oracle Portal system

A user must have the All Provider Manage or All Provider Publish privilege to move the provider.

This topic explains how to move a portlet provider from one node to another node while maintaining valid path references in portlet pages. Reasons to move a provider may include load redistribution to increase performance and to logically group providers.

Assumptions:

  • The source and destination nodes belong to the same distributed Oracle Portal, that is, the Oracle Portal nodes are attached within the same Oracle Portal distributed system.

  • Any installation-specific values, such as portlet preference store values and NLS strings, are exported to the destination node before the provider is deregistered from the source node.

Notes:

  • Any installation-specific data that, from the provider perspective, should be retained and made available for the provider's portlets after the provider is moved, must be migrated to the destination node before running wwpro_api_provider_registry.deregister_provider on the source node.

  • Provider developers should take steps both to prevent the loss of data and to appropriately migrate data stored by the provider.
  • Deregistering the provider on the source node causes Oracle Portal to call the provider's internal deregister_provider function for the source node.
  • Registering the provider on the destination node causes Oracle Portal to call the provider's internal register_provider procedure for the destination node.

Provider migration procedure:

  1. Access the source node.

  2. If it is not known, get the provider ID with the wwpro_api_provider_registry.find_provider function or with the Edit a Portlet Provider function on the Administer page of the Portal UI.

    Note: The original provider ID should be used when registering the provider on the new node.

  3. Export all provider-stored data from the source node to the destination node, and store it in a temporary location.

  4. Deregister the provider from the source node with the wwpro_api_provider_registry.deregister_provider procedure or with the Edit a Portlet Provider function on the Administer page of the Portal UI.

  5. Access the destination node.

  6. Register the provider on the destination node. You can do this in two ways: First, you can use the wwpro_api_provider_registry.registry_provider function to register the provider by passing in the original provider ID. Second, you can use the Add a portlet function on the Administration page of the Portal UI to add the provider and then use the Edit a portlet function on the Administration page to change the provider ID to the original provider ID.

  7. Import the provider-stored data that was exported from the original provider location in step 3.

  8. Do any other cleanup of the source node that may be required for your portlets.

Terms and definitions

source node

The original location of the provider being moved.

destination node

The new location of the provider being moved.

Note

A portlet instance is the display of a portlet on a single page. The same portlet may be displayed multiple times on the same page. Each time a portlet is added to a page, the portal generates a unique portlet instance ID that is the instance's reference path.

Related topics