Skip Headers
Oracle® Fusion Middleware Administrator's Guide for Oracle WebCenter Interaction
10g Release 4 (10.3.3.0.0)

Part Number E14107-04
Go to Documentation Home
Home
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
View PDF

12 Migrating, Backing-Up, and Restoring Your Portal

This chapter describes the steps you take to migrate (export and import), back up, and restore portal objects.

It includes the following sections:

About Object Migration

Object migration lets you copy resources from one portal to another. You might want to do this for several reasons. You might have multiple portals to handle a global deployment or you might want to create multiple portals to separate development, testing, and production.

You can copy resources from one portal to another by creating migration packages, which can be used to:

There are several things you can do to make migration as easy and effective as possible:

Note:

User preferences for associated with add-on products, such as Oracle WebCenter Collaboration, are not migrated with the user.

The Migration - Export utility in the portal lets you create migration packages. To import objects from a migration package, you use the Migration - Import utility.

Migration Feature Description

Portal objects that can be included in the package

All objects

Oracle WebCenter Collaboration information

Can migrate Oracle WebCenter Collaboration information

Requests and approval

Users with at least Edit access to objects can request migration, but only members of the Administrators group can approve objects for migration.

An administrator selects approved objects to add to a migration package, and can also add object to the package without making a migration request.

Users with the Access Utilities activity right can check the status of their migration requests.

Creating a migration package

Only users with the Access Utilities activity right can create a migration package.

An administrator can add objects that do not have migration requests to a migration package (bypassing the request and approval process).

Object dependencies

Dependencies always maintained. Dependent objects can be included in a migration package, but do not must be.

Unique universal identifiers (UUIDs) and their effect on subsequent importing migration packages

By default UUIDs are maintained, so that subsequent migrations overwrite previously migrated objects. However, if you do not want to overwrite previously migrated objects, you have the option of creating a new instance of the same object, with a new UUID.


Migrating Objects

This section describes the following tasks:

Requesting That an Object Be Migrated

You can request that an object be added to a migration package to be exported to another portal.

Note:

You must have at least Edit access to the object for which you want to request migration.

  1. Search for the object or click Administration and navigate to the object.

  2. Select the object and click the Migrate icon.

  3. In the Script Prompt dialog box, describe why you want this object migrated and click OK.

To view the status of your migration request, open the object's editor and click the Migration History and Status page. Under Migration Status, you see whether your request is waiting for approval, has been approved, or has been rejected, as well as your comments and any comments from the portal administrator approving or rejecting the object.

Approving Objects for Migration

When users want an object to be migrated, they submit a migration request. A portal administrator can then approve the request, and the object is added to the migration package.

There are two ways to approve objects for migration: in the object's editor or using the Approve Objects for Migration Utility.

Approving an Object for Migration

When users want an object to be migrated, they submit a migration request. A portal administrator can then approve the request, and the object is added to the migration package.

  1. Open the object's editor by creating a new object or editing an existing object.

  2. Click the Migration History and Status page.

    Under Migration Status, you see whether this object has been requested for migration, and, if so, whether it is waiting for approval, has been approved, or has been rejected.

  3. If you are a member of the Administrators group, and you want to add this object to the migration package to be migrated to another portal, select Approve this object for migration.

    Note:

    Users who are not members of the Administrators group do not see this option.

After approving objects for migration, you can use the Migration - Export Utility to create a migration package.

Approving Objects for Migration Through the Administrative Utility

When users want an object to be migrated, they submit a migration request. A portal administrator can then approve the request, and the object is added to the migration package.

To use the Approve Objects for Migration Utility you must be a member of the Administrators Group.

Creating a Migration Package in the Portal

You can create a migration package that includes portal resources as well as Oracle WebCenter Collaboration information.

