Chapter 19 PAR File Format

This chapter contains the following:

• Overview

• PAR Format

• Files

Overview

This document describes the PAR file format, and the PAR directory structure for Portal Server. The PAR file format is the file structure that is used by the psadmin import/export command to store portal data. The PAR directory structure is the directory structure from where a PAR file can be generated using the psadmin create-par command. The PAR directory structure describes the file system directories that is similar to the PAR file format with additional mapping properties file.

There are two ways to generate a PAR file:

• Extract portal data from a system running Portal using the psadmin export command

• Extract portal data from a file system directory structure using the psadmin create-par command

PAR Format

This section contains the following:

• PAR File Format

• PAR Directory Structure

PAR File Format

The following table describes the PAR file format.

PAR Directory Structure

The following table describes the PAR directory structure.

Files

This section contains the following:

• DPMapping.properties File

• Files in /dp Directory

• Manifest File

DPMapping.properties File

The following describes properties in the DPMapping.properties file:

dpnode

The display profile root dn. The value of dpnode can be a dn, or defaultOrganization. If dpnode is not defined, the default organization dn will be assumed.

name

The dn relative to the dpnode, then dpnode. For example, "o=org1,dpnode".

Example 19–1 This example shows how the DPMapping.properties file is used. For example, under the /dp directory, there are the following files:

dp/
		global-base.xml, global-desktop.xml, global-map.xml,...
		node1.xml, node1-default.xml,...
		node2-default.xml, node2-eng.xml
		node3.properties
		DPMapping.properties

In DPMapping.properties file, it has:

dpnode=dc=red,dc=iplanet,dc=com
node1=dpnode
node2=cn=eng,dpnode
node3=cn=sales,dpnode

The psadmin create-par command will combine the display profile snippets for all files with the same name before the - into one display profile. In the above example, the end PAR file has:

dp/
		global.xml
		node1.xml
		node2.xml
		node3.properties

The dn mapping will be stored in the PAR manifest file like this:

META-INF
		MANIFEST.MF:
		Manifest-Version: V1.0
		...
		
		PS-DP-DOCS:global.xml,node1.xml,node2.xml
		PS-Attributes-Properties:node3.properties
		PS-AutoExtract: dpnode=dc%3Dred%2Cdc%3Diplanet%2Cdc%3Dcom,entry=global,
    node1=dpnode,node2=cn%3Deng%2Cdpnode,node3=cn%3Dsales%2Cdpnode

Files in /dp Directory

XML Files

The DP XML files must contain the full display profile format based on the psdp.dtd. For example:

<!DOCTYPE DisplayProfile SYSTEM "jar://resources/psdp.dtd">
<DisplayProfile version="1.0"...>
		<Properties>...</Properties>
		<Channels>...</Channels>
		<Providers>...</Providers>
</DisplayProfile>

Properties Files

The properties files contains name/value pairs for the service attributes. The following is a description of the properties file format:

Manifest File

The manifest.mf file describes what is contained in the PAR file and how the files are structured, as well as the export file version information.

The manifest file for the .par file contains the main and entries section, following the JAR manifest convention. The main section contains headers which describe the backup file version number and the top level archive directories. The following headers are included:

Manifest-Version

The manifest version number

PS-Version

The portal server version number

PS-Backup-Version

The backup file version number, the version number is an unique identification number.

The backup version number contains information about the portal domain, portal name, the backup file data type, and the backup version number. The data type can be the following: desktop, provider+channel.

PS-Backup-Timestamp

A timestamp on when the backup file is created.

PS-DefaultEntry

This is only used by the PAR utility.

PS-PBFileRoot

The root directory in the archive for the property based files. For now, this is the root of the templates and properties file directories.

PS-DPRoot

The root directory in the archive for the display profile documents.

PS-StaticRoot

The root for static content in the archive.

PS-ClassRoot

The root for the Java classes in the archive. If unspecified, the corresponding files are rooted at the top of the archive.

PS-WARRoot

The root for the WAR files in the archive.

The entries section defines named entries which declare details about the backup file. When there are multiple name entries, each named entry corresponds to one parEntry when the backup target is channels, providers, or display profiles. For other backup data type, there will be only one entry. Each name entry includes the following headers:

PS-EntryName

The entry name to identify the entry.

PS-AutoExtract

This provides information for the import subcommand with the --autoextract option.

PS-DP-Docs

A comma separated list of distinguished names. This gives a complete list of which display profile documents are archived in the backup file.

PS-Include

List of included files or directories.

PS-Attribute-Properties

List of attribute properties files