| Oracle® Fusion Middleware System Administrator's Guide for Content Server 11g Release 1 (11.1.1) E10792-01 |
|
 Previous |
 Next |
Home > System Administrator' > Managing System Migration a... > Archives, Collections and B...
| Oracle® Fusion Middleware System Administrator's Guide for Content Server 11g Release 1 (11.1.1) E10792-01 |
|
Previous |
Next |
Home > System Administrator' > Managing System Migration a... > Archives, Collections and B...
Archiving your content consists of three elements: the archive itself, a collection, and a batch file.
This section describes the structure of the archiver and how it uses collections and targets. For an overview of the archiver and how it compares to other archiving tools, see "Archiving Overview".
An archive is a set of exported content files and their associated batch files. Each archive has its own subdirectory in the collection it belongs to.
|
Caution: Do not edit any of the files created by Archiver. |
An archive subdirectory includes the following:
| File or Directory | Description |
|---|---|
| Batch file directories | Each batch file has a subdirectory in the archive. The subdirectory name reflects the date and time of the export, with a default format of yy-MMM-dd_HH.mm.ss_SSS. For example, 03-feb-04_15.04.14_174. |
| temp directory | Contains transferred Zip files. |
| archive.hda file | Specifies information about the archive, such as export and import settings, the export query, field and value import maps, archiving history, and so forth. |
| doctypes.hda file | Lists the content types (DocTypes database table) in the source content server. This file is present only if content types were exported. |
| exports.hda file | Specifies the batch files that are included in the archive. |
| users.hda file | Lists the user attributes (Users database table) in the source content server. This file is present only if user attributes were exported. |
Figure 7-7 Archive Subdirectory Structure
This section provides information about collections.
Summary
A collection is a set of archives on a particular content server instance.
Each instance has a default collection, which is located in the IntradocDir/archives/ directory. Additional collections can be created, but are necessary only in rare situations. For example, you could create a new collection if you want to save disk space by archiving to another system that does not have Content Server on it.
Collections can be created only through the standalone Archiver. See "Running the Archiver as a Standalone Application" for details about using the standalone Archiver.
A collection can be removed from a content server instance, but this only makes it unavailable from the Archiver application; the archive and batch files remain until you delete them from the file system.
|
Tip: Archiver collections are normally compatible between different versions of Content Server. One possible exception would be User Configuration information that was archived from a pre-3.0 content server instance. The format of the Users database table changed in version 3.0, so this information might not be compatible between pre- and post-3.0 content servers. |
Structure
An archive collection includes the following:
| File or Directory | Description |
|---|---|
| collection.hda file | Specifies the archives that are included in the collection. |
| collection.mrk file | Internal file used by Archiver. |
| Archive directories | Each archive has a subdirectory in the collection. |
This section provides information about batch files.
Summary
A batch file is a text file that contains the file records for archived content items. Batch files describe the metadata for each exported revision.
A new batch file subdirectory is created each time an archive is exported.
Each batch file contains up to 1000 file records. If an export contains more than 1000 revisions, a new batch file is created.
|
Note: Archiver batch files are not the same as the batch files that are used with the Batch Loader application. |
Structure
A batch file subdirectory includes the following:
| File or Directory | Description |
|---|---|
| Content files | A subdirectory named '1' in the batch file directory contains a vault structure that is copied from the source content server. If web-viewable files are being archived, this subdirectory also contains a weblayout structure. |
| Batch file | Specifies the metadata for each revision that was exported. Batch files are HDA files that are named with a unique number generated by Archiver. For example, 0335150414~1.hda. |
| docmetadefinition.hda file | Lists the custom metadata fields in the source content server (DocMetaDefinition database table). This file is used by Archiver to create import maps. |
You can use the archiver to archive the following content:
Web-viewable files (.pdf, .html, and so forth)
Metadata fields and changes
User information fields
Security groups (user attributes and settings)
User updates
Subscription types
File formats
Document types
Content types
User attributes (such as user login, full name, password, e-mail address, and so forth)
|
Note: Content types and user attributes can be exported and imported manually, but cannot be transferred or archived automatically through replication. Table replication can be used, though, to replicate user information. |
|
Caution: Archiver cannot be used to move or copy data between two instances that share the same content server instance name (IDC_Name). To do so will corrupt the data on the target system. |
If you are experiencing Archiver problems, view the Archiver logs for more information.
Summary
The Archiver logs are listed by date and time. They are generated once per day when the first Archiver information status, irrecoverable error, or error occurs.
Click the Archiver Logs link on the Administration page to view information about imports, exports, and replications.
Click the link that appears for the desired log file. A table showing the type, date and time, and description of each action is displayed. It also includes the name of the content server instance that created the archive.
Log Entries
The following types of archiver log entries are generated:
Info: Displays basic status information. For example, status information is logged when an export and an import starts and finishes.
Error: Displays user/administration errors that occur but do not stop the software from functioning. For example, an error is logged if there is no file information for a content item that you are trying to export.
Fatal: Displays errors that stop the software from functioning. For example, an irrecoverable error is logged if the content server cannot access the database. Check the connection string, user name, and password.
After archives are created, they can be added to collections and manipulated as a group.
To create a new, undefined archive:
Display Main Archiver Screen in either standalone or browser mode.
If necessary, open the collection where you want to create the new archive. See "Opening a Collection".
From Edit, select Add.
The Add Archive Screen is displayed.
Enter the archive name and description. The archive name cannot contain spaces.
Click OK.
To copy an existing archive to a different directory location:
|
Note: This procedure copies the files in an archive. It does not create a new collection or update the collection.hda file if the archive is copied to a collection directory. |
Display the archiver in standalone mode.
If necessary, open the collection that contains the archive to be copied. See "Opening a Collection".
Select the archive to be copied.
From Edit, select Copy To.
The Copy Archive Screen is displayed.
Accept the original archive name, or change the name as necessary.
In the Copy Archive To Directory field, enter the directory path where the archive will be copied.
Click OK.
The archive files are copied to the specified directory.
You can copy archives from your system for storage or to your system from another archive if you are using the Archiver standalone version.
To create a new archive in the current collection by copying an existing archive:
Display the archiver in standalone mode.
If necessary, open the collection where you want to create the new archive. See "Opening a Collection".
From Edit, select Add.
The Add Archive Screen is displayed.
Enter the archive name and description. The archive name cannot contain spaces.
Select the Copy From check box.
Click Browse.
Navigate to and select the desired archive file (archive.hda).
Click Open.
Click OK.
The archive files are copied to the default archive directory in the local content server instance.
To delete an archive from a collection:
Open the archive collection.
Select the archive to delete in the Current Archives list.
From Edit, select Delete.
You are prompted to confirm the action.
Click OK.
The archive is deleted from the collection.
Collections are a set of archives and are used to group archives for different archive functions.
|
Note: The standalone version of the Archiver application is required to create new collections or browse the local file system to connect to new collections. |
To open an existing archive collection:
Display the Archiver in standalone mode.
From Options, select Open Archive Collection.
The Open Archive Collection Screen is displayed, with the default collection and any other connected collections listed.
Select the collection from the list, or browse to a new collection as follows:
To select the collection from a shared file system location (standalone Archiver only):
Click Browse Local. The Find Archive Collection Definition File Screen is displayed.
Navigate to and select the collection HDA file.
Click Open.
To select the collection from a remote content server instance:
Click Browse Proxied.
The Browse for Proxied Collection Screen is displayed. The list includes all content server instances to which an outgoing provider has been set up.
Select the content server instance in the Proxied Servers list.
Select the collection in the Collections list.
Click OK.
Click Open.
The Browse To Archiver Collection Screen is displayed.
To create a new archive collection:
|
Note: You can create a new collection only on the local content server instance using the standalone Archiver. |
Display the archiver interface in standalone mode.
From Options, select Open Archive Collection.
The Open Archive Collection Screen is displayed.
Click Browse Local.
The Find Archive Collection Definition File Screen is displayed.
Navigate to and select the directory where you want to create the new collection.
Enter a file name for the new collection (collection.hda is the default).
Click Open.
You are prompted to create a collection definition (HDA) file.
Click Yes.
The Browse To Archiver Collection Screen is displayed.
Enter a collection name in the Name field.
Collection names cannot contain spaces.
Use the same name for a collection and its directory to make navigation easier.
Enter the directory path for the weblayout and vault directories in the Web Directory and Vault Directory fields.
Use the same path style as shown in the Location field.
To find the directory paths, display the Configuration Information Page.
Click OK.
The new collection is shown in the Open Archive Collection screen.
Click Open to open the new collection.
To remove an archive collection:
|
Note: You cannot remove the default collection. |
Select Options, and then click Open Archive Collection.
The Open Archive Collection Screen is displayed.
Select the collection to be removed.
Click Remove.
You are prompted to confirm the action.
Click OK.
The collection is removed from the content server instance. (The collection and archive files remain in the file system, and must be deleted manually.)
You can change the file system location of the default archive collection by moving the collection and pointing the content server to the new location. For example, you might want to keep all of your archive data on a separate drive from the program files for easier backup and expansion.
|
Note: The default collection is the /archives/ directory. |
To move the default archive collection:
For data safety, close any standalone Archiver applications and stop the content server.
Add the CollectionLocation configuration variable to the DomainHome/ucm/cs/bin/intradoc.cfg file:
CollectionLocation=path
To maintain the previously created archives for the default collection, move the contents of the /archives/ directory to the new location you specified in the CollectionLocation setting.
If you do not move the contents, the system creates an empty collection.
Start the content server.
|
Note: The content server will re-create the default Domain_home/ucm/cs/archives/ directory when it is restarted, but the Archiver will default to using the collection in the new location. |
A batch file describes the metadata for exported revisions. A batch file is created each time the archiver performs an export.
To remove individual revisions from a batch file:
Open the archive collection. See "Opening a Collection".
Select the archive in the Current Archives list.
Click View Batch Files on the Main Archiver Screen.
The View Batch Files Screen is displayed.
Select the batch file.
Click Edit.
The View Exported Content Items Screen is displayed.
Use the Filter element and the navigation buttons to display the revision to be deleted.
Select the revision to be deleted.
Click Delete.
The Status changes to Deleted for the selected revision.
To undo the last deletion, click Undo. To return all deleted revisions to Archived status, click Refresh.
Click Apply to delete the specified revisions.
Click Close.
To delete a batch file from an archive:
Open the archive collection. See "Opening a Collection".
Select the archive in the Current Archives list.
Click View Batch Files on the Archiver (General Tab).
The View Batch Files Screen is displayed.
Select the batch file to delete.
Click Delete.
You are prompted to confirm the action.
Click OK.
The batch file is deleted from the archive.
Specify whether to replace existing batch files upon export:
To delete all existing batch files when the next export is initiated, select the Replace Existing Export Files check box.
To leave existing batch files in place when the next export is initiated, clear the Replace Existing Export Files check box.
Specify which files to export:
To export the native (vault) and web-viewable (weblayout) files, select the Copy Web Content check box.
To export only the native (vault) files, clear the Copy Web Content check box.
Click OK.
The export options are displayed in the Export Options section of the General tab.