To create a migration package, you must be a member of the Administrators group.

  1. Click Administration.

  2. In the Select Utility list, click Migration - Export.

  3. On the Portal Resources page, perform tasks as necessary:

  4. On the Package Settings page, perform tasks as necessary:

  5. On the Add Existing Package Resources page, perform tasks as necessary:

  6. Click Finish.

    A status message is displayed as the migration package is being created. When the migration package is created, you can download it to your desktop.

    Note:

    If you are also migrating Oracle WebCenter Collaboration objects, those will be written to a .zip file on the computer where Oracle WebCenter Collaboration is installed. You must move this file from this location to the target location.

You can now use the migration package to import the migrated resources into another portal.

Specifying a Name, Description, and Contact for a Migration Package

You must specify a name, description, and contact person for a migration package.

To create a migration package, you must have at least Edit access to the objects you want to add to the package.

  1. If the Migration — Export Utility is not already open, open it now.

  2. Click the Package Settings page.

  3. In the Package name box, type the name for the package file that will be created when you click Finish (this file is given a .pte extension).

  4. In the Package description box, type a description that clarifies the purpose of this export package to other portal administrators.

  5. In the Publisher name box, type the person to contact with any questions about this export package.

Selecting Objects to Export in a Migration Package

You can select objects to export on the Portal Resources page of the Migration — Export Utility.

To create a migration package, you must have at least Edit access to the objects you want to add to the package.

  1. If the Migration — Export Utility is not already open, open it now and display the Portal Resources page.

  2. Under Resources, select the objects you want to add and what you want to export.

  3. To select individual objects, select the type of object from the Select Resources list, then, in the dialog box, select the objects you want to add and click OK.

  4. To add all objects that have been approved for migration, click Add All Approved.

  5. If the object is a folder and you want to export the folder's contents, select Export Contents.

  6. To export the object's dependencies, select Export Dependencies.

    Dependencies are any other objects that are required by the object you are exporting.

  7. To remove an object, select the object and click the Remove icon.

    To select or clear all of the object check boxes in a column, select or clear the check box above the column.

  8. To toggle the sort order of the objects, click Resources.

  9. Under Export Settings, select the check box if you also want to export parent folders of objects you marked for Export Dependencies.

    If you do not select this option, only references to those parent folders will be exported.

Adding Resources from Another Migration Package

You can add objects from an existing migration package to the package you are creating on the Add Existing Package Resources page of the Migration — Export Utility.

To create a migration package, you must have at least Edit access to the objects you want to add to the package.

Note:

If the portal settings on an object in the existing migration package have changed since the package was created, the current portal settings on the object will be exported.

  1. If the Migration — Export Utility is not already open, open it now and display the Add Existing Package Resources page.

  2. Under Migration Package, specify the package from which you want to add objects.

    • To browse to a package on your computer or in your network, click Browse, select the migration package file (a .pte file), and click Open.

    • To get the package from a Web address, select Web Address and type the URL to the package.

      If you must enter login credential to access the Web address, type the information in the Username and Password boxes.

  3. Click Load Package.

    Note:

    Only objects that are currently in the portal will be displayed on the Portal Resources page.

Select resources from this package on the Portal Resources page.

Creating a Migration Package Using the Command Line Tool

You can create a migration package to export portal objects from one portal to be imported into another portal.

Note:

You cannot export Oracle WebCenter Collaboration objects using the command line tool. To export those objects, use the Migration - Export Utility in the portal. See Creating a Migration Package in the Portal.

  1. Log in to the host computer for the portal as the user who owns the portal installation.

  2. Use the command ptmigration.bat (for Windows) or ./ptmigration.sh (for UNIX) with the following parameters:

    ./ptmigration.sh [username] [password] -export [migration_package_name] [log_file_name] <-exportdependencies>
    

    Where the parameters are as follows:

    Parameter Description

    migration_package_name

    Required. The name and path of the migration package to be created

    log_file_name

    Required. The name and path of the log file to be created. The path to the log file must be different from that of the migration package.

    -exportdependencies

    Optional. Use this parameter to export any additional objects upon which the objects you are exporting depend.


  3. Press ENTER.

    All objects approved for migration are exported into the migration package. The migration utility updates the migration status in the source portal.

Importing Objects in the Portal

You can import objects from another portal using the Migration — Import Utility.

