You are viewing a plain text version of this content. The canonical link for it is here.
Posted to general@portals.apache.org by rw...@apache.org on 2009/06/30 05:29:00 UTC
svn commit: r789542 - in /portals/site/jetspeed: jetspeed-2.1/src/site/xdoc/
jetspeed-2.2/src/site/xdoc/
Author: rwatler
Date: Tue Jun 30 03:28:59 2009
New Revision: 789542
URL: http://svn.apache.org/viewvc?rev=789542&view=rev
Log:
JS2-1034: add ETL migration documentation for the Jetspeed installer
Added:
portals/site/jetspeed/jetspeed-2.1/src/site/xdoc/guide-etl-migration.xml
portals/site/jetspeed/jetspeed-2.2/src/site/xdoc/guide-etl-migration.xml
Modified:
portals/site/jetspeed/jetspeed-2.1/src/site/xdoc/getting-started-installer.xml
portals/site/jetspeed/jetspeed-2.1/src/site/xdoc/guide-migration.xml
portals/site/jetspeed/jetspeed-2.2/src/site/xdoc/getting-started-installer.xml
portals/site/jetspeed/jetspeed-2.2/src/site/xdoc/guide-migration.xml
Modified: portals/site/jetspeed/jetspeed-2.1/src/site/xdoc/getting-started-installer.xml
URL: http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.1/src/site/xdoc/getting-started-installer.xml?rev=789542&r1=789541&r2=789542&view=diff
==============================================================================
--- portals/site/jetspeed/jetspeed-2.1/src/site/xdoc/getting-started-installer.xml (original)
+++ portals/site/jetspeed/jetspeed-2.1/src/site/xdoc/getting-started-installer.xml Tue Jun 30 03:28:59 2009
@@ -65,6 +65,12 @@
<source>
java -jar jetspeed-2.1.3-installer.jar text
</source>
+ <p>
+ After starting the installer and advancing through the splash and license pages, select the
+ <code>Install Jetspeed Portal</code> installer operation and continue. The installer will then
+ prompt for information required for the installation process. Documentation for the other
+ installer operations used primarily for ETL migration can be found here: <a href="guide-etl-migration.html">ETL Migration Guide</a>.
+ </p>
</subsection>
<subsection name="Database Selection">
<p>
Added: portals/site/jetspeed/jetspeed-2.1/src/site/xdoc/guide-etl-migration.xml
URL: http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.1/src/site/xdoc/guide-etl-migration.xml?rev=789542&view=auto
==============================================================================
--- portals/site/jetspeed/jetspeed-2.1/src/site/xdoc/guide-etl-migration.xml (added)
+++ portals/site/jetspeed/jetspeed-2.1/src/site/xdoc/guide-etl-migration.xml Tue Jun 30 03:28:59 2009
@@ -0,0 +1,274 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<document>
+ <properties>
+ <title>ETL Migration Guide</title>
+ <subtitle>ETL Migration Guide</subtitle>
+ <authors>
+ <person name="Randy Watler" email="rwatler@apache.org" />
+ </authors>
+ </properties>
+ <body>
+ <section name="ETL Migration Using Jetspeed 2.1.3/2.1.4+ and 2.2.1+ Installers">
+ <p>
+ To facilitate ETL based migration or data manipulation strategies, the Jetspeed installer
+ includes the ability to export, initialize, and import a Jetspeed database. In addition to
+ basic portal data, these operations also will include database PSML and user preferences
+ stored in the Jetspeed database. The installer does not require a Jetspeed portal build or
+ runtime environment to execute these operations.
+ </p>
+ <p>
+ The binary installer can be obtained from the download page, (<a href="download.html">Download</a>),
+ both the minimal and demo installers include the neccessary data operations. In addition to
+ the installer, the appropriate JDBC driver for the installation and access to the database
+ will be required.
+ </p>
+ </section>
+ <section name="Exporting a Jetspeed database">
+ <p>
+ The first step in migrating a database is to export its contents into a file based
+ representation. It is best to perform this step on quiescent or shutdown portal instance.
+ Once the binary installer for the existing Jetspeed release and JDBC drivers have been gathered,
+ invoke the installer using the following shell command:
+ </p>
+ <source>
+ <![CDATA[java -jar <Jetspeed installer JAR file>]]>
+ </source>
+ <p>
+ To run the installer in the console without a GUI, append the <code>text</code> argument to the
+ shell command:
+ </p>
+ <source>
+ <![CDATA[java -jar <Jetspeed installer JAR file> text]]>
+ </source>
+ <p>
+ After starting the installer and advancing through the splash and license pages, select the
+ <code>Export Jetspeed Portal Database</code> installer operation and continue. The installer
+ will then prompt for the following information:
+ </p>
+ <table>
+ <tr>
+ <th nowrap="true">Installer Prompt</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td nowrap="true"><code>Export data files location</code></td>
+ <td>
+ Select a new directory where the export is to write the database XML files. Existing
+ files and directories in the selected directory will be removed when the export operation
+ is complete.
+ </td>
+ </tr>
+ <tr>
+ <td nowrap="true"><code>Temporary installation location</code></td>
+ <td>
+ If the default temporary location is not vaild, select a new temporary directory where the
+ installer Jetspeed instance can be unpacked, (it is removed after the installation is
+ complete).
+ </td>
+ </tr>
+ <tr>
+ <td nowrap="true"><code>JVM memory size</code></td>
+ <td>
+ Export operations can consume a large chunk of memory as the database is traversed. Enter
+ a larger JVM maximum memory size in megabytes as necessary for the installer Jetspeed
+ instance invocation.
+ </td>
+ </tr>
+ <tr>
+ <td nowrap="true"><code>Database selection</code></td>
+ <td>
+ Select the current portal database type. DB2, MSSQL, MySql, PostgreSQL, Oracle, and SapDB
+ are supported. Note that Derby is not currently supported.
+ </td>
+ </tr>
+ <tr>
+ <td nowrap="true"><code>Database connection parameters</code></td>
+ <td>
+ Enter or validate the current portal database user, password, connection string, driver
+ class, and driver JAR archive file.
+ </td>
+ </tr>
+ </table>
+ <p>
+ After configuring the export operation, the installer will test the database connection before
+ proceeding to the confirmation page. Continue the installation process as instructed. When it
+ has finished, be sure to review the <code>Show Details</code> tab to ensure the export has
+ completed as expected. The following files should appear in the export data files location
+ specified during the installation:
+ <ul>
+ <li><code>j2-data.xml</code> file</li>
+ <li><code>j2-prefs-data.xml</code> file, (2.1.X installers only)</li>
+ <li><code>pages</code> directory, (if database Page Manager enabled)</li>
+ </ul>
+ If the installation fails or errors occur in the detail output, the export has probably failed.
+ </p>
+ </section>
+ <section name="Editing the Jetspeed database Exported XML Files">
+ <p>
+ Exported Jetspeed database XML files can be edited, provided the original format and all
+ dependencies are maintained. The formats and files that make up a release do change between
+ releases, so care must be taken to keep the syntax and files consistent with the export release
+ version. No editing should be required to migrate between dataabase vendors.
+ </p>
+ <p>
+ Multiple imports can be performed in an additive fashion to merge slices of data cut from
+ individual exports. However, individual objects in the data model are replaced with new versions
+ loaded during the latest import; merging does not take place at the object level. Bulk edits may
+ also be performed to modify data during migration to complement the portal upgrades if desired.
+ </p>
+ </section>
+ <section name="Initializing a Jetspeed database">
+ <p>
+ Full exports are designed to be imported into an empty Jetspeed database. Creating databases is
+ left to the datbase administrator, but the loading of the Jetspeed database schema can also be
+ accompished using the Jetspeed installer. Databases that contain instances of older Jetspeed
+ portal schemas should be cleaned by dropping all Jetspeed tables prior to reinitialization by the
+ installer. <b>All information within the database will be removed when the Jetspeed database is
+ initialized.</b>
+ </p>
+ <p>
+ To initialize a new database, the installer should be obtained and started for the target Jetspeed
+ release version as documented above for the export operation, except the <code>Initialize Jetspeed Portal Database</code>
+ operation must be selected. The installer will then prompt for the following information:
+ </p>
+ <table>
+ <tr>
+ <th nowrap="true">Installer Prompt</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td nowrap="true"><code>Temporary installation location</code></td>
+ <td>
+ If the default temporary location is not vaild, select a new temporary directory where the
+ installer Jetspeed instance can be unpacked, (it is removed after the installation is
+ complete).
+ </td>
+ </tr>
+ <tr>
+ <td nowrap="true"><code>Database selection</code></td>
+ <td>
+ Select the current portal database type. DB2, MSSQL, MySql, PostgreSQL, Oracle, and SapDB
+ are supported. Note that Derby is not currently supported.
+ </td>
+ </tr>
+ <tr>
+ <td nowrap="true"><code>Database connection parameters</code></td>
+ <td>
+ Enter or validate the current portal database user, password, connection string, driver
+ class, and driver JAR archive file.
+ </td>
+ </tr>
+ </table>
+ <p>
+ After configuring the initialization operation, the installer will test the database connection
+ before proceeding to the confirmation page. Continue the installation process as instructed to
+ load or reload the Jetspeed database schema. When it has finished, be review the <code>Show Details</code>
+ tab to ensure the export has completed as expected. If the installation fails or errors occur in
+ the detail output, the initialization has probably failed. This normally indicates that the
+ database was not clean before the initialization was attempted or sufficient permissions were not
+ granted to the specified database user.
+ </p>
+ </section>
+ <section name="Importing a Jetspeed database">
+ <p>
+ Previously exported Jetspeed database XML files can be reloaded using the installer import
+ operation. Full exports are normally loaded into empty databases, but multiple imports can be used
+ to load partial export data slices as necessary. Data in these slices can only be dependent on
+ information contained within the export or the export files themselves. Individual objects in the
+ XML data files are fully replaced upon load; object instance merging is not supported by import.
+ <b>All data objects imported to the database will replace any existing objects in the Jetspeed
+ database on import.</b>
+ </p>
+ <p>
+ The installer will expect the following files to appear in the import data files location
+ directory specified during the installation:
+ <ul>
+ <li><code>j2-data.xml</code> file</li>
+ <li><code>j2-prefs-data.xml</code> file, (2.1.X exports only)</li>
+ <li><code>pages</code> directory, (assumes Page Manager to be enabled)</li>
+ </ul>
+ All other files in the import data files location directory will be ignored.
+ </p>
+ <p>
+ Jetspeed database import operations should only be attempted on a shutdown portal instance; imports
+ on a running portal may lead to unexpected results and is not supported. If the import is to merge
+ with data already loaded in the database, performing a full backup before the import is highly
+ recommended.
+ </p>
+ <p>
+ To import an existing database export file set, the installer should be obtained and started for the
+ target Jetspeed release version as documented above. The <code>Import Jetspeed Portal Database</code>
+ operation must be selected. The installer will then prompt for the following information:
+ </p>
+ <table>
+ <tr>
+ <th nowrap="true">Installer Prompt</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td nowrap="true"><code>Import data files location</code></td>
+ <td>
+ Select an existing directory that contains the exported Jetspeed database XML files.
+ </td>
+ </tr>
+ <tr>
+ <td nowrap="true"><code>Temporary installation location</code></td>
+ <td>
+ If the default temporary location is not vaild, select a new temporary directory where the
+ installer Jetspeed instance can be unpacked, (it is removed after the installation is
+ complete).
+ </td>
+ </tr>
+ <tr>
+ <td nowrap="true"><code>JVM memory size</code></td>
+ <td>
+ Import operations can consume a large chunk of memory as the database is loaded. Enter
+ a larger JVM maximum memory size in megabytes as necessary for the installer Jetspeed
+ instance invocation.
+ </td>
+ </tr>
+ <tr>
+ <td nowrap="true"><code>Database selection</code></td>
+ <td>
+ Select the target portal database type. DB2, MSSQL, MySql, PostgreSQL, Oracle, and SapDB
+ are supported. Note that Derby is not currently supported.
+ </td>
+ </tr>
+ <tr>
+ <td nowrap="true"><code>Database connection parameters</code></td>
+ <td>
+ Enter or validate the target portal database user, password, connection string, driver
+ class, and driver JAR archive file.
+ </td>
+ </tr>
+ </table>
+ <p>
+ After configuring the import operation, the installer will test the database connection before
+ proceeding to the confirmation page. Continue the installation process as instructed. When it
+ has finished, review the <code>Show Details</code> tab to ensure the export has completed as
+ expected. If the installation fails or errors appear in the detail output, the import has probably
+ failed and the database has been corrupted. The import operation(s) will have to be attempted
+ again from a clean or known database backup state. Problems are normally caused by data
+ incompatabilities/overlap between multiple import data slices or insufficient database permissions
+ granted to the specified database user.
+ </p>
+ </section>
+ </body>
+</document>
+
Modified: portals/site/jetspeed/jetspeed-2.1/src/site/xdoc/guide-migration.xml
URL: http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.1/src/site/xdoc/guide-migration.xml?rev=789542&r1=789541&r2=789542&view=diff
==============================================================================
--- portals/site/jetspeed/jetspeed-2.1/src/site/xdoc/guide-migration.xml (original)
+++ portals/site/jetspeed/jetspeed-2.1/src/site/xdoc/guide-migration.xml Tue Jun 30 03:28:59 2009
@@ -25,6 +25,13 @@
</authors>
</properties>
<body>
+ <section name="Data Migrating to 2.2 Releases">
+ <p>
+ Due to the major Jetspeed database schema modifications made for the 2.2 releases, ETL migration
+ using the Jetspeed installer is supported. Documentation for installer operations used for ETL
+ migration can be found here: <a href="guide-etl-migration.html">ETL Migration Guide</a>.
+ </p>
+ </section>
<section name="Data Migrating from Jetspeed 2.1.3 to 2.1.4">
<p>The following tables describe database schema changes from version 2.1.4 to version 2.1.3.
</p>
Modified: portals/site/jetspeed/jetspeed-2.2/src/site/xdoc/getting-started-installer.xml
URL: http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.2/src/site/xdoc/getting-started-installer.xml?rev=789542&r1=789541&r2=789542&view=diff
==============================================================================
--- portals/site/jetspeed/jetspeed-2.2/src/site/xdoc/getting-started-installer.xml (original)
+++ portals/site/jetspeed/jetspeed-2.2/src/site/xdoc/getting-started-installer.xml Tue Jun 30 03:28:59 2009
@@ -65,6 +65,12 @@
<source>
java -jar jetspeed-installer-minimal-2.2.0.jar text
</source>
+ <p>
+ After starting the installer and advancing through the splash and license pages, select the
+ <code>Install Jetspeed Portal</code> installer operation and continue. The installer will then
+ prompt for information required for the installation process. Documentation for the other
+ installer operations used primarily for ETL migration can be found here: <a href="guide-etl-migration.html">ETL Migration Guide</a>.
+ </p>
</subsection>
<subsection name="Database Selection">
<p>
Added: portals/site/jetspeed/jetspeed-2.2/src/site/xdoc/guide-etl-migration.xml
URL: http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.2/src/site/xdoc/guide-etl-migration.xml?rev=789542&view=auto
==============================================================================
--- portals/site/jetspeed/jetspeed-2.2/src/site/xdoc/guide-etl-migration.xml (added)
+++ portals/site/jetspeed/jetspeed-2.2/src/site/xdoc/guide-etl-migration.xml Tue Jun 30 03:28:59 2009
@@ -0,0 +1,274 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<document>
+ <properties>
+ <title>ETL Migration Guide</title>
+ <subtitle>ETL Migration Guide</subtitle>
+ <authors>
+ <person name="Randy Watler" email="rwatler@apache.org" />
+ </authors>
+ </properties>
+ <body>
+ <section name="ETL Migration Using Jetspeed 2.1.3/2.1.4+ and 2.2.1+ Installers">
+ <p>
+ To facilitate ETL based migration or data manipulation strategies, the Jetspeed installer
+ includes the ability to export, initialize, and import a Jetspeed database. In addition to
+ basic portal data, these operations also will include database PSML and user preferences
+ stored in the Jetspeed database. The installer does not require a Jetspeed portal build or
+ runtime environment to execute these operations.
+ </p>
+ <p>
+ The binary installer can be obtained from the download page, (<a href="download.html">Download</a>),
+ both the minimal and demo installers include the neccessary data operations. In addition to
+ the installer, the appropriate JDBC driver for the installation and access to the database
+ will be required.
+ </p>
+ </section>
+ <section name="Exporting a Jetspeed database">
+ <p>
+ The first step in migrating a database is to export its contents into a file based
+ representation. It is best to perform this step on quiescent or shutdown portal instance.
+ Once the binary installer for the existing Jetspeed release and JDBC drivers have been gathered,
+ invoke the installer using the following shell command:
+ </p>
+ <source>
+ <![CDATA[java -jar <Jetspeed installer JAR file>]]>
+ </source>
+ <p>
+ To run the installer in the console without a GUI, append the <code>text</code> argument to the
+ shell command:
+ </p>
+ <source>
+ <![CDATA[java -jar <Jetspeed installer JAR file> text]]>
+ </source>
+ <p>
+ After starting the installer and advancing through the splash and license pages, select the
+ <code>Export Jetspeed Portal Database</code> installer operation and continue. The installer
+ will then prompt for the following information:
+ </p>
+ <table>
+ <tr>
+ <th nowrap="true">Installer Prompt</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td nowrap="true"><code>Export data files location</code></td>
+ <td>
+ Select a new directory where the export is to write the database XML files. Existing
+ files and directories in the selected directory will be removed when the export operation
+ is complete.
+ </td>
+ </tr>
+ <tr>
+ <td nowrap="true"><code>Temporary installation location</code></td>
+ <td>
+ If the default temporary location is not vaild, select a new temporary directory where the
+ installer Jetspeed instance can be unpacked, (it is removed after the installation is
+ complete).
+ </td>
+ </tr>
+ <tr>
+ <td nowrap="true"><code>JVM memory size</code></td>
+ <td>
+ Export operations can consume a large chunk of memory as the database is traversed. Enter
+ a larger JVM maximum memory size in megabytes as necessary for the installer Jetspeed
+ instance invocation.
+ </td>
+ </tr>
+ <tr>
+ <td nowrap="true"><code>Database selection</code></td>
+ <td>
+ Select the current portal database type. DB2, MSSQL, MySql, PostgreSQL, Oracle, and SapDB
+ are supported. Note that Derby is not currently supported.
+ </td>
+ </tr>
+ <tr>
+ <td nowrap="true"><code>Database connection parameters</code></td>
+ <td>
+ Enter or validate the current portal database user, password, connection string, driver
+ class, and driver JAR archive file.
+ </td>
+ </tr>
+ </table>
+ <p>
+ After configuring the export operation, the installer will test the database connection before
+ proceeding to the confirmation page. Continue the installation process as instructed. When it
+ has finished, be sure to review the <code>Show Details</code> tab to ensure the export has
+ completed as expected. The following files should appear in the export data files location
+ specified during the installation:
+ <ul>
+ <li><code>j2-data.xml</code> file</li>
+ <li><code>j2-prefs-data.xml</code> file, (2.1.X installers only)</li>
+ <li><code>pages</code> directory, (if database Page Manager enabled)</li>
+ </ul>
+ If the installation fails or errors occur in the detail output, the export has probably failed.
+ </p>
+ </section>
+ <section name="Editing the Jetspeed database Exported XML Files">
+ <p>
+ Exported Jetspeed database XML files can be edited, provided the original format and all
+ dependencies are maintained. The formats and files that make up a release do change between
+ releases, so care must be taken to keep the syntax and files consistent with the export release
+ version. No editing should be required to migrate between dataabase vendors.
+ </p>
+ <p>
+ Multiple imports can be performed in an additive fashion to merge slices of data cut from
+ individual exports. However, individual objects in the data model are replaced with new versions
+ loaded during the latest import; merging does not take place at the object level. Bulk edits may
+ also be performed to modify data during migration to complement the portal upgrades if desired.
+ </p>
+ </section>
+ <section name="Initializing a Jetspeed database">
+ <p>
+ Full exports are designed to be imported into an empty Jetspeed database. Creating databases is
+ left to the datbase administrator, but the loading of the Jetspeed database schema can also be
+ accompished using the Jetspeed installer. Databases that contain instances of older Jetspeed
+ portal schemas should be cleaned by dropping all Jetspeed tables prior to reinitialization by the
+ installer. <b>All information within the database will be removed when the Jetspeed database is
+ initialized.</b>
+ </p>
+ <p>
+ To initialize a new database, the installer should be obtained and started for the target Jetspeed
+ release version as documented above for the export operation, except the <code>Initialize Jetspeed Portal Database</code>
+ operation must be selected. The installer will then prompt for the following information:
+ </p>
+ <table>
+ <tr>
+ <th nowrap="true">Installer Prompt</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td nowrap="true"><code>Temporary installation location</code></td>
+ <td>
+ If the default temporary location is not vaild, select a new temporary directory where the
+ installer Jetspeed instance can be unpacked, (it is removed after the installation is
+ complete).
+ </td>
+ </tr>
+ <tr>
+ <td nowrap="true"><code>Database selection</code></td>
+ <td>
+ Select the current portal database type. DB2, MSSQL, MySql, PostgreSQL, Oracle, and SapDB
+ are supported. Note that Derby is not currently supported.
+ </td>
+ </tr>
+ <tr>
+ <td nowrap="true"><code>Database connection parameters</code></td>
+ <td>
+ Enter or validate the current portal database user, password, connection string, driver
+ class, and driver JAR archive file.
+ </td>
+ </tr>
+ </table>
+ <p>
+ After configuring the initialization operation, the installer will test the database connection
+ before proceeding to the confirmation page. Continue the installation process as instructed to
+ load or reload the Jetspeed database schema. When it has finished, be review the <code>Show Details</code>
+ tab to ensure the export has completed as expected. If the installation fails or errors occur in
+ the detail output, the initialization has probably failed. This normally indicates that the
+ database was not clean before the initialization was attempted or sufficient permissions were not
+ granted to the specified database user.
+ </p>
+ </section>
+ <section name="Importing a Jetspeed database">
+ <p>
+ Previously exported Jetspeed database XML files can be reloaded using the installer import
+ operation. Full exports are normally loaded into empty databases, but multiple imports can be used
+ to load partial export data slices as necessary. Data in these slices can only be dependent on
+ information contained within the export or the export files themselves. Individual objects in the
+ XML data files are fully replaced upon load; object instance merging is not supported by import.
+ <b>All data objects imported to the database will replace any existing objects in the Jetspeed
+ database on import.</b>
+ </p>
+ <p>
+ The installer will expect the following files to appear in the import data files location
+ directory specified during the installation:
+ <ul>
+ <li><code>j2-data.xml</code> file</li>
+ <li><code>j2-prefs-data.xml</code> file, (2.1.X exports only)</li>
+ <li><code>pages</code> directory, (assumes Page Manager to be enabled)</li>
+ </ul>
+ All other files in the import data files location directory will be ignored.
+ </p>
+ <p>
+ Jetspeed database import operations should only be attempted on a shutdown portal instance; imports
+ on a running portal may lead to unexpected results and is not supported. If the import is to merge
+ with data already loaded in the database, performing a full backup before the import is highly
+ recommended.
+ </p>
+ <p>
+ To import an existing database export file set, the installer should be obtained and started for the
+ target Jetspeed release version as documented above. The <code>Import Jetspeed Portal Database</code>
+ operation must be selected. The installer will then prompt for the following information:
+ </p>
+ <table>
+ <tr>
+ <th nowrap="true">Installer Prompt</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td nowrap="true"><code>Import data files location</code></td>
+ <td>
+ Select an existing directory that contains the exported Jetspeed database XML files.
+ </td>
+ </tr>
+ <tr>
+ <td nowrap="true"><code>Temporary installation location</code></td>
+ <td>
+ If the default temporary location is not vaild, select a new temporary directory where the
+ installer Jetspeed instance can be unpacked, (it is removed after the installation is
+ complete).
+ </td>
+ </tr>
+ <tr>
+ <td nowrap="true"><code>JVM memory size</code></td>
+ <td>
+ Import operations can consume a large chunk of memory as the database is loaded. Enter
+ a larger JVM maximum memory size in megabytes as necessary for the installer Jetspeed
+ instance invocation.
+ </td>
+ </tr>
+ <tr>
+ <td nowrap="true"><code>Database selection</code></td>
+ <td>
+ Select the target portal database type. DB2, MSSQL, MySql, PostgreSQL, Oracle, and SapDB
+ are supported. Note that Derby is not currently supported.
+ </td>
+ </tr>
+ <tr>
+ <td nowrap="true"><code>Database connection parameters</code></td>
+ <td>
+ Enter or validate the target portal database user, password, connection string, driver
+ class, and driver JAR archive file.
+ </td>
+ </tr>
+ </table>
+ <p>
+ After configuring the import operation, the installer will test the database connection before
+ proceeding to the confirmation page. Continue the installation process as instructed. When it
+ has finished, review the <code>Show Details</code> tab to ensure the export has completed as
+ expected. If the installation fails or errors appear in the detail output, the import has probably
+ failed and the database has been corrupted. The import operation(s) will have to be attempted
+ again from a clean or known database backup state. Problems are normally caused by data
+ incompatabilities/overlap between multiple import data slices or insufficient database permissions
+ granted to the specified database user.
+ </p>
+ </section>
+ </body>
+</document>
+
Modified: portals/site/jetspeed/jetspeed-2.2/src/site/xdoc/guide-migration.xml
URL: http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.2/src/site/xdoc/guide-migration.xml?rev=789542&r1=789541&r2=789542&view=diff
==============================================================================
--- portals/site/jetspeed/jetspeed-2.2/src/site/xdoc/guide-migration.xml (original)
+++ portals/site/jetspeed/jetspeed-2.2/src/site/xdoc/guide-migration.xml Tue Jun 30 03:28:59 2009
@@ -22,15 +22,93 @@
<authors>
<person name="David Sean Taylor" email="taylor@apache.org" />
<person name="Ate Douma" email="ate@douma.nu" />
+ <person name="Randy Watler" email="rwatler@apache.org" />
</authors>
</properties>
<body>
- <section name="Data Migrating from Jetspeed 2.1.3 to 2.2.0">
- <p>Migration from 2.1.3 to 2.2.0 is currently not supported. A migration path from version 2.1.4 to 2.2.1 will be provided with the 2.1.4 and 2.2.1 releases.
+ <section name="Data Migrating from Jetspeed 2.1.3/2.1.4 to 2.2.1">
+ <p>
+ Extensive schema changes were made between the 2.1 and 2.2 versions related to the Portlet API 2.0 Standard
+ implementation, the Pluto 2.0 integration, and the refactoring of the security and SSO components. Here
+ is a summary of the table modifications that were made:
</p>
- </section>
+ <table>
+ <tr><th>Registry and Preferences Table Name</th><th>Modification</th></tr>
+ <tr><td>CUSTOM_PORTLET_MODE</td><td>columns changed</td></tr>
+ <tr><td>CUSTOM_WINDOW_STATE</td><td>columns changed</td></tr>
+ <tr><td>EVENT_ALIAS</td><td>new table</td></tr>
+ <tr><td>EVENT_DEFINITION</td><td>new table</td></tr>
+ <tr><td>FILTERED_PORTLET</td><td>new table</td></tr>
+ <tr><td>FILTER_LIFECYCLE</td><td>new table</td></tr>
+ <tr><td>FILTER_MAPPING</td><td>new table</td></tr>
+ <tr><td>LANGUAGE</td><td>columns changed</td></tr>
+ <tr><td>LOCALE_ENCODING_MAPPING</td><td>new table</td></tr>
+ <tr><td>LOCALIZED_DESCRIPTION</td><td>columns changed</td></tr>
+ <tr><td>LOCALIZED_DISPLAY_NAME</td><td>columns changed</td></tr>
+ <tr><td>NAMED_PARAMETER</td><td>new table</td></tr>
+ <tr><td>PARAMETER</td><td>columns changed</td></tr>
+ <tr><td>PARAMETER_ALIAS</td><td>new table</td></tr>
+ <tr><td>PA_SECURITY_CONSTRAINT</td><td>new table</td></tr>
+ <tr><td>PORTLET_APPLICATION</td><td>columns changed</td></tr>
+ <tr><td>PORTLET_CONTENT_TYPE</td><td>deleted</td></tr>
+ <tr><td>PORTLET_DEFINITION</td><td>columns changed</td></tr>
+ <tr><td>PORTLET_ENTITY</td><td>deleted</td></tr>
+ <tr><td>PORTLET_FILTER</td><td>new table</td></tr>
+ <tr><td>PORTLET_LISTENER</td><td>new table</td></tr>
+ <tr><td>PORTLET_PREFERENCE</td><td>new table</td></tr>
+ <tr><td>PORTLET_PREFERENCE_VALUE</td><td>new table</td></tr>
+ <tr><td>PORTLET_SUPPORTS</td><td>new table</td></tr>
+ <tr><td>PREFS_NODE</td><td>deleted</td></tr>
+ <tr><td>PREFS_PROPERTY_VALUE</td><td>deleted</td></tr>
+ <tr><td>PROCESSING_EVENT</td><td>new table</td></tr>
+ <tr><td>PUBLIC_PARAMETER</td><td>new table</td></tr>
+ <tr><td>PUBLISHING_EVENT</td><td>new table</td></tr>
+ <tr><td>RUNTIME_OPTION</td><td>new table</td></tr>
+ <tr><td>RUNTIME_VALUE</td><td>new table</td></tr>
+ <tr><td>SECURED_PORTLET</td><td>new table</td></tr>
+ <tr><td>SECURITY_ROLE</td><td>columns and constraints changed</td></tr>
+ <tr><td>USER_ATTRIBUTE</td><td>columns changed</td></tr>
+ <tr><td>WEB_APPLICATION</td><td>deleted</td></tr>
+ </table>
+ <p/>
+ <table>
+ <tr><th>Security and SSO Table Name</th><th>Modification</th></tr>
+ <tr><td>SECURITY_ATTRIBUTE</td><td>new table</td></tr>
+ <tr><td>SECURITY_CREDENTIAL</td><td>columns changed</td></tr>
+ <tr><td>SECURITY_DOMAIN</td><td>new table</td></tr>
+ <tr><td>SECURITY_GROUP_ROLE</td><td>deleted</td></tr>
+ <tr><td>SECURITY_PERMISSION</td><td> columns and constraints changed</td></tr>
+ <tr><td>SECURITY_PRINCIPAL</td><td>columns and constraints changed</td></tr>
+ <tr><td>SECURITY_PRINCIPAL_ASSOC</td><td>new table</td></tr>
+ <tr><td>SECURITY_USER_GROUP</td><td>deleted</td></tr>
+ <tr><td>SECURITY_USER_ROLE</td><td>deleted</td></tr>
+ <tr><td>SSO_COOKIE</td><td>deleted</td></tr>
+ <tr><td>SSO_COOKIE_TO_REMOTE</td><td>deleted</td></tr>
+ <tr><td>SSO_PRINCIPAL_TO_REMOTE</td><td>deleted</td></tr>
+ <tr><td>SSO_SITE</td><td>columns and constraints changed</td></tr>
+ <tr><td>SSO_SITE_TO_PRINCIPALS</td><td>deleted</td></tr>
+ <tr><td>SSO_SITE_TO_REMOTE</td><td>deleted</td></tr>
+ </table>
+ <p/>
+ <table>
+ <tr><th>Statisitics Table Name</th><th>Modification</th></tr>
+ <tr><td>ADMIN_ACTIVITY</td><td>column sizes changed</td></tr>
+ <tr><td>USER_ACTIVITY</td><td>column sizes changed</td></tr>
+ </table>
+ <p>
+ Given the extensive modifications made between these releases, migration is best performed using an ETL
+ approach. To support this outside of the Jetspeed portal build and runtime environments, export,
+ initialization, and import functionality have been integrated into the Jetspeed installer. The installer
+ can be downloaded as a binary and, together with a JDBC driver, can be used to migrate from 2.1.3/2.1.4
+ to 2.2.1.
+ </p>
+ <p>
+ Documentation for ETL migration using the Jetspeed installer can be found here: <a href="guide-etl-migration.html">ETL Migration Guide</a>.
+ Note that migration of Derby databases using the installer is not currently supported.
+ </p>
+ </section>
<section name="Data Migrating from Jetspeed 2.1.3 to 2.1.4">
- <p>The following tables describe database schema changes from version 2.1.3 to version 2.1.4.
+ <p>The following tables describe database schema changes from version 2.1.3 to version 2.1.4.
</p>
<subsection name="Constraint removed">
<table>