Skip Headers
Oracle® Fusion Middleware Administering Oracle WebCenter Content
11g Release 1 (11.1.1)

Part Number E26692-01
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

32 Archiving the Folder Structure

The Folder Structure Archive feature enables you to archive the Oracle WebCenter Content folder structure as well as its associated content for Contribution Folders.

This chapter covers the following topics:

32.1 Overview of Folder Structure Archive

Folder Structure Archive can be used to archive the folder structure and optionally its associated content for Contribution Folders (supported by the Folders_g component). The structure of the folders is archived through database table replication. You can configure which folders (along with all subfolders) should be archived. The folder archives can be accessed by the Archiver utility for further processing (for example, replication or transfer to a different Content Server instance).

Note:

Folder Structure Archive does not support Folders. The Archiver utility can be used to move Folders structure and content. For details, see Chapter 33.

The FolderStructureArchive component is installed, but disabled, by default with the Content Server instance. To use the component you must enable it with the Component Manager.

Folder Structure Archive has several uses, including:

32.2 Important Implementation Considerations

Please note the following important implementation considerations:

32.3 Differences With Built-in Folders Archiving Features

Folders Structure Archive has its own built-in archiving features, which are accessed on the Contribution Folder Administration Configuration page.

Functionality Differences

Folder Structure Archive can be used alongside built-in archiving features, but its functionality differs in several important ways:

Processing Differences

If you export the complete folder structure using the built-in Contribution Folders archiving features and you import it into another Content Server instance (using the Contribution Folders user interface), then that server's existing folder structure is deleted entirely and replaced with the imported structure.

If you create an archive using Folder Structure Archive and you import, transfer, or replicate it to another Content Server instance (using the Archiver utility), then the existing folder structure is not deleted, and the archived structure is merged into the existing structure.

Note:

For more information on the built-in archiving features of the Folders_g component, see Oracle Fusion Middleware Managing Oracle WebCenter Content.

32.4 Managing Folder Structure Archives

This section provides information about working with folder structure archives:

32.4.1 Creating a Folder Structure Archive

To create a new folder structure archive:

  1. Log in to the Content Server instance as an administrator.

  2. Choose Administration, then Folder Archive Configuration.

  3. In the Collection Name list on the Folder Archive Configuration page, select the archive collection that the new folder structure archive should be part of.

  4. In the Archive Name field, specify the name of the new folder structure archive.

    Important:

    Ensure that you provide an archive name before selecting folders to be included in the archive. If you select folders first and then specify an archive name, nothing happens when you click Add. (The folder tree collapses completely and your folder selection is lost).

  5. In the shaded area, select all folders to include in the folder structure archive. If you click the check box of a parent folder, all its child folders are selected automatically as well. You can also select and deselect any of the child folders individually. A parent folder will only be selected if all of its subfolders are selected as well. If you deselect any of the child folders, its parent folder is automatically deselected, too. This does not affect the virtual folder path properties of the child folder.

  6. Click Add. A message is displayed saying that the folder archive was added successfully. The archive is now included in the Archive Name list, and also in the list of current archives for the Content Server instance; see Section 32.4.3.

32.4.2 Updating a Folder Structure Archive

You can use the definition of an existing folder structure archive, modify it, and create an updated archive. To update a folder structure archive:

  1. Log in to the Content Server instance as an administrator.

  2. Choose Administration, then Folder Archive Configuration.

  3. If required, on the Folder Archive Configuration page assign the archive to a different collection in the Collection Name list.

  4. In the Archive Name list, select the name of the folder structure archive to update. The folder archive tree in the shaded area is updated to reflect the current selections for the archive.

    Note:

    You cannot save the selected archive under a different name. If you change the name in the Archive Name field and click Add, the archive is considered a new archive and you must select the folders again before clicking Add.

  5. When defining the folder structure archive on the Folder Archive Configuration page, you can select a folder without selecting its parent folder.

    If you click the check box of a parent folder, all its child folders are selected automatically as well. You can also select and deselect any of the child folders individually. A parent folder will only be selected if all of its subfolders are selected as well. If you deselect any of the child folders, its parent folder is automatically deselected, too. This does not affect the virtual folder path properties of the child folder.

    Note:

    By default, if a parent folder is not selected, its source collection ID is not passed on to its child folders. If you want the source collection ID of a folder to be retained even if its parent folder is not selected, set the AllowMigrationOfParentFoldersMeta variable to true (this is not the default). For details, see Section 32.4.4.

  6. Click Update. A message is displayed saying that the folder archive was updated successfully. To process this archive further, see Section 32.4.3.