Before you import a migration package (.pte file), place the package to a location that is accessible over your network.

Notes:

  • If you are also importing Oracle WebCenter Collaboration objects, you must place the .zip file in the same location as the .pte file.

  • If you are importing a migration package created with a previous version of Oracle WebCenter Interaction and the migration package includes users, you must either manually edit the user's password in the administrative user interface or you must export the users and import them again. Previously passwords were saved as clear text and are therefore not supported in the current version.

To import a migration package you must be a member of the Administrators group.

  1. Click Administration.

  2. In the Select Utility list, click Migration - Import.

  3. On the Package Settings page, perform tasks as necessary:

  4. Click the Unresolved Dependencies page and complete the following task:

    Note:

    This page appears only if there is an unresolved dependency.

  5. On the Portal Resources page, perform tasks as necessary:

  6. Click Finish.

    A status message is displayed as the migration package is being created. When the migration package is created, you can download it to your desktop.

Specifying the Location and Import Settings for the Migration Package

To import objects you specify the location of the migration package and what you want you want to import.

To import a migration package, you must have at least Edit access to the objects you want to add to the package.

  1. Under Migration Package, specify the package from which you want to add objects.

    • To browse to a package on your computer or in your network, click Browse, select the migration package file (a .pte file), and click Open.

    • To get the package from a Web address, select Web Address and type the URL to the package.

      If you must enter login credential to access the Web address, type the information in the Username and Password boxes.

  2. Click Load Package.

  3. Under Import Settings, select options for import.

    Option Description

    Import ACLs

    Select this to import the Access Control Lists (user and group security settings) for all the objects you are importing.

    Overwrite Remote Servers

    Specifies that existing remote server objects should be overwritten by remote server objects in the migration package. The default is that existing remote servers are not overwritten.

    Remember Dependency Settings

    Select this if, on subsequent imports, you want the objects you are now importing to retain the new dependencies that you select in the importing portal. (You select new dependencies on the Unresolved Dependencies page.)

    Always Create New Object Instances (Create Duplicates of Existing Objects)

    Select this if you want to create new object instances instead of overwriting objects that may already exist on the importing portal.


Selecting Objects to Import from a Migration Package

You can select objects to import on the Portal Resources page of the Migration — Import Utility.

To import a migration package, you must have at least Edit access to the objects you want to add to the package.

This page displays the objects contained in the migration package you loaded. All objects will be imported when you click Finish, unless you remove them.

  1. If the Migration — Import Utility is not already open, open it now.

  2. Click the Portal Resources page.

  3. Remove objects you do not want to import by selecting them and clicking the Remove icon.

If there are objects to import from Oracle WebCenter Collaboration, you can choose those objects on the Collaboration Resources page.

Resolving Import Dependencies

If any of the objects you are importing depend on resources that are not included in the package, those missing resources are listed on the Unresolved Dependencies page of the Migration — Import Utility. For example, in your migration package you may have a portlet that depends on a Web service, which is not included in the package. You can resolve those dependencies by pointing to existing objects in your portal.

To create a migration package, you must have at least Edit access to the objects you want to add to the package.

Note:

This page appears only if there is an unresolved dependency.

  1. If the Migration — Import Utility is not already open, open it now.

  2. Click display the Unresolved Dependencies page.

    Any missing resources are displayed in the Dependency column. The associated object in the migration package is listed under each missing dependency.

  3. Click the Edit icon beside the dependency.

  4. Select a replacement object from this portal and click OK.

    The replacement object is displayed in the Replacement column.

Importing Objects Using a Command Line Tool

