This appendix describes how to migrate wiki content from wiki applications, such as Confluence, into WebCenter Portal using a custom wiki extraction tool in combination with the Document Migration Utility. The custom wiki extraction tool extracts the wiki content into an archive format that you can import into a WebCenter Portal content repository, using the Document Migration Utility. You should have an understanding of the content created in Content Server for a portal, portal template, wiki documents, and wiki pages, and a detailed understanding of the Document Migration Utility and the format of its archive.
Note:
In this WebCenter Portal release, do not use the Document Migration Utility to export or import portal folders and portal template folders. Starting in release 11.1.1.8.0, content folders are exported with the portal or portal template. For details, see Section 40.1, "Deploying Portals" and Section 40.2, "Deploying Portal Templates."
This appendix includes the following topics:
This section describes the format and how wiki documents and wiki pages work in WebCenter Portal. For more information about wiki documents and wiki pages in WebCenter Portal, see the "Working with Wikis" chapter in Oracle Fusion Middleware Using Oracle WebCenter Portal.
This section contains the following topics:
In WebCenter Portal you can create a wiki document using document task flows. These documents can reside anywhere in the hierarchy of any created folders inside a portal. Wiki documents can sit alongside documents of other types, or you could choose to arrange all your wiki documents inside a single folder.
When a wiki document is created in WebCenter Portal, an HTML document is created and checked into Content Server. This wiki document contains special metadata values that tell WebCenter Portal that the document is a wiki document as opposed to a regular HTML document. These metadata values are:
dDocType = Application dDocFunction = wiki dOriginalName (document filename) = <wikiName>.htm
When you open a document in WebCenter Portal with the above metadata, WebCenter Portal will know to display it as a wiki document.
In WebCenter Portal you can create a wiki page by creating a page based on the Wiki page template. When you navigate to a wiki page you are presented with a wiki document. Depending on the display template of your portal, you may see a Wikis menu, which you can click to list all the wiki pages in your portal. See the "Working with Wikis" chapter in Oracle Fusion Middleware Using Oracle WebCenter Portal for details on how to create wiki pages.
When a wiki page is created in WebCenter Portal the following artifacts are created in Content Server:
A folder is created in the folder for the portal the wiki page is being created in; the name of the wiki folder is the same name as the wiki page name but with special characters removed.
A document is created inside the wiki folder with the following metadata:
dDocTitle = document title (same name as the wiki page name with an extension of .htm)
dOriginalName = the documents filename (same as dDocTitle)
dDocFunction = wiki
dDocType = Application
xWCPageID = the name of the wiki page's JSPX page
This is best illustrated with an example. If the root folder is WebCenter, the portal in which a wiki page is being created is Marketing, and the wiki page being created is Wiki1, the following artifacts will be created in Content Server:
Folder: /WebCenter/Marketing/Wiki1
Document: /WebCenter/Marketing/Wiki1/Wiki1.htm
dDocTitle= Wiki1.htm
dOriginalName = Wiki1.htm
dDocFunction = 'wiki'
dDocType = 'Application'
xWCPageID = Wiki1.jspx
When you navigate to a wiki page the following occurs:
WebCenter Content is queried for the document in the following location:
/<RootFolder>/<PortalFolder>/<wikiPageName>/<wikiPageName>.htm
For example: /WebCenter/Marketing/Wiki1/Wiki1.htm
If the document is found, it is displayed as a wiki document.
If the document is not found the wiki page will display the contents of the wiki folder.
In this WebCenter Portal release (11.1.1.8.3), only use the Document Migration Utility to migrate content from an existing wiki application to WebCenter Portal as described in Section F.3, "Migrating Data from the Source Wiki Application to WebCenter Portal."
Note:
Do not use the Document Migration Utility to export or import portal folders and portal template folders. In this release, content folders are exported with the portal or portal template. For details, see Section 40.1, "Deploying Portals" and Section 40.2, "Deploying Portal Templates."
This section describes the Document Migration Utility. It contains the following topics:
Section F.2.1, "Understanding the Document Migration Utility's Export Function"
Section F.2.2, "Understanding the Document Migration Utility's Import Function"
On export the document content stored in Content Server for the specified portals and portal templates are extracted into a Document Migration Archive. The Document Migration Archive extracts all the contents of a portal or portal template into its own top-level folder in the archive. The name of this folder is based on the internal GUID of the portal or portal template folder in Content Server.
The Document Migration Archive will contain a root folder for each portal or portal template in the export. That is, if you are exporting content from four portals, the archive will have four root folders. The names of these root folders is based on the internal GUID of the corresponding portal or portal template folder in Content Server.
In order to have one archive per portal or portal template, the Document Migration Utility should be called specifying one portal/portal template at a time and a unique archive name.
Inside each top level folder in the archive is an XML document (ExportImportData.xml) that fully describes the data in that root folder (that is, it describes the data exported for that portal or portal template). It contains all the metadata of the folders and files in the source Content Server that are to be maintained on import. For more information about the format of the archive, see Section F.2, "Understanding the Document Migration Utility." For more information about the metadata maintained between the source and target, see Section F.2.2.1, "Understanding How the Document Migration Utility Handles Metadata."
Assuming there are portals or portal templates for which contents are to be exported, the following occurs during export:
A temporary directory is created.
For each portal or portal template:
a directory is created in the temporary directory with its name being the GUID of the corresponding folder in Content Server
an ExportImportData.xml document is created inside that new directory
Content Server is queried for the contents of the portal/portal template
If there are contents, they are read and information about the folders/documents are written to the ExportImportData.xml document and the files are downloaded into the temporary directory
If there are contents, they are read and information about the folders and documents are written to the ExportImportData.xml document. The actual files are downloaded into the directory maintaining the folder hierarchy as in the Content Server. For example, if in the Content Server the document doc1.doc is in folder Folder1 the document will be added to the root folder under Folder1 as shown below.
/<tmpDir>/<portalFolder>/Folder1/doc1.doc
After all contents have been extracted, the entire contents of the temporary directory are zipped up into the Document Migration Archive.
Before you import content using the Document Migration Utility, the target portal and/or portal templates must exist on the target Content Server. If these folders do not exist in Content Server the import of document content will fail.
Note:
You cannot simply create a portal or portal template in the target with the same name as in the source and expect it to work. If you do this, the folder in Content Server will have the same name as in the source but with a different GUID. It is this folder GUID that is used to tie the portal in WebCenter Portal with the folder in Content Server as well as what is used to synchronize the data in the export archive with the target folder in the target Content Server.
On import, the Document Migration Archive is read and for each portal or portal template's data the content is recreated in the corresponding portal or portal template's folder in the target Content Server. The names of the top level folders in the archive are used to synchronize with the portal or portal template folder in the target Content Server instance. If the portal or portal template folders in the target Content Server already contain content, the content is deleted before the import process begins.
Note:
the default behavior can be overwritten by specifying the CheckExistingContents property (values are true or false) in the properties file when running the Document Migration Utility specifying all the properties in a file. When set to false, the default behavior is overridden such that the target folder is not checked for any existing content and any existing content is not deleted. Care should be taken with having this setting as false; if there is any content in the target with the same Content ID or any content in the same folder with the same filename, the import will fail.
The XML document (ExportImportData.xml) located inside each top level folder is used to drive the import. This document describes the hierarchy of files and folders to recreate in the target Content Server. It also contains the metadata to be used when creating the artifacts and for documents it contains the path to the native file in the archive to use in the upload. For more information about the format of the archive, see Section F.2, "Understanding the Document Migration Utility."
On import, the following happens:
The Document Migration Archive is unzipped into a temporary directory
For each folder at the root of the archive (which represent a portal or portal template):
The corresponding folder is obtained from the target Content Server instance (using the folder name that is the GUID of the folder in Content Server)
The ExportImportData.xml document is read
For each folder or file described in the ExportImportData.xml the contents are recreated in the target instance
The attributes in the ExportImportData.xml document for the folders and files are used as metadata for the contents being created and the files are uploaded from the corresponding location in the archive.
At the end of a successful import, this temporary directory is deleted. If the import fails before completion, this temporary directory will remain.
The Document Migration Utility will maintain as much metadata as possible between the source and target. Most internal metadata (such as IDs), however, are not maintained. The following metadata is not included in the export set:
Any date metadata, such as the creation date (for example, dCreateDate, dReleaseDate, dDocLastModifiedDate)
For a document:
No internal identifiers for the document revisions or renditions (for example, dID, dDoc). Note that the content ID, dDocName, is included
The ID of the folder in which the document resides (for example, xCollectionID)
No Web-viewable renditions, as these will be recreated when the document is checked into the target
No information about the actual file (for example, its file type or mimetype) as these will get set when document is checked into the target
No status information, such as checked out, released state as these are irrelevant when creating the document in the target (for example, dIsCheckedOut, dReleaseState)
For a folder:
No internal identifiers or paths such as the parent folder ID, or its own path (for example, hasCollectionID, dCollectionID, dCollectionGUID, hasCollectionPath, dCollectionPath)
Storage rule, as this is dependent on the configuration of the target Content Server
Security group or other security permissions, as these will get set when the content is created in the target (for example, dSecurityGroup, dRead, canReadCollection)
Metadata that is maintained:
Names of artifacts, such as folder name or document title (for example, dCollectionName, dDocTitle)
User name of person who created the content and modified it (for example, dCollectionOwner, dDocOwner)
Wiki metadata, such as dDocFunction, dDocType, xWCPageID
For a document:
The name of the file to upload for the document (dOriginalName)
The content ID (dDocName)
If at the time of import a content item already exists in the target Content Server with the same content ID, import will fail. When rerunning an import with the property CheckExistingContents=false set, ensure that the target folder does not already contain the contents from the archive being imported to avoid a content ID error.
Custom metadata (for example, myCustomInteger).
The Document Migration Utility creates a single archive when exporting content from a source Content Server. The archive is used when running the Document Migration Utility to import the data into the target environment. The Document Migration archive has a specific layout and if an archive does not match this layout, the Document Migration Utility import will fail.
The following describes the layout of the Document Migration Archive.
At the top level of the archive is a folder for each portal/portal template that has had their data exported.
If a single portal/portal template has been exported there will only be one root folder, if multiple portals/portal templates have been exported there will be multiple root folders.
The root folder names are the same as the internal GUID of the corresponding folder in Content Server (for example, 13828FE1-75D8-4A0B-A53B-A76AE78C1AE6)
In each top level folder is an ExportImportData.xml document that describes the hierarchy of files and folders to recreate in the target Content Server for that portal or portal template. This document contains the metadata to be used when creating the artifacts (internal metadata, such as xCollectionID, isreadonly, xStorageRule, will not be included). For documents, it contains the path to the native file in the archive to use in the upload.
In each top-level portal and portal template folder are the exported documents. The layout of the documents inside the top-level folder mimics the layout in the source portal and portal template in the source Content Server. For example, if document doc1.doc resides in folder1, the top-level folder in the archive will contain a folder folder1 in which doc1.doc resides. The documents file/folder structure in the top-level folder must match the hierarchy described in the ExportImportData.xml so that the import code can find the native file for the documents described in that document uploading the document into the target. Empty folders in the portal or portal template folder in the source will not be in the archive. However, these folders are still described in the ExportImportData.xml document in order for them to be recreated in the target.
In a simplified overview, this would look like:
Portal1 top level folder:
ExportImportData.xml
<Portal1's documents arranged in the same folder hierarchy as in the source>
Portal2 top level folder:
ExportImportData.xml
<Portal2's documents arranged in the same folder hierarchy as in the source>
Understanding the ExportImportData.xml Document
The XSD for the ExportImportData.xml document is shown below.
XSD for ExportImportData.xml:
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="groupspace-folder" type="FolderType" />
<!-- 'folders' must contain 1 or more 'folder' child elements -->
<xs:complexType name="FoldersType">
<xs:sequence>
<xs:element name="folder" type="FolderType"
minOccurs="1" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
<!-- 'documents' must contain 1 or more 'document' elements -->
<xs:complexType name="DocumentsType">
<xs:sequence>
<xs:element name="document" type="DocumentType"
minOccurs="1" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
<!-- 'attributes' must have 1 or more 'attribute' child elements -->
<xs:complexType name="AttributesType">
<xs:sequence>
<xs:element name="attribute" type="AttributeType"
minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<!-- 'folder' has to have 1 and only 1 'attributes' child element
0 or 1 'folders' child element, 0 or 1 'documents' child element -->
<xs:complexType name="FolderType">
<xs:sequence>
<xs:element name="attributes" type="AttributesType"
minOccurs="1" maxOccurs="1" />
<xs:element name="folders" type="FoldersType"
minOccurs="0" maxOccurs="1" />
<xs:element name="documents" type="DocumentsType"
minOccurs="0" maxOccurs="1" />
</xs:sequence>
</xs:complexType>
<!-- 'document' has to have : 1 and only 1 'attributes' child element
and nothing else -->
<xs:complexType name="DocumentType">
<xs:sequence>
<xs:element name="attributes" type="AttributesType"
minOccurs="1" maxOccurs="1" />
</xs:sequence>
</xs:complexType>
<!-- 'attribute' element has to have a 'name' and 'value' attributes -->
<xs:complexType name="AttributeType">
<xs:attribute name="name" type="xs:string" use="required" />
<xs:attribute name="value" type="xs:string" use="required" />
</xs:complexType>
</xs:schema>
Where:
<groupspace-folder> is the root tag that represents the portal or portal template folder.
This tag contains the <attributes> tag, which in turn contains a number of attributes about the root folder and export data. These attributes are for information purposes only; they are not used in the import.
<attributes> is used to group all the attributes of the document or folder.
This tag must contain one or more <attribute> tags. No other child tags are permitted.
<attribute> contains the metadata for a folder or document.
This tag has two attributes:
name - the Content Server metadata name
value - the value of the metadata
No child tags are permitted.
<folders> is used to group all the folders in the current folder
This tag must contain 1 or more <folder> tags. No other child tags are permitted.
<folder> is used to indicate a child folder.
This tag must have the <attributes> tag. If the folder has child folders, it will have the <folders> tag. If the folder has child documents, it will have the <documents> tag.
<documents> is used to group all the documents in the current folder.
This tag must contain one or more <document> tags. No other child tags are permitted.
<document> is used to indicate a document in the current folder.
This tag must have the <attributes> tag. No other child tags are permitted.
Annotated example:
The following annotated example shows a partially complete ExportImportData.xml document. Note that the example contains blank lines and XML comments that should not exist in a real ExportImportData.xml document.
<?xml version="1.0"encoding="UTF-8"standalone="yes"?>
<groupspace-folder>
<attributes>
<!-- Contains a set of attributes of the main portal folder -->
<attribute name="export-date" value="2011-07-22 13:02:29"/>
</attributes>
<folders> <!-- only present if the portal contains any child folders -->
<folder> <!-- a 'folder' tag exists for each child folder -->
<attributes>
<!-- contains the set of folder attributes, examples below -->
<attribute value="F1" name="dCollectionName"/>
</attributes>
<!-- a 'folder' tag will contain the 'folders' tag if this folder
contains child folders, i.e. if 'F1' has child folders -->
<folders>
<folder>
<!-- attribute tags, child folders, child documents etc -->
</folder>
</folders> <!-- closing tag for all the folders in the
current folder à
<!-- a 'folder' tag will contain the 'documents' tag if this folder
contains documents, i.e. if 'F1' has documents at its root -->
<documents>
<document>
<!-- attributes tags, see below -->
</document>
</documents> <!-- closing tag for all the documents in the
current folder -->
</folder> <!-- closing tag for folder 'F1' -->
</folders> <!-- closing tag for all the folders in the portal root -->
<documents> <!- only present if the folder contains any documents
in the root folder -->
<document> <!-- a 'document' tag exists for each document in the
folder -->
<attributes>
<!- contains the set of document attributes, examples below -->
<attribute name="dDocTitle" value="Doc1"/>
<attribute name="xForceFolderSecurity" value="TRUE"/>
<attribute name="xSecurityClearanceLevel" value="public"/>
</attributes>
<document> <!-- closing tag for document 'Doc1' -->
</documents><!-- closing tag for all the documents in the portal root -->
</groupspace-folder>
Building the ExportImportData.xml Document
The following shows pseudo code for how the XML document is built:
- query Content Server for the portal's folder information
- create a 'group-space-folder' node
- create an 'attributes' node
- for each of the three attributes we want to maintain (folder name, path
and GUID)
- create an 'attribute' node with name and value
- add that 'attribute' node to the 'attributes' node
- add that 'attributes' node to the 'group-space-folder' node
- query Content Server for the contents of the portal root folder
- * If there are child folders
- Create a 'folders' node
- For each child folder
- create a 'folder' node
- create an 'attributes' node
- for each folder metadata we want to maintain
- create an 'attribute' node with name and value
- add that 'attribute' node to the 'attributes' node
- add the 'attributes' node to the 'folder' node
- query Content Server for the contents of this current folder
- go to * and repeat traversing folders which reside in this
current folder
- go to # and repeat for documents which reside in this current
folder
- add the 'folder' node to the 'folders' node
- add the 'folders' node to the parent node (which will either be a
'folder' node or the 'group-space-folder' node)
- # If there are documents in this current folder
- create a 'documents' node
- for each document
- create a 'document' node
- create an 'attributes' node
- for each metadata we want to maintain
- create an 'attribute' node with name and value
- add that 'attribute' node to the 'attributes' node
- add the 'attributes' node to the 'document' node
- add that 'document' node to the 'documents' node
- add the 'documents' node to the 'folder' node
- use jaxb to write the whole data to an xml file
Document Migration Archive Example
Below is an example of the archive format for a set of sample data and a sample ExportImportData.xml document for one of the portals in the example.
WebCenter Data
In the example below, two portals (Marketing and Sales) have been created in WebCenter Portal. In the Marketing portal two wiki pages have been created: MarketingWiki and Tradeshows. The Marketing portal has also had two folders created (Branding and Presentations), the latter of which contains subfolders with a PowerPoint document and a wiki document. The Sales portal has no wiki pages, but does contain three folders with some contents.
Marketing
Marketing portal contains the Content Server folder GUID= 29A4E019-7AE7-46A1-823B-AF16A313BBEF
MarketingWiki
MarketingWiki.htm with the following metadata:
dOriginalName="MarketingWiki.htm"
dDocTitle="MarketingWiki.htm"
dDocFunction="wiki"
dDocType="Application"
xWCPageID="Page2.jspx"
Presentations
Branding
ProductBranding.pptx
Presentation Dates.htm with the following metadata:
(Note that here the wiki document is created inside a folder in a portal, rather than being created when a wiki page is created as for MarketingWiki.htm above)
dOriginalName=" Presentation Dates.htm"
dDocTitle="Presentation Dates"
dDocFunction="wiki"
dDocType="Application"
xWCPageID = not set (as the wiki was not created when creating a wiki page)
ProjectedDesigns.pptx
Products
TradeShows
TradeShows.htm with the following metadata:
dOriginalName=" TradeShows.htm"
dDocTitle=" TradeShows.htm"
dDocFunction="wiki"
dDocType="Application"
xWCPageID="Page4.jspx"
Sales
WebCenter Content folder GUID = 629BFEBD-4E83-4DCA-895A-C72E5192FBFD
DecConference
GuestSpeakers.doc
SalesConference
Attendees.doc
TalkSchedules.doc
BudgetForcasts.doc
Archive Contents
29A4E019-7AE7-46A1-823B-AF16A313BBEF (contains Marketing portal contents)
MarketingWiki
MarketingWiki.htm
Presentations
Branding (ProductBranding.pptx)
ProjectedDesigns.pptx
Presentation Dates.htm
Tradeshows
TradeShows.htm
ExportImportData.xml
2001Plans.doc
629BFEBD-4E83-4DCA-895A-C72E5192FBFD (contains Sales portal contents)
DecConference
GuestSpeakers.doc
SalesConference
Attendees.doc
TalkSchedules.doc
ExportImportData.xml
BudgetForcasts.doc
Note:
There is no Products folder under the Marketing portal's root folder as this folder did not contain any documents.
ExportImportData.xml for the Marketing portal
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<groupspace-folder>
<attributes>
<attribute value="2011-10-27 15:50:18" name="export-date" />
<attribute value="/WebCenter0711/Marketing/" name="group-space-path" />
<attribute value="Marketing" name="group-space-name" />
<attribute value="29A4E019-7AE7-46A1-823B-AF16A313BBEF"
name="group-space-guid" />
</attributes>
<folders>
<folder>
<attributes>
<attribute value="TRUE" name="xForceFolderSecurity" />
<attribute value="sysadmin" name="dCollectionCreator" />
<attribute value="MarketingWiki" name="dCollectionName" />
<attribute value="0" name="isLink" />
<attribute value="Page2.jspx" name="xWCPageId" />
<attribute value="sysadmin" name="dCollectionOwner" />
<attribute value="sysadmin" name="dCollectionModifier" />
<attribute value="1" name="dCollectionEnabled" />
</attributes>
<documents>
<document>
<attributes>
<attribute value="TRUE" name="xForceFolderSecurity" />
<attribute value="Page2.jspx" name="xWCPageId" />
<attribute value="wiki" name="dDocFunction" />
<attribute value="Application" name="dDocType" />
<attribute value="0" name="ishidden" />
<attribute value="sysadmin" name="dDocOwner" />
<attribute value="MarketingWiki.htm" name="dOriginalName" />
<attribute value="MarketingWiki.htm" name="dDocTitle" />
<attribute value="FALSE" name="xInhibitUpdate" />
<attribute value="0" name="isreadonly" />
<attribute value="0" name="CustomInteger" />
<attribute value="sysadmin" name="dDocCreator" />
<attribute value="sysadmin" name="dDocAuthor" />
<attribute value="OWCSVR01USORAC012754" name="dDocName" />
<attribute value="1" name="dRevisionID" />
<attribute value="sysadmin" name="dDocLastModifier" />
</attributes>
</document>
</documents>
</folder>
<folder>
<attributes>
<attribute value="TRUE" name="xForceFolderSecurity" />
<attribute value="sysadmin" name="dCollectionCreator" />
<attribute value="Presentations" name="dCollectionName" />
<attribute value="0" name="isLink" />
<attribute value="sysadmin" name="dCollectionOwner" />
<attribute value="sysadmin" name="dCollectionModifier" />
<attribute value="1" name="dCollectionEnabled" />
</attributes>
<folders>
<folder>
<attributes>
<attribute value="TRUE" name="xForceFolderSecurity" />
<attribute value="sysadmin" name="dCollectionCreator" />
<attribute value="Branding" name="dCollectionName" />
<attribute value="0" name="isLink" />
<attribute value="sysadmin" name="dCollectionOwner" />
<attribute value="sysadmin" name="dCollectionModifier" />
<attribute value="1" name="dCollectionEnabled" />
</attributes>
<documents>
<document>
<attributes>
<attribute value="TRUE" name="xForceFolderSecurity" />
<attribute value="Document" name="dDocType" />
<attribute value="sysadmin" name="dDocOwner" />
<attribute value="0" name="ishidden" />
<attribute value="ProductBranding.pptx" name="dDocTitle" />
<attribute value="ProductBranding.pptx"
name="dOriginalName" />
<attribute value="FALSE" name="xInhibitUpdate" />
<attribute value="0" name="isreadonly" />
<attribute value="0" name="CustomInteger" />
<attribute value="sysadmin" name="dDocCreator" />
<attribute value="sysadmin" name="dDocAuthor" />
<attribute value="OWCSVR01USORAC012748" name="dDocName" />
<attribute value="1" name="dRevisionID" />
<attribute value="sysadmin" name="dDocLastModifier" />
</attributes>
</document>
</documents>
</folder>
</folders>
<documents>
<document>
<attributes>
<attribute value="TRUE" name="xForceFolderSecurity" />
<attribute value="wiki" name="dDocFunction" />
<attribute value="Application" name="dDocType" />
<attribute value="0" name="ishidden" />
<attribute value="sysadmin" name="dDocOwner" />
<attribute value="Presentation Dates" name="dDocTitle" />
<attribute value="Presentation Dates.htm"
name="dOriginalName" />
<attribute value="FALSE" name="xInhibitUpdate" />
<attribute value="0" name="isreadonly" />
<attribute value="0" name="CustomInteger" />
<attribute value="sysadmin" name="dDocCreator" />
<attribute value="sysadmin" name="dDocAuthor" />
<attribute value="OWCSVR01USORAC012758" name="dDocName" />
<attribute value="1" name="dRevisionID" />
<attribute value="sysadmin" name="dDocLastModifier" />
</attributes>
</document>
<document>
<attributes>
<attribute value="TRUE" name="xForceFolderSecurity" />
<attribute value="Document" name="dDocType" />
<attribute value="sysadmin" name="dDocOwner" />
<attribute value="0" name="ishidden" />
<attribute value="ProjectedDesigns.pptx" name="dDocTitle" />
<attribute value="ProjectedDesigns.pptx"
name="dOriginalName" />
<attribute value="FALSE" name="xInhibitUpdate" />
<attribute value="0" name="isreadonly" />
<attribute value="0" name="CustomInteger" />
<attribute value="sysadmin" name="dDocCreator" />
<attribute value="sysadmin" name="dDocAuthor" />
<attribute value="OWCSVR01USORAC012747" name="dDocName" />
<attribute value="1" name="dRevisionID" />
<attribute value="sysadmin" name="dDocLastModifier" />
</attributes>
</document>
</documents>
</folder>
<folder>
<attributes>
<attribute value="TRUE" name="xForceFolderSecurity" />
<attribute value="sysadmin" name="dCollectionCreator" />
<attribute value="Products" name="dCollectionName" />
<attribute value="0" name="isLink" />
<attribute value="sysadmin" name="dCollectionOwner" />
<attribute value="sysadmin" name="dCollectionModifier" />
<attribute value="1" name="dCollectionEnabled" />
</attributes>
</folder>
<folder>
<attributes>
<attribute value="TRUE" name="xForceFolderSecurity" />
<attribute value="sysadmin" name="dCollectionCreator" />
<attribute value="TradeShows" name="dCollectionName" />
<attribute value="0" name="isLink" />
<attribute value="Page4.jspx" name="xWCPageId" />
<attribute value="sysadmin" name="dCollectionOwner" />
<attribute value="sysadmin" name="dCollectionModifier" />
<attribute value="1" name="dCollectionEnabled" />
</attributes>
<documents>
<document>
<attributes>
<attribute value="TRUE" name="xForceFolderSecurity" />
<attribute value="Page4.jspx" name="xWCPageId" />
<attribute value="wiki" name="dDocFunction" />
<attribute value="Application" name="dDocType" />
<attribute value="0" name="ishidden" />
<attribute value="sysadmin" name="dDocOwner" />
<attribute value="TradeShows.htm" name="dOriginalName" />
<attribute value="TradeShows.htm" name="dDocTitle" />
<attribute value="FALSE" name="xInhibitUpdate" />
<attribute value="0" name="isreadonly" />
<attribute value="0" name="CustomInteger" />
<attribute value="sysadmin" name="dDocCreator" />
<attribute value="sysadmin" name="dDocAuthor" />
<attribute value="OWCSVR01USORAC012756" name="dDocName" />
<attribute value="1" name="dRevisionID" />
<attribute value="sysadmin" name="dDocLastModifier" />
</attributes>
</document>
</documents>
</folder>
</folders>
<documents>
<document>
<attributes>
<attribute value="TRUE" name="xForceFolderSecurity" />
<attribute value="Document" name="dDocType" />
<attribute value="sysadmin" name="dDocOwner" />
<attribute value="0" name="ishidden" />
<attribute value="2011Plans.doc" name="dDocTitle" />
<attribute value="2011Plans.doc" name="dOriginalName" />
<attribute value="FALSE" name="xInhibitUpdate" />
<attribute value="0" name="isreadonly" />
<attribute value="0" name="CustomInteger" />
<attribute value="sysadmin" name="dDocCreator" />
<attribute value="sysadmin" name="dDocAuthor" />
<attribute value="OWCSVR01USORAC012746" name="dDocName" />
<attribute value="1" name="dRevisionID" />
<attribute value="sysadmin" name="dDocLastModifier" />
</attributes>
</document>
</documents>
</groupspace-folder>
To migrate content from an existing wiki application to WebCenter Portal, perform the following steps:
Prepare WebCenter Portal for import of the wiki content.
Write and run a 'Custom Wiki Extraction Tool' to extract content from the Wiki application into an archive matching the precise format expected by the Document Migration Utility.
Use the Document Migration Utility to import the archive into Content Server.
Create any wiki pages in WebCenter Portal to tie up with the content in Content Server.
These steps are described in more detail in the following topics:
Section F.3.1, "Preparing WebCenter Portal for Importing Wiki Content"
Section F.3.3, "Using the Document Migration Utility to Import the Archive into the Target Portal"
Section F.3.4, "Creating Wiki Pages in WebCenter Portal for the Content in Content Server"
When the documents tool is enabled in a portal or portal template, a folder is created in Content Server for that portal or portal template. The GUIDs of these folders must be determined in order to construct the archive to be used with the Document Migration Utility. The folder GUIDs can be determined by following steps below:
Decide if you want to import all the wiki content into a single portal or multiple portals.
Log into WebCenter Portal and create the portals, taking note of the internal name of the portals.
Ensure you are using a template that includes documents tool, otherwise you will have to enable the documents tool and setup the role permissions after portal creation.
Log into Content Server.
Ensure that the user's layout is Top Menus:
Click the user's name to display the user's Profile page.
Under User Personalization Settings check that Layout is set to Top Menu.
For each portal in which wiki content is to be imported, determine the folder GUID:
Click Browse Content.
Click on the root folder for the WebCenter Portal instance.
This is the same as the Root Folder setting in the Content Server connection.
Click the folder for the portal.
The folder name will be the same as the portal's internal name.
Click Info on the toolbar to display the folder information.
Add IsSoap=1 to the URL.
Search for the string dCollectionGUID. For example:
<idc:field name="dCollectionGUID">05573322-E895-EDA3-8A83-07CF39CBDE05</idc:field>
Keep a note of the portal folder name and its GUID as the GUID is needed when building the archive in the next step.
To extract content from the source wiki application into an archive suitable for use with the Document Migration Utility, you'll need to write a custom application. For information about the format of the archive, see Section F.2, "Understanding the Document Migration Utility."
The custom wiki extraction tool must perform the following steps:
Extract and arrange the wiki content.
Create a temporary directory and extract the wiki content from the source wiki application into it and arrange in the file system as it is to appear in WebCenter Portal.
Clean up the source HTML of wiki documents.
For each wiki document, edit the HTML to remove application-specific HTML tags.
Re-write the URLs.
For each wiki document, replace the existing URLs to content in the source wiki application to the URLs of the same artifacts that will be imported into WebCenter Portal.
Build the ExportImportData.xml documents.
For each root folder build the ExportImportData.xml document which describes the data in the export set and is used to drive the import
Build the archive file.
Create an archive of the manipulated wiki content that can be used to import the wiki content into WebCenter Portal.
Each of these steps is described more fully in the following topics:
Section F.3.2.1, "Extracting and Arranging the Wiki Content"
Section F.3.2.2, "Cleaning Up the Source HTML of Wiki Documents"
Section F.3.2.4, "Building the ExportImportData.xml Documents"
The wiki documents in the source application need to be extracted into a temporary directory on the file system and then arranged such that the file system mimics how the content is to be laid out in the target WebCenter Portal instance. If all the wiki documents are to be imported into a single portal, all of the content should be laid out under a single root folder named with the GUID of the corresponding portal folder in Content Server. If the wiki documents are to be imported into multiple portals, the content should be laid out under multiple root folders, each named with the GUID of their corresponding folder in Content Server. For more information on determining the GUID of a portal folder in Content Server, see Section F.3.1, "Preparing WebCenter Portal for Importing Wiki Content."
Note that when arranging the wiki content on the file system, you should consider how that content will be used in WebCenter Portal. For example:
If wiki pages are to be created, then the wiki document for that wiki page must be located under a folder of the same name. For more information about wiki pages, see Section F.1, "Understanding Wiki Documents and Wiki Pages."
When a folder contains a large number of contents, the rendering of that folder's contents could be impaired.
Content Server has two settings that limit the number of folders and the number of files which can reside in a folder (Maximum Folders Per Virtual Folder and Maximum Content Per Virtual Folder). When arranging your wiki content, ensure that a folder does not contain more folders than the folder limit setting or more documents than the document limit setting.
To create extracted wiki content, perform the following tasks:
Create root folders for each portal into which you will be importing the wiki documents, name the folders based on the GUID of the corresponding portal folder in Content Server.
For wiki documents for which wiki pages will be created in WebCenter Portal after import:
Create a wiki folder with the same name as the wiki document.
Place the wiki document in this folder.
Place any other documents in this folder, if required.
If there are related images and/or documents, add them to this wiki folder as well.
For any other wiki documents, create the folder hierarchy that will contain the documents.
Example:
Portal S1's folder in Content Server has a GUID of 21SD15F13B8_141D_421B_AD0e_BC54B6F16893. After import, the MarketingWiki and Tradeshows wiki pages will be created and it is expected these wiki pages will show the MarketingWiki.htm and Tradeshows.htm wiki documents.
The following shows the organized structure of the extracted wiki documents and artifacts:
21SD15F13B8_141D_421B_AD0e_BC54B6F16893 (Root portal folder)
Home.htm (Wiki document)
MarketingWiki (Folder)
MarketingWiki.htm (Wiki document)
Branding (Folder)
Presentation Dates.htm (Wiki document)
Presentations (Folder)
ProductBranding.pptx (File)
ProjectedDesigns.pptx (File)
Tradeshows (Folder)
TradeShows.htm (Wiki document)
Images (Folder)
Image.jpg (Image)
In WebCenter Portal, the wiki editor will remove any HTML tags when the wiki page is being edited. Therefore it is advisable to remove any such HTML tags in the wiki documents prior to importing them into WebCenter Portal to avoid any confusion of tags being removed when editing a wiki document after import. The following tags can be safely removed:
<html>, </html> <head>, </head> <meta>, </meta> <title>, </title> <body>, </body> <tbody>, </tbody> <thead>, </thead> <tfoot>, </tfoot> <script>, </script> <link>, </link>
Wiki pages in the source wiki application may contain URLs referencing artifacts in within the source wiki application, such as links for embedded images or to other wiki page or documents. These artifacts will be migrated to the target WebCenter Portal instance and these links will need to be updated to reference the new artifact locations in the target WebCenter Portal instance.
The following types of URLs in the extracted wiki pages need to be changed to reference the URLs of the same artifacts in WebCenter Portal:
Links to other Wiki pages
Links to embedded images
Links to documents
Follow the steps below to rewrite the URLs in the wiki documents:
Define attributes for the target WebCenter Portal instance that will be used in the URL replacement in step 3.
WC_BASE_URL: WebCenter instance base URL
Example: WC_BASE_URL=https://webcenter.example.com
UCM_ID: The name of the connection in WebCenter Portal to the Content Server
Example: UCM_ID=dev_ucm
SPACE_GUID: The GUID of the portal in WebCenter Portal where the content resides
Example: SPACE_GUID=s21sd15f13b8_141d_421b_ad0e_bc54b6f16893
For more information about determining the GUID, see Section F.3.1, "Preparing WebCenter Portal for Importing Wiki Content."
For each content item, define the item attributes that will be used in the URL replacement in step 3.
FILE_NAME: File name of the content item
Example: FILE_NAME=Home.htm
FILE_ID: Unique Content Server content ID
Example: MARKETINGPORTAL1001
Note that the FILE_ID must be unique across the entire Content Server instance. A suggested value is the name of the portal which the wiki documents are going to be imported into (with no portal in the name) post-fixed with a unique number (in the example above, the portal name was Marketing Portal).
Rewrite the URLs using the defined attributes as shown below:
Embedded images
New URL format:
IMG_REPLACE=img alt="FILE_NAME" resourceid="UCM_ID#dDocName:FILE_ID" src="WC_BASE_URL/webcenter/content/conn/UCM_ID/uuid/dDocName%3aFILE_ID"
Example:
Source URL:
<img alt="image.jpg" src="images/image.jpg">
WebCenter URL:
<img alt="image.jpg" resourceid="dev-ucm#dDocName:WSIMPORT4" src="http://webcenter.example.com/webcenter/content/conn/dev-ucm/uuid/dDocName%3aWSIMPORT4">
Wiki pages
New URL format:
URL_REPLACE=WC_BASE_URL/webcenter/faces/owResource.jspx?z=oracle.webcenter.doclib%21SPACE_GUID%21UCM_ID%2523dDocName%253AFILE_ID%21%21FILE_NAME
Example:
Source URL:
<a href="Home.htm">Home</a>
WebCenter URL:
<a href="http://webcenter.example.com/webcenter/faces/owResource.jspx?z=oracle.webcenter.doclib%21sd15f13b8_141d_421b_ad0e_bc54b6f16893%21dev-ucm%2523dDocName%253AWSIMPORT25%21%21Home.htm>Home</a>
Links to documents
New URL format:
DOCUMENT_REPLACE=WC_BASE_URL/webcenter/content/conn/UCM_ID/uuid/dDocName%3aFILE_ID
Example:
Source URL:
<a href="MarketingWiki/Presentations/ProductBranding.pptx"> Download Product Branding Presentation</a>
WebCenter URL:
<a href="http://webcenter.example.com/webcenter/content/dev-ucm/uuid/dDocName%3aWSIMPORT7"> Download Product Branding Presentation</a>
In each root folder containing the contents to be imported an ExportImportData.xml document needs to be created. The ExportImportData.xml document describes the contents of the root folder and is used to drive the import when importing the content into WebCenter Portal using the Document Migration Utility. For more information about the Document Migration Utility and the ExportImportData.xml document, see Section F.2, "Understanding the Document Migration Utility."
Any metadata to be created with the document on import must be specified in the ExportImportData.xml document. In WebCenter Portal, wiki documents are stored as HTML documents but have extra metadata to identify them as wiki documents rather than normal HTML documents. Ensure the ExportImportData.xml document has this metadata specified for all wiki documents in the extracted contents. For more information about the metadata required for wiki document, see Section F.1, "Understanding Wiki Documents and Wiki Pages."
Note:
A content ID (dDocName) is automatically generated by Content Server when a document is checked in without one being specified. If you wish your documents to have fixed content IDs, include the dDocName metadata with the document metadata in the ExportImportData.xml document. The dDocName must be unique across the whole Content Server or document check in will fail. A suggestion is to chose your own prefix for the content ID and append numbers incrementally to the end.
The ExportImportData.xml document can be generated manually for each root folder. Alternatively, you can write a custom script to traverse through the root folder contents and generate the document.
It is imperative for the structure of the contents on the file system is detailed in ExportImportData.xml document correctly. If there is a mismatch between the hierarchy of contents described in the ExportImportData.xml document and the file system, the import into the portal folder in the target Content Server will fail.
Example:
In this example a custom script named convert_program traverses through a root folder called 21SD15F13B8_141D_421B_AD0e_BC54B6F16893 and creates an ExportImportData.xml document in the current working directory detailing the contents of the folder.
cd 21SD15F13B8_141D_421B_AD0e_BC54B6F16893 run convert_program
Create an archive of the extracted and manipulated wiki documents by zipping up the root portal folders. The zip archive must have the root folders inside the archive rather than just the contents of the root folders. One zip file can contain multiple root folders for different portals, or you can create one zip file for each root folder.
Example:
In the following example, wiki documents have been extracted and manipulated in a folder called 21SD15F13B8_141D_421B_AD0e_BC54B6F16893 in the folder /scratch/wikiexports and the archive to create is wsimport.zip.
cd /scratch/wikiexports zip –r wcimport.zip 21SD15F13B8_141D_421B_AD0e_BC54B6F16893/
Note:
Ensure that the archive does not exist prior to zipping up the folder contents as some zip tools will add content to the specified archive if it already exists rather than overwriting the archive.
Run the Document Migration Utility specifying the archive generated in the previous step to import the content into the target Content Server. For information about using the Document Migration Utility, see Section F.3.3.2, "Migrating Content Using the Document Migration Utility."
Log into WebCenter Portal and navigate to the portals to which content was imported and ensure the content exists.
Table F-1 describes the properties required to run the Document Migration Utility. For information on how to run the utility, see Section F.3.3.2, "Migrating Content Using the Document Migration Utility."
Table F-1 Document Migration Properties
| Property | Description | Requirement |
|---|---|---|
|
Usage |
Specifies whether you want to import or export content to a file. Options are: |
Export and Import |
|
MDSConn |
Specifies MDS JDBC connection in the format:
|
Export |
|
MDSUser |
Specifies the MDS user name used by WebCenter Portal. |
Export |
|
MDSPwd |
Specifies password for the MDS user. Only include to avoid password prompt. |
Export |
|
ExportScopes |
Specifies the internal name of each portal/portal template with content to export. Separate multiple portal/template names with a comma. Prefix portal template names with You can obtain internal names from the About Portal and About Portal Template dialogs. Do not enter display names here. |
Export |
|
UCMConn |
Specifies Content Server URL in the format: When When |
Export and Import |
|
UCMUser |
Specifies the Content Server user name used to connect through RIDC. This user must have sufficient privileges to perform the export or import; either a user defined in an external identity store or the Content Server administrator |
Export and Import |
|
UCMPwd |
Specifies password for the Content Server user. Only include to avoid password prompt. |
Export and Import |
|
TmpDirPath |
Optional. Temporary location for data extraction. If not specified, defaults to the system |
Export and Import |
|
ArchivePath |
Document archive location. |
Export and Import |
|
ArchiveName |
Optional. Name for the document archive ( |
Export and Import |
You can use any of the following methods:
Specifying Document Migration Properties in a Properties File
Specifying Document Migration Properties on the Command Line
Specifying Document Migration Properties on the Command Line When Prompted
Specifying Document Migration Properties in a Properties File
Create a properties file containing all the properties required for your export/import. See Table F-1 for a description of all the properties.
Copy and paste the following properties file into Notepad or another suitable text editor, then edit according to your environment:
# Document migration properties. # Specify whether you want to export content to a file or # import content from an archive to another content repository # valid values: export | import Usage=export # Specify connection details for Oracle WebCenter Content repository: # UCMConn - Content Server URL. Format: idc://host:intradocPort # UCMUser - Content Server user name used to connect through RIDC # UCMPwd - Password for UCMUser. Only include to avoid password prompt # Required for: Export and Import UCMConn=idc://mycontentserver.mycompany.com:9444 UCMUser=<enter Content Server admin user name here> #UCMPwd=<enter password for UCMUser here> # Specify a temp directory and name/location for the export archive # TmpDirPath -Optional. Temporary location for data extraction. # If not specified, defaults to the system temporary directory. # ArchiveName -Optional. Name for the document archive (.zip). # Default is docsexport.zip. # ArchivePath -Document archive location # Required for: Export and Import TmpDirPath=/scratch/user1/migrateMyPortalDocs/tmpdir ArchivePath=/scratch/user1/migrateMyPortalDocs/output ArchiveName=myportaldocs.zip # Specify MDS details (export only) # MDSConn - MDS JDBC connection. Format: # jdbc:oracle:thin:@host:port:SID or # jdbc:oracle:thin:@host:port/ServiceName # MDSUser - MDS schema user name used by the WebCenter Portal application # MDSPwd = Password for MDSUser. Only include to avoid password prompt # Required for: Export MDSConn=jdbc:oracle:thin:@mymdshost.mycompany.com:1521:wkcdb01 MDSUser=<enter MDS user name here> #MDSPwd=<enter password for MDSUser here> # Specify target portal for export or import. # Seperate multiple portal/template names with a comma. # Use internal names only. Do not enter display names. # Obtain internal names from "About Portal" and "About Portal Template" dialogs. # Prefix portal template names with 'spacetemplate/<template_internal_name>' # as indicated in the example. # Required for: Export ExportScopes=MyPortal1,MyPortal2,spacetemplate/MyPortalTemplate
Save the file. For example, save as myMigrationProperties.properties or similar.
Navigate to the WCP_ORACLE_HOME/webcenter/archives directory in which the Document Migration Utility, content-migration-tool.jar is located.
Run the Document Migration Utility by specifying the absolute path to your document migration properties file on the command line (Example F-1):
java -jar content-migration-tool.jar <absolute_path_to_migrationPropertiesFilename>
Optionally, specify logging settings using the java.util.logging.config.file parameter as described in Section F.3.3.3, "Running the Document Migration Utility with Additional Logging."
Specifying Document Migration Properties on the Command Line
Navigate to the WCP_ORACLE_HOME/webcenter/archives directory in which the Document Migration Utility, content-migration-tool.jar is located.
Run the Document Migration Utility by specifying individual properties on the command line:
To export content:
java -jar content-migration.jar Usage UCMConn UCMUser TmpDirPath ArchivePath ArchiveName MDSConn MDSUser ExportScopes [UCMPwd MDSPwd]
To import content:
java -jar content-migration.jar Usage UCMConn UCMUser TmpDirPath ArchvePath ArchiveName [UCMPwd]
Note: You can, optionally, specify the UCMPwd and MDSPwd parameters on the command line. If you do not do so, you are prompted to provide them.
Optionally, specify logging settings using the java.util.logging.config.file parameter, as described in Section F.3.3.3, "Running the Document Migration Utility with Additional Logging."
Specifying Document Migration Properties on the Command Line When Prompted
Navigate to the WCP_ORACLE_HOME/webcenter/archives directory in which the Document Migration Utility, content-migration-tool.jar is located.
Run the Document Migration Utility by specifying the properties on the command line when prompted:
java -jar content-migration.jar
Optionally, specify logging settings using the java.util.logging.config.file parameter, as described in Section F.3.3.3, "Running the Document Migration Utility with Additional Logging."
You can optionally run the Document Migration Utility with additional logging using the java.util.logging.config.file parameter as follows:
java -Djava.util.logging.config.file=<absolute_path_to_logging_properties_file> -jar content-migration-tool.jar <migrationProperties>
Note: The java.util.logging.config.file parameter must be specified immediately after the java command and before -jar.
Where the logging_properties_file includes settings such as:
handlers=java.util.logging.ConsoleHandler.level=INFO java.util.logging.ConsoleHandler.level=FINER java.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter oracle.webcenter.doclib.level=INFO
To use WebCenter Portal wiki pages to display the imported wikis, perform the steps below. For more information about wiki pages, see Section F.1, "Understanding Wiki Documents and Wiki Pages."
Log into WebCenter Portal.
Locate the portal where the content has been uploaded.
Click Actions and select Create and Page.
Give the wiki page a Name and select the Wiki page layout.
Note that the name of the wiki page must match the name of the folder in the portal folder in WebCenter Portal, which contains the wiki page of the same name.
For example, if in the portal folder you have a MarketingWiki folder and a MarketingWiki.htm document, the name of the wiki page must be MarketingWiki.