32.4.3 Using a Folder Structure Archive

After you create a new folder structure archive, its files are located in the Intradoc_Dir/archives/Archive_Name directory, and it is included in the list of current archives for the Content Server instance in the Archiver utility:

Figure 32-1 Folder structure archive in Archiver utility

Description of Figure 32-1 follows
Description of "Figure 32-1 Folder structure archive in Archiver utility"

The Name column contains the name that was given to the archive when it was created. See Section 32.4.1. The Description column will always say "Archive with folder structures" to indicate the archive's purpose.

The folder structure archive can now be processed further. All normal Archiver functions can be used. For example, the archive can be transferred or replicated to a different Content Server instance.

Note:

For several important considerations that should be taken into account when implementing the Folder Structure Archive component, see Section 32.2.

32.4.4 Configuration Variables

There are several configuration variables that you can use to modify the behavior of folder structure archiving. This section provides information about the types of such variables.

32.4.4.1 Folder Structure Archive Variables

The variables for Folder Structure Archive are set in the following file: IdcHomeDir/components/FolderStructureArchive/folderstructurearchive_environment.cfg. This is a read-only file, so if you want to modify a setting, use the Admin Server: General Configuration page.

The following configuration parameters are supported:

  • ArchiveFolderStructureOnly=true|false: If this variable is set to true, the archive will only include the folder structure and none of the content items contained in the structure. This variable enables you to create a copy of the folder structure for backup purposes or identical multi-server setup. The default is false, which means that content items are included in the folder archive.

  • AllowArchiveNoneFolderItem=true|false: If this variable is set to true, the archive will include content items, even if they are not in the folder structure. The content that does not belong to any folder is included in the folder structure archive. If it is set to false, only content items that are in the folder structure are exported. You can use this configuration variable to set up replication for folders and content at the same time; otherwise additional replication for folders and normal content would be required. The default is true, which means that content items outside of the folder structure are also included in the folder archive.

  • AllowMigrationOfParentFoldersMeta=true|false: If this variable is set to true, the source collection ID of a folder is retained (migrated from the parent folder), even if the parent folder is not selected on the Folder Archive Configuration page. The default is false, which means that metadata of parent folders is not passed on unless the parent folder is specifically selected.

    Important:

    After modifying a configuration parameter value, ensure that you restart the Content Server instance.

32.4.4.2 Folders_g Component Variables

The variables for the Folders_g component are set in the following file: IdcHomeDir/components/Folders_g/folders_environment.cfg. This is a read-only file, so if you want to modify a setting, use the Admin Server: General Configuration page.

The following Folders_g configuration variable is useful with Folder Structure Archive:

  • CollectionIsConsumptionOnly=true|false: If this variable is set to true, the folders environment on the Content Server instance is locked, which means the server is set to receive folder data only (hence consumption). Users with RWD permissions are not allowed to create, move, modify, or delete folders. Users with Admin permissions are not allowed to create folders, but they can move, modify, and delete folders.

    This setting should typically be set on a Content Server instance that is the target of an archive transfer or replication. It prevents out-of-sync errors between the source server and target server, which could arise if folders were manipulated manually on the target server.

    The default setting is false, which means the folders environment on the Content Server instance is not locked.

    In a replication setup, any deleted folders on the source system are not automatically deleted on the target system. Even with the target system in consumption-only mode, system administrators can manually delete the affected folder on the target system. (Please note that they cannot create folders.)

    Caution:

    If users are allowed to manipulate folders on the target server, ensure that you select a different initial collection ID (InitialColID setting) for the target server than for the source server during the Folders_g component installation. Otherwise there may be collection ID collision errors.

    Important:

    After modifying a configuration parameter value, ensure that you restart the Content Server instance.