You can import objects from another portal with a migration package.

  1. Copy the migration package to the target portal host computer.

  2. Log in to the host computer for the portal as the user who owns the portal installation.

  3. Use the command ptmigration.bat (for Windows) or ./ptmigration.sh (for UNIX) with the following parameters:

    ptmigration.bat [username] [password] -import [migration package name] [log file name] <-noacl> <-overwriteremoteservers> <-createnewobjectinstances>
    

    Where the parameters are as follows:

    Parameter Description

    migration package name

    Required. The name and path of the migration package to be created

    log file name

    Required. The name and path of the log file to be created. The path to the log file must be different from that of the migration package.

    -noacl

    Optional. Use this parameter if you do not want to import the Access Control Lists (security data) associated with the objects you are importing.

    -overwriteremoteservers

    Optional. Specifies that existing remote server objects should be overwritten by remote server objects in the migration package. The default is that existing remote servers are not overwritten.

    -createnewobjectinstances

    Optional. Use this parameter if you want to create new object instances instead of overwriting objects that may already exist on the importing portal.


  4. Press ENTER.

    All the objects in the migration package are imported. The imported objects are located in the same folders on the target portal as on the source portal. Objects with missing dependencies will be skipped and not imported. Check the migration log to see which ones were skipped.

Backing Up the Portal

You can back up your system without taking it offline.

  1. Back up your database according to your database vendor documentation and best practices.

  2. Create a snapshot of your search collection and back it up to another location or tape backup.

  3. Back up your document repository files and log files to another location or tape backup.

Restoring the Portal

  1. Stop the Web service on all computers hosting the portal application.

  2. Stop the Oracle WCI Automation Service on all computers hosting Automation Services.

  3. Stop the Oracle WCI Search service.

  4. If you must rebuild your portal database, use your database software to restore from a previously saved database.

  5. Replace your search collection with backups as close as possible to the time of the database backup you are using.

Your database backup might not exactly match your search collection backup, so the restored database and search collection will be out of sync. To correct this, rebuild the search collection.

Rebuilding the Search Collection

Your search index might get out of sync with your database if, during a crawl, the Search Service became unavailable or a network failure prevented an indexing operation from completing. Another possibility is that a Search Service with empty indexes was swapped into an existing portal with pre-existing documents and folders.

To rebuild the search collection you must have the following rights:

The Search Service Manager lets you specify when and how often the Search Update Agent repairs your search index. Rather than synchronizing particular objects, the repair synchronizes all objects in the database with the search index. Searchable objects in the database are compared with IDs in the search index. If an object ID in the database is not in the search index, the Search Update Agent attempts to re-index the object; if an ID in the search index is not in the database, the Search Update Agent removes the object from the search index.

Run the Search Update Agent for purposes of background maintenance or complete repopulation of the search index.

  1. Configure the Search Service to repair itself.

    1. Click Administration.

    2. From the Select Utility list, choose Search Service Manager.

    3. Under Search Repair Settings, change Next Repair Date to a time in the past.

    4. Click Administration again.

  2. Wait one minute for the setting to update.

  3. Run one of the Search Update jobs in verbose mode.

    1. Open the Intrinsic Operations folder.

    2. Open one of the Search Update jobs.

      The Job Editor opens.

    3. Change the Logging Level to Verbose and click Finish.

      Note:

      Make note of the logging mode before you change it, so that you can change it back after the repair is complete.

    4. Select the job you just edited and click Run Once.

      By running the job this way, you avoid having to go back into the job and revert to the previous schedule settings.

  4. Ensure that the job is running in repair mode.

    1. Open the job you just created; it should be called something like Search Update 1 — Run Once.

      The Job Editor opens.

    2. Click the Job History page.

    3. Click the job name.

      The job log opens.

    4. Ensure that the job is running in repair mode.

      The second line of the job log should be similar to this:

      Mar 1, 2008 9:10:02 AM- PTIndexer.ctor : Indexing will extract at most 1000000 encoded bytes of text from each document.
      

      About half-way down the first page of the log you should see a message that should be similar to this:

      Mar 1, 2008 9:10:02 AM- Search Update Agent is repairing the directories...
      
  5. Reinstall the Search Service and select Overwrite the existing search index. For details on installing the Search Service, refer to the Oracle Fusion Middleware Installation Guide for Oracle WebCenter Interaction for Windows or the Oracle Fusion Middleware Installation Guide for Oracle WebCenter Interaction for Unix and Linux.