This chapter contains the following:
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
This section contains the following:
The following table describes the PAR file format.
File/Directory under PAR Directory |
Sub Directory |
Description |
---|---|---|
META-INF |
/MANIFEST.MF |
The manifest.mf file describes what is contained in the exported file. |
/dp |
/name.properties |
Contains component service attribute values. |
/name.xml |
Contains display profile document. |
|
/pbfiles |
/providerClassBaseDir |
Contains customized desktop provider classes. |
/templateBaseDir |
Contains desktop JSPs and templates. |
|
/templateBaseDir/classes |
Contains desktop provider resource bundle files. |
|
/communityTemplateBaseDir |
Contains community templates and properties files. |
|
/static |
Static files to be deployed as part of the portal war. This maps to (by default in UNIX platform) /var/opt/SUNWps/portals/portal-ID directory. |
|
/war |
War files to be deployed. This maps to (by default in UNIX platform) /var/opt/SUNWps/portals/portal-ID/war directory. |
|
.jar |
JAR files associated with providers. |
|
Java-class-files |
Class files associated with providers. |
The following table describes the PAR directory structure.
Directory under PAR Directory |
Files and Sub Directories |
Description |
---|---|---|
/dt |
DPMapping.properties |
Mapping file properties contains name -> dn mapping |
/name.properties |
The name should be defined in the DPMapping.properties file. |
|
/name.xml |
There could be multiple files start with the same name, appended by -XXX.xml, files start with same name will be merged into one XML file. The name must be defined in the DPMapping.properties file (with exception of the name global). For example, global-1.xml and global-2.xml will be merged into global.xml, and global should be defined in the DPMapping.properties file. |
|
/pbfiles |
/providerClassBaseDir |
This directory structure maps to (by default on UNIX platform) /var/opt/SUNWps/portals/portal-ID/desktop/classes. Under this directory, you can have customized provider classes in packaged subdirectories. |
/templateBaseDir |
This directory structure maps to (by default on UNIX platform) /var/opt/SUNWps/portals/portal-ID/desktop. Under this directory, you can have anoymous/, default/, sampleportal/ etc. |
|
/communityTemplateBaseDir |
This directory structure maps to (by default on UNIX platform) /var/opt/SUNWps/portals/portal-ID/communitytemplates directory. |
|
/static |
/web-src |
Can contain any customized files in open WAR. The files in this directory will be included in the par/static directory, and will be imported into portal-data-dir/web-src directory. |
/war |
Contains war files, note that is the portal war file is will not be added in the par file |
This section contains the following:
The following describes properties in the DPMapping.properties file:
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.
The dn relative to the dpnode, then dpnode. For example, "o=org1,dpnode".
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 |
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> |
The properties files contains name/value pairs for the service attributes. The following is a description of the properties file format:
Property Name |
Property Value |
---|---|
The component service attribute name. The service attribute names can be obtained by using the psadmin list-attributes command. For example, for desktop service attribute names, use the following command: psadmin list-attributes -u adminuser —f passwordfile —p portal-ID –component=desktop |
The service attribute value. The values are separated by the delimiter @@@!!!. A single value will end with the delimiter. For example: EditChannel=JSPEditContainer@@@!!! |
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:
The manifest version number
The portal server version number
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.
A timestamp on when the backup file is created.
This is only used by the PAR utility.
The root directory in the archive for the property based files. For now, this is the root of the templates and properties file directories.
The root directory in the archive for the display profile documents.
The root for static content in the archive.
The root for the Java classes in the archive. If unspecified, the corresponding files are rooted at the top of the archive.
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:
The entry name to identify the entry.
This provides information for the import subcommand with the --autoextract option.
A comma separated list of distinguished names. This gives a complete list of which display profile documents are archived in the backup file.
List of included files or directories.
List of attribute properties files