Sample XML configuration files

Sample files are provided. Many of the samples need to be modified with valid page or user name before they can be used. The sample XML configuration files are located in:

PortalServer_root/doc/xml-samples

Some of the XML samples are listed in the following. This list is not complete.

• Export.xml
• ExportRelease.xml
• ExportPage.xml
• ExportPageResult.xml
• CreatePage.xml
• CreateCsaPage.xml
• CreateLegacyPage.xml
• CreatePageFromZip.xml
• CreatePageFromTemplate.xml
• DeployPortlet.xml
• ClonePortlet.xml
• ModifyPortlet.xml
• ExportPortletAndPage.xml
• ExportSubTree.xml
• UpdateAccesscontrol.xml
• UpdateVault.xml
• CopyPage.xml
• CreateURL.xml
• CreateUser.xml
• CreateLanguage.xml: (Add/Remove a languages)
• DeployTheme.xml
• ExportAllPortlets.xml
• Transaction.xml
• MovePage.xml (The actual move of the page is done by the last two lines.)
• ActivatePortlet.xml (Change the states of portlets, portlet applications, or Web applications between active and inactive)
• Task.xml (Create a scheduler task for cleaning up portal resources, com.ibm.portal.datastore.task.ResourceCleanup.)

• RegisterPreDeployedEAR.xml

  Install a predeployed portlet. For deploy_target_directory specify PortalServer. An Enterprise Application Archive (EAR) can hold more than one Web Application Archive (WAR) files. To configure the predeployed portlet resources into portal we need to reference each Web Application resource separately in the XML configuration script. Provide a dedicated <web-app> statement with the corresponding data in the XML script for every WAR file that contains a portlet application in that EAR file.

• CleanupUsers.xml

  Identify users and groups in the portal database who have been removed from the user registry, but not from the portal database. In order for the file to work properly, we must set both attributes cleanup-users and export-users to true . Running this sample file results in a file that lists those users and groups and marks them for deletion. The result file also lists all users who have been muted, for example after too many wrong password attempts. Before you re-import the file, check the file and remove all users and groups that we want to keep in the portal database. During XML import all users and groups that remain listed in the file will be removed from the portal database. After deleting these entries via the modified XML script, all customizations are lost for the deleted users and groups.

• ExportIncludingOrphanedData.xml

  Perform an export that includes all orphaned data. We do this to prepare for deleting the orphaned data. Note that this sample uses the request type export-orphaned-data.

Parent topic: XML configuration reference

• XML samples for creating or removing language definitions
• XML samples for creating Producer definitions
• Export a Producer definition using the XML configuration interface
• Create a Producer definition and consuming a portlet by a single XML script

